- Team Name: ParaSpell✨
- Payment Address: 0xB7d45Ef044fD9342e4c03e28D9e9bddA2d4Fe3e1 (USDC)
- Level: 1 🐣
Project Overview 📄
Previously completed grants:
What is ParaSpell: ParaSpell is XCM & XCMP Developer tool ment to ease integration of cross-chain functionality into dApps. As we have learnt by now, cross-chain experience between Parachains can be very diverse. ParaSpell means to unify this experience by doing all the research for developers. We have wrapped all XCM pallets from compatible nodes into simple patterns from which it is easy to create XCM call. As an example we provide image below.
In this image we can see, that ParaSpell saves much time to developers. Just one call can contain multiple lines of JSON which would otherwise have to be integrated manually by developer. ParaSpell does it in marginally less lines and hides complex logic of building message which ensures, that messages are constructed correctly. This call in the end results into following lengthy extrinsic:
Following extrinsic can be subscribed into and we can check for it's events on front end. ParaSpell provides front end for testing XCM transactions and XCM called UI-V2. This UI is also deployed on netlify so users only have to run local network to start testing. UI also provides ability to open or close HRMP channels or test out XYK pool functionality that was implemented in collaboration with HydraDX team. In the picture below we provide overview of the UI.
ParaSpell is split into three main repositories at the moment:
- XCM SDK: Meant to unify cross-chain experience on Substrate. Can serve any dApp developer that wishes to integrate XCM or other pallets support for they app.
- UI-V2: Allows for launching local network and testing XCM or HRMP channels across that local network
- Docs: Extensive documentary for overview of ParaSpell, guide for SDK and UI
This SDK currently support 42 compatible XCM nodes. They can transfer XCM messages in three different scenarios.
- Parachain to Parachain - HRMP
- Parachain to Relay chain - UMP
- Relay chain to Parachain - DMP
SDK contains many useful features that allow for easier inntegration:
Builder pattern implementation, easy to construct XCM calls, much more used recently for simplicity of implementation.
Suggestions, SDK contains TYPES that help to guide developer through integration. For example he get's compatible nodes suggested.
Console printouts, SDK allows for printing into console so developer can alway check if call they constructed is correct.
Exporting registered assets for each compatible node in many useful functions
Exporting supported XCM pallets for each compatible node in useful functions
UI is used as testing tool for Parachain developers, they can simply add their node into network and test it with HRMP channels as well as XCM transfers. UI also allows dApp developers to test and learn XCM before integrating it from our SDK.
UI is made to be as simple to use as possible. It is now also deployed on netlify so developers only have to start local network from configuration file provided by ParaSpell which starts network of Relay chain and 3 different Parachains (Bifrost,Karura & Pichiu)
Below are some examples of UI with running network:
Above we can see open/ close channel screen. It is simple to work with and intuitive. Nodes are pulled from relay chain by query so if network is not running you cannot see any nodes.
Above we can observe, that UI contains simple Wallet login with test accounts.
Above we can see XCM screen which is also very simple to navigate and nodes are pulled from relay chain by query.
Docs contain important information regarding SDK, UI and other repositories that are in ParaSpell or ParaSpell contributed to / collaborated with. The key areas are:
Guide on importing SDK
Guide on launching local network and UI
Guide on executing operations in UI
Guide on implementing SDK
- Important links
UI is purposely designed to be as simple as possible. This guarantees, that all tasks can be done quickly and without extended searching. All necessary screens also feature notifications which will as a milestone explain be callback reactive. The loading screen is only present on the first application & network startup, once accessing the same screen after the application was loaded it will be skipped automatically. The screen serves to register necessary assets in parachain nodes. This is only required to be run once per network startup.
SDK currently handles transfers to 42 compatible Parachains (all XCM Palletts) (ParaSpell SDK) and also can transfer to both Relay chains. It is easy to construct calls as is but we want to make it even easier and more developer friendly.
Technology Stack 💻️
- Polkadot api libraries
- Parachain launch
- Substrate compatible nodes (For now Rococo, Pichiu(Kylin network), Bifrost & Acala)
Ecosystem Fit 🌳
There are not many XCM & XCMP related development tools released currently. We aim to aid this mostly empty space and help developers to understand XCM & XCMP as the current state-of-the-art technology by providing documentation and a user interface in which they can do development tasks more easily and faster.
In Polkadot and Kusama ecosystem, there are few XCM related tools in development. For example Moonbeam XCM SDK was released only recently. We bring comparison table that compares our ParaSpell SDK to Moonbeam SDK | Features | ParaSpell XCM SDK | Moonbeam XCM SDK | | -----: | ----------- | ------------- | | Number of packages user has to install | User needs to install only 1 package | User needs to install 2 packages | | Support for Parachains | Already integrated for every XCM compatible pallet Link to implementation ParaSpell SDK | Every new node has to be added manually | | Build pattern | Integrated as intuitive as possible | Integrated, not as intuitive to implement however | | Support for asset pallet operations | Integrated | Not integrated | | Support for HRMP pallet operations | Integrated users can open & close HRMP channels on their local chain (Useful feature for devs) | Not integrated | | Support for checking details that do not change | Integrated & also be covered with some error handling eg (too little ammount being sent, not sufficient for XCM transfer) | Integrated in form of small "map" for different Tokens & Node IDs | | Support for Axelar GMP (General message passing) that will connect Substrate with EVM chains | Planned to be implemented in the future | No data |
Unlike the already mentioned "Moonbeam XCM" platform ParaSpell provides UI enhancement that uses our XCM SDK and users can try/learn technology from it. ParaSpell also includes support for 42 Substrate Parachains (ParaSpell SDK that have XCM pallets compared to Moonbeam XCM to which users have to implement compatible nodes manually. ParaSpell SDK only needs one package compared to Moonbeam XCM which has total of two. Compared to Moonbeam XCM which contains only XCM calls ParaSpell also contains calls that can open or close HRMP channels. We also include support for Parachains that have template pallet for XCM called polkadotXCM this pallet is a little harder to work with than xTokens, even more for inexperienced developers.
Another comparison worth mentioning is UI vs Morph which is also enhancement of XCM UI Transfer tool | Features | ParaSpell XCM UI | Morph | | -----: | ----------- | ------------- | | Focus: | Developers & users that wish to try XCM locally first | Users | | Wiki: | Comprehensive Wiki explaining XCM, how to add assets to UI & Nodes and more implemented | Not implemented | | Support for transfers: | In three different scenarios | In two scenarios | | Support for local network configuration: | Fully implemented example network configuration that uses maintained Parachain-launch library | Not implemented | | Support for HRMP channel opening/closing: | Fully implemented | Not implemented |
Unlike the already mentioned "Morph" platform ParaSpell focuses more on developers. ParaSpell features complete network install and startup configuration in one single command. This automatization ensures, that developers do not need to do any extra tasks when they wish to run development nodes locally. ParaSpell also allows developers to open and close HRMP channels between Parachains they connected. Like "Morph", ParaSpell can also transfer fungible tokens in three scenarios. From Parachains to Relay chain, from Relay chain to Parachains & from Parachains to Parachains.
We are currently in talks with several Parachain teams that like the idea of unified SDK for XCM transfers as much as we do. SDK that unifies XCM can be very helpful for entire ecosystem in our opinion.
Our target audiences are Web3 projects and starting/current blockchain developers.
Dušan Morháč - Student, project Founder & Core Dev. Faculty of Informatics and Information Technologies STU in Bratislava
Michael Absolon - Student, SDK Core Dev. Faculty of Informatics and Information Technologies STU in Bratislava
- Contact Name: Dušan Morháč
- Contact Email: firstname.lastname@example.org
- Registered Address: Tomášovská 453/2, Kalinovo 98501, Slovak Republic
- Registered Legal Entity: Dušan Morháč ml.
Dušan is the founder & researcher behind this project and he has successfully presented it at the international conference ICECET2022 held in Prague from which there is an article regarding XCMP & ParaSpell project. It is published by IEEE. Dušan also studies Blockchain technology and had a bachelor's thesis about cross-blockchain sharing from which this idea was born. Dušan also continues research on this idea in his Master's thesis. He is actively working on ParaSpell full-time & has also participated in other ecosystem projects. Recently he attended Polkadot Blockchain Academy 2023 in Buenos Aires which gave him a lot of insight into the ecosystem and he also graduated from the academy successfully. ![img14](https://user-images.githubusercontent.com/55763425/223093342-7d947a57-b114-4260-8999-fd4506adc76e.jpg" width="380" height="280")
Team Code Repos
Team Github Profiles 🧑🎓
Team LinkedIn Profiles 🧑🎓
Development Status 📖
SDK is currently released into main and is in version that is fully operable. There are still some tweaks we plan to add and make, they are mentioned below. UI-V2 currently runs on state-of-the-art technology version VueJS 3 and newest version of Nuxt. It deprecated V1 and introduced much smoother interface and modules brought from subscaffold template ParaSpell contributed to. Docs are currently in ready state but there is still some tweaking to do.
Sidenote: We have recently developed article about Polkadot & Paraspell called Enhancing XCMP Interoperability Across Polkadot Paraverse and it was accepted to International IEEE ICBC 2023 conference held in Dubai.
Development Roadmap 🔩
- Total Estimated Duration: 2 months
- Full-Time Equivalent (FTE): 1 FTE
- Total Costs: 10,000 USD
Milestone 1 - Phase 3, make XCM SDK more efficient, add new nodes & rework Localhost network in UI
- Estimated duration: 2 months ⌛️
- FTE: 1
- Costs: 10,000 USD 💰️
|0b.||Documentation||We will provide both inline documentation of the code and a usage explanation in readme.md|
|0c.||Testing and Testing Guide||SDK Core UNIT tests will be provided for xTokens Pallet, HRMP pallet, polkadotXCM pallet|
|0d.||Docker||Docker file that allows to test ParaSpell SDK through ParaSpell UI will be provided.|
|0e.||Create Medium article about development of Phase 3 ParaSpell||Add article covering new features & improvements brought in Phase3|
|1.||Merge currencyId & currency in XCM Transfers||Merge currency ID and currency symbol into one so user do not need to enther both. Raised in issue: https://github.com/paraspell/xcm-sdk/issues/16|
|2.a||Add support for new compatible nodes in DMP Scenario (Downwards message passing)||Check for new Parachain support & update Parachains, that have new compatibility with other Parachains in DMP Scenario & Update list of compatible Parachains accordingly|
|2.b||Add support for new compatible nodes in UMP Scenario (Upwards message passing)||Check for new Parachain support & update Parachains, that have new compatibility with other Parachains in UMP Scenario & Update list of compatible Parachains accordingly|
|2.c||Add support for new compatible nodes in HRMP Scenario (Horizontall message passing)||Check for new Parachain support & update Parachains, that have new compatibility with other Parachains in HRMP Scenario & Update list of compatible Parachains accordingly|
|3.||Rework Utils.ts to remove huge switch that constructs message||Rework construct XCM message function to not have switch and be more efficient in construction - link|
|4.a||Deprecate Parachain-launch & replace it with Zombienet I||Replace network startup configuration from Parachain-launch library into state of the art technology called Zombienet link1, link2|
|4.b||Deprecate Parachain-launch & replace it with Zombienet II||Update ParaSpell Docs|
|5.||Add suggestions we received in our previous grant evaluations (If not added already)||Add suggestions from our phase1 and phase2 proposal evaluations if they were not added already|
Future Plans 🔭
Once everything will be implemented according to the proposed plan application will still be under constant improvement as technology will progress. For example, once the XCMP protocol will be released we wish to deprecate the HRMP protocol we currently use for channels.
In a long run, we also want to improve design of the UI, add new features that can be useful for developers and support for new nodes.
Project goal is that SDK will serve dApp developers and UI will teach new substrate developers to use XCM and will serve to existing substrate developers to test their freshly baked Parachains.
Additional Information ➕
How did you hear about the Grants Program? Personal recommendation
Project achievements in chronological order ⌛️
- 📙 Article about project created & presented on international conference ICECET2022 held in Prague (450 out of 1000+ articles accepted) Link to IEEE publication - IEEE Sharing Fungible Assets Across Polkadot Paraverse
- 🥈 2nd Prize, Build a XCM related Tool for Moonbeam - Polkadot North America Hackathon Hackathon entry
- 🥉 3rd Prize, EVM+ DApp for aUSD yield - Polkadot North America Hackathon Hackathon entry
- 🎈 Web 3 Foundation base grant Application, Delivery
- 🐍 Basilisk treasury proposal 2/2 Approved link, link2
- ⭐️ Astar XCM bounty Polkadot hackathon Latam Bounty link
- 🔭 Web 3 Foundation phase 2 grant Milestone 3 / 3 delivered Application, Delivery1, Delivery 2 & 3
- 📕 Article about Polkadot & ParaSpell created & accepted to be presented at international cross-chain conference IEEE ICBC 2023 [links TBA]