Skip to content

paraspell/xcm-tools

Repository files navigation

ParaSpell✨ monorepo for XCM-Tool set

ParaSpell logo

Monorepo contains the following XCM tools:

  • XCM SDK 🪄: A tool designed to unify the cross-chain experience on Polkadot and serve as a layer 2 protocol that enables seamless integration of XCM into your decentralized applications. Having three versions: PolkadotAPI Version (With Swap package available (Formerly XCM Router)), PolkadotJS Version & Dedot Version as the first and only XCM SDK in the ecosystem.
  • XCM API ⚡️ (Lightspell logo): An API that provides the ability to integrate XCM interoperability into your decentralized application in a package-less way, offloading heavy computing tasks from your decentralized application, and reducing associated costs.
  • XCM Analyser 🔎 - Analyser package to convert XCM Multilocations into a human-readable format.
  • XCM Visualizer 🖼️ - An application developed to visualize XCM within the Polkadot ecosystem.

Other:

Documentation:


Starter templates:
Monorepo infrastructure:
apps | - XCM Playground
     | - XCM API
     | - XCM Tools Landing page
     | - XCM Visualizer FE
     | - XCM Visualizer BE

packages | - XCM SDK
         | - XCM SDK-PJS
         | - XCM SDK-DEDOT
         | - XCM SDK-Core
         | - XCM SDK-Common
         | - Swap
         | - XCM Analyser
         | - Assets
         | - Pallets
Monorepo commands:

These commands will be run on all packages in the monorepo.

Make sure to run the following two commands first (from repository root), before running any others below:

  • Install necessary node modules using pnpm install

  • Build all packages and apps using pnpm build

Afterwards, you should be able to use any of the following commands (from repository root):

  • Run compilation using pnpm compile

  • Run formatter using pnpm format:check

  • Run formatter with write permissions using pnpm format:write

  • Run linter using pnpm lint:check

  • Run unit tests using pnpm test

  • Run end-to-end tests using pnpm test:e2e

  • Launch the XCM Tools Playground from the root using pnpm run:playground

  • Launch XCM API from the root using pnpm run:api

  • Launch the landing page from the root using pnpm run:paraspell-site

  • Run asset update script for XCM SDK from the root using pnpm run:updateAssets

  • Run the pallet update script for XCM SDK from the root using pnpm run:updatePallets

  • Run asset update script for XCM Router from the root using pnpm run:updateRouterAssets

To run a command only for a specific package or app in a monorepo, use:

pnpm --filter <package_selector> <command> or cd into appropriate folder.

pnpm --filter <package>... build to build package or app with all its dependencies.

Podcast about XCM Tools:

Tired of reading? Listen to this AI generated Podcast about ParaSpell XCM Tools.

Downtime check:

Your favourite tool seems to be down? Check this link to confirm: status.paraspell.xyz

XCM Tools bug bounty:

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.


Tools supported by:

Shows a black logo in light color mode and a white one in dark color mode.

About

ParaSpell✨ - The Hub of XCM Tools 🧰: Seamlessly Integrate Interoperability into Your Application Within Seconds

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors

Languages