update solidity interface docs

Moonsong-Labs · Apr 22, 2024 · b07151a · b07151a
1 parent f5dca12
commit b07151a
Showing 1 changed file with 26 additions and 5 deletions.
diff --git a/precompiles/pallet-xcm/XcmInterface.sol b/precompiles/pallet-xcm/XcmInterface.sol
@@ -17,12 +17,13 @@ interface XCM {
         uint64 proofSize;
     }
 
-    // A way to represent fungible assets in XCM
+    // A way to represent fungible assets in XCM using Location format
     struct AssetLocationInfo {
         Location location;
         uint256 amount;
     }
 
+    // A way to represent fungible assets in XCM using address format
     struct AssetAddressInfo {
         address asset;
         uint256 amount;
@@ -31,7 +32,7 @@ interface XCM {
     /// @dev Function to send assets via XCM using transfer_assets() pallet-xcm extrinsic.
     /// @custom:selector 59df8416
     /// @param dest The destination chain.
-    /// @param beneficiary The actual account that will receive the tokens in dest.
+    /// @param beneficiary The actual account that will receive the tokens on dest.
     /// @param assets The combination (array) of assets to send.
     /// @param feeAssetItem The index of the asset that will be used to pay for fees.
     /// @param weight The weight to be used for the whole XCM operation.
@@ -44,8 +45,15 @@ interface XCM {
         Weight memory weight
     ) external;
 
-    /// TODO add docs
+    /// @dev Function to send assets via XCM to a 20 byte-like parachain 
+    /// using transfer_assets() pallet-xcm extrinsic.
     /// @custom:selector b489262e
+    /// @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.
+    /// @param feeAssetItem The index of the asset that will be used to pay for fees.
+    /// @param weight The weight to be used for the whole XCM operation.
+    /// (uint64::MAX in refTime means Unlimited weight)
     function transferAssetsToPara20(
         uint32 paraId,
         address beneficiary,
@@ -54,8 +62,15 @@ interface XCM {
         Weight memory weight
     ) external;
 
-    /// TODO add docs
+    /// @dev Function to send assets via XCM to a 32 byte-like parachain 
+    /// using transfer_assets() pallet-xcm extrinsic.
     /// @custom:selector 4461e6f5
+    /// @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.
+    /// @param feeAssetItem The index of the asset that will be used to pay for fees.
+    /// @param weight The weight to be used for the whole XCM operation.
+    /// (uint64::MAX in refTime means Unlimited weight)
     function transferAssetsToPara32(
         uint32 paraId,
         bytes32 beneficiary,
@@ -64,8 +79,14 @@ interface XCM {
         Weight memory weight
     ) external;
 
-    /// TODO add docs
+    /// @dev Function to send assets via XCM to the relay chain 
+    /// using transfer_assets() pallet-xcm extrinsic.
     /// @custom:selector d7c89659
+    /// @param beneficiary The actual account that will receive the tokens on the relay chain.
+    /// @param assets The combination (array) of assets to send.
+    /// @param feeAssetItem The index of the asset that will be used to pay for fees.
+    /// @param weight The weight to be used for the whole XCM operation.
+    /// (uint64::MAX in refTime means Unlimited weight)
     function transferAssetsToRelay(
         bytes32 beneficiary,
         AssetAddressInfo[] memory assets,