diff --git a/docs/classes/AssetTransferApi.AssetTransferApi.html b/docs/classes/AssetTransferApi.AssetTransferApi.html index c440f4e9..2e0628ec 100644 --- a/docs/classes/AssetTransferApi.AssetTransferApi.html +++ b/docs/classes/AssetTransferApi.AssetTransferApi.html @@ -28,7 +28,7 @@
Find the full documentation here, for quick start guide read below. All examples can be found here.
Summary: Asset-transfer-api is a library focused on simplifying the construction of asset transfers for Substrate based chains that involves system parachains like Asset Hub (Polkadot and Kusama). It exposes a reduced set of methods which facilitates users to send transfers to other (para) chains or locally.
The below chart is focusing on what directions are supported for constructing asset transfers and in what XCM version. The goal is to have everything in green checkmarks. Note that local transfers (intra-chain) are not visualized here.
-Note: Parachain To Parachain support is currently limited to XCM V2, with the exception of Parachain primary asset tx construction (e.g. MOVR, SDN, etc.)
Parachain to Parachain | ✅ | -❌ | +✅ |
Parachain to Relay | ❌ | -❎ | +❌ |
Parachain to System | @@ -83,6 +82,7 @@✅ |
Parachain To Parachain support is currently limited to XCM V2, with the exception of Parachain primary asset tx construction (e.g. MOVR, SDN, etc.).
Note: System refers to System Parachains like Asset Hub.
npm install @substrate/asset-transfer-api
yarn add @substrate/asset-transfer-api
Optional
Optional
isOptional
Optional
keepOptional
Optional
paysOptional
Optional
paysOptional
Optional
sendersOptional
Optional
transferOptional
Optional
weightOptional
Optional
xcmOptional
The direction of the cross chain transfer.
The constructed transaction.
The xcm version that was used to construct the tx.