https://github.com/aelfproject/aelf-sdk-cross-chain.js
sdk for cross chain transaction.
https://github.com/aelfproject/aelf-sdk-cross-chain.js
Last synced: about 1 year ago
JSON representation
sdk for cross chain transaction.
- Host: GitHub
- URL: https://github.com/aelfproject/aelf-sdk-cross-chain.js
- Owner: AElfProject
- Created: 2019-08-30T08:28:05.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-09-06T09:22:47.000Z (almost 5 years ago)
- Last Synced: 2024-04-26T08:04:29.530Z (about 2 years ago)
- Language: JavaScript
- Size: 484 KB
- Stars: 1
- Watchers: 6
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# aelf-sdk-cross-chain.js
## Introduction
A JS sdk aims to provide cross chain tool.
Please pay attention that some function of `aelf-sdk.js` is the input params of the `aelf-sdk-cross-chain.js`.
If we want use `aelf-sdk-cross-chain.js`, we need import/require `aelf-sdk.js` at first.
## Installation
### Script
```html
```
### Npm
```bash
npm install aelf-sdk-cross-chain
```
### Yarn
```bash
yarn add aelf-sdk-cross-chain
```
## Library files
In our dist directory, we support different packages for different platforms, such as Node and Browser.
packages | usage
---|---
dist/aelf-cross-chain.umd.js | built for browser & node, add some node modules by webpack
You can choose any packages based on what you need, for examples:
if you are new to FrontEnd, you can use `window.AElfCrossChain` by add a script tag in your html files.
```html
// window.AElfCrossChain
```
if you want to use a bundle system such as webpack or rollup, and build your applications for Node.js and Browsers, just import the specified version of package files.
### For browser usage and use UMD
Webpack:
```js
module.exports = {
// ...
resolve: {
alias: {
'aelf-sdk-cross-chain': 'aelf-sdk-cross-chain/dist/aelf-cross-chain.umd.js'
}
}
}
```
Rollup:
```js
const alias = require('rollup-plugin-alias');
rollup({
// ...
plugins: [
alias({
'aelf-sdk-cross-chain': require.resolve('aelf-sdk-cross-chain/dist/aelf-cross-chain.umd.js')
})
]
})
```
### For Node.js usage and use commonjs module system
Webpack:
```js
module.exports = {
// ...
resolve: {
alias: {
'aelf-sdk-cross-chain': 'aelf-sdk-cross-chain/dist/aelf-cross-chain.umd.js'
}
}
}
```
Rollup:
```js
const alias = require('rollup-plugin-alias');
rollup({
// ...
plugins: [
alias({
'aelf-sdk-cross-chain': require.resolve('aelf-sdk-cross-chain/dist/aelf-cross-chain.umd.js')
})
]
})
```
## Basic Demo
```javascript
/**
* @author huangzonghze
* @description cross chain demo
*/
/* eslint-env node */
const AElf = require('aelf-sdk');
const Wallet = AElf.wallet;
const {
CrossChain
} = require('aelf-sdk-cross-chain');
// address: 2hxkDg6Pd2d4yU1A16PTZVMMrEDYEPR8oQojMDwWdax5LsBaxX
const defaultPrivateKey = 'bdb3b39ef4cd18c2697a920eb6d9e8c3cf1a930570beb37d04fb52400092c42b';
const receiveAddress = '2hxkDg6Pd2d4yU1A16PTZVMMrEDYEPR8oQojMDwWdax5LsBaxX';
const wallet = Wallet.getWalletByPrivateKey(defaultPrivateKey);
const sendInstance = new AElf(new AElf.providers.HttpProvider('http://127.0.0.1:8000')); // a chain
const receiveInstance = new AElf(new AElf.providers.HttpProvider('http://127.0.0.1:8001')); // another chain
async function init() {
const crossChainInstance = new CrossChain({
AElfUtils: AElf.utils,
sendInstance,
receiveInstance,
wallet,
mainChainId: 9992731,
issueChainId: 9992731
});
// await crossChainInstance.init();
// Can accelerate the process.
await crossChainInstance.init({
contractAddresses: {
tokenContractAddressSend: '7RzVGiuVWkvL4VfVHdZfQF2Tri3sgLe9U991bohHFfSRZXuGX',
crossChainContractAddressSend: '2snHc8AMh9QMbCAa7XXmdZZVM5EBZUUPDdLjemwUJkBnL6k8z9',
tokenContractAddressReceive: 'JRmBduh4nXWi1aXgdUsj5gJrzeZb2LxmrAbf7W99faZSvoAaE',
crossChainContractAddressReceive: '2SQ9LeGZYSWmfJcYuQkDQxgd3HzwjamAaaL4Tge2eFSXw2cseq'
},
chainIds: {
chainIdSend: 'tDVV',
chainIdReceive: 'AELF'
}
});
const {
crossTransferTxId
} = await crossChainInstance.send({
to: receiveAddress,
symbol: 'ELF',
amount: 1,
memo: 'Hello World'
});
// const registerMsg = await crossChainInstance.tokenCrossChainInstance.checkRegister();
// const result = await crossChainInstance.isChainReadyToReceive({
// crossTransferTxId: '560f44f346b23eb455fb43b37f8ae1ef28636c5a1fc3a9aed3c55f475c82d0aa'
// });
const receiveInfo = await crossChainInstance.receive({
// crossTransferTxId: 'cad78d4697f23ec34d03956ab17c0c8443d97277f7590d2b178d714d4a9682d3'
crossTransferTxId
});
return receiveInfo;
}
init().then(result => {
console.log('init result: ', result);
}).catch(error => {
console.log('init error: ', error);
});
```
## Use tokenCrossChainBasic
`crossChain` of `aelf-sdk-cross-chain` is a wrap of `tokenCrossChainBasic`.
`tokenCrossChainBasic` only provide basic methods `init`, `send` and `recevie`.
It means we need write our own logic to ensure whether the chains are ready to recevie the cross chain transaction.
`crossChain` provide a simple logic to solve this situation.
```javascript
// Demo
const tokenCrossChainInstance = new TokenCrossChainBasic({
AElfUtils: AElf.Utils,
sendInstance: sendInstance,
receiveInstance: receiveInstance
});
const contractsAndChainIds = await tokenCrossChainInstance.init({
wallet: wallet
});
const params = {
to: receiveAddress,
symbol: 'ELF',
amount: 1,
memo: 'Hello World'
};
const sendInfo = await tokenCrossChainInstance.send(contractsAndChainIds, params);
const receiveInfo = await tokenCrossChainInstance.receive({
crossTransferTxId // sendInfo.crossTransferTxId
});
// const registerMsg = await crossChainInstance.tokenCrossChainInstance.checkRegister();
const registerMsg = await tokenCrossChainInstance.checkRegister();
```
And you can get more information from the source code.