Skip to content

Commit

Permalink
improve pallet-xcm precompile docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Agusrodri committed Dec 12, 2024
1 parent 5b507ef commit 1e6b681
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions precompiles/pallet-xcm/XcmInterface.sol
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

0 comments on commit 1e6b681

Please sign in to comment.