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.
-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.
+The specName was not provided when injecting a new chain in the registry.
+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 Parachain.
-Relay to System Parachain.
-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 Parachain.
+Relay to System Parachain.
+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
-Copy each binary that is necessary into the root <root>/bin folder.
From the root directory run ./<zombienet_binary_name> -p native spawn ./zombienet/<network_file>.toml | tee zombienet.log
From the root directory run yarn start:zombienet-post-script. You can run this right after running your zombienet network.
You can access the E2E tests and its documentation here.
+Return value for constructApiPromise
Return value for constructApiPromise
Polkadot-js ApiPromise
-SafeXcmVersion for the chain which the api is connected too.
-SpecName 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.
+payload, call, or submittable.
Note: A submittable will return a SubmittableExtrinsic polkadot-js type, whereas
a payload or call will return a hex.
Optional isBoolean to declare if this will be with limited XCM transfers. +
Optional isBoolean to declare if this will be with limited XCM transfers. Deafult is unlimited.
-Optional keepFor creating local asset transfers, this will allow for a transferKeepAlive as oppose
+
Optional keepFor creating local asset transfers, this will allow for a transferKeepAlive as oppose
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 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 transferBoolean to declare if this will transfer liquidity tokens. +
Optional transferBoolean to declare if this will transfer liquidity tokens. Default is false.
-Optional weightWhen isLimited is true, the option for applying a weightLimit is possible. +
Optional weightWhen isLimited is true, the option for applying a weightLimit is possible.
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 xcmSet the xcmVersion for message construction. If this is not present a supported version +
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.
-The method used in the transaction.
-The origin specName of the transaction
-The constructed transaction.
-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.
+The method used in the transaction.
+The origin specName of the transaction
+The constructed transaction.
+The xcm version that was used to construct the tx.
+Options that are appplied at initialization of the AssetTransferApi.
Optional injectedOption to inject chain information into the registry.
+Options that are appplied at initialization of the AssetTransferApi.
Optional injectedOption to inject chain information into the registry.
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.1.7Class 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
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
fetch
Fetch estimated fee information for an extrinsic
+Returns string
fetch
Fetch estimated fee information for an extrinsic
Type Parameters
T extends Format
Parameters
tx: ConstructedFormat<T>
a payload, call or submittable
format: T
The format the tx is in
-Returns Promise<null | RuntimeDispatchInfo | RuntimeDispatchInfoV1>
initialize
Initialize the registry. This will only activate the registry for the CDN. +
Returns Promise<null | RuntimeDispatchInfo | RuntimeDispatchInfoV1>
initialize
Initialize the registry. This will only activate the registry for the CDN. If the
-registryTypeisNPMthe initalization will exit since the AssetTransferApi initializes with the reigstry from the NPM package.Returns Promise<void>
Settings
Member Visibility
Theme
On This Page