diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e91ee1e --- /dev/null +++ b/LICENSE @@ -0,0 +1,190 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright [2023] [HugoByte AI Labs Pvt Ltd] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md index 942a9e9..3af592c 100644 --- a/README.md +++ b/README.md @@ -1,106 +1,193 @@ -# Polkadot-kurtosis-package +![HugoByte](img/hugobyte_logo.jpeg) -Polkadot-kurtosis-package is a tool built leveraging the power of Kurtosis, a developer platform for packaging and launching environments. This tool simplifies the process of setting up various local, testnet, and mainnet network configurations and scenarios for Polkadot parachains. +**Empower your Polkadot development with the Polkadot-kurtosis-package, an all-in-one solution for effortlessly spawning relay chains and parachains. Dive into a world of efficiency, reliability, and innovation, all meant to enhance your Polkadot experience. Welcome to the future of decentralized possibilities! Remember, the key to our existence is to distribute, decentralize, and democratize.** + +[![Discord](https://img.shields.io/badge/Discord-hugobyte-00FF00?style=flat&logo=discord&logoColor=00FF00&labelColor=black)](https://discord.gg/GyRQSBN3Cu) + +# Table of Contents +- [Introduction](#introduction) + - [About](#about) + - [Polkadot](#polkadot) + - [Kusama](#kusama) + - [Parachains](#parachains) + - [Explorer](#explorer) + - [Setup and Requirements](#setup-and-requirements) +- [Integrated Parachains Within the Polkadot-kurtosis-package](#integrated-parachains-within-the-polkadot-kurtosis-package) + - [Overall List of Integrated Parachains](#overall-list-of-integrated-parachains) + - [Parachains Supported in Local](#parachains-supported-in-local) + - [Parachains Supported in Testnet](#parachains-supported-in-testnet) + - [Parachains Supported in Mainnet](#parachains-supported-in-mainnet) +- [Configuration File Guidelines](#configuration-file-guidelines) + - [Configuration Fields](#configuration-fields) + - [Possible Values for Configuration Fields](#possible-values-for-configuration-fields) + - [Example Configurations](#example-configurations) +- [Usage](#usage) +- [Service Details](#service-details) +- [Using Explorer with Service Details](#using-explorer-with-service-details) +- [Using Grafana with Service Details](#using-grafana-with-service-details) +- [Chopstick Compatibility](#chopstick-compatibility) + - [Parachains Compatible with Chopsticks](#parachains-compatible-with-chopsticks) + - [Configuration for Chopsticks](#configuration-for-chopsticks) + - [Using Chopsticks](#using-chopsticks) + - [Service Details for Chopstikcs](#service-details-for-chopstikcs) +- [Dive CLI Integration](#dive-cli-integration) +- [Known Issues](#known-issues) +- [Troubleshooting](#troubleshooting) +- [Contributing](#contributing) +- [License](#license) +- [Feedback](#feedback) + +# Introduction + +Polkadot-kurtosis-package is a tool built leveraging the power of Kurtosis, a developer platform for packaging and launching environments. This tool simplifies the process of setting up various local, testnet, and mainnet network configurations and scenarios for Polkadot and Kusama parachains. ## About -The primary goal of this project is to streamline the setup of Polkadot parachain environments using the Kurtosis platform. With just a few one-liners, developers can package and launch environments tailored to their needs. +The primary goal of this project is to streamline the setup of Polkadot and Kusama parachain environments using the Kurtosis platform. With just a few one-liners, developers can package and launch environments tailored to their needs. -## Setup and Requirements +### Polkadot: -Ensure the following prerequisites are met before using the Polkadot-kurtosis-package: -- Docker installed on your machine[https://www.docker.com/] -- Kurtosis installed on your machine[https://www.kurtosis.com/] +Polkadot is a blockchain platform that aims to connect different blockchains together, allowing them to communicate and share data. Imagine it as a web of interconnected blockchains, with each blockchain being an island and Polkadot being the bridges that connect them. This allows for a more seamless and efficient transfer of data and value between different blockchain networks. -# Integrated Parachains +You can read more about polkadot [here](https://polkadot.network/). -List of integrated parachains within the Polkadot-kurtosis-package. +### Kusama: -- acala -- ajuna -- bifrost -- centrifuge -- clover -- frequency -- integritee -- interlay -- kilt -- kylin -- litentry -- manta -- moonbeam -- moonsama -- nodle -- parallel -- pendulum -- phala -- polkadex -- subsocial -- zeitgeist -- encointer -- altair -- bajun -- calamari -- karura -- khala -- kintsugi-btc -- litmus -- mangata -- moonriver -- robonomics -- subzero -- turing +Kusama serves as a real-world testing environment for Polkadot, a top blockchain platform designed for interoperability and scalability. Developers initially deploy and experiment with new features and upgrades on Kusama, allowing possible issues to be identified and resolved before they are implemented on the main Polkadot network. This iterative process promotes resilience and stability in the final product. +You can read more about kusama [here](https://kusama.network/). +### Parachains: -## Chopstick Compatibility +In the context of Polkadot and Kusama, a parachain is a specialized, independent blockchain that connects to the main network (also known as the Relay Chain). Each parachain is tailor-made for a specific purpose, catering to diverse applications like DeFi, gaming, or asset management. They have their own governance, consensus mechanisms, and tokens. -The package also supports Chopsticks, a tool offering a user-friendly approach to locally branching existing Substrate-based chains. It enables block replay, multi-block forking, and more. +You can read more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains). You can also see list of all the parachains on polkadot and kusama [here](https://parachains.info/). -### Parachains Compatible with Chopsticks +### Explorer: -- astar -- basilisk -- acala -- centrifuge -- composable-polkadot -- hydradx -- imbu -- interlay -- karura -- mandala -- mangata -- moonbase -- moonbeam -- moonriver -- nodle-eden -- picasso-kusama -- picasso-rococo -- polkadex -- shibuya -- shiden -- statemine -- statemint --ß tinkernet +The Polkadot JS Explorer is a web-based application that serves as a comprehensive gateway to interact with and explore the Polkadot and Kusama blockchain networks. It provides a user-friendly interface for a variety of functions. -Check more info on Chopsticks, refer to the [Chopsticks]. +You can access the explorer [here](https://polkadot.js.org/). -## Zombienet +## Setup and Requirements -Zombienet is a CLI tool that facilitates the creation and testing of ephemeral Polkadot/Substrate networks. It offers a straightforward interface for developers to spawn and examine these temporary networks, enabling them to thoroughly evaluate their applications and protocols within a simulated real-world environment. +Ensure the following prerequisites are met before using the Polkadot-kurtosis-package: +- [Docker](https://www.docker.com/): Make sure Docker is installed on your machine. You can [install it here](https://www.docker.com/). +- [Kurtosis](https://www.kurtosis.com/): Ensure Kurtosis is installed on your machine. You can [install it here](https://www.kurtosis.com/). -## Usage +# Integrated Parachains Within the Polkadot-kurtosis-package -To use the package, run the following command inside the root directory of your project: +A list of all the parachains supported by the package and the environments they are available in. -```bash -kurtosis run . --enclave 'enclavename' --args-file=path/to/config/file -``` +## Overall List of Integrated Parachains + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PolkadotKusama
acalaaltair
ajunabajun
bifrostbifrost
centrifugecalamari
cloverencointer
frequencykarura
kiltkhala
kylinintegritee
litentrylitmus
mantamangata
moonbeammoonriver
moonsamarobonomics
nodlesubzero
parallelturing
pendulum
phala
polkadex
subsocial
zeitgeist
+
+ +## Parachains Supported in Local: + +- **For Polkadot:** acala, ajuna, bifrost, centrifuge, clover, frequency, kilt, kylin, litentry, manta, moonbeam, moonsama, nodle, parallel, pendulum, phala, polkadex, subsocial, zeitgeist + +- **For Kusama:** altair, bajun, bifrost, calamari, encointer, karura, khala, integritee, litmus, mangata, moonriver, robonomics, subzero, turing + +## Parachains Supported in Testnet: + +- **For Polkadot:** ajuna, bifrost, frequency, kilt, litentry, moonbeam, nodle, pendulum, phala, zeitgeist + +- **For Kusama:** bajun, bifrost, encointer, integritee, mangata, moonriver, turing -For detailed instructions on writing the configuration file, refer to the [Configuration File Guidelines] +- **Inactive Testnet:** karura, khala, robonomics, altair, litmus, calamari, subsocial, moonsama, manta, kylin, centrifuge, acala, polkadex, clover -Certainly! Let's create a section in your README file to explain how to write the configuration file using the provided example. I'll include a breakdown of each field and provide explanations: +- **No Testnet available:** parallel, subzero + +## Parachains Supported in Mainnet: + +- **For Polkadot:** acala, ajuna, bifrost, centrifuge, clover, frequency, kilt, kylin, litentry, manta, moonbeam, moonsama, nodle, parallel, pendulum, phala, polkadex, subsocial, zeitgeist + +- **For Kusama:** altair, bajun, bifrost, calamari, encointer, karura, khala, integritee, litmus, mangata, moonriver, robonomics, subzero, turing # Configuration File Guidelines @@ -108,72 +195,382 @@ To use the Polkadot-kurtosis-package, you need to create a configuration file sp ```json { - "chain-type": "testnet", + "chain_type": "testnet", "relaychain": { "name": "rococo", "nodes": [ { "name": "alice", "node_type": "validator", - "port": 9944, "prometheus": false }, { "name": "bob", - "node_type": "full", - "port": 9945, - "prometheus": false + "node_type": "validator", + "prometheus": true + } ] }, - "para": [ + + "parachains": [ { - "name":"kilt", + "name":"acala", "nodes": [ { "name": "alice", - "node_type": "validator", + "node_type": "collator", "prometheus": false + }, { "name": "bob", "node_type": "full", - "prometheus": false + "prometheus": true } ] } ], - "chopstick": { - "xcm": false, - "relaychain":"", - "parachains": ["acala"] - } + "explorer": true } ``` ## Configuration Fields: -- **chain-type:** Specifies the type of the network (e.g., "localnet","testnet", "mainnet"). -- **relaychain:** Configuration for the relay chain. (When chain-type is "testnet" or "mainenet", the "relaychain" can be empty dictonary) +- **chain_type:** Specifies the type of the network (e.g., "local","testnet", "mainnet"). +- **relaychain:** Configuration for the relay chain. (When chain_type is "testnet" or "mainenet", the "relaychain" can be an empty dictonary). - **name:** Name of the relay chain (e.g., "rococo-local", "rococo", "polkadot" or "kusama"). - **nodes:** List of nodes on the relay chain, each with: - **name:** Node name (e.g., "alice"). - **node_type:** Node type, can be "validator" or "full". - - **port:** Port number for the node (e.g., 9944). - **prometheus:** Whether Prometheus monitoring is enabled (true/false). -- **para:** List of parachains, each with: +- **parachains:** List of parachains, each with: - **name:** Parachain name (e.g., "kilt"). - **nodes:** List of nodes on the parachain, similar to relay chain nodes. - **name:** Node name (e.g., "alice"). - - **node_type:** Node type, can be "callator" or "full". + - **node_type:** Node type, can be "collator" or "full". - **prometheus:** Whether Prometheus monitoring is enabled (true/false). -- **chopstick:** Configuration for Chopstick integration. - - **xcm:** Whether XCM (Cross-Chain Messaging) is enabled (true/false). - - **relaychain:** Name of the relay chain for Chopstick integration. - - **parachains:** List of parachains compatible with Chopsticks. +- **explorer:** Whether Polkadot js explorer is enabled (true/false). + +Feel free to modify this example configuration file based on your specific network requirements. [Here](./config.json) is a link to the official template that you can edit and use. + +## Possible Values for Configuration Fields: + +- **chain_type:** local, mainnet, testnet +- **relaychain name:** + - for local: rococo-local + - for testnet: rococo, westend + - for mainnet: polkadot, kusama +- **node_type:** + - for relaychain: validator, full + - for parachain: collator, full +- **parachain name:** + - for polkadot: any valid parachain for polkadot from [this list](#integrated-parachains) + - for kusama: any valid parachain for kusama from [this list](#integrated-parachains) +- **prometheus:** true or false +- **explorer:** true or false +- **node-name:** any + +> **Note:** You can pass relaychain as an empty dictionary `{}` when chain_type is 'testnet' or 'mainnet'. This will only spawn the parachain. + +## Example Configurations: + +Here are some example configurations you can pass to the package. + +**Passing mutiple parachains without relay chain in testnet:** + +```json +{ + "chain_type": "testnet", + "relaychain": { + }, + + "parachains": [ + { + "name":"mangata", + "nodes": [ + { + "name": "alice", + "node_type": "collator", + "prometheus": true + + }, + { + "name": "bob", + "node_type": "full", + "prometheus": true + } + ] + }, + { + "name":"acala", + "nodes": [ + { + "name": "alice", + "node_type": "collator", + "prometheus": true + + }, + { + "name": "bob", + "node_type": "full", + "prometheus": false + } + ] + } + ], + "explorer": false +} +``` + +**Passing relay chain without parachain in mainnet:** +```json +{ + "chain_type": "mainnet", + "relaychain": { + "name": "rococo", + "nodes": [ + { + "name": "alice", + "node_type": "validator", + "prometheus": true + }, + { + "name": "bob", + "node_type": "full", + "prometheus": true + + } + ] + }, + + "parachains": [ + ], + "explorer": false +} +``` + +# Usage + +To use the package, run the following command: + +> Before proceeding, make sure the Kurtosis Engine is running in the background. If it's not already running, start it by executing the following command: `kurtosis engine start` + + +```bash +kurtosis run github.com/hugobyte/polkadot-kurtosis-package --enclave 'enclavename' --args-file=path/to/config/file +``` + +For detailed instructions on writing the configuration file, refer to the [Configuration File Guidelines](#configuration-file-guidelines). + +# Service Details + +Consider this sample config file: + +```json +{ + "chain_type": "local", + "relaychain": { + "name": "rococo-local", + "nodes": [ + { + "name": "alice", + "node_type": "validator", + "prometheus": false + }, + { + "name": "bob", + "node_type": "full", + "prometheus": true + + } + ] + }, + + "parachains": [ + { + "name":"frequency", + "nodes": [ + { + "name": "alice", + "node_type": "validator", + "prometheus": false + + } + ] + } + ], + "explorer": true +} +``` +The **service details** receieved after running the package with this config should be as follows: + +![Service Details](img/service_details.png) + +You should also get the **user services** from kurtosis as follows: + +![User Services](img/user_services.png) + +The service name 'frequency-alice-local' contains the details of the 'frequency' parachain node and the service names 'rococo-local-alice' and 'rococo-local-bob' contain the details of the relay chain nodes. Each node has its own service name and service details. + +The 'polkadot-js-explorer' service contains the details of the explorer. + +The 'prometheus' and 'grafana' services contain the details of required metrics. + +# Using Explorer with Service Details + +To use the explorer with the service details, open the given endpoint for 'polkadot-js-explorer' in the **user services**. In this case, it would be: 'http://127.0.0.1:32970' + +A page like this should open: + +![Polkadot js explorer](img/polkadot_js_explorer.png) + +Click on the orange icon next to unknown. This should open a side-menu. Click on Development and replace the custom endpoint port with the port of the node for which you would like to view the explorer details. + +You can find the node in the **user services**. For example, consider port 32964. After passing the port in custom endpoint, your page should look like this: + +![Explorer](img/explorer.png) + +# Using Grafana with Service Details + +Grafana is automatically enabled when prometheus for any node is given as true. To use the grafana with the service details, open the given endpoint for 'grafana' in the **user services**. In this case, it would be: 'http://127.0.0.1:32969' + +A page like this should open: + +![Grafana](img/grafana.png) + +Click on Data Sources, select Prometheus. In Connection field, enter the endpoint given in 'prometheus' service in **service details**. In this case it would be 'http://172.16.0.13:9090'. Scroll down and click on *save and test*. + +Now, open the side menu and click on *Dashboards*. Click on *Create Dashboard* and then *import dashboard*. Type `13759` in the *Find and import dashboards for common applications* field and click on Load. You can also use your custom dashboards here. + +After loading, select prometheus from the drop down menu in the *Substrate Node* field and click on *Import*. You should now be able to see the metrics. It should look something like this: + +![Metrics](img/metrics.png) + +# Chopstick Compatibility + +The package also supports Chopsticks, a tool offering a user-friendly approach to locally branching existing Substrate-based chains. It enables block replay, multi-block forking, and more. + +## Parachains Compatible with Chopsticks + +- astar +- basilisk +- acala +- centrifuge +- composable-polkadot +- hydradx +- imbu +- interlay +- karura +- mandala +- mangata +- moonbase +- moonbeam +- moonriver +- nodle-eden +- picasso-kusama +- picasso-rococo +- polkadex +- shibuya +- shiden +- statemine +- statemint +- ß tinkernet + +You can read more about Chopsticks [here](https://github.com/AcalaNetwork/chopsticks). + +## Configuration for Chopsticks + +```json +{ + "parachain": "acala", + "xcm": { + "relaychain": "polkadot", + "parachains": [ + "acala", + "moonbeam" + ] + } +} +``` + +- **chain:** Name of the chain to run fork of. +- **xcm:** A dict containing the following details to set up XCM multichain: + - **relaychain:** Name of relay chain. + - **parachains:** List of parachains. + +Feel free to modify this example configuration file based on your specific network requirements. [Here](./chopsticks/chopsticks.json) is a link to the official template that you can edit and use. + +## Using Chopsticks + +```bash +kurtosis run github.com/hugobyte/polkadot-kurtosis-package/chopsticks --enclave 'enclavename' --args-file=path/to/config/file +``` + +## Service Details for Chopstikcs + +The service details after running chopsticks should be similar to this: + +![Chopsticks Service Details](img/chopsticks_service_details.png) + +# Dive CLI Integration + +We recommend using the [Dive CLI](https://github.com/HugoByte/DIVE) developed by our company for enhanced capabilities and a seamless experience with this package. Dive CLI provides additional features that complement the functionality of this package. + +To get started with Dive CLI: + +1. [Download Dive CLI](https://github.com/HugoByte/DIVE) +2. Install and configure Dive CLI following the [documentation](https://github.com/HugoByte/DIVE/blob/main/README.md). + +Feel free to explore the powerful features of Dive CLI alongside our package for an optimized development workflow. + +## Known Issues + +[Here](https://github.com/HugoByte/polkadot-kurtosis-package/issues) is a list of known issues and their status that our team is currently working to resolve. + +## Troubleshooting + +If you encounter issues while using the Polkadot-kurtosis-package, refer to the following troubleshooting tips to resolve common problems: + +- Clean kurtosis engine using: +```bash +kurtosis clean -a +``` + +- Restart kurtosis engine using: +```bash +kurtosis engine restart +``` + +- Check if your docker is installed: +```bash +docker --version +``` + +If you still experience issues after following these troubleshooting tips, please [open an issue](https://github.com/HugoByte/polkadot-kurtosis-package/issues) to get further assistance. -Feel free to modify this example configuration file based on your specific network requirements. ## Contributing -We welcome contributions to enhance and expand the functionality of the Polkadot-kurtosis-package. Feel free to fork the repository, make your changes, and submit a pull request. +Contributions are what make the open source community such an amazing place to learn, inspire, and create. We welcome contributions to enhance and expand the functionality of the Polkadot-kurtosis-package. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please fork the repo and create a pull request. + +1. Fork the Project. + +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) + +3. Commit your Changes (`git commit -m 'feature message'`) + +4. Push to the Branch (`git push origin feature/AmazingFeature`) + +5. Open a Pull Request. + +## License + +Distributed under the Apache 2.0 License. See [LICENSE](./LICENSE) for more information. + +## Feedback + +We would happy to hear your thoughts on our project. Your feedback helps us improve and make it better for everyone. Please submit your valuable feedback [here](https://docs.google.com/forms/d/e/1FAIpQLScnesE-4IWPrFQ-W2FbRXHyQz8i_C0BVjIP_aWaxKe3myTgyw/viewform?usp=sharing) + diff --git a/chopsticks/config.json b/chopsticks/chopsticks.json similarity index 83% rename from chopsticks/config.json rename to chopsticks/chopsticks.json index 7672915..ecb5552 100644 --- a/chopsticks/config.json +++ b/chopsticks/chopsticks.json @@ -1,5 +1,5 @@ { - "parachain": "acala", + "chain": "acala", "xcm": { "relaychain": "polkadot", "parachains": [ diff --git a/chopsticks/kurtosis.yml b/chopsticks/kurtosis.yml new file mode 100644 index 0000000..e78ba1f --- /dev/null +++ b/chopsticks/kurtosis.yml @@ -0,0 +1 @@ +name: "github.com/hugobyte/polkadot-kurtosis-package/chopsticks" \ No newline at end of file diff --git a/chopsticks/chopstick.star b/chopsticks/main.star similarity index 70% rename from chopsticks/chopstick.star rename to chopsticks/main.star index 63610f2..e4a45de 100644 --- a/chopsticks/chopstick.star +++ b/chopsticks/main.star @@ -2,23 +2,18 @@ This package contains code for spawning the chopstick network. """ -# explorer = import_module("github.com/hugobyte/polkadot-kurtosis-package/package_io/polkadot_js_app.star") - -def run(plan, args): +def run(plan, chain = None, xcm = {}): service_details = {} - if args["parachain"] != None: - service_details["parachain"] = run_chopsticks_parachain(plan, args["parachain"]) + if chain != None: + service_details["chain"] = run_chopsticks_parachain(plan, chain) - if len(args["xcm"]) != 0: + if len(xcm) != 0: plan.print("Running XCM service....") - if len(args["xcm"]["parachains"]) >= 2: - service_details["xcm"] = run_chopsticks_xcm(plan, args["xcm"]["relaychain"], args["xcm"]["parachains"]) + if len(xcm["parachains"]) >= 2: + service_details["xcm"] = run_chopsticks_xcm(plan, xcm["relaychain"], xcm["parachains"]) else: fail("xcm needs atleast two parachains") - # if args["explorer"] == True: - # explorer.run_pokadot_js_app(plan, "ws://127.0.0.1:8000") - return service_details @@ -37,9 +32,6 @@ def run_chopsticks_parachain(plan, para_chain): ports={ "TCP": PortSpec(number=8000) }, - # public_ports={ - # "TCP": PortSpec(number=8000) - # }, entrypoint=["/bin/sh", "-c", "yarn add @acala-network/chopsticks@beta && npx @acala-network/chopsticks --config=%s --port=8000 --allow-unresolved-imports=true" % (para_chain)] ) @@ -66,9 +58,12 @@ def run_chopsticks_xcm(plan, relay_chain, para_chains): ports = {} public_ports = {} - for i in range(0, len(para_chains) + 1): - ports["TCP" + str(i)] = PortSpec(number=8000 + i) - public_ports["TCP" + str(i)] = PortSpec(number=8000 + i) + ports["TCP-" + relay_chain] = PortSpec(number=8000) + public_ports["TCP-" + relay_chain] = PortSpec(number=8000) + + for i in range(0, len(para_chains)): + ports["TCP-" + para_chains[i]] = PortSpec(number=8000 + i + 1) + public_ports["TCP-" + para_chains[i]] = PortSpec(number=8000 + i + 1) service_config = ServiceConfig( image="node:latest", diff --git a/local.json b/config.json similarity index 100% rename from local.json rename to config.json diff --git a/img/chopsticks_service_details.png b/img/chopsticks_service_details.png new file mode 100644 index 0000000..b415b5f Binary files /dev/null and b/img/chopsticks_service_details.png differ diff --git a/img/explorer.png b/img/explorer.png new file mode 100644 index 0000000..ce1487b Binary files /dev/null and b/img/explorer.png differ diff --git a/img/grafana.png b/img/grafana.png new file mode 100644 index 0000000..2e1486b Binary files /dev/null and b/img/grafana.png differ diff --git a/img/hugobyte_logo.jpeg b/img/hugobyte_logo.jpeg new file mode 100644 index 0000000..e84f016 Binary files /dev/null and b/img/hugobyte_logo.jpeg differ diff --git a/img/metrics.png b/img/metrics.png new file mode 100644 index 0000000..56882a8 Binary files /dev/null and b/img/metrics.png differ diff --git a/img/polkadot_js_explorer.png b/img/polkadot_js_explorer.png new file mode 100644 index 0000000..400a163 Binary files /dev/null and b/img/polkadot_js_explorer.png differ diff --git a/img/service_details.png b/img/service_details.png new file mode 100644 index 0000000..8f501af Binary files /dev/null and b/img/service_details.png differ diff --git a/img/user_services.png b/img/user_services.png new file mode 100644 index 0000000..a42d1cf Binary files /dev/null and b/img/user_services.png differ diff --git a/package_io/chopsticks.star b/package_io/chopsticks.star deleted file mode 100644 index 0c45d5a..0000000 --- a/package_io/chopsticks.star +++ /dev/null @@ -1,58 +0,0 @@ -""" -This package contains code for spawning the chopstick network. -""" - -def run_chopsticks_parachain(plan, para_chain): - """ - Set up a service for the chopstick network for given parachain. - - Args: - plan: The Kurtosis plan. - para_chain (string): The parachain to configure for the chopstick network. - """ - - service_config = ServiceConfig( - image="node:latest", - ports={ - "TCP": PortSpec(number=8000) - }, - public_ports={ - "TCP": PortSpec(number=8000) - }, - entrypoint=["/bin/sh", "-c", "yarn add @acala-network/chopsticks@latest && npx @acala-network/chopsticks --config=%s --port=8000" % (para_chain)] - ) - - plan.add_service(name="chopstick-", config=service_config) - - -def run_chopsticks_xcm(plan, relay_chain, para_chains): - """ - Set up a service for the chopstick network with cross-chain messaging (xcm) support with give relachain and parachains. - - Args: - plan: The Kurtosis plan. - relay_chain (string): The relay chain for cross-chain messaging. - para_chains (list): List of parachains to include in the network. - """ - - exec_cmd = "npx @acala-network/chopsticks xcm" - exec_cmd = exec_cmd + " -r " + relay_chain - - for para in para_chains: - exec_cmd = exec_cmd + " -p " + para - - ports = {} - public_ports = {} - - for i in range(0, len(para_chains) + 1): - ports["TCP" + str(i)] = PortSpec(number=8000 + i) - public_ports["TCP" + str(i)] = PortSpec(number=8000 + i) - - service_config = ServiceConfig( - image="node:latest", - ports=ports, - public_ports=public_ports, - entrypoint=["/bin/sh", "-c", "yarn add @acala-network/chopsticks@latest && %s" % (exec_cmd)] - ) - - plan.add_service(name="chopstick-", config=service_config) diff --git a/package_io/constant.star b/package_io/constant.star index e65767a..22210cc 100644 --- a/package_io/constant.star +++ b/package_io/constant.star @@ -22,7 +22,7 @@ DIFFERENT_IMAGES_FOR_TESTNET = { "acala": "acala/mandala-node:latest", } -CHAIN_COMMAND = ["manta", "moonsama", "interlay", "kintsugi-btc", "polkadex", "centrifuge", "altair", "robonomics", "kilt", "mangata"] +CHAIN_COMMAND = ["manta", "moonsama", "interlay", "kintsugi-btc", "polkadex", "centrifuge", "altair", "robonomics", "kilt", "mangata", "litentry"] -KUSAMA_PARACHAINS = ["altair", "bajun", "bifrost", "calamari", "encointer", "karura", "khala", "kintsugi-btc", "litmus", "mangata", "moonriver", "robonomics", "subzero", "turing"] -POLKADOT_PARACHAINS = ["acala", "ajuna", "bifrost", "centrifuge", "clover", "frequency", "integritee", "interlay", "kilt", "kylin", "litentry", "manta", "moonbeam", "moonsama", "nodle", "parallel", "pendulum", "phala", "polkadex", "subsocial", "zeitgeist"] +KUSAMA_PARACHAINS = ["altair", "bajun", "bifrost", "calamari", "encointer", "karura", "khala", "kintsugi-btc", "integritee", "litmus", "mangata", "moonriver", "robonomics", "subzero", "turing"] +POLKADOT_PARACHAINS = ["acala", "ajuna", "bifrost", "centrifuge", "clover", "frequency", "interlay", "kilt", "kylin", "litentry", "manta", "moonbeam", "moonsama", "nodle", "parallel", "pendulum", "phala", "polkadex", "subsocial", "zeitgeist"] diff --git a/parachain/static_files/images.star b/parachain/static_files/images.star index 6b6c587..2a92ecb 100644 --- a/parachain/static_files/images.star +++ b/parachain/static_files/images.star @@ -31,9 +31,9 @@ parachain_images = { "base": ["frequency-rococo-local", "frequency-rococo", "frequency"], }, "integritee": { - "image": "integritee/parachain", - "entrypoint": "/usr/local/bin/integritee-collator", - "base": ["integritee-rococo", "integritee-rococo", "integritee-polkadot"], + "image": "integritee/parachain:latest", + "entrypoint": "/usr/local/bin/integritee-node", + "base": ["integritee-rococo-local-dev", "integritee-rococo", "integritee-kusama"], }, "interlay": { "image": "interlayhq/interbtc:latest", @@ -101,7 +101,7 @@ parachain_images = { "base": ["local-rococo", "/app/soonsocial.json", ""], }, "zeitgeist": { - "image": "zeitgeistpm/zeitgeist-node-parachain", + "image": "zeitgeistpm/zeitgeist-node-parachain:latest", "entrypoint": "/usr/local/bin/zeitgeist", "base": ["dev", "battery_station", "zeitgeist"], },