Skip to content

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

License

Notifications You must be signed in to change notification settings

paraspell/xcm-tools

Repository files navigation

ParaSpell✨ monorepo for XCM-Tool set

ParaSpell logo

AI-generated podcast about ParaSpell XCM tools:

Tired of reading? Listen to this AI generated Podcast about ParaSpell XCM Tools (New version).

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 two versions: PolkadotAPI Version & PolkadotJS 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 package-less way offloading heavy computing tasks from your decentralized application, and reducing associated costs.
  • XCM ROUTER ☄️ (Spellrouter logo): A tool aiming to provide the capability of cross-chain swaps where you receive different assets than those you send (e.g. send DOT from Polkadot and receive ASTR on Astar) — all within a single command.
  • XCM Analyser 🔎 - Analyser package to convert XCM Multilocations into a human-readable format.
  • XCM Visualizator 🖼️ - An application developed to visualize XCM within the Polkadot ecosystem.

Other:

Documentation:


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

packages | - XCM SDK
         | - XCM SDK-PJS
         | - XCM SDK-Core
         | - XCM SDK-Common
         | - XCM Router
         | - 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:wríte

  • Run linter using pnpm lint:check

  • Run unit tests using pnpm test

  • Run integration tests using pnpm test:integration

  • 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:landing-page

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

  • Run the existential deposit update script for XCM SDK from the root using run:updateEds

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

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:

version

About

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

Topics

Resources

License

Stars

Watchers

Forks

Languages