Information

This package serves as a core component for both @paraspell/sdk and @paraspell/sdk-pjs and is automatically installed as a dependency. The package on its own offers functionality that can be imported separately and be used in front-end applications. It allows developers to query the XCM pallets that Parachains currently support.

Implementation

$3

``bash
pnpm | npm install || yarn add @paraspell/pallets
`

$3

To use this functionality you first have to import it in the following way.
`ts
import { getDefaultPallet, getSupportedPallets, getPalletIndex, SUPPORTED_PALLETS, getNativeAssetsPallet, getOtherAssetsPallets } from '@paraspell/pallets'
`

$3

The function returns the default XCM pallet for selected compatible Parachain.
`ts
getDefaultPallet(chain: TChain)
`

$3

The function returns all supported XCM pallets for selected compatible Parachain.
`ts
getSupportedPallets(chain: TChain)
`

$3

The function returns all index of XCM Pallet for selected Parachain.
`ts
getPalletIndex(chain: TChain)
`

$3

This returns all supported XCM pallets supported by compatible Parachains as constant.
`ts
console.log(SUPPORTED_PALLETS)
`

$3

Following function returns all pallets for local transfers of native assets for specific chain.
`ts
getNativeAssetsPallet(chain: TChain)
`

$3

Following function returns all pallets for local transfers of foreign assets for specific chain.
`ts
getOtherAssetsPallets(chain: TChain)
`

💻 Tests

- Run compilation using pnpm compile

- Run linter using pnpm lint

- Run unit tests using pnpm test

- Update XCM pallets in the map using script - pnpm updatePallets`

> [!NOTE]
> Pallet queries can be tested in XCM Playground.

Contribute to XCM Tools and earn rewards 💰

We 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.

Get Support 🚑

- Contact form on our landing page.
- Message us on our X.
- Support channel on telegram.

License

Made with 💛 by ParaSpell✨

Published under MIT License.

Supported by