@moonbeam-network/xcm-sdk
v2.7.4
Published
The Moonbeam XCM SDK enables developers to easily deposit and withdraw assets to Moonbeam/Moonriver from the relay chain and other parachains in the Polkadot/Kusama ecosystem
Downloads
2,872
Readme
The Moonbeam XCM SDK enables developers to easily transfer assets between chains, either between parachains or between a parachain and the relay chain, within the Polkadot/Kusama ecosystem. With the SDK, you don't need to worry about determining the multilocation of the origin or destination assets or which extrinsics are used on which networks to send XCM transfers.
The XCM SDK offers helper functions, that provide a very simple interface to execute XCM transfers between chains in the Polkadot/Kusama ecosystem. In addition, the XCM config package allows any parachain project to add their information in a standard way, so they can be immediately supported by the XCM SDK.
Documentation
You can find the documentation at https://moonbeam-foundation.github.io/xcm-sdk/latest/.
Installation
npm i @moonbeam-network/xcm-sdk
:warning: You need to have peer dependencies of SDK installed as well.
npm i @polkadot/api @polkadot/api-augment @polkadot/types @polkadot/util @polkadot/util-crypto @polkadot/apps-config ethers
Usage
The following sections contain basic examples of how to work with the XCM SDK to build transfer data to transfer an asset from one chain to another and how to submit the transfer. For a detailed overview on how to use each method, including a reference to the parameters and returned data of each method exposed by the SDK, please refer to the XCM SDK docs.
Build XCM Transfer Data
import { Sdk } from '@moonbeam-network/xcm-sdk';
const { assets, getTransferData } = Sdk();
// You can build the XCM transfer data via the assets function
const dataViaAssetsMethod = await assets()
.asset('INSERT_ASSET')
.source('INSERT_SOURCE_CHAIN')
.destination('INSERT_DESTINATION_CHAIN')
.accounts('INSERT_SOURCE_ADDRESS', 'INSERT_DESTINATION_ADDRESS', {
evmSigner?: 'INSERT_EVM_SIGNER',
polkadotSigner?: 'INSERT_POLKADOT_SIGNER',
});
// Or via the getTransferData function
const dataViaGetTransferDataMethod = await getTransferData({
destinationAddress: 'INSERT_DESTINATION_ADDRESS',
destinationKeyOrChain: 'INSERT_DESTINATION_CHAIN',
evmSigner?: 'INSERT_EVM_SIGNER',
keyOrAsset: 'INSERT_ASSET',
polkadotSigner?: 'INSERT_POLKADOT_SIGNER',
sourceAddress: 'INSERT_SOURCE_ADDRESS',
sourceKeyOrChain: 'INSERT_SOURCE_CHAIN',
});
Transfer
...
const hash = await dataViaGetTransferDataMethod.transfer('INSERT_TRANSFER_AMOUNT');
Examples
git clone [email protected]:moonbeam-foundation/xcm-sdk.git
cd xcm-sdk
npm i
cd examples/sdk-simple
# edit index.ts by adding your accounts
npm start
Contributing
git clone [email protected]:moonbeam-foundation/xcm-sdk.git
npm i
npm run dev
Tests
Unit tests
npm run test
Acceptance tests
cp .env.example .env
# add private key and suri to .env file
npm run test:acc
Release
To create a dev version go to GitHub actions and run publish dev versions
workflow.
To create a release version run:
npm run changeset
Testing the change in the SDK locally
Build the project:
npm run build
npm run link
In your project where you would like to test the changes:
npm link @moonbeam-network/xcm-types @moonbeam-network/xcm-utils @moonbeam-network/xcm-builder @moonbeam-network/xcm-config @moonbeam-network/xcm-sdk
If you need you can link other packages too.
After testing is done, unlink the SDK:
npm unlink @moonbeam-network/xcm-types @moonbeam-network/xcm-utils @moonbeam-network/xcm-builder @moonbeam-network/xcm-config @moonbeam-network/xcm-sdk