From c1c84116603c9db59741608f321d8ed7154d8762 Mon Sep 17 00:00:00 2001 From: gnv-zeeve <74914749+gnv-zeeve@users.noreply.github.com> Date: Sun, 25 Dec 2022 13:45:38 +0530 Subject: [PATCH 1/8] Create Zeeve_Parachain_deployment_zoombienet_testing_automation.md --- ...eployment_zoombienet_testing_automation.md | 149 ++++++++++++++++++ 1 file changed, 149 insertions(+) create mode 100644 applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md diff --git a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md new file mode 100644 index 00000000000..dba7692a182 --- /dev/null +++ b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md @@ -0,0 +1,149 @@ +# Zeeve - Substrate parachain DevOps Automation + +- **Team Name:** [Zeeve](https://www.zeeve.io) +- **Payment Address:** Ethereum (USDT/USDC) 0x5E1257E928aa42E3D0cd9E2A7537E37D108D811B +- **[Level](https://github.com/w3f/Grants-Program/tree/master#level_slider-levels):** 3 + +### Overview +Blockchain adoption is happening at a very rapid rate, with a lot many use cases being implemented and seeing the light of the day. The concept of the parachain enables the possibilities further. While we focus on building the use cases, code them and implement the business logic of it, including the creation of Parachain and then further logic running upon it, we majorly underestimate the DevOps activity to deploy, maintain, scale and manage the parachain itself. This includes initial launch of the parachain, its thorough testing using Zoombie-net and scaling it further by providing support for users to create and deploy validator, full and archive nodes with ease as well as to have secure RPC endpoints. The most deficit we see is around advanced analytics and proactive monitoring to ensure a production grade incident management of networks and nodes. + +### Project Details +Zeeve will provide a command line based tool to setup of new Substrate parachain network with in-depth and flexible configurations in few clicks on the cloud of choice to distribute nodes upon (AWS, GCP, DigitalOcean and Linode) - supporting K8 and native VMs whichever fits the parachains better. + +A GUI will be built to allow a quick setup of the parachain with zombie-net with the desired capabilities to test multiple configurations and compare the results. This in turn will allow the developers and parachain teams to try multiple chain configurations while setting up the parachains with Zoombie-net, as well as to choose different nodes to try and test for the best possibilities on the parachain. + +This not only will allow configurations on the parachain side but will also allow you to pick different DSL templates on Zombie net as well as creating new templates without needing to write the code. The configurator will be an intuitive graphical wizard based interface to create in-depth [Network definition spec](https://paritytech.github.io/zombienet/network-definition-spec.html#network-definition-spec) and apply on the go. Furthermore, to allow seamless testing using the dynamic wizard based DSL creation allowing to choose and configure all available [Assertions](https://paritytech.github.io/zombienet/cli/test-dsl-definition-spec.html#available-assertions) + +The graphical control panel will support all the other configurations or operations required to enable the developer or parachain team to test with as much flexibility as required. These operations include: + + - Restart - after x seconds, will stop the `process` and start again after the `x`amount of seconds or immediately. + - Stop - will pause (SIGSTOP) the process) +- Resume - will pause (SIGCONT) the process) +- Sleep - will allow config to sleep the test-runner for `x` ammount of seconds) + +**Test result and logs** +The interface will allow the developer to test and see live logs of the test run, post run results and logs on the aforementioned interface and save them for analysis later to be able to compare with the previous executions on demand. Furthermore, a stack of Prometheus and Grafana will allow easy monitoring of the parachain nodes. Along with the mentioned CLI capabilities to the developers. + +**Templating** +The control panel will also allow the developer or the parachain team to one-click replicate one of the existing network configurations, save as template or pick from previously saved template and re-create a new test with some rapid tweaks to it. + +## Team :busts_in_silhouette: + +### Team members + +- Ghan Vashishtha +- Sankalp Sharma +- Arjun Chamyal +- Rahul Meena + +### Contact + +- **Contact Name:** Ghan Vashishtha +- **Contact Email:** ghan@zeeve.io +- **Website:** www.zeeve.io + +### Legal Structure + +- **Registered Address:** 1603 Capitol Ave Ste 310, Cheyenne 82001, WY +- **Registered Legal Entity:** Zeeve Inc. + +### Team's experience +Founded by a team of experienced professionals and enterprenuers from industry, Zeeve's cofounders collectively have over 45+ years of experience in technology, product development, and various business verticals. Zeeve has built an enterprise-grade no-code Blockchain Infrastructure Automation platform that enables Enterprises, Blockchain Startups, Blockchain Consulting Companies and Web3 Developers to deploy Blockchain nodes and Decentralised Apps within minutes, and manage them with advanced analytics and real-time alerts. In June 2022, the Startup raised $2.65 Million in a Seed Round from Leo Capital and Blu Ventures. It plans to deploy the funds towards product development, augmenting the technology team and enhancing its reach among DApp developers and global corporations, please consider visiting our prior [work](https://www.zeeve.io/platform). + +### Team Code Repos + +- https://github.com/Zeeve-App +- https://github.com/Zeeve-App/sawtooth-artifacts +- https://github.com/Zeeve-App/Zeeve-read-the-docs + +Please also provide the GitHub accounts of all team members. If they contain no activity, references to projects hosted elsewhere or live are also fine. + +- https://www.zeeve.io/about-us + + +### Team LinkedIn Profiles (if available) + +- https://www.linkedin.com/in/ghan-vashishtha/ +- https://www.linkedin.com/in/sankalp-sharma-502008139/ +- https://www.linkedin.com/in/arjun-chamyal-a4466086/ +- https://www.linkedin.com/in/rahul-m-0ba16487/ + +## Development Status :open_book: + +Before applying for the Web3 Foundation Grant, the Zeeve team has built a DevOps automation for Polkadot and other substrate chains, also created substrates based relay chains: + +- Automated Polkadot deployments including validator nodes, archive nodes [here](https://www.zeeve.io/blockchain-protocols/deploy-polkadot-node/) +- Automated Kusama deployments including validator nodes, archive nodes [here](https://www.zeeve.io/blockchain-protocols/deploy-kusama-node/) +- Created a relay chain on substrate with some customisations done at the core to accomodate the tokenomics and custom reward mechanism [here](https://axscan.axiacoin.network/#/explorer) +- Published a [blog post](https://www.zeeve.io/blog/how-to-use-substrate-to-create-parachains-in-polkadot/) about the usage and omlememtation of praachains +- The focus for Zeeve will be automating the parachain deployments, dedicated node setups and help with faster testing with zombie-net. +- Spoke with David Hawig, Richard Casey and Gautam Dhameja from the Parity team regarding the development of Zeeve and the Web3 Grant application + +## Development Roadmap :nut_and_bolt: + +### Overview +- **Total Estimated Duration:** 4 months +- **Full-Time Equivalent (FTE):** 4 FTE +- **Total Costs:** 100,000 USD. + +### Milestone 1 — Implement Core Parachain Automation +- **Estimated duration:** 1 month +- **FTE:** 4 +- **Costs:** 25,000 USD + + + +| Number | Deliverable | Specification | +| -----: | ----------- | ------------- | +| 0a. | License | GPLv3 | +| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Substrate based parachain nodes and send test transactions, which will show how the new functionality works. | +| 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | +| 0d. | Docker/Cluster | We will provide a Dockerfile(s)/Cluster Yaml(s) that can be used to test all the functionality delivered with this milestone. | +| 0e. | Article | Using our PR channels, we will publish an **article** that explains the high-level overview of automation as part of the grant, followed by a set of extensive examples. | +| 1. | Initial Automation | We will build the core cli driven automation to create and deploy the substrate based parachain nodes. | +| 2. | Configuration | Parachain configuration is critical and complicated, we will provide the Cli based pick and choose for genesis parameters and chain configs to start wtih parachain setup. | +| 3. | Node type support | Implement support for all node types including Full node, Archive node, Validator node and Collator node for the respective parachain. | +| 4. | Cloud agnostic setup | Design and implement the multi cloud deployment support for parachain nodes including AWS, DigitalOcean, GCP and more. | + + +### Milestone 2 — Network Monitoring +- **Estimated Duration:** 1 month +- **FTE:** 2 +- **Costs:** 25,000 USDC + +| Number | Deliverable | Specification | +| -----: | ----------- | ------------- | +| 0a. | License | GPLv3 | +| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Substrate based parachain nodes and setup monitoring for it, which will show how the new functionality works. | +| 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | +| 0d. | Docker/Cluster | We will provide a Dockerfile(s)/Cluster Yaml(s) that can be used to test all the functionality delivered with this milestone. | +| 0e. | Article | Using our PR channels, we will publish an **article** that explains the high-level overview of automation as part of the grant, followed by a set of extensive examples. | +| 1. | Design monitoring strategy | The prachains doesn't provide any embedded monitoring tool, we will with the node setup automation, automatically setup prometheus and Grafana on the nodes. | +| 2. | Setup Dashboard | The deployment done for Prometheus and Grafana will show standard Dashboard having node resource and Blockchain specific details shown on the aforementioned Grafana GUI Dashboard. | + + +### Milestone 3 — Zombie net automation and testing +- **Estimated Duration:** 2 month +- **FTE:** 4 +- **Costs:** 50,000 USD + +| Number | Deliverable | Specification | +| -----: | ----------- | ------------- | +| 0a. | License | GPLv3 | +| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Substrate based parachain nodes and start one command testing with Zoombie net on it, which will show how the new functionality works. | +| 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | +| 0d. | Docker/Cluster | We will provide a Dockerfile(s)/Cluster Yaml(s) that can be used to test all the functionality delivered with this milestone. | +| 0e. | Article | Using our PR channels, we will publish an **article** that explains the high-level overview of automation as part of the grant, followed by a set of extensive examples. | +| 1. | Design testing strategy | GUI driven Setup of K8/native based Zombienet and guided configuration of validators and parachains, including Prometheus/Grafana stack to monitor.| +| 2. | Setup Testing | Intuitive GUI for testing including options to, pick Network definition spec from a set of pre-defined templates, Create and choose from available DSL files to start. | +| 3. | Templating | Create and save configurations for setup as templates, replicate further to create to conduct A-B testings, GUI to display test results, logs and compare results from different templates. | + +## Future Plans +- We will promote the project by giving talks in the community, writing tutorials and videos. +- We will spread the project in Zeeve's developer and client community of 15K+ +- We will also work closely with the developers and clients of the Parity ecosystem for getting feedback and refine our project. +- Our long-term plan is to make the tool become one of the default Parachain tools for the Parity ecosystem. +- We will also add more followup, integration with the Zeeve enterprise platform allowing more flexibility for enterprises to built and deploy use case or application specific parachains. + +## Additional Information :heavy_plus_sign: +**How did you hear about the Grants Program?** Web3 Foundation Website / Parity team / a conversation with Richard Casey. From 957651fe5c6baff0de6a573156b0c96986e005a4 Mon Sep 17 00:00:00 2001 From: "arjun.chamyal" Date: Fri, 20 Jan 2023 21:37:42 +0530 Subject: [PATCH 2/8] Added mockups, technology stack and refine the deliverables as requested --- ...eployment_zoombienet_testing_automation.md | 95 +++++++++++++++---- 1 file changed, 76 insertions(+), 19 deletions(-) diff --git a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md index dba7692a182..1917d50cb35 100644 --- a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md +++ b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md @@ -1,13 +1,16 @@ -# Zeeve - Substrate parachain DevOps Automation +# larch - Zoombinet Automation + - **Team Name:** [Zeeve](https://www.zeeve.io) - **Payment Address:** Ethereum (USDT/USDC) 0x5E1257E928aa42E3D0cd9E2A7537E37D108D811B - **[Level](https://github.com/w3f/Grants-Program/tree/master#level_slider-levels):** 3 ### Overview + Blockchain adoption is happening at a very rapid rate, with a lot many use cases being implemented and seeing the light of the day. The concept of the parachain enables the possibilities further. While we focus on building the use cases, code them and implement the business logic of it, including the creation of Parachain and then further logic running upon it, we majorly underestimate the DevOps activity to deploy, maintain, scale and manage the parachain itself. This includes initial launch of the parachain, its thorough testing using Zoombie-net and scaling it further by providing support for users to create and deploy validator, full and archive nodes with ease as well as to have secure RPC endpoints. The most deficit we see is around advanced analytics and proactive monitoring to ensure a production grade incident management of networks and nodes. ### Project Details + Zeeve will provide a command line based tool to setup of new Substrate parachain network with in-depth and flexible configurations in few clicks on the cloud of choice to distribute nodes upon (AWS, GCP, DigitalOcean and Linode) - supporting K8 and native VMs whichever fits the parachains better. A GUI will be built to allow a quick setup of the parachain with zombie-net with the desired capabilities to test multiple configurations and compare the results. This in turn will allow the developers and parachain teams to try multiple chain configurations while setting up the parachains with Zoombie-net, as well as to choose different nodes to try and test for the best possibilities on the parachain. @@ -16,14 +19,15 @@ This not only will allow configurations on the parachain side but will also allo The graphical control panel will support all the other configurations or operations required to enable the developer or parachain team to test with as much flexibility as required. These operations include: - - Restart - after x seconds, will stop the `process` and start again after the `x`amount of seconds or immediately. - - Stop - will pause (SIGSTOP) the process) +- Restart - after x seconds, will stop the `process` and start again after the `x`amount of seconds or immediately. +- Stop - will pause (SIGSTOP) the process) - Resume - will pause (SIGCONT) the process) - Sleep - will allow config to sleep the test-runner for `x` ammount of seconds) **Test result and logs** The interface will allow the developer to test and see live logs of the test run, post run results and logs on the aforementioned interface and save them for analysis later to be able to compare with the previous executions on demand. Furthermore, a stack of Prometheus and Grafana will allow easy monitoring of the parachain nodes. Along with the mentioned CLI capabilities to the developers. - + + **Templating** The control panel will also allow the developer or the parachain team to one-click replicate one of the existing network configurations, save as template or pick from previously saved template and re-create a new test with some rapid tweaks to it. @@ -45,13 +49,13 @@ The control panel will also allow the developer or the parachain team to one-cli ### Legal Structure - **Registered Address:** 1603 Capitol Ave Ste 310, Cheyenne 82001, WY -- **Registered Legal Entity:** Zeeve Inc. +- **Registered Legal Entity:** Zeeve Inc. ### Team's experience + Founded by a team of experienced professionals and enterprenuers from industry, Zeeve's cofounders collectively have over 45+ years of experience in technology, product development, and various business verticals. Zeeve has built an enterprise-grade no-code Blockchain Infrastructure Automation platform that enables Enterprises, Blockchain Startups, Blockchain Consulting Companies and Web3 Developers to deploy Blockchain nodes and Decentralised Apps within minutes, and manage them with advanced analytics and real-time alerts. In June 2022, the Startup raised $2.65 Million in a Seed Round from Leo Capital and Blu Ventures. It plans to deploy the funds towards product development, augmenting the technology team and enhancing its reach among DApp developers and global corporations, please consider visiting our prior [work](https://www.zeeve.io/platform). ### Team Code Repos - - https://github.com/Zeeve-App - https://github.com/Zeeve-App/sawtooth-artifacts - https://github.com/Zeeve-App/Zeeve-read-the-docs @@ -60,7 +64,6 @@ Please also provide the GitHub accounts of all team members. If they contain no - https://www.zeeve.io/about-us - ### Team LinkedIn Profiles (if available) - https://www.linkedin.com/in/ghan-vashishtha/ @@ -80,33 +83,34 @@ Before applying for the Web3 Foundation Grant, the Zeeve team has built a DevOps - Spoke with David Hawig, Richard Casey and Gautam Dhameja from the Parity team regarding the development of Zeeve and the Web3 Grant application ## Development Roadmap :nut_and_bolt: - + ### Overview + - **Total Estimated Duration:** 4 months - **Full-Time Equivalent (FTE):** 4 FTE - **Total Costs:** 100,000 USD. ### Milestone 1 — Implement Core Parachain Automation + - **Estimated duration:** 1 month - **FTE:** 4 - **Costs:** 25,000 USD - - | Number | Deliverable | Specification | | -----: | ----------- | ------------- | | 0a. | License | GPLv3 | -| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Substrate based parachain nodes and send test transactions, which will show how the new functionality works. | +| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Substrate based Zoombinet nodes and initiate testing, which will show how the new functionality works. | | 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | | 0d. | Docker/Cluster | We will provide a Dockerfile(s)/Cluster Yaml(s) that can be used to test all the functionality delivered with this milestone. | | 0e. | Article | Using our PR channels, we will publish an **article** that explains the high-level overview of automation as part of the grant, followed by a set of extensive examples. | -| 1. | Initial Automation | We will build the core cli driven automation to create and deploy the substrate based parachain nodes. | -| 2. | Configuration | Parachain configuration is critical and complicated, we will provide the Cli based pick and choose for genesis parameters and chain configs to start wtih parachain setup. | -| 3. | Node type support | Implement support for all node types including Full node, Archive node, Validator node and Collator node for the respective parachain. | -| 4. | Cloud agnostic setup | Design and implement the multi cloud deployment support for parachain nodes including AWS, DigitalOcean, GCP and more. | +| 1. | Initial Automation | We will build the core GUI driven automation to create and deploy the substrate based Zoombienet configurations including relaychain and parachain configurations. | +| 2. | Configuration | Parachain configuration is critical and complicated, we will provide the GUI based pick and choose for genesis parameters and chain configs to start wtih parachain setup for the desired Zoombinet | +| 3. | Node type support | Implement setup of all node types including Full node, Validator node and Collator node for the respective relay chain and parachain within the configured Zoombi-net. | +| 4. | Cloud agnostic setup | Design and implement the multi cloud deployment support for Zoombinet nodes including AWS, DigitalOcean, GCP. | ### Milestone 2 — Network Monitoring + - **Estimated Duration:** 1 month - **FTE:** 2 - **Costs:** 25,000 USDC @@ -114,18 +118,18 @@ Before applying for the Web3 Foundation Grant, the Zeeve team has built a DevOps | Number | Deliverable | Specification | | -----: | ----------- | ------------- | | 0a. | License | GPLv3 | -| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Substrate based parachain nodes and setup monitoring for it, which will show how the new functionality works. | +| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Zoombinet, test and setup monitoring for it, which will show how the new functionality works. | | 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | | 0d. | Docker/Cluster | We will provide a Dockerfile(s)/Cluster Yaml(s) that can be used to test all the functionality delivered with this milestone. | | 0e. | Article | Using our PR channels, we will publish an **article** that explains the high-level overview of automation as part of the grant, followed by a set of extensive examples. | -| 1. | Design monitoring strategy | The prachains doesn't provide any embedded monitoring tool, we will with the node setup automation, automatically setup prometheus and Grafana on the nodes. | +| 1. | Design monitoring strategy | The Zoombinet doesn't provide any embedded monitoring tool, we will with the node setup automation, automatically setup prometheus and Grafana on the nodes. | | 2. | Setup Dashboard | The deployment done for Prometheus and Grafana will show standard Dashboard having node resource and Blockchain specific details shown on the aforementioned Grafana GUI Dashboard. | - ### Milestone 3 — Zombie net automation and testing + - **Estimated Duration:** 2 month - **FTE:** 4 -- **Costs:** 50,000 USD +- **Costs:** 50,000 USD | Number | Deliverable | Specification | | -----: | ----------- | ------------- | @@ -138,7 +142,59 @@ Before applying for the Web3 Foundation Grant, the Zeeve team has built a DevOps | 2. | Setup Testing | Intuitive GUI for testing including options to, pick Network definition spec from a set of pre-defined templates, Create and choose from available DSL files to start. | | 3. | Templating | Create and save configurations for setup as templates, replicate further to create to conduct A-B testings, GUI to display test results, logs and compare results from different templates. | +## Application Mockup + +Following are the mockups for high-level application operations, these are subject to change during development basis the requirement and behaviour. + +### Dashboard +![Dashboard](https://lh3.google.com/u/1/d/1w67xT8vRNHRT9UFPh3I1iHaFJcgHEd6O=w3456-h1830-iv1) + +### Zoombinet network list + +![List all created Zoombie networks](https://lh3.google.com/u/1/d/14ZGT5z-xC8nmSjI0OcERdU3ED9wGCIix=w3456-h848-iv1) + +### Create a new Zoombinet + +![Zoombinet Settings](https://lh3.google.com/u/1/d/1A5TPhqW76niVF75VJ07_qGVjpUDtjBL7=w3456-h1330-iv1) + +![Zoombinet Relaychain Configuration](https://lh3.google.com/u/1/d/1D40Xxmsn17DpvEkoKTOnCYjMDkJpw0yt=w3456-h1330-iv1) + +![Zoombinet Parachain configuration](https://lh3.google.com/u/1/d/1NMBQcvYw_MSIruRsOuWlhlDHszT5nQ9U=w3456-h1330-iv1) + +![Zoombinet Collator configuration](https://lh3.google.com/u/1/d/1GyqImmyBl_J1xI4YkW2HrWUd0zFX3TV_=w3456-h1330-iv1) + +![Zoombinet HRMP configuration](https://lh3.google.com/u/1/d/1zDm3oS4b5QnPnJ_GOTD_k8tArf3vH86-=w3456-h1330-iv1) + +### Relaychain, Parachain, specfile and WASM templates + +![Zoombinet Configuration teomplates](https://lh3.google.com/u/1/d/1wFXzNpOwyx9C5FLV7-WFhgM-lNBqfjCv=w3456-h1330-iv1) + +![Zoombinet WASM image templates](https://lh3.google.com/u/1/d/1GaABdQLd2c2t76Jlp4hFRfIc5Q6rsrco=w3456-h1330-iv1) + +### User activity and operation history + +![User activity and operation history](https://lh3.google.com/u/1/d/1RRK-tqEY1OzIR-xg6k1Mn0VYFCEu7iFg=w3456-h1330-iv1) + +### DSL Templates + +![DSL Template list](https://lh3.google.com/u/1/d/189hmcnQIoAF48UEYCKaDQT_CxgkNfPEl=w3456-h1330-iv1) + +### Embedded DSL Editor + +![DSL Editor](https://lh3.google.com/u/1/d/1BTrVDYNYx5MO40pL_6owvB-fe3E2Eho3=w3456-h1330-iv1) + +## Technology Stack +- ReactJS +- NodeJS +- Apache/Nginx +- TailwindCSS +- System Scripts +- Kubernetes/Podman/Docker +- Terraform +- Prometheus, Grafana, Telegraph + ## Future Plans + - We will promote the project by giving talks in the community, writing tutorials and videos. - We will spread the project in Zeeve's developer and client community of 15K+ - We will also work closely with the developers and clients of the Parity ecosystem for getting feedback and refine our project. @@ -146,4 +202,5 @@ Before applying for the Web3 Foundation Grant, the Zeeve team has built a DevOps - We will also add more followup, integration with the Zeeve enterprise platform allowing more flexibility for enterprises to built and deploy use case or application specific parachains. ## Additional Information :heavy_plus_sign: + **How did you hear about the Grants Program?** Web3 Foundation Website / Parity team / a conversation with Richard Casey. From d3aee1fcb499ba195aeb4d0762955cddc739398e Mon Sep 17 00:00:00 2001 From: "arjun.chamyal" Date: Tue, 24 Jan 2023 14:35:47 +0530 Subject: [PATCH 3/8] url update for images --- ...eployment_zoombienet_testing_automation.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md index 1917d50cb35..a732e45451d 100644 --- a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md +++ b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md @@ -147,41 +147,41 @@ Before applying for the Web3 Foundation Grant, the Zeeve team has built a DevOps Following are the mockups for high-level application operations, these are subject to change during development basis the requirement and behaviour. ### Dashboard -![Dashboard](https://lh3.google.com/u/1/d/1w67xT8vRNHRT9UFPh3I1iHaFJcgHEd6O=w3456-h1830-iv1) +![Dashboard](https://larch.zeeve.net/images/larch%20-%20Dasboard.png) ### Zoombinet network list -![List all created Zoombie networks](https://lh3.google.com/u/1/d/14ZGT5z-xC8nmSjI0OcERdU3ED9wGCIix=w3456-h848-iv1) +![List all created Zoombie networks](https://larch.zeeve.net/images/larch-znet-list.png) ### Create a new Zoombinet -![Zoombinet Settings](https://lh3.google.com/u/1/d/1A5TPhqW76niVF75VJ07_qGVjpUDtjBL7=w3456-h1330-iv1) +![Zoombinet Settings](https://larch.zeeve.net/images/larch-znet-settings.png) -![Zoombinet Relaychain Configuration](https://lh3.google.com/u/1/d/1D40Xxmsn17DpvEkoKTOnCYjMDkJpw0yt=w3456-h1330-iv1) +![Zoombinet Relaychain Configuration](https://larch.zeeve.net/images/larch-znet-relaychain.png) -![Zoombinet Parachain configuration](https://lh3.google.com/u/1/d/1NMBQcvYw_MSIruRsOuWlhlDHszT5nQ9U=w3456-h1330-iv1) +![Zoombinet Parachain configuration](https://larch.zeeve.net/images/larch-znet-parachain.png) -![Zoombinet Collator configuration](https://lh3.google.com/u/1/d/1GyqImmyBl_J1xI4YkW2HrWUd0zFX3TV_=w3456-h1330-iv1) +![Zoombinet Collator configuration](https://larch.zeeve.net/images/larch-znet-collator.png) -![Zoombinet HRMP configuration](https://lh3.google.com/u/1/d/1zDm3oS4b5QnPnJ_GOTD_k8tArf3vH86-=w3456-h1330-iv1) +![Zoombinet HRMP configuration](https://larch.zeeve.net/images/larch-znet-hrmp.png) ### Relaychain, Parachain, specfile and WASM templates -![Zoombinet Configuration teomplates](https://lh3.google.com/u/1/d/1wFXzNpOwyx9C5FLV7-WFhgM-lNBqfjCv=w3456-h1330-iv1) +![Zoombinet Configuration teomplates](https://larch.zeeve.net/images/larch-template-config.png) -![Zoombinet WASM image templates](https://lh3.google.com/u/1/d/1GaABdQLd2c2t76Jlp4hFRfIc5Q6rsrco=w3456-h1330-iv1) +![Zoombinet WASM image templates](https://larch.zeeve.net/images/Larch-Template-image.png) ### User activity and operation history -![User activity and operation history](https://lh3.google.com/u/1/d/1RRK-tqEY1OzIR-xg6k1Mn0VYFCEu7iFg=w3456-h1330-iv1) +![User activity and operation history](https://larch.zeeve.net/images/larch-user-activity.png) ### DSL Templates -![DSL Template list](https://lh3.google.com/u/1/d/189hmcnQIoAF48UEYCKaDQT_CxgkNfPEl=w3456-h1330-iv1) +![DSL Template list](https://larch.zeeve.net/images/larch-dsl-list.png) ### Embedded DSL Editor -![DSL Editor](https://lh3.google.com/u/1/d/1BTrVDYNYx5MO40pL_6owvB-fe3E2Eho3=w3456-h1330-iv1) +![DSL Editor](https://larch.zeeve.net/images/larch-dsl-editor.png) ## Technology Stack - ReactJS From 86f88df5ac75225efe966a8d4cb7479b2463ad3c Mon Sep 17 00:00:00 2001 From: "arjun.chamyal" Date: Fri, 3 Feb 2023 00:02:05 +0530 Subject: [PATCH 4/8] updated the milestones and grant scope --- ...eployment_zoombienet_testing_automation.md | 196 ++++++++++++------ 1 file changed, 132 insertions(+), 64 deletions(-) diff --git a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md index a732e45451d..fef6cb506f8 100644 --- a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md +++ b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md @@ -1,23 +1,23 @@ -# larch - Zoombinet Automation - + +# larch - Zombie-net Automation - **Team Name:** [Zeeve](https://www.zeeve.io) + - **Payment Address:** Ethereum (USDT/USDC) 0x5E1257E928aa42E3D0cd9E2A7537E37D108D811B -- **[Level](https://github.com/w3f/Grants-Program/tree/master#level_slider-levels):** 3 + +- **[Level](https://github.com/w3f/Grants-Program/tree/master#level_slider-levels):** 1 ### Overview -Blockchain adoption is happening at a very rapid rate, with a lot many use cases being implemented and seeing the light of the day. The concept of the parachain enables the possibilities further. While we focus on building the use cases, code them and implement the business logic of it, including the creation of Parachain and then further logic running upon it, we majorly underestimate the DevOps activity to deploy, maintain, scale and manage the parachain itself. This includes initial launch of the parachain, its thorough testing using Zoombie-net and scaling it further by providing support for users to create and deploy validator, full and archive nodes with ease as well as to have secure RPC endpoints. The most deficit we see is around advanced analytics and proactive monitoring to ensure a production grade incident management of networks and nodes. +Blockchain adoption is happening at a very rapid rate, with a lot many use cases being implemented and seeing the light of the day. The concept of the parachain enables the possibilities further. While we focus on building the use cases, code them and implement the business logic of it, including the creation of Parachain and then further logic running upon it, we majorly underestimate the DevOps activity to deploy, maintain, scale and manage the parachain itself. This includes initial launch of the parachain, its thorough testing using Zombie-net and scaling it further by providing support for users to create and deploy validator, full and archive nodes with ease as well as to have secure RPC endpoints. The most deficit we see is around advanced analytics and proactive monitoring to ensure a production grade incident management of networks and nodes. ### Project Details -Zeeve will provide a command line based tool to setup of new Substrate parachain network with in-depth and flexible configurations in few clicks on the cloud of choice to distribute nodes upon (AWS, GCP, DigitalOcean and Linode) - supporting K8 and native VMs whichever fits the parachains better. +Zeeve will provide a GUI tool to setup the new Substrate zombie-net network with in-depth and flexible configurations in few clicks supporting K8 and native VMs whichever fits the parachains better. -A GUI will be built to allow a quick setup of the parachain with zombie-net with the desired capabilities to test multiple configurations and compare the results. This in turn will allow the developers and parachain teams to try multiple chain configurations while setting up the parachains with Zoombie-net, as well as to choose different nodes to try and test for the best possibilities on the parachain. +A GUI will be built to allow a quick setup of the relaychain, parachain with zombie-net with the desired capabilities to test multiple configurations. This in turn will allow the developers and parachain teams to try multiple chain configurations while setting up the parachains with Zombie-net, as well as to choose different nodes to try and test for the best possibilities on the parachain. -This not only will allow configurations on the parachain side but will also allow you to pick different DSL templates on Zombie net as well as creating new templates without needing to write the code. The configurator will be an intuitive graphical wizard based interface to create in-depth [Network definition spec](https://paritytech.github.io/zombienet/network-definition-spec.html#network-definition-spec) and apply on the go. Furthermore, to allow seamless testing using the dynamic wizard based DSL creation allowing to choose and configure all available [Assertions](https://paritytech.github.io/zombienet/cli/test-dsl-definition-spec.html#available-assertions) - -The graphical control panel will support all the other configurations or operations required to enable the developer or parachain team to test with as much flexibility as required. These operations include: +This not only will allow configurations on the parachain side but will also allow you to pick from a set of predefined DSL templates on Zombie-net as well as upload the new templates without needing to write the code. The graphical control panel will support all the other configurations or operations required to enable the developer or parachain team to test with as much flexibility as required. These operations include: - Restart - after x seconds, will stop the `process` and start again after the `x`amount of seconds or immediately. - Stop - will pause (SIGSTOP) the process) @@ -25,180 +25,248 @@ The graphical control panel will support all the other configurations or operati - Sleep - will allow config to sleep the test-runner for `x` ammount of seconds) **Test result and logs** -The interface will allow the developer to test and see live logs of the test run, post run results and logs on the aforementioned interface and save them for analysis later to be able to compare with the previous executions on demand. Furthermore, a stack of Prometheus and Grafana will allow easy monitoring of the parachain nodes. Along with the mentioned CLI capabilities to the developers. - - + +The interface will allow the developer to test and see live logs of the test run, post run results and logs on the aforementioned interface. Furthermore, a stack of Prometheus and Grafana will allow easy monitoring of the Zombie-net. + **Templating** -The control panel will also allow the developer or the parachain team to one-click replicate one of the existing network configurations, save as template or pick from previously saved template and re-create a new test with some rapid tweaks to it. + +The control panel will also allow the developer or the parachain team to one-click replicate one of the existing zombie-net configurations, save as template or pick from previously saved template and re-create a new test with some rapid tweaks to it. + + ## Team :busts_in_silhouette: ### Team members - Ghan Vashishtha + - Sankalp Sharma + - Arjun Chamyal + - Rahul Meena + + ### Contact + + - **Contact Name:** Ghan Vashishtha + - **Contact Email:** ghan@zeeve.io + - **Website:** www.zeeve.io + + ### Legal Structure + + - **Registered Address:** 1603 Capitol Ave Ste 310, Cheyenne 82001, WY + - **Registered Legal Entity:** Zeeve Inc. + + ### Team's experience + + Founded by a team of experienced professionals and enterprenuers from industry, Zeeve's cofounders collectively have over 45+ years of experience in technology, product development, and various business verticals. Zeeve has built an enterprise-grade no-code Blockchain Infrastructure Automation platform that enables Enterprises, Blockchain Startups, Blockchain Consulting Companies and Web3 Developers to deploy Blockchain nodes and Decentralised Apps within minutes, and manage them with advanced analytics and real-time alerts. In June 2022, the Startup raised $2.65 Million in a Seed Round from Leo Capital and Blu Ventures. It plans to deploy the funds towards product development, augmenting the technology team and enhancing its reach among DApp developers and global corporations, please consider visiting our prior [work](https://www.zeeve.io/platform). + + ### Team Code Repos + - https://github.com/Zeeve-App + - https://github.com/Zeeve-App/sawtooth-artifacts + - https://github.com/Zeeve-App/Zeeve-read-the-docs + + Please also provide the GitHub accounts of all team members. If they contain no activity, references to projects hosted elsewhere or live are also fine. + + - https://www.zeeve.io/about-us + + ### Team LinkedIn Profiles (if available) + + - https://www.linkedin.com/in/ghan-vashishtha/ + - https://www.linkedin.com/in/sankalp-sharma-502008139/ + - https://www.linkedin.com/in/arjun-chamyal-a4466086/ + - https://www.linkedin.com/in/rahul-m-0ba16487/ + + ## Development Status :open_book: + + Before applying for the Web3 Foundation Grant, the Zeeve team has built a DevOps automation for Polkadot and other substrate chains, also created substrates based relay chains: + + - Automated Polkadot deployments including validator nodes, archive nodes [here](https://www.zeeve.io/blockchain-protocols/deploy-polkadot-node/) + - Automated Kusama deployments including validator nodes, archive nodes [here](https://www.zeeve.io/blockchain-protocols/deploy-kusama-node/) + - Created a relay chain on substrate with some customisations done at the core to accomodate the tokenomics and custom reward mechanism [here](https://axscan.axiacoin.network/#/explorer) + - Published a [blog post](https://www.zeeve.io/blog/how-to-use-substrate-to-create-parachains-in-polkadot/) about the usage and omlememtation of praachains + - The focus for Zeeve will be automating the parachain deployments, dedicated node setups and help with faster testing with zombie-net. + - Spoke with David Hawig, Richard Casey and Gautam Dhameja from the Parity team regarding the development of Zeeve and the Web3 Grant application + + ## Development Roadmap :nut_and_bolt: + + ### Overview -- **Total Estimated Duration:** 4 months + + +- **Total Estimated Duration:** 2 months + - **Full-Time Equivalent (FTE):** 4 FTE -- **Total Costs:** 100,000 USD. -### Milestone 1 — Implement Core Parachain Automation +- **Total Costs:** 30,000 USD. + + + +### Milestone 1 — Implement Core Zombie-net Automation + + + +- **Estimated duration:** 40 days -- **Estimated duration:** 1 month - **FTE:** 4 -- **Costs:** 25,000 USD + +- **Costs:** 20,000 USD + + | Number | Deliverable | Specification | | -----: | ----------- | ------------- | | 0a. | License | GPLv3 | -| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Substrate based Zoombinet nodes and initiate testing, which will show how the new functionality works. | +| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Substrate based Zombie-net nodes and initiate testing, which will show how the new functionality works. | | 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | | 0d. | Docker/Cluster | We will provide a Dockerfile(s)/Cluster Yaml(s) that can be used to test all the functionality delivered with this milestone. | | 0e. | Article | Using our PR channels, we will publish an **article** that explains the high-level overview of automation as part of the grant, followed by a set of extensive examples. | -| 1. | Initial Automation | We will build the core GUI driven automation to create and deploy the substrate based Zoombienet configurations including relaychain and parachain configurations. | -| 2. | Configuration | Parachain configuration is critical and complicated, we will provide the GUI based pick and choose for genesis parameters and chain configs to start wtih parachain setup for the desired Zoombinet | -| 3. | Node type support | Implement setup of all node types including Full node, Validator node and Collator node for the respective relay chain and parachain within the configured Zoombi-net. | -| 4. | Cloud agnostic setup | Design and implement the multi cloud deployment support for Zoombinet nodes including AWS, DigitalOcean, GCP. | +| 1. | Initial Automation | We will build the core GUI driven automation to create and deploy the substrate based Zombie-net configurations including relaychain and parachain configurations. | +| 2. | Configuration | Parachain configuration is critical and complicated, we will provide the GUI based pick and choose for genesis parameters and chain configs to start wtih parachain setup for the desired Zombie-net | +| 3. | Node type support | Implement setup of all node types including Full node, Validator node and Collator node for the respective relay chain and parachain within the configured Zombie-net. | +| 4. | Cloud agnostic setup | The larch setup will be cloud agnostic and it can be installed on the choice of cloud, instructions and documentation will be provided for the same. | +| 5. | User management | The larch will allow to setup different users with desired permissions and access controls such as add, delete zombie-net, view, delete logs and save, delete templates. | + + + -### Milestone 2 — Network Monitoring +### Milestone 2 — Monitoring -- **Estimated Duration:** 1 month -- **FTE:** 2 -- **Costs:** 25,000 USDC + -| Number | Deliverable | Specification | -| -----: | ----------- | ------------- | -| 0a. | License | GPLv3 | -| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Zoombinet, test and setup monitoring for it, which will show how the new functionality works. | -| 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | -| 0d. | Docker/Cluster | We will provide a Dockerfile(s)/Cluster Yaml(s) that can be used to test all the functionality delivered with this milestone. | -| 0e. | Article | Using our PR channels, we will publish an **article** that explains the high-level overview of automation as part of the grant, followed by a set of extensive examples. | -| 1. | Design monitoring strategy | The Zoombinet doesn't provide any embedded monitoring tool, we will with the node setup automation, automatically setup prometheus and Grafana on the nodes. | -| 2. | Setup Dashboard | The deployment done for Prometheus and Grafana will show standard Dashboard having node resource and Blockchain specific details shown on the aforementioned Grafana GUI Dashboard. | +- **Estimated Duration:** 20 days -### Milestone 3 — Zombie net automation and testing +- **FTE:** 2 -- **Estimated Duration:** 2 month -- **FTE:** 4 -- **Costs:** 50,000 USD +- **Costs:** 10,000 USDC + + | Number | Deliverable | Specification | | -----: | ----------- | ------------- | | 0a. | License | GPLv3 | -| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Substrate based parachain nodes and start one command testing with Zoombie net on it, which will show how the new functionality works. | +| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Zombie-net, test and setup monitoring for it, which will show how the new functionality works. | | 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | | 0d. | Docker/Cluster | We will provide a Dockerfile(s)/Cluster Yaml(s) that can be used to test all the functionality delivered with this milestone. | | 0e. | Article | Using our PR channels, we will publish an **article** that explains the high-level overview of automation as part of the grant, followed by a set of extensive examples. | -| 1. | Design testing strategy | GUI driven Setup of K8/native based Zombienet and guided configuration of validators and parachains, including Prometheus/Grafana stack to monitor.| -| 2. | Setup Testing | Intuitive GUI for testing including options to, pick Network definition spec from a set of pre-defined templates, Create and choose from available DSL files to start. | -| 3. | Templating | Create and save configurations for setup as templates, replicate further to create to conduct A-B testings, GUI to display test results, logs and compare results from different templates. | +| 1. | Design monitoring strategy | The Zombie-net doesn't provide any embedded monitoring tool, we will with the zombie-net setup automation, automatically setup prometheus and Grafana while configuring the zombie-net. | +| 2. | Setup Dashboard | The deployment done for Prometheus and Grafana will show standard Dashboard having system resource and zombie-net specific details shown on the aforementioned Grafana GUI Dashboard. | +| 3. | Activity | The system will log all the activities and operations perform by the different users. | ## Application Mockup + + Following are the mockups for high-level application operations, these are subject to change during development basis the requirement and behaviour. + + ### Dashboard -![Dashboard](https://larch.zeeve.net/images/larch%20-%20Dasboard.png) -### Zoombinet network list +![Dashboard](https://larch.zeeve.net/images/Dashboard.png) -![List all created Zoombie networks](https://larch.zeeve.net/images/larch-znet-list.png) +### Zombie-net network list +![List all created Zombie networks](https://larch.zeeve.net/images/My-Networks.png) -### Create a new Zoombinet +### Create a new Zombie-net -![Zoombinet Settings](https://larch.zeeve.net/images/larch-znet-settings.png) +![Zombie-net Settings](https://larch.zeeve.net/images/Create-Networks-Settings.png) -![Zoombinet Relaychain Configuration](https://larch.zeeve.net/images/larch-znet-relaychain.png) +![Zombie-net Relaychain Configuration](https://larch.zeeve.net/images/Create-Networks-Relaychain-Configuration.png) -![Zoombinet Parachain configuration](https://larch.zeeve.net/images/larch-znet-parachain.png) +![Zombie-net Parachain configuration](https://larch.zeeve.net/images/Create-Networks-Parachain-Configuration.png) -![Zoombinet Collator configuration](https://larch.zeeve.net/images/larch-znet-collator.png) +![Zombie-net Collator configuration](https://larch.zeeve.net/images/Create-Networks-Collator-Configuration.png) -![Zoombinet HRMP configuration](https://larch.zeeve.net/images/larch-znet-hrmp.png) +![Zombie-net HRMP configuration](https://larch.zeeve.net/images/Create-Networks-HRMP-Channels.png) ### Relaychain, Parachain, specfile and WASM templates -![Zoombinet Configuration teomplates](https://larch.zeeve.net/images/larch-template-config.png) - -![Zoombinet WASM image templates](https://larch.zeeve.net/images/Larch-Template-image.png) +![Zombie-net Configuration templates](https://larch.zeeve.net/images/Templates-Configuration.png) -### User activity and operation history - -![User activity and operation history](https://larch.zeeve.net/images/larch-user-activity.png) + -### DSL Templates +![Zombie-net WASM image templates](https://larch.zeeve.net/images/Templates-Managment.png) -![DSL Template list](https://larch.zeeve.net/images/larch-dsl-list.png) + -### Embedded DSL Editor +### User activity and operation history -![DSL Editor](https://larch.zeeve.net/images/larch-dsl-editor.png) +![User activity and operation history](https://larch.zeeve.net/images/Activity.png) ## Technology Stack + - ReactJS + - NodeJS + - Apache/Nginx + - TailwindCSS + - System Scripts + - Kubernetes/Podman/Docker -- Terraform + - Prometheus, Grafana, Telegraph ## Future Plans - We will promote the project by giving talks in the community, writing tutorials and videos. + - We will spread the project in Zeeve's developer and client community of 15K+ + - We will also work closely with the developers and clients of the Parity ecosystem for getting feedback and refine our project. + - Our long-term plan is to make the tool become one of the default Parachain tools for the Parity ecosystem. + - We will also add more followup, integration with the Zeeve enterprise platform allowing more flexibility for enterprises to built and deploy use case or application specific parachains. ## Additional Information :heavy_plus_sign: From 23767d4b8059b49f9743a5473d3967577161bf2c Mon Sep 17 00:00:00 2001 From: "arjun.chamyal" Date: Fri, 3 Feb 2023 00:03:58 +0530 Subject: [PATCH 5/8] updated the milestones and grant scope --- .../Zeeve_Parachain_deployment_zoombienet_testing_automation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md index fef6cb506f8..567604e4aad 100644 --- a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md +++ b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md @@ -185,7 +185,7 @@ Before applying for the Web3 Foundation Grant, the Zeeve team has built a DevOps - **FTE:** 2 -- **Costs:** 10,000 USDC +- **Costs:** 10,000 USD From 197b86a37c292e09d9216eb420d22764ab99ca7e Mon Sep 17 00:00:00 2001 From: "arjun.chamyal" Date: Fri, 3 Feb 2023 00:07:04 +0530 Subject: [PATCH 6/8] updated the milestones and grant scope --- .../Zeeve_Parachain_deployment_zoombienet_testing_automation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md index 567604e4aad..ec04d236e81 100644 --- a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md +++ b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md @@ -5,7 +5,7 @@ - **Payment Address:** Ethereum (USDT/USDC) 0x5E1257E928aa42E3D0cd9E2A7537E37D108D811B -- **[Level](https://github.com/w3f/Grants-Program/tree/master#level_slider-levels):** 1 +- **[Level](https://github.com/w3f/Grants-Program/tree/master#level_slider-levels):** 2 ### Overview From c6e684bbce5d327adc28f6e000cff547df06acac Mon Sep 17 00:00:00 2001 From: "arjun.chamyal" Date: Fri, 3 Feb 2023 09:18:42 +0530 Subject: [PATCH 7/8] removing artical from 1st milestone --- .../Zeeve_Parachain_deployment_zoombienet_testing_automation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md index ec04d236e81..482003617f4 100644 --- a/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md +++ b/applications/Zeeve_Parachain_deployment_zoombienet_testing_automation.md @@ -166,7 +166,6 @@ Before applying for the Web3 Foundation Grant, the Zeeve team has built a DevOps | 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) create a new Substrate based Zombie-net nodes and initiate testing, which will show how the new functionality works. | | 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | | 0d. | Docker/Cluster | We will provide a Dockerfile(s)/Cluster Yaml(s) that can be used to test all the functionality delivered with this milestone. | -| 0e. | Article | Using our PR channels, we will publish an **article** that explains the high-level overview of automation as part of the grant, followed by a set of extensive examples. | | 1. | Initial Automation | We will build the core GUI driven automation to create and deploy the substrate based Zombie-net configurations including relaychain and parachain configurations. | | 2. | Configuration | Parachain configuration is critical and complicated, we will provide the GUI based pick and choose for genesis parameters and chain configs to start wtih parachain setup for the desired Zombie-net | | 3. | Node type support | Implement setup of all node types including Full node, Validator node and Collator node for the respective relay chain and parachain within the configured Zombie-net. | From 6534ec1b2d821979665f270dc6cf86f09284df2c Mon Sep 17 00:00:00 2001 From: Jasti Sri Radhe Shyam Date: Wed, 10 May 2023 23:02:34 +0530 Subject: [PATCH 8/8] add ink playground ide improvements Signed-off-by: Jasti Sri Radhe Shyam --- .../ink-playground-ide-improvements.md | 154 ++++++++++++++++++ 1 file changed, 154 insertions(+) create mode 100644 applications/ink-playground-ide-improvements.md diff --git a/applications/ink-playground-ide-improvements.md b/applications/ink-playground-ide-improvements.md new file mode 100644 index 00000000000..0ef50586b16 --- /dev/null +++ b/applications/ink-playground-ide-improvements.md @@ -0,0 +1,154 @@ +# Ink Playground IDE Improvements Grant + +- **Team Name:** [Zeeve](https://www.zeeve.io) +- **Payment Address:** Ethereum (USDT/USDC) 0x5E1257E928aa42E3D0cd9E2A7537E37D108D811B +- **[Level](https://github.com/w3f/Grants-Program/tree/master#level_slider-levels):** 2 + +## Overview +The adoption of any technology depends on the accessibility and ease of use to both the maintainer and user, blockchain +or distributed ledger technologies are inherently a lot difficult to understand and maintain, so we have to build tools +to make the process much easier and painless. In the case of Polkadot's substrate based smart contract development we have +Ink! playground which helps smart contract developers to prototype and test it before deploying on the parachain in a +Sandboxed environment with having to do time-consuming setup of dependencies and also with ability to set up a local +environment to do development. + +## Project Details + +The community posed few challenges and issues to improve the Ink! Playground to keep up with the Ink's advancements and +have Ink's own docs with ability to execute the examples with multi version support, the following issues were proposed +by the Grant team to resolve: + +- [Support supplying ink! version in URL · Issue #427 · paritytech/ink-playground](https://github.com/paritytech/ink-playground/issues/427) +- [Update playground automatically upon new ink! release · Issue #197 · paritytech/ink-playground · GitHub](https://github.com/paritytech/ink-playground/issues/197) +- [Implement versioning for ink! playground · Issue #460 · paritytech/ink-playground · GitHub](https://github.com/paritytech/ink-playground/issues/460) +- [Support running code from crate docs · Issue #428 · paritytech/ink-playground · GitHub](https://github.com/paritytech/ink-playground/issues/428) + +The brief overview of the issue resolution: + +- **Dependency Versioning**: Provide an API and UI components to set dependency versions for the contract, which will + help developers to build for targeted systems and environments. +- Automated **Ink! Version upgrade** in Ink! Playground system when new Ink! Version releases. +- Ability to select **Ink! version** to compile the code in the IDE. +- In Ink! **Crate docs** code examples can be executed using the Ink! Playground backend with Ink! version support. + +Additionally, we would like to propose further enhancements to the Ink! Playground which will benefit the Polkadot community +by easing the development process with better Developer Experience. We are excited to work on the following enhancements +once we complete the aforementioned improvements and build upon to provide maintenance of the Ink! Playground. + +- **Local file system storage:** Use the local file system for contract storage which will help developers + to open and save the file without leaving the IDE. +- **Template contracts:** Provide contract templates similar to the Ethereum contract standards based on + the popular use cases. +- **Ability to run contract functions** based on the metadata generated for a contract, this + will help developers to prototype, test and debug the contracts faster. +- **Deploy contracts from the IDE:** Deploy the contracts to the remote contract execution environment by + providing the remote endpoint. +- **Recent contracts:** List all the recent contracts that were saved for faster access to previously edited + contracts. + +## Team :busts_in_silhouette: + +### Team members +- Ghan Vashishtha +- Sankalp Sharma +- Jasti Sri Radhe Shyam + +### Contact +- **Contact Name:** Ghan Vashishtha +- **Contact Email:** ghan@zeeve.io +- **Website:** www.zeeve.io + +### Legal Structure +- **Registered Address:** 1603 Capitol Ave Ste 310, Cheyenne 82001, WY +- **Registered Legal Entity:** Zeeve Inc. + +### Team's experience + +Founded by a team of experienced professionals and entrepreneurs from industry, Zeeve's co-founders +collectively have over 45+ years of experience in technology, product development, and various +business verticals. Zeeve has built an enterprise-grade no-code Blockchain Infrastructure Automation +platform that enables Enterprises, Blockchain Startups, Blockchain Consulting Companies and Web3 +Developers to deploy Blockchain nodes and Decentralized Apps within minutes, and manage them with +advanced analytics and real-time alerts. In June 2022, the Startup raised $2.65 Million in a Seed +Round from Leo Capital and Blu Ventures. It plans to deploy the funds towards product development, +augmenting the technology team and enhancing its reach among DApp developers and global corporations, +please consider visiting our prior [work](https://www.zeeve.io/platform). + +### Team Code Repos + +- https://github.com/Zeeve-App +- https://github.com/Zeeve-App/sawtooth-artifacts +- https://github.com/Zeeve-App/Zeeve-read-the-docs +- https://github.com/Zeeve-App/larch + +### Team LinkedIn Profiles (if available) + +- https://www.linkedin.com/in/ghan-vashishtha/ +- https://www.linkedin.com/in/sankalp-sharma-502008139/ +- https://www.linkedin.com/in/jastisriradheshyam/ + +## Development Status :open_book: + +Before applying for the Web3 Foundation Grant, the Zeeve team has built a DevOps automation for Polkadot and other substrate chains, also created substrates based relay chains: + +- Automated Polkadot deployments including validator nodes, archive nodes [here](https://www.zeeve.io/blockchain-protocols/deploy-polkadot-node/) +- Automated Kusama deployments including validator nodes, archive nodes [here](https://www.zeeve.io/blockchain-protocols/deploy-kusama-node/) +- Created a relay chain on substrate with some customizations done at the core to accommodate the tokenomics and custom reward mechanism [here](https://axscan.axiacoin.network/#/explorer) +- Published a [blog post](https://www.zeeve.io/blog/how-to-use-substrate-to-create-parachains-in-polkadot/) about the usage and implementation of parachain's +- The focus for Zeeve will be automating the parachain deployments, dedicated node setups and help with faster testing with zombie-net. +- Spoke with David Hawig, Richard Casey and Gautam Dhameja from the Parity team regarding the development of Zeeve and the Web3 Grant application +- Developed Larch, a UI for the Parity's Zombienet - [GitHub - Zeeve-App/larch](https://github.com/Zeeve-App/larch) + +## Development Road-map :nut_and_bolt: + +### Overview + +- **Total Estimated Duration:** 100 working days +- **Full-Time Equivalent (FTE):** 3 FTE +- **Total Costs:** 24,000 USD. + +### Milestone 1 — Implement Ink's Dependency versioning + +- **Estimated duration:** 90 working days +- **FTE:** 3 +- **Costs:** 21,000 USD + +| Number | Deliverable | Specification | +| -----: | -------------- | ------------- | +| 0.a. | License | Apache-2.0 | +| 0.b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can open and save a file | +| 1. | On demand version specific compilation | We will add the ability to build the compiler environment if a compiler environment is not present with a specific version of Ink! | +| 2. | Dependency Version support | We will upgrade and maintain Ink! and `cargo-contract` dependencies versions up to date and have provision to have older version support | +| 3. | Ink! Upgrades | We will add the ability to add Playground's Ink! version support to latest version as soon as new version of Ink! is released without manual intervention | +| 4. | Select Ink! version from UI | We will add ability to select Ink!'s version from the IDE to compile | + +### Milestone 2 - Ink! crate docs code execution + +- **Estimated duration:** 10 working days +- **FTE:** 3 +- **Costs:** 3000 USD + +| Number | Deliverable | Specification | +| -----: | -------------- | ------------- | +| 0.a. | License | Apache-2.0 | +| 0.b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can open and save a file | +| 1. | Ink! Create docs | We will provide the API and update create docs to run the code examples | + +## Technology Stack + +- Javascript +- CSS +- HTML +- Typescript +- Rust +- Docker + +## Additional Information :heavy_plus_sign: + +**How did you hear about the Grants Program?** Web3 Foundation Website / Parity team / a conversation with Richard Casey. + +### References: + +[1]: [What is Parity's ink!? | Parity Technologies](https://www.parity.io/blog/what-is-paritys-ink) + +[2]: [ink/ARCHITECTURE.md at master · paritytech/ink · GitHub](https://github.com/paritytech/ink/blob/master/ARCHITECTURE.md)