Dry Run a call to determine its execution result
const executionResult = await assetApi.dryRunCall(sendersAddr, tx, 'call');
console.log(executionResult.toJSON());
address of the account sending the transaction
a payload, call or submittable
The format the tx is in
-Fetch estimated fee information for an extrinsic
const feeInfo = assetApi.fetchFeeInfo(tx, 'call');
console.log(feeInfo.toJSON());
a payload, call or submittable
The format the tx is in
-Errors that may be returned by the API.
-Errors that may be returned by the API.
+Not able to find the asset.
-The following option is disabled given the inputs.
-An issue has happened internally.
-The inputted address is invalid.
-The inputted asset is incorrect or invalid, and does not exist given the surrounding specs. +
The following option is disabled given the inputs.
+An issue has happened internally.
+The inputted address is invalid.
+The inputted asset is incorrect or invalid, and does not exist given the surrounding specs.
This exlcudes MultiLocation assets which are handled using InvalidMultiLocationAsset.
The direction in which these assets are going to be sent is incorrect.
-An input or lack of input to any public facing function by the user is incorrect, and or invalid. +
The direction in which these assets are going to be sent is incorrect.
+An input or lack of input to any public facing function by the user is incorrect, and or invalid. This may include using options incorrectly.
-The inputted multilocation is incorrect.
-The following pallet does not support the method to be used.
-The xcm version is invalid.
-Multiple assets have been found for a single token symbol.
-The provided paysWithFeeOrigin asset has no liquidity pool.
-Not Implemented yet.
-The following pallet is not found.
-Not able to find the pertinent registry to gather certain information. This can refer to xcAssets.
-Did not find the correct call in the current runtime.
-The specName was not provided when injecting a new chain in the registry.
-The tokens were not provided when injecting a new chain in the registry.
-Did not find a known consensus system for bridge transaction.
-The provided JS environment is not supported, and the api will not run.
-The inputted multilocation is incorrect.
+The following pallet does not support the method to be used.
+The xcm version is invalid.
+Multiple assets have been found for a single token symbol.
+The provided paysWithFeeOrigin asset has no liquidity pool.
+Not Implemented yet.
+The following pallet is not found.
+Not able to find the pertinent registry to gather certain information. This can refer to xcAssets.
+Did not find the correct call in the current runtime.
+The specName was not provided when injecting a new chain in the registry.
+The tokens were not provided when injecting a new chain in the registry.
+Did not find a known consensus system for bridge transaction.
+The provided JS environment is not supported, and the api will not run.
+Represents all possible tx directions
-Represents all possible tx directions
+Local tx
-Parachain to Parachain.
-Parachain to Relay chain.
-Parachain to System parachain.
-Relay chain to an external GlobalConsensus chain.
Relay chain to Parachain.
-Relay to System Parachain.
-System parachain to an external GlobalConsensus chain.
System parachain to Parachain.
-System parachain to Relay chain.
-System parachain to System parachain chain.
-Parachain to Parachain.
+Parachain to Relay chain.
+Parachain to System parachain.
+Relay chain to an external GlobalConsensus chain.
Relay chain to Parachain.
+Relay to System Parachain.
+System parachain to an external GlobalConsensus chain.
System parachain to Parachain.
+System parachain to Relay chain.
+System parachain to System parachain chain.
+Construct a Polkadot-js ApiPromise, and retrieve the specName of the chain.
+Construct a Polkadot-js ApiPromise, and retrieve the specName of the chain.
import { constructApiPromise } from '@substrate/asset-transfer-api';
const { api, specName, safeXcmVersion } = constructApiPromise('wss://some_ws_url');
WebSocket Url to connect to.
ApiOptions
-yarn build:examples && node ./examples/build/examples/<file_to_run>.js.
import { AssetTransferApi, constructApiPromise } from '@substrate/asset-transfer-api';
// NOTE: This should all be wrapped in an asynchronous layer.
// This constructs a polkadot-js ApiPromise, it is totally viable for one to construct their
// own ApiPromise, and pass it into AssetTransferApi, but keep in mind the `specName`, and `safeXcmVersion` are also necessary.
const { api, specName, safeXcmVersion } = await constructApiPromise('wss://westmint-rpc.polkadot.io');
const assetsApi = new AssetTransferApi(api, specName, safeXcmVersion);
const call = assetsApi.createTransferTransaction(
'2001', // destChainId (If the destination is a relay chain put `0`)
'0x00', // destAddress
['1', '2'], // Array of AssetIds
['1000000000', '2000000000'], // Array of amounts of each token to transfer
{
format: 'call',
xcmVersion: 1
} // Options
)
// The AssetTransferApi exposes one method as of now called: `createTransferTransaction`
/**
* Create an XCM transaction to transfer Assets, or native tokens from one
* chain to another.
*
* @param destChainId ID of the destination (para) chain (‘0’ for Relaychain)
* @param destAddr Address of destination account
* @param assetIds Array of assetId's to be transferred
* @param amounts Array of the amounts of each token to transfer
* @param opts Options
*/
AssetTransferApi.createTransferTransaction(
destChainId: string,
destAddr: string,
assetIds: string[],
amounts: string[],
opts?: TransferArgsOpts<T>
)
+AssetTransferApi & AssetTransferApiOpts & TransferArgsOpts
// The AssetTransferApi method: `createTransferTransaction`
/**
* Create an XCM transaction to transfer Assets, or native tokens from one
* chain to another.
*
* @param destChainId ID of the destination (para) chain (‘0’ for Relaychain)
* @param destAddr Address of destination account
* @param assetIds Array of assetId's to be transferred
* @param amounts Array of the amounts of each token to transfer
* @param opts Options
*/
AssetTransferApi.createTransferTransaction(
destChainId: string,
destAddr: string,
assetIds: string[],
amounts: string[],
opts?: TransferArgsOpts<T>
)
+
+// The AssetTransferApi method: `fetchFeeInfo`
/**
* Fetch estimated fee information for an extrinsic
*
* @param tx a payload, call or submittable
* @param format The format the tx is in
*/
AssetTransferApi.fetchFeeInfo(
tx: ConstructedFormat<T>,
format: T,
)
// AssetTransferApiOpts are the options for the `AssetTransferApi`
type AssetTransferApiOpts = {
/**
* The injectedRegistry allows you to add custom values to the predefined initialized registry.
* If you would like to see the registry you may visit https://github.com/paritytech/asset-transfer-api-registry/blob/main/docs/registry.json
* When adding a new chain, the `specName` and `tokens` fields are mandatory.
*
* An example input of the registry would be:
* {
* polkadot: {
* '9876': {
* tokens: ['TST'],
* assetsInfo,
* specName: 'testing',
* }
* }
* }
*
* NOTE: It supports adding info for `polkadot`, `kusama`, `westend` and `rococo`.
*/
injectedRegistry?: RequireAtLeastOne<ChainInfoRegistry>;
/**
* The overrideRegistry option allows you to modify chain data already present in the registry,
* either overriding fields' values or adding new information. If the chain of which data is
* being overriden is not present in the registry, it will be treated as if it were
* and injectedRegistry and added following the same logic.
*
* If the chain is present in the registry, it will override only the fields
* present in the passed overrideRegistry, leaving the remaining as is.
*
* An example input for overrideRegistry would be:
* {
* westend: {
* '0': {
* tokens: ['WER'],
* }
* }
* }
*
* This would override the existing native token for the Westend Relay Chain
* to WER instead of WND.
*/
overrideRegistry?: RequireAtLeastOne<ChainInfoRegistry<InjectedChainInfoKeys>>;
/**
* RegistryTypes is a string and can either be 'CDN' or 'NPM'.
*
* CDN - The registry will be initialized with the up to date version given the CDN
* NPM - The registry will be initialized with the NPM version which is updated less frequently.
*/
registryType?: RegistryTypes;
};
@@ -153,4 +155,4 @@ Asset API used for common good parachains
Running Zombienet
From the root directory run ./<zombienet_binary_name> -p native spawn ./zombienet/<network_file>.toml | tee zombienet.log
Create an asset
From the root directory run yarn start:zombienet-post-script. You can run this right after running your zombienet network.
E2E Testing
You can access the E2E tests and its documentation here.
-Return value for constructApiPromise
Return value for constructApiPromise
Polkadot-js ApiPromise
-Chain name of the chain which the api is connected to.
-SafeXcmVersion for the chain which the api is connected too.
-SpecName of the chain which the api is connected to.
-Chain name of the chain which the api is connected to.
+SafeXcmVersion for the chain which the api is connected too.
+SpecName of the chain which the api is connected to.
+The TransferArgsOpts are the options passed into createTransferTransaction.
-The TransferArgsOpts are the options passed into createTransferTransaction.
+Optional assetThe XCM TransferType used to transfer assets.
Provided to construct transferAssetsUsingTypeAndThen transactions.
Optional customOptional custom XCM message to be executed on destination chain. +
Optional customOptional custom XCM message to be executed on destination chain.
Should be provided if a custom xcm message is needed after transfering assets.
Defaults to Xcm(vec![DepositAsset { assets: Wild(AllCounted(assets.len())), beneficiary }])
Optional dryOptionally allows for dry running the constructed tx in order get the estimated fees and execution result.
-Optional feesThe XCM TransferType used to pay fees for an XCM transfer.
+
Optional dryOptionally allows for dry running the constructed tx in order get the estimated fees and execution result.
+Optional feesThe XCM TransferType used to pay fees for an XCM transfer.
Provided to construct transferAssetsUsingTypeAndThen transactions.
Optional formatOption that specifies the format in which to return a transaction. +
Optional formatOption that specifies the format in which to return a transaction.
It can either be a payload, call, or submittable.
Note: A submittable will return a SubmittableExtrinsic polkadot-js type, whereas
a payload or call will return a hex.
Optional keepFor creating local asset transfers, this will allow for a transferKeepAlive as opposed
+
Optional keepFor creating local asset transfers, this will allow for a transferKeepAlive as opposed
to a transfer.
Optional paysAssetId to pay fee's on the destination parachain.
-Optional paysAssetId to pay fee's on the current common good parachain. +
Optional paysAssetId to pay fee's on the destination parachain.
+Optional paysAssetId to pay fee's on the current common good parachain. Polkadot AssetHub: default DOT Kusama AssetHub: default KSM
-Optional remoteThe RemoteReserve location for an XCM transfer. +
Optional remoteThe RemoteReserve location for an XCM transfer.
Should be provided when specifying an assetTransferType of RemoteReserve.
Optional remoteThe RemoteReserve location for an XCM transfers' fees. +
Optional remoteThe RemoteReserve location for an XCM transfers' fees.
Should be provided when specfying a feesTransferType of RemoteReserve.
Optional sendersThe SS58 Address the tx will be sent from. This is specifically used for the format payload.
+
Optional sendersThe SS58 Address the tx will be sent from. This is specifically used for the format payload.
It is necessary because the payload will need information such as the nonce.
Optional transferFor creating local asset transfers, this will allow for a transferAll call as opposed
+
Optional transferFor creating local asset transfers, this will allow for a transferAll call as opposed
to a transfer call.
Optional transferBoolean to declare if this will transfer liquidity tokens. +
Optional transferBoolean to declare if this will transfer liquidity tokens. Default is false.
-Optional weightOption for applying a custom weightLimit.
+
Optional weightOption for applying a custom weightLimit.
If not inputted it will default to Unlimited.
Optional proofProvided when creating limited txs, represents the amount of storage in bytes that can be used by the tx
Optional refProvided when creating limited txs, represents the allowed amount of computation time the tx can use
-Optional xcmOptional assetId that will be used to pay for fees. Used with the dryRunCall option to determine fees in the specified asset.
Optional xcmSet the xcmVersion for message construction. If this is not present a supported version +
Optional xcmOptional assetId that will be used to pay for fees. Used with the dryRunCall option to determine fees in the specified asset.
Optional xcmSet the xcmVersion for message construction. If this is not present a supported version will be queried, and if there is no supported version a safe version will be queried.
-The TxResult is the result of constructing a transaction. +
The TxResult is the result of constructing a transaction. T extends Format in the context of the options passed in for the Format the user expects.
-The destination specName of the transaction
-The direction of the cross chain transfer.
-The format type the tx is ouputted in.
-Optional forwardedList of forwarded xcms and the weights needed to execute them.
-Optional localWeight needed to execute the local segment of a provided XCM.
-The method used in the transaction.
-The origin specName of the transaction
-The constructed transaction.
-Optional xcmThe result of xcm execution.
-The xcm version that was used to construct the tx.
-The direction of the cross chain transfer.
+The format type the tx is ouputted in.
+Optional forwardedList of forwarded xcms and the weights needed to execute them.
+Optional localWeight needed to execute the local segment of a provided XCM.
+The method used in the transaction.
+The origin specName of the transaction
+The constructed transaction.
+Optional xcmThe result of xcm execution.
+The xcm version that was used to construct the tx.
+Options that are appplied at initialization of the AssetTransferApi.
Options that are appplied at initialization of the AssetTransferApi.
Optional chainChain name of the chain which the api is connected to.
Optional injectedOption to inject chain information into the registry.
Optional overrideOption to override the registry with the supplied chain information.
Optional registryWhether or not to apply the registry from the npm package asset-transfer-api-registry,
or the hosted CDN which updates frequently.
The Format types possible for a constructed transaction.
-The Format types possible for a constructed transaction.
+AssetTransferApi supports three formats to be returned:
+AssetTransferApi supports three formats to be returned:
ExtrinsicPayload as a hex.Call as a hex.SubmittableExtrinsic.The types of local transactions the api can construct.
-The types of local transactions the api can construct.
+The Methods are the collections of methods the API will use to construct a transaction.
-The Methods are the collections of methods the API will use to construct a transaction.
+Types that the registry can be initialized as.
+Types that the registry can be initialized as.
CDN - The registry will be initialized with the up to date version given the CDN NPM - The registry will be initialized with the NPM version which is updated less frequently.
-The direction of the cross chain transfer. This only concerns XCM transactions.
-The direction of the cross chain transfer. This only concerns XCM transactions.
+
Holds open an api connection to a specified chain within the ApiPromise in order to help +
- Preparing search index...
- The search index is not available
@substrate/asset-transfer-api - v0.4.1Class AssetTransferApi
Holds open an api connection to a specified chain within the ApiPromise in order to help construct transactions for assets and estimating fees.
-Index
Methods
Index
Methods
amounts: string[]
Array of the amounts of each trapped asset to be claimed
beneficiary: string
Address of the account to receive the trapped assets
opts: TransferArgsOpts<T>
Options
-Returns Promise<TxResult<T>>
create
Create an asset transfer transaction. This can be either locally on a systems parachain or relay chain, +
Returns Promise<TxResult<T>>
create
Create an asset transfer transaction. This can be either locally on a systems parachain or relay chain, or between chains using xcm.
@@ -24,23 +24,23 @@assetIds: string[]
Array of assetId's to be transferred
amounts: string[]
Array of the amounts of each token to transfer
opts: TransferArgsOpts<T> = {}
Options
-Returns Promise<TxResult<T>>
decode
Decodes the hex of an extrinsic into a string readable format.
+Returns Promise<TxResult<T>>
decode
Decodes the hex of an extrinsic into a string readable format.
Type Parameters
T extends Format
Parameters
encodedTransaction: string
the hex of an extrinsic tx
format: T
The format the tx is in
-Returns string
dry
Dry Run a call to determine its execution result
+Returns string