Client Applications
In this chapter, we will examine how to use TypeScript to interact with the XCM pallet and construct XCM transactions. Using this information, you will be able to create an XCM dApp, or bridge.
While interacting with the XCM pallet via the Substrate RPC, we will make use of the polkadot/api package, throughout this chapter.
First, you will need to initialize the API as you would with any Substrate application.
import { ApiPromise, WsProvider } from '@polkadot/api';
const myApp = async () => {
const provider = new WsProvider('wss://rpc.shiden.astar.network');
const chainApi = await (new ApiPromise({ provider })).isReady;
const paraId = await chainApi.query.parachainInfo.parachainId.toString();
// Should output 2007
console.log(paraId)
};
On Astar Network, we use the Substrate Assets pallet to handle the XCM multi-asset representation. Let’s retrieve the list of assets from the network.
// import the known types
import { AssetMetadata, AssetDetails } from '@polkadot/types/interfaces';
// we create a custom interface for convenience
interface ChainAsset extends AssetDetails {
id: string;
metadata: AssetMetadata;
}
//...snip
// note that this function requires the chain to implement the Assets pallet
// note: The asset ID will have different meanings depending on the range
// 1 ~ 2^32-1 = User-defined assets. Anyone can register this assets on chain.
// 2^32 ~ 2^64-1 = Statemine/Statemint assets map. This is a direct map of all the assets stored in the common-goods state chain.
// 2^64 ~ 2^128-1 = Ecosystem assets like native assets on another parachain or other valuable tokens.
// 2^128 ~ 1 = Relaychain native token (DOT or KSM).
const assetsListRaw = await chainApi.query.assets.asset.entries();
const assetMetadataListRaw = await chainApi.query.assets.metadata.entries();
const assetInfos = assetsListRaw.map((i, index) => {
const assetId = (i[0].toHuman() as string[])[0].replaceAll(',', '');
const assetInfo = i[1].toHuman() as any as AssetDetails;
const metadata = assetMetadataListRaw[index][1].toHuman() as any as AssetMetadata;
return {
id: assetId,
...assetInfo,
metadata,
} as ChainAsset;
});
// convert the list into a string array of numbers without the comma and no nested entries
};
Running this function will produce a list of assets that are registered on the chain. This is useful when you want to create a UI that lists all possible assets, including XCM-compatible assets.
Next, let’s execute a cross-consensus function. Parachains will have a pallet called polkadotXcm, while Relay Chains will use the pallet xcmPallet. Both of them will use the same functions and syntax for sending XCM transactions.
In this example, we will send the Relay Chain asset to the parachain, as we've done in previous chapters, but this time, we’ll use TypeScript.
Let’s create two API instances, one for the parachain and another for the Relay Chain. Although for our example, we will only call the extrinsic from the Relay Chain, and initialize the parachain API instance to dynamically obtain the parachain ID.
import { ApiPromise, WsProvider } from '@polkadot/api';
import { Vec, u32 } from '@polkadot/types';
const parachainApi = async () => {
const provider = new WsProvider('wss://rpc.shiden.astar.network');
const chainApi = await (new ApiPromise({ provider })).isReady;
const paraId = (await chainApi.query.parachainInfo.parachainId()).toString();
// Should output 2007
console.log(paraId);
return chainApi;
};
const relaychainApi = async () => {
const provider = new WsProvider('wss://kusama-rpc.polkadot.io');
const chainApi = await (new ApiPromise({ provider })).isReady;
const parachains = ((await chainApi.query.paras.parachains()) as Vec<u32>).map((i) => i.toNumber());
// Should output a list of parachain IDs
console.log(parachains);
return chainApi;
};
Next, we create the main function for handling the actual XCM transaction.
import { Keyring } from '@polkadot/keyring';
import { decodeAddress, cryptoWaitReady } from '@polkadot/util-crypto';
const myApp = async () => {
await cryptoWaitReady();
const keyring = new Keyring({ type: 'sr25519' });
// ensure that this account has some KSM
const account = keyring.addFromUri('account seed', { name: 'Default' }, 'sr25519');
const parachainApiInst = await parachainApi();
const relaychainApiInst = await relaychainApi();
const parachainId = await parachainApiInst.query.parachainInfo.parachainId.toString();
// the target parachain connected to the current relaychain
const dest = {
V1: {
interior: {
X1: {
Parachain: parachainId,
},
},
parents: 0,
},
};
// the account ID within the destination parachain
const beneficiary = {
V1: {
interior: {
X1: {
AccountId32: {
network: 'Any',
id: decodeAddress(account.address),
},
},
},
parents: 0,
},
};
// 1 KSM
const amountToSend = new BN(10).pow(new BN(12));
// amount of fungible tokens to be transferred
const assets = {
V1: [
{
fun: {
Fungible: amountToSend,
},
id: {
Concrete: {
interior: 'Here',
parents: 0,
},
},
},
],
};
const txHash = await relaychainApiInst.tx.xcmPallet.reserveTransferAssets(dest, beneficiary, assets, 0).signAndSend(account);
};
To summarize, the first half of the function loads the account that will send the KSM and initialize the API. The real magic happens in the latter half of the function.
// the target parachain connected to the current relaychain
const dest = {
V1: {
interior: {
X1: {
Parachain: parachainId,
},
},
parents: 0,
},
};
// the account ID within the destination parachain
const beneficiary = {
V1: {
interior: {
X1: {
AccountId32: {
network: 'Any',
id: decodeAddress(account.address),
},
},
},
parents: 0,
},
};
// 1 KSM
const amountToSend = new BN(10).pow(new BN(12));
// amount of fungible tokens to be transferred
const assets = {
V1: [
{
fun: {
Fungible: amountToSend,
},
id: {
Concrete: {
interior: 'Here',
parents: 0,
},
},
},
],
};
As you can see, the dest refers to the destination or target chain that will receive the asset identified by the parachain ID. The beneficiary refers to the account within the parachain that will receive the token. Finally, the assets parameter refers to the amount you wish to send. Finally, we can sign the transaction with the following function:
// This can be zero
const feeAsset = 0;
const txHash = await relaychainApiInst.tx.xcmPallet.reserveTransferAssets(dest, beneficiary, assets, feeAsset).signAndSend(account);
Now once you finish the XCM transaction, you can list all the assets with the following script:
const assetsListRaw = await parachainApiInst.query.assets.asset.entries();
const assetMetadataListRaw = await parachainApiInst.query.assets.metadata.entries();
const assetInfos = assetsListRaw.map((i, index) => {
const assetId = (i[0].toHuman() as string[])[0].replaceAll(',', '');
const assetInfo = i[1].toHuman() as any as AssetDetails;
const metadata = assetMetadataListRaw[index][1].toHuman() as any as AssetMetadata;
return {
id: assetId,
...assetInfo,
metadata,
} as ChainAsset;
});
const assetBalance = await Promise.all(assetInfos.map(async (i) => {
const balance = await parachainApiInst.query.assets.account(i.id, account.address);
return {
symbol: i.metadata.symbol.toString(),
balance: balance.toString(),
}
}))
console.log(assetBalance);
Now, you should be able to transfer the asset from the Relay Chain to the parachain, and check to see if it was successful by listing all the assets within the asset pallet that the current account holds.
Please note that the gas fee will be deducted from the amount transferred, so it should be adjusted accordingly, based on the estimated gas fee. Please refer to the Gas Price API if required, for specific use cases.
You can find an entire project that integrates similar functionality in this repository.