pnpm | npm install || yarn add @polkadot/api @polkadot/types @polkadot/api-base @polkadot/apps-config @polkadot/utilpnpm | npm install || yarn add @paraspell/sdkBuilder pattern:
import { Builder } from '@paraspell/sdk'Other patterns:
// ESM
import * as paraspell from '@paraspell/sdk'
// CommonJS
const paraspell = require('@paraspell/sdk')NOTES:
- If you wish to transfer from Parachain that uses long IDs for example Moonbeam you have to add the character 'n' to the end of currencyID. Eg: .currency({id: 42259045809535163221576417993425387648n}) will mean you transfer xcDOT.
- You can now use custom ParachainIDs if you wish to test in TestNet. Just add parachainID as an additional parameter eg: .to('Basilisk', 2948).
- You can now add an optional parameter useKeepAlive which will ensure, that you send more than the existential deposit.
- Since v5 you can fully customize all multilocations (address, currency and destination). Instead of a string parameter simply pass an object with multilocation instead for more information refer to the following PR https://github.com/paraspell/xcm-tools/pull/199.
- Fee asset is now a required builder parameter when you enter a multilocation array.
- When using a multilocation array the amount parameter is overridden.
- Multilocation arrays are now available. Customize your asset multilocations by .currency({multiasset: [{multilocation1},{multilocation2}..{multilocationN}]}) For more information refer to the official documentation or following PR https://github.com/paraspell/xcm-tools/pull/224.
- POLKADOT <> KUSAMA Bridge is now available! Try sending DOT or KSM between AssetHubs - More information here: https://paraspell.github.io/docs/sdk/xcmPallet.html#ecosystem-bridges.
- You can now customize XCM Version! Try using .xcmVersion parameter after address in builder.
- POLKADOT <> ETHEREUM Bridge is now available! Try sending WETH between the ecosystems - More information here: https://paraspell.github.io/docs/sdk/xcmPallet.html#ecosystem-bridges.
await Builder(/*node api - optional*/)
.from(NODE)
.to(NODE /*,customParaId - optional*/ | Multilocation object /*Only works for PolkadotXCM pallet*/)
.currency({id: currencyID} | {symbol: currencySymbol}, | {multilocation: multilocationJson} | {multiasset: multilocationJsonArray})
/*.feeAsset(feeAsset) - Parameter required when using MultilocationArray*/
.amount(amount) // Overriden when using MultilocationArray
.address(address | Multilocation object /*If you are sending through xTokens, you need to pass the destination and address multilocation in one object (x2)*/)
/*.xcmVersion(Version.V1/V2/V3/V4) //Optional parameter for manual override of XCM Version used in call*/
.build()
/*
EXAMPLE:
await Builder()
.from('Basilisk')
.to('Robonomics')
.currency({symbol:'XRT'})
.amount(1000000000000)
.address('4FCUYBMe2sbq5KosN22emsPUydS8XUwZhJ6VUZesmouGu6qd')
.build()
*/await Builder(/*node api - optional*/)
.to(NODE/*,customParaId - optional*/ | Multilocation object)
.amount(amount)
.address(address | Multilocation object)
/*.xcmVersion(Version.V1/V2/V3/V4) //Optional parameter for manual override of XCM Version used in call*/
.build()
/*
EXAMPLE:
await Builder()
.to('AssetHubPolkadot')
.amount(1000000000000)
.address('141NGS2jjZca5Ss2Nysth2stJ6rimcnufCNHnh5ExSsftn7U')
.build()
*/await Builder(/*node api - optional*/)
.from(NODE)
.amount(amount)
.address(address | Multilocation object)
/*.xcmVersion(Version.V1/V2/V3/V4) //Optional parameter for manual override of XCM Version used in call*/
.build()
/*
EXAMPLE:
await Builder()
.from('AssetHubPolkadot')
.amount(1000000000000)
.address('141NGS2jjZca5Ss2Nysth2stJ6rimcnufCNHnh5ExSsftn7U')
.build()
*/NOTE: Custom multilocations are not available when keepALive check is used
await Builder(/*node api - optional*/)
.from(NODE)
.amount(amount)
.address(address)
.useKeepAlive(destinationParaAPI)
/*.xcmVersion(Version.V1/V2/V3/V4) //Optional parameter for manual override of XCM Version used in call*/
.build()You can batch XCM calls and execute multiple XCM calls within one call. All three scenarios (Para->Para, Para->Relay, Relay->Para) can be used and combined.
await Builder(/*node api - optional*/)
.from(NODE) //Ensure, that origin node is the same in all batched XCM Calls.
.to(NODE_2) //Any compatible Parachain
.currency(currency) //Currency to transfer (If Para->Para), otherwise you do not need to specify .currency()
.amount(amount)
.address(address | Multilocation object)
.addToBatch()
.from(NODE) //Ensure, that origin node is the same in all batched XCM Calls.
.to(NODE_3) //Any compatible Parachain
.currency(currency) //Currency to transfer (If Para->Para), otherwise you do not need to specify .currency()
.amount(amount)
.address(address | Multilocation object)
.addToBatch()
.buildBatch({
// This settings object is optional and batch all is the default option
mode: BatchMode.BATCH_ALL //or BatchMode.BATCH
})NOTES:
- Since version v5 there was a breaking change introduced. You now pass single object with properties instead of parameters
- Since v5 you can fully customize all multilocations (address, currency and destination). Instead of string parameter simply pass object with multilocation instead for more information refer to the following PR https://github.com/paraspell/xcm-tools/pull/199.
- Custom multilocations are not available when keepALive check is used
// Transfer assets from Parachain to Parachain
await paraspell.xcmPallet.send(
{
api?: ApiPromise,
origin: origin Parachain name string,
currency: {id: currencyID} | {symbol: currencySymbol}, | {multilocation: multilocationJson} | {multiasset: multilocationJsonArray},
feeAsset? - Fee asset select id
amount: any,
to: destination address string | Multilocation object,
destination: destination Parachain ID | Multilocation object /*If you are sending through xTokens, you need to pass the destination and address multilocation in one object (x2)*/,
paraIdTo?: number,
destApiForKeepAlive?: ApiPromise
}
)
// Transfer assets from Parachain to Relay chain
await paraspell.xcmPallet.send(
{
api?: ApiPromise,
origin: origin Parachain name string,
amount: any,
to: destination address string | Multilocation object,
paraIdTo?: number,
destApiForKeepAlive?: ApiPromise
}
)
// Transfer assets from Relay chain to Parachain
await paraspell.xcmPallet.transferRelayToPara(
{
api?: ApiPromise,
destination: destination Parachain ID | Multilocation object,
amount: any,
to: destination address string | Multilocation object,
paraIdTo?: number,
destApiForKeepAlive?: ApiPromise
}
)//Claim XCM trapped assets from the selected chain
await Builder(api)
.claimFrom(NODE)
.fungible(MultilocationArray (Only one multilocation allowed) [{Multilocation}])
.account(address | Multilocation object)
/*.xcmVersion(Version.V3) Optional parameter, by default V3. XCM Version ENUM if a different XCM version is needed (Supported V2 & V3). Requires importing Version enum.*/
.build()// Retrieve assets object from assets.json for particular node including information about native and foreign assets
paraspell.assets.getAssetsObject(node: TNode)
// Retrieve foreign assetId for a particular node and asset symbol
paraspell.assets.getAssetId(node: TNode, symbol: string)
// Retrieve the symbol of the relay chain for a particular node. Either "DOT" or "KSM"
paraspell.assets.getRelayChainSymbol(node: TNode)
// Retrieve string array of native assets symbols for particular node
paraspell.assets.getNativeAssets(node: TNode)
// Retrieve object array of foreign assets for a particular node. Each object has a symbol and assetId property
paraspell.assets.getOtherAssets(node: TNode)
// Retrieve string array of all assets symbols. (native and foreign assets are merged into a single array)
paraspell.assets.getAllAssetsSymbols(node: TNode)
// Check if a node supports a particular asset. (Both native and foreign assets are searched). Returns boolean
paraspell.assets.hasSupportForAsset(node: TNode, symbol: string)
// Get decimals for specific asset
paraspell.assets.getAssetDecimals(node: TNode, symbol: string)
// Get specific node id
paraspell.assets.getParaId(node: TNode)
// Get specific TNode from nodeID
paraspell.assets.getTNode(nodeID: number)
// Import all compatible nodes as constant
paraspell.NODE_NAMESimport { getDefaultPallet, getSupportedPallets, SUPPORTED_PALLETS } from '@paraspell/sdk'
//Retrieve default pallet for specific Parachain
getDefaultPallet(node: TNode)
// Returns an array of supported pallets for a specific Parachain
getSupportedPallets(node: TNode)
// Print all pallets that are currently supported
console.log(SUPPORTED_PALLETS)import { getExistentialDeposit } from "@paraspell/sdk";
const ed = getExistentialDeposit('Acala')import { getTransferInfo, getBalanceForeign, getBalanceNative, getOriginFeeDetails } from "@paraspell/sdk";
//Get balance of foreign currency
await getBalanceForeign(address, Parachain name, currency /*- {id: currencyID} | {symbol: currencySymbol}*/)
//Get balance of native currency
await getBalanceNative(address, Parachain name)
//Get fee information regarding XCM call
await getOriginFeeDetails(from, to, currency /*- {id: currencyID} | {symbol: currencySymbol}*/, amount, originAddress)
//Get all the information about XCM transfer
await getTransferInfo(from, to, address, destinationAddress, currency /*- {id: currencyID} | {symbol: currencySymbol}*/, amount)-
Run compilation using
pnpm compile -
Run linter using
pnpm lint -
Run unit tests using
pnpm test -
Run end-to-end tests using
pnpm test:e2e -
Update Parachain registered assets in the map using script -
pnpm updateAssets -
Update XCM pallets in the map using script -
pnpm updatePallets -
Update existential deposits in the map using script -
pnpm updateEds -
Run all core tests and checks using
pnpm runAll
XCM SDK can be tested in Playground.
Made with 💛 by ParaSpell✨
Published under MIT License.
