Polkadot XCM Pallet Documentation (#1022)

* update

* edit

* rev

* run grammarly

* run prettier

* revisions

* rev

.snippets/code/builders/ethereum/precompiles/utility/relay-data-verifier/ethers-relay-data-verifier.js

@@ -9,7 +9,7 @@ const abi = JSON.parse(fs.readFileSync('./RelayChainDataVerifierABI.json'));
 const privateKey = 'INSERT_PRIVATE_KEY';
 const precompileAddress = '0x0000000000000000000000000000000000000819';
 const moonbeamURL = 'https://rpc.api.moonbase.moonbeam.network';
-const relayURL = 'wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network';
+const relayURL = 'wss://relay.api.moonbase.moonbeam.network';
 
 // Create Ethers provider and signer
 const provider = new ethers.JsonRpcProvider(moonbeamURL);

.snippets/code/builders/ethereum/precompiles/utility/relay-data-verifier/web3js-relay-data-verifier.js

@@ -9,7 +9,7 @@ const abi = JSON.parse(fs.readFileSync('./RelayChainDataVerifierABI.json'));
 const privateKey = 'INSERT_PRIVATE_KEY';
 const precompileAddress = '0x0000000000000000000000000000000000000819';
 const moonbeamURL = 'https://rpc.api.moonbase.moonbeam.network';
-const relayURL = 'wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network';
+const relayURL = 'wss://relay.api.moonbase.moonbeam.network';
 
 // Create Web3js provider and signer
 const web3 = new Web3(moonbeamURL);

.snippets/code/builders/ethereum/precompiles/utility/relay-data-verifier/web3py-relay-data-verifier.py

@@ -1,15 +1,15 @@
 # Import packages
+from eth_account import Account
 from substrateinterface import SubstrateInterface
 from web3 import Web3
-from eth_account import Account
 
 # Initialize variables
 abi = INSERT_ABI
 
 privateKey = "INSERT_PRIVATE_KEY"
 precompileAddress = "0x0000000000000000000000000000000000000819"
 moonbeamURL = "https://rpc.api.moonbase.moonbeam.network"
-relayURL = "wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network"
+relayURL = "wss://relay.api.moonbase.moonbeam.network"
 
 # Create provider for Moonbeam network
 web3 = Web3(Web3.HTTPProvider(moonbeamURL))

.snippets/code/builders/interoperability/xcm/remote-execution/remote-evm-calls/send.js

@@ -3,7 +3,7 @@ import { cryptoWaitReady } from '@polkadot/util-crypto';
 
 // 1. Input data
 const providerWsURL =
-  'wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network';
+  'wss://relay.api.moonbase.moonbeam.network';
 const privateKey = 'INSERT_PRIVATE_KEY';
 const dest = { V4: { parents: 0, interior: { X1: [{ Parachain: 1000 }] } } };
 const instr1 = {

.snippets/code/builders/interoperability/xcm/xc20/send-xc20s/polkadot-xcm/asset-traps.js

@@ -0,0 +1,15 @@
+import { ApiPromise, WsProvider } from '@polkadot/api';
+
+const main = async () => {
+  const api = await ApiPromise.create({
+    provider: new WsProvider('wss://wss.api.moonbeam.network'),
+  });
+
+  const hash =
+    '0x166f82439fd2b25b28b82224e82ad9f26f2da26b8257e047182a6a7031accc9a';
+  const trapCount = await api.query.polkadotXcm.assetTraps(hash);
+
+  console.log('Trap count:', trapCount.toNumber());
+};
+
+main();

.snippets/code/builders/interoperability/xcm/xc20/send-xc20s/polkadot-xcm/check-xcm-version.js

@@ -0,0 +1,24 @@
+import { ApiPromise, WsProvider } from '@polkadot/api';
+
+const main = async () => {
+  const api = await ApiPromise.create({
+    provider: new WsProvider('wss://wss.api.moonbase.moonbeam.network'),
+  });
+
+  const testLocation = {
+    V4: {
+      parents: 1,
+      interior: 'Here',
+    },
+  };
+
+  const supportedVersion = await api.query.polkadotXcm.supportedVersion(
+    4, // Testing XCM v4
+    testLocation
+  );
+
+  console.log('Location:', JSON.stringify(testLocation, null, 2));
+  console.log('Supported Version:', supportedVersion.toHuman());
+};
+
+main();

.snippets/code/builders/interoperability/xcm/xc20/send-xc20s/polkadot-xcm/destination-beneficiary-fee.js

@@ -0,0 +1,40 @@
+      // dest
+      {
+        V3: {
+          parents: 1,
+          interior: 'Here'
+        }
+      },
+      // beneficiary
+      {
+        V3: {
+          parents: 0,
+          interior: {
+            X1: {
+              AccountId32: {
+                id: Array.from(beneficiaryRaw),
+                network: null
+              }
+            }
+          }
+        }
+      },
+      // assets
+      {
+        V3: [
+          {
+            id: {
+              Concrete: {
+                parents: 1,
+                interior: 'Here'
+              }
+            },
+            fun: {
+              Fungible: '1000000000000'
+            }
+          }
+        ]
+      },
+      0, // feeAssetItem
+      'Unlimited' // weightLimit
+    );

.snippets/code/builders/interoperability/xcm/xc20/send-xc20s/polkadot-xcm/pallet-version.js

@@ -0,0 +1,11 @@
+import { ApiPromise, WsProvider } from '@polkadot/api';
+
+const main = async () => {
+  const api = await ApiPromise.create({
+    provider: new WsProvider('wss://wss.api.moonbase.moonbeam.network'),
+  });
+  const palletVersion = await api.query.polkadotXcm.palletVersion();
+  console.log("The pallet version is " + palletVersion);
+};
+
+main();

.snippets/code/builders/interoperability/xcm/xc20/send-xc20s/polkadot-xcm/query-counter.js

@@ -0,0 +1,13 @@
+import { ApiPromise, WsProvider } from '@polkadot/api';
+
+const main = async () => {
+  const api = await ApiPromise.create({
+    provider: new WsProvider('wss://wss.api.moonbeam.network'),
+  });
+
+  const queryIndex = await api.query.polkadotXcm.queryCounter();
+
+  console.log('Query Index:', queryIndex.toNumber());
+};
+
+main();

.snippets/code/builders/interoperability/xcm/xc20/send-xc20s/polkadot-xcm/safe-xcm-version.js

@@ -0,0 +1,13 @@
+import { ApiPromise, WsProvider } from '@polkadot/api';
+
+const main = async () => {
+  const api = await ApiPromise.create({
+    provider: new WsProvider('wss://wss.api.moonbeam.network'),
+  });
+
+  const safeVersion = await api.query.polkadotXcm.safeXcmVersion();
+
+  console.log('Safe XCM Version:', safeVersion.toHuman());
+};
+
+main();

.snippets/code/builders/interoperability/xcm/xc20/send-xc20s/polkadot-xcm/send-xcm.js

@@ -0,0 +1,77 @@
+import { ApiPromise, WsProvider, Keyring } from '@polkadot/api';
+import { BN } from '@polkadot/util';
+import { decodeAddress } from '@polkadot/util-crypto';
+
+const main = async () => {
+  // Setup provider and API
+  const wsProvider = new WsProvider('wss://wss.api.moonbase.moonbeam.network');
+  const api = await ApiPromise.create({ provider: wsProvider });
+
+  // Setup account with ethereum format
+  const keyring = new Keyring({ type: 'ethereum' });
+  const account = keyring.addFromUri('INSERT_PRIVATE_KEY');
+
+  // Convert the SS58 address to raw bytes
+  const beneficiaryRaw = decodeAddress('INSERT_DESTINATION_ADDRESS');
+
+  try {
+    // Create the transaction
+    const tx = api.tx.polkadotXcm.transferAssets(
+      // dest
+      {
+        V3: {
+          parents: 1,
+          interior: 'Here',
+        },
+      },
+      // beneficiary
+      {
+        V3: {
+          parents: 0,
+          interior: {
+            X1: {
+              AccountId32: {
+                id: Array.from(beneficiaryRaw),
+                network: null,
+              },
+            },
+          },
+        },
+      },
+      // assets
+      {
+        V3: [
+          {
+            id: {
+              Concrete: {
+                parents: 1,
+                interior: 'Here',
+              },
+            },
+            fun: {
+              Fungible: '1000000000000',
+            },
+          },
+        ],
+      },
+      0, // feeAssetItem
+      'Unlimited' // weightLimit
+    );
+
+    // Sign and send the transaction, displaying the transaction hash
+    const unsub = await tx.signAndSend(account, ({ status, events }) => {
+      if (status.isInBlock) {
+        console.log(`Transaction included in blockHash ${status.asInBlock}`);
+      } else if (status.isFinalized) {
+        console.log(`Transaction finalized in blockHash ${status.asFinalized}`);
+        unsub();
+        process.exit(0);
+      }
+    });
+  } catch (error) {
+    console.error('Error:', error);
+    process.exit(1);
+  }
+};
+
+main().catch(console.error);

.snippets/code/tutorials/interoperability/remote-batched-evm-calls/build-xcm-message.js

@@ -2,7 +2,7 @@ import { ApiPromise, WsProvider } from '@polkadot/api'; // Version 10.13.1
 
 // 1. Input Data
 const providerWsURL =
-  'wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network';
+  'wss://relay.api.moonbase.moonbeam.network';
 const amountToWithdraw = BigInt(1 * 10 ** 16); // 0.01 DEV
 const devMultiLocation = {
   parents: 0,

.snippets/code/tutorials/interoperability/remote-batched-evm-calls/send-xcm-message.js

@@ -3,7 +3,7 @@ import { cryptoWaitReady } from '@polkadot/util-crypto';
 
 // 1. Input Data
 const providerWsURL =
-  'wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network';
+  'wss://relay.api.moonbase.moonbeam.network';
 const MNEMONIC = 'INSERT_MNEMONIC'; // Not safe, only for testing
 const txCall =
   '0xb50a04630004000100a10f041000040000000f0000c16ff28623130000000f0000c16ff28623000601070053cd200a02350c007d09260001f0490200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008080000000000000000000000000000000000000000000000000000000000000000110896e292b8000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000e0000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000001e000000000000000000000000000000000000000000000000000000000000000020000000000000000000000001fc56b105c4f0a1a8038c2b429932b122f6b631f000000000000000000000000ed13b028697febd70f34cf9a9e280a8f1e98fd29000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000042004ffd90000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000042004ffd9000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000d010000010300f0615483cbe76f5b2aa80a8ce2b2e9a8206deb65';

.snippets/code/tutorials/interoperability/remote-staking/remote-staking.js

@@ -43,7 +43,7 @@ const message = { V4: [instr1, instr2, instr3] };
 const performRemoteDelegation = async () => {
   // 2. Construct API provider
   const wsProvider = new WsProvider(
-    'wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network'
+    'wss://relay.api.moonbase.moonbeam.network'
   );
   const api = await ApiPromise.create({ provider: wsProvider });
 

.snippets/code/tutorials/interoperability/uniswapv2-swap/build-xcm-message.js

@@ -2,7 +2,7 @@ import { ApiPromise, WsProvider } from '@polkadot/api'; // Version 10.13.1
 
 // 1. Input Data
 const providerWsURL =
-  'wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network';
+  'wss://relay.api.moonbase.moonbeam.network';
 const amountToWithdraw = BigInt(1 * 10 ** 16); // 0.01 DEV
 const devMultiLocation = {
   parents: 0,

.snippets/code/tutorials/interoperability/uniswapv2-swap/send-xcm-message.js

@@ -3,7 +3,7 @@ import { cryptoWaitReady } from '@polkadot/util-crypto';
 
 // 1. Input Data
 const providerWsURL =
-  'wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network';
+  'wss://relay.api.moonbase.moonbeam.network';
 const MNEMONIC = 'INSERT_MNEMONIC'; // Not safe, only for testing
 const txCall =
   '0x450604630004000100a10f0410000400010403000f0000c16ff286231300010403000f0000c16ff286230006010700902f500982b92a00fd042600019b40090000000000000000000000000000000000000000000000000000000000008a1932d6e26433f3037bd6c3a40c816222a6ccd40000c16ff286230000000000000000000000000000000000000000000000000091037ff36ab50000000000000000000000000000000000000000000000000de0b6b3a7640000000000000000000000000000000000000000000000000000000000000000008000000000000000000000000061cd3e07fe7d7f6d4680e3e322986b7877f108dd00000000000000000000000000000000000000000000000000000000a036b1b90000000000000000000000000000000000000000000000000000000000000002000000000000000000000000d909178cc99d318e4d46e7e66a972955859670e10000000000000000000000001fc56b105c4f0a1a8038c2b429932b122f6b631f000d01000001030061cd3e07fe7d7f6d4680e3e322986b7877f108dd';

.snippets/text/builders/interoperability/xcm/calculate-multilocation-derivative-account.md

@@ -1,4 +1,4 @@
-Copy the account of your existing or newly created account on the [Moonbase relay chain](https://polkadot.js.org/apps/?rpc=wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network#/accounts){target=\_blank}. You're going to need it to calculate the corresponding Computed Origin account, which is a special type of account that’s keyless (the private key is unknown). Transactions from a Computed Origin account can be initiated only via valid XCM instructions from the corresponding account on the relay chain. In other words, you are the only one who can initiate transactions on your Computed Origin account, and if you lose access to your Moonbase relay account, you’ll also lose access to your Computed Origin account.
+Copy the account of your existing or newly created account on the [Moonbase relay chain](https://polkadot.js.org/apps/?rpc=wss://relay.api.moonbase.moonbeam.network#/accounts){target=\_blank}. You're going to need it to calculate the corresponding Computed Origin account, which is a special type of account that’s keyless (the private key is unknown). Transactions from a Computed Origin account can be initiated only via valid XCM instructions from the corresponding account on the relay chain. In other words, you are the only one who can initiate transactions on your Computed Origin account, and if you lose access to your Moonbase relay account, you’ll also lose access to your Computed Origin account.
 
 To generate the Computed Origin account, first clone the [xcm-tools](https://github.com/Moonsong-Labs/xcm-tools){target=\_blank} repo. Run `yarn` to install the necessary packages, and then run:
 

builders/interoperability/xcm/remote-execution/remote-evm-calls.md

@@ -172,7 +172,7 @@ The process for building and performing the remote execution can be summarized a
 
 To be able to send the call from the relay chain, you need the following:
 
-- An [account](https://polkadot.js.org/apps/?rpc=wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network#/accounts){target=\_blank} on the relay chain with funds (UNIT) to pay for the transaction fees. You can acquire some xcUNIT by swapping for DEV tokens (Moonbase Alpha's native token) on [Moonbeam-Swap](https://moonbeam-swap.netlify.app){target=\_blank}, a demo Uniswap-V2 clone on Moonbase Alpha, and then [send them to the relay chain](/builders/interoperability/xcm/xc20/send-xc20s/xtokens-pallet/){target_blank}. Additionally, you can [contact us on Discord](https://discord.com/invite/PfpUATX){target=\_blank} to get some UNIT tokens directly
+- An [account](https://polkadot.js.org/apps/?rpc=wss://relay.api.moonbase.moonbeam.network#/accounts){target=\_blank} on the relay chain with funds (UNIT) to pay for the transaction fees. You can acquire some xcUNIT by swapping for DEV tokens (Moonbase Alpha's native token) on [Moonbeam-Swap](https://moonbeam-swap.netlify.app){target=\_blank}, a demo Uniswap-V2 clone on Moonbase Alpha, and then [send them to the relay chain](/builders/interoperability/xcm/xc20/send-xc20s/xtokens-pallet/){target_blank}. Additionally, you can [contact us on Discord](https://discord.com/invite/PfpUATX){target=\_blank} to get some UNIT tokens directly
 - The address of your Computed Origin account. Please refer to the [Computed Origin](/builders/interoperability/xcm/remote-execution/computed-origins/){target=\_blank} guide to learn how to calculate your Computed Origin address
 - To fund your Computed Origin account. The account must have enough DEV tokens (or GLMR/MOVR for Moonbeam/Moonriver) to cover the cost of the XCM execution of the remote EVM call. Note that this is the account from which the remote EVM call will be dispatched (the `msg.sender`). Consequently, the account must satisfy whatever conditions are required for the EVM call to be executed correctly. For example, hold any relevant ERC-20 token if you are doing an ERC-20 transfer
 
@@ -305,9 +305,9 @@ Now that you have the values for each of the parameters, you can write the scrip
 ```
 
 !!! note
-    You can view an example of the output of the above script on [Polkadot.js Apps](https://polkadot.js.org/apps/?rpc=wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network#/extrinsics/decode/0x630004000100a10f040c000400010403001300008a5d784563011300010403001300008a5d784563010006010300286bee007901260001581501000000000000000000000000000000000000000000000000000000000000a72f549a1a12b9b49f30a7f3aeb1f4e96389c5d8000000000000000000000000000000000000000000000000000000000000000010d09de08a00){target=\_blank} using the following encoded call data: `0x630004000100a10f040c000400010403001300008a5d784563011300010403001300008a5d784563010006010300286bee007901260001581501000000000000000000000000000000000000000000000000000000000000a72f549a1a12b9b49f30a7f3aeb1f4e96389c5d8000000000000000000000000000000000000000000000000000000000000000010d09de08a00`.
+    You can view an example of the output of the above script on [Polkadot.js Apps](https://polkadot.js.org/apps/?rpc=wss://relay.api.moonbase.moonbeam.network#/extrinsics/decode/0x630004000100a10f040c000400010403001300008a5d784563011300010403001300008a5d784563010006010300286bee007901260001581501000000000000000000000000000000000000000000000000000000000000a72f549a1a12b9b49f30a7f3aeb1f4e96389c5d8000000000000000000000000000000000000000000000000000000000000000010d09de08a00){target=\_blank} using the following encoded call data: `0x630004000100a10f040c000400010403001300008a5d784563011300010403001300008a5d784563010006010300286bee007901260001581501000000000000000000000000000000000000000000000000000000000000a72f549a1a12b9b49f30a7f3aeb1f4e96389c5d8000000000000000000000000000000000000000000000000000000000000000010d09de08a00`.
 
-Once the transaction is processed, you can check the relevant extrinsics and events in the [relay chain](https://polkadot.js.org/apps/?rpc=wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network#/explorer/query/0x2a0e40a2e5261e792190826ce338ed513fe44dec16dd416a12f547d358773f98){target=\_blank} and [Moonbase Alpha](https://polkadot.js.org/apps/?rpc=wss://wss.api.moonbase.moonbeam.network#/explorer/query/0x7570d6fa34b9dccd8b8839c2986260034eafef732bbc09f8ae5f857c28765145){target=\_blank}.
+Once the transaction is processed, you can check the relevant extrinsics and events in the [relay chain](https://polkadot.js.org/apps/?rpc=wss://relay.api.moonbase.moonbeam.network#/explorer/query/0x2a0e40a2e5261e792190826ce338ed513fe44dec16dd416a12f547d358773f98){target=\_blank} and [Moonbase Alpha](https://polkadot.js.org/apps/?rpc=wss://wss.api.moonbase.moonbeam.network#/explorer/query/0x7570d6fa34b9dccd8b8839c2986260034eafef732bbc09f8ae5f857c28765145){target=\_blank}.
 
 In the relay chain, the extrinsic is `xcmPallet.send`, and the associated event is `xcmPallet.Sent` (among others related to the fee). In Moonbase Alpha, the XCM execution happens within the `parachainSystem.setValidationData` extrinsic, and there are multiple associated events that can be highlighted:
 

builders/interoperability/xcm/xc-registration/xc-integration.md

@@ -64,7 +64,7 @@ There are also some [snapshots for the Alphanet ecosystem relay chain](https://w
 
 You can calculate the Sovereign account information using [a script from the xcm-tools repository](https://github.com/Moonsong-Labs/xcm-tools){target=\_blank}. To run the script, you must provide the parachain ID and the name of the associated relay chain.
 
-You can find the parachain IDs that have already been used on the [relay chain's Polkadot.js Apps page](https://polkadot.js.org/apps/?rpc=wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network#/parachains){target=\_blank}.
+You can find the parachain IDs that have already been used on the [relay chain's Polkadot.js Apps page](https://polkadot.js.org/apps/?rpc=wss://relay.api.moonbase.moonbeam.network#/parachains){target=\_blank}.
 
 The accepted values for the relay chain are `polkadot` (default), `kusama`, and `moonbase`.
 
@@ -187,7 +187,7 @@ Running the following command will provide the encoded calldata to accept an ope
     ```bash
     yarn hrmp-manipulator --target-para-id YOUR_PARACHAIN_ID \
     --parachain-ws-provider wss://wss.api.moonbase.moonbeam.network  \
-    --relay-ws-provider wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network \
+    --relay-ws-provider wss://relay.api.moonbase.moonbeam.network \
     --hrmp-action accept
     ```
 
@@ -235,7 +235,7 @@ Running the following command will provide the encoded calldata to create the HR
     ```bash
     yarn hrmp-manipulator --target-para-id YOUR_PARACHAIN_ID \
     --parachain-ws-provider wss://wss.api.moonbase.moonbeam.network  \
-    --relay-ws-provider wss://fro-moon-rpc-1-moonbase-relay-rpc-1.moonbase.ol-infra.network \
+    --relay-ws-provider wss://relay.api.moonbase.moonbeam.network \
     --max-capacity 1000 --max-message-size 102400 \
     --hrmp-action open
     ```

builders/interoperability/xcm/xc20/send-xc20s/.pages

@@ -2,6 +2,7 @@ title: Send XC-20s
 nav:
   - index.md
   - 'Overview': 'overview.md'
-  - 'Using the Substrate API': 'xtokens-pallet.md'
+  - 'Using the Substrate API: X-Tokens Pallet': 'xtokens-pallet.md'
+  - 'Using the Substrate API: PolkadotXCM Pallet' : 'xcm-pallet.md'
   - 'Using the Ethereum API: X-Tokens Precompile': 'xtokens-precompile.md'
   - 'Using the Ethereum API: XCM Precompile' : 'eth-api.md'