Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve pallet-xcm-precompile docs (assets ordering) #58

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve pallet-xcm-precompile docs (assets ordering) #58

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e6b681
improve pallet-xcm precompile docs
Agusrodri Dec 12, 2024
b09ebf9
add examples for assets ordering
Agusrodri Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions precompiles/pallet-xcm/XcmInterface.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ interface XCM {
/// @param dest The destination chain.
/// @param beneficiary The actual account that will receive the tokens on dest.
/// @param assets The combination (array) of assets to send in Location format.
/// Assets MUST be sorted, otherwise there may be discrepancies with the feeAssetItem.
/// @param feeAssetItem The index of the asset that will be used to pay for fees.
function transferAssetsLocation(
Location memory dest,
Expand All @@ -55,6 +56,7 @@ interface XCM {
/// @param paraId The para-id of the destination chain.
/// @param beneficiary The actual account that will receive the tokens on paraId destination.
/// @param assets The combination (array) of assets to send in Address format.
/// Assets MUST be sorted, otherwise there may be discrepancies with the feeAssetItem.
/// @param feeAssetItem The index of the asset that will be used to pay for fees.
function transferAssetsToPara20(
uint32 paraId,
Expand All @@ -69,6 +71,7 @@ interface XCM {
/// @param paraId The para-id of the destination chain.
/// @param beneficiary The actual account that will receive the tokens on paraId destination.
/// @param assets The combination (array) of assets to send in Address format.
/// Assets MUST be sorted, otherwise there may be discrepancies with the feeAssetItem.
/// @param feeAssetItem The index of the asset that will be used to pay for fees.
function transferAssetsToPara32(
uint32 paraId,
Expand All @@ -82,6 +85,7 @@ interface XCM {
/// @custom:selector 6521cc2c
/// @param beneficiary The actual account that will receive the tokens on the relay chain.
/// @param assets The combination (array) of assets to send in Address format.
/// Assets MUST be sorted, otherwise there may be discrepancies with the feeAssetItem.
/// @param feeAssetItem The index of the asset that will be used to pay for fees.
function transferAssetsToRelay(
bytes32 beneficiary,
Expand All @@ -97,6 +101,7 @@ interface XCM {
/// @custom:selector 8425d893
/// @param dest The destination chain.
/// @param assets The combination (array) of assets to send in Location format.
/// Assets MUST be sorted, otherwise there may be discrepancies with the remoteFeesIdIndex.
/// @param assetsTransferType The TransferType corresponding to assets being sent.
/// @param remoteFeesIdIndex The index of the asset (inside assets array) to use as fees.
/// @param feesTransferType The TransferType corresponding to the asset used as fees.
Expand All @@ -115,6 +120,7 @@ interface XCM {
/// @custom:selector fc19376c
/// @param dest The destination chain.
/// @param assets The combination (array) of assets to send in Location format.
/// Assets MUST be sorted, otherwise there may be discrepancies with the remoteFeesIdIndex.
/// @param remoteFeesIdIndex The index of the asset (inside assets array) to use as fees.
/// @param customXcmOnDest The XCM message to execute on destination chain (SCALE encoded).
/// @param remoteReserve The remote reserve corresponding for assets and fees. They MUST
Expand All @@ -135,6 +141,7 @@ interface XCM {
/// @custom:selector 998093ee
/// @param dest The destination chain.
/// @param assets The combination (array) of assets to send in Address format.
/// Assets MUST be sorted, otherwise there may be discrepancies with the remoteFeesIdIndex.
/// @param assetsTransferType The TransferType corresponding to assets being sent.
/// @param remoteFeesIdIndex The index of the asset (inside assets array) to use as fees.
/// @param feesTransferType The TransferType corresponding to the asset used as fees.
Expand All @@ -153,6 +160,7 @@ interface XCM {
/// @custom:selector aaecfc62
/// @param dest The destination chain.
/// @param assets The combination (array) of assets to send in Address format.
/// Assets MUST be sorted, otherwise there may be discrepancies with the remoteFeesIdIndex.
/// @param remoteFeesIdIndex The index of the asset (inside assets array) to use as fees.
/// @param customXcmOnDest The XCM message to execute on destination chain (SCALE encoded).
/// @param remoteReserve The remote reserve corresponding for assets and fees. They MUST
Expand Down
Loading