Class AssetTransferApi

Create a local claimAssets XCM transaction to retrieve trapped assets. This can be either locally on a systems parachain, on the relay chain or any chain that supports the pallet-xcm claimAssets runtime call.

import { TxResult } from '@substrate/asset-transfer-api'

let callInfo: TxResult<'call'>;
try {
  callInfo = await assetsApi.claimAssets(
	   [`{"parents":"0","interior":{"X2":[{"PalletInstance":"50"},{"GeneralIndex":"1984"}]}}`],
    ['1000000000000'],
    '0xf5d5714c084c112843aca74f8c498da06cc5a2d63153b825189baa51043b1f0b',
    {
      format: 'call',
      xcmVersion: 2,
    }
  )
} catch (e) {
  console.error(e);
  throw Error(e);
}
Copy

Create an asset transfer transaction. This can be either locally on a systems parachain or relay chain, or between chains using xcm.

import { TxResult } from '@substrate/asset-transfer-api'

let callInfo: TxResult<'call'>;
try {
  callInfo = await assetsApi.createTransferTransaction(
    '1000',
    '5EWNeodpcQ6iYibJ3jmWVe85nsok1EDG8Kk3aFg8ZzpfY1qX',
    ['WND'],
    ['1000000000000'],
    {
      format: 'call',
      xcmVersion: 2,
    }
  )
} catch (e) {
  console.error(e);
  throw Error(e);
}
Copy

Decodes the hex of an extrinsic into a string readable format.

const decodedExt = assetsApi.decodeExtrinsic(tx, 'call');
console.log(JSON.parse(decodedExt));
Copy

Dry Run a call to determine its execution result

const executionResult = await assetApi.dryRunCall(sendersAddr, tx, 'call');
console.log(executionResult.toJSON());
Copy

Fetch estimated fee information for an extrinsic

const feeInfo = assetApi.fetchFeeInfo(tx, 'call');
console.log(feeInfo.toJSON());
Copy

Initialize the registry. This will only activate the registry for the CDN. If the registryType is NPM the initalization will exit since the AssetTransferApi initializes with the reigstry from the NPM package.

Queries the provided chain and returns the estimated fees for forwarded xcms in an executed dry run