# aelf-sdk-cross-chain

> sdk for cross chain

Latest version **1.0.14** (published 2020-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install aelf-sdk-cross-chain
pnpm add aelf-sdk-cross-chain
yarn add aelf-sdk-cross-chain
bun add aelf-sdk-cross-chain
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.14 |
| Published | 2020-12-26 |
| First published | 2019-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 452.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | hzz780 |
| Maintainers | hzz780 |
| Keywords | aelf-sdk-cross-chain |

## Links

- npm: https://www.npmjs.com/package/aelf-sdk-cross-chain
- Repository: https://github.com/AElfProject/aelf-sdk-cross-chain.js
- Homepage: https://github.com/AElfProject/aelf-sdk-cross-chain.js#readme
- Issues: https://github.com/AElfProject/aelf-sdk-cross-chain.js/issues
- npm.io page: https://npm.io/package/aelf-sdk-cross-chain

## Dependencies (1)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2

## Recent versions

- 1.0.14 (latest) — 2020-12-26
- 1.0.13 — 2020-12-25
- 1.0.12 — 2020-07-17
- 1.0.11 — 2020-02-18
- 1.0.10 — 2020-02-15
- 1.0.9 — 2019-12-30
- 1.0.8 — 2019-12-24
- 1.0.7 — 2019-10-23
- 1.0.6 — 2019-10-23
- 1.0.5 — 2019-10-09
- 1.0.4 — 2019-10-09
- 1.0.3 — 2019-10-09
- 1.0.2 — 2019-10-09
- 1.0.1 — 2019-09-12
- 1.0.0 — 2019-08-31

## 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
<!-- minified version with UMD module -->
<script src="https://unpkg.com/aelf-sdk-cross-chain@lastest/dist/aelf-cross-chain.umd.js"></script>
```

### 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
<!-- minified version with UMD module -->
<script src="https://unpkg.com/aelf-sdk-cross-chain@lastest/dist/aelf-cross-chain.umd.js"></script>
<script>
  // window.AElfCrossChain
</script>
```

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.

---
_Source: https://npm.io/package/aelf-sdk-cross-chain · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._