\r\n## Installation\r\n\r\n#### Install SDK \r\n\r\n```bash\r\nnpm install | pnpm add | yarn add @paraspell/xcm-analyser \r\n```\r\n## Implementation\r\n\r\n> [!NOTE]\r\n> **The following junction types are supported:**\r\n> - Parachain\r\n> - AccountId32\r\n> - AccountIndex64\r\n> - AccountKey20\r\n> - PalletInstance\r\n> - GeneralIndex\r\n> - GeneralKey\r\n> - OnlyChild\r\n> - Plurality\r\n> - GlobalConsensus\r\n\r\n\r\n#### Compile a single location object to the URL\r\n\r\nTo compile a single location object to url use the following structure:\r\n\r\n```js\r\n//Importing the call\r\nimport { convertLocationToUrl } from '@paraspell/xcm-analyser';\r\n\r\n//Define the location you wish to convert to URL\r\n/*const location: Location = {\r\n parents: 0,\r\n interior: {\r\n X2: [\r\n {\r\n PalletInstance: 50,\r\n },\r\n {\r\n GeneralIndex: '41',\r\n },\r\n ],\r\n },\r\n };*/\r\n\r\nconst result = convertLocationToUrl(location);\r\n\r\n/*\r\nThis should result into:\r\n'./PalletInstance(50)/GeneralIndex(41)'\r\n*/\r\n```\r\n\r\n#### Compile a single location JSON to the URL\r\nTo compile a single location JSON to url use the following structure:\r\n\r\n```js\r\n//Importing the call\r\nimport { convertLocationToUrlJson } from '@paraspell/xcm-analyser';\r\n\r\n//Define location JSON\r\n/*const locationJson = `{\r\n \"parents\": 3,\r\n \"interior\": {\r\n \"X2\": [\r\n {\r\n \"PalletInstance\": 50\r\n },\r\n {\r\n \"GeneralIndex\": \"41\"\r\n }\r\n ]\r\n }\r\n }`*/\r\n\r\nconst result = convertLocationToUrl(locationJson);\r\n\r\n/*\r\nThis should result into:\r\n''../../../PalletInstance(50)/GeneralIndex(41)''\r\n*/\r\n```\r\n\r\n#### Compile the entire XCM call to the URL\r\nTo compile the entire XCM call to the URL use the following structure:\r\n\r\n```js\r\n//Importing the call\r\nimport { convertXCMToUrls } from '@paraspell/xcm-analyser';\r\n\r\n//Define XCM call arguments you wish to convert\r\n/*const xcmCallArguments = [\r\n {\r\n V3: {\r\n parents: 1,\r\n interior: {\r\n X1: {\r\n Parachain: 2006,\r\n },\r\n },\r\n },\r\n },\r\n {\r\n V3: {\r\n parents: 0,\r\n interior: {\r\n X1: {\r\n AccountId32: {\r\n network: null,\r\n id: 'accountID',\r\n },\r\n },\r\n },\r\n },\r\n },\r\n {\r\n V3: [\r\n {\r\n id: {\r\n Concrete: {\r\n parents: 0,\r\n interior: {\r\n X2: [{ PalletInstance: 50 }, { GeneralIndex: '1984' }],\r\n },\r\n },\r\n },\r\n fun: {\r\n Fungible: 'amount',\r\n },\r\n },\r\n ],\r\n },\r\n];*/\r\n\r\nconst urls = convertXCMToUrls(xcmCallArguments);\r\n\r\n/*\r\nThis should result into:\r\n[\r\n '../Parachain(2006)',\r\n './AccountId32(null, accountID)',\r\n './PalletInstance(50)/GeneralIndex(1984)',\r\n]\r\n*/\r\n```\r\n\r\n## 💻 Tests\r\n- Run compilation using `pnpm compile`\r\n\r\n- Run linter using `pnpm lint`\r\n\r\n- Run unit tests using `pnpm test`\r\n\r\n- Run all core tests and checks using `pnpm runAll`\r\n\r\n- Run an example from [example file](https://github.com/paraspell/xcm-tools/blob/main/packages/xcm-analyser/scripts/example.ts) using `pnpm runExample`\r\n\r\n> [!NOTE]\r\n> XCM Analyser can be tested in [Playground](https://playground.paraspell.xyz/xcm-analyser).\r\n\r\n## Contribute to XCM Tools and earn rewards 💰\r\n\r\nWe run an open Bug Bounty Program that rewards contributors for reporting and fixing bugs in the project. More information on bug bounty can be found in the [official documentation](https://paraspell.github.io/docs/contribution-guidelines.html).\r\n\r\n## Get Support 🚑\r\n\r\n- Contact form on our [landing page](https://paraspell.xyz/#contact-us).\r\n- Message us on our [X](https://x.com/paraspell).\r\n- Support channel on [telegram](https://t.me/paraspell).\r\n\r\n## License\r\n\r\nMade with 💛 by [ParaSpell✨](https://paraspell.xyz/)\r\n\r\nPublished under [MIT License](https://github.com/paraspell/xcm-tools/blob/main/packages/xcm-analyser/LICENSE).\r\n\r\n\r\n","readmeFilename":""}
![\"version\"](\"https://img.shields.io/npm/v/@paraspell/xcm-analyser?style=flat-square\")
![\"downloads\"](\"https://img.shields.io/npm/dm/@paraspell/xcm-analyser?style=flat-square\")
![\"build\"](\"https://github.com/paraspell/xcm-sdk/actions/workflows/release.yml/badge.svg\"){kind=icon}
\r\n \r\n