From 15a49f28c14632b96ace757dab88cc87630c949c Mon Sep 17 00:00:00 2001 From: kay404 Date: Sun, 18 Jun 2023 12:18:58 +0800 Subject: [PATCH 1/5] + Omniverse_DLT_milestone_2.md --- deliveries/Omniverse_DLT_milestone_2.md | 57 +++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 deliveries/Omniverse_DLT_milestone_2.md diff --git a/deliveries/Omniverse_DLT_milestone_2.md b/deliveries/Omniverse_DLT_milestone_2.md new file mode 100644 index 000000000..7304e38b3 --- /dev/null +++ b/deliveries/Omniverse_DLT_milestone_2.md @@ -0,0 +1,57 @@ +# Milestone Delivery :mailbox: + +> ⚡ Only the GitHub account that submitted the application is allowed to submit milestones. +> +> Don't remove any of the mandatory parts presented in bold letters or as headlines! Lines starting with `>`, such as this one, can be removed. + +**The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/milestone-deliverables-guidelines.md).** + +* **Application Document:** [Omniverse DLT](https://github.com/w3f/Grants-Program/blob/master/applications/Omniverse%20DLT.md). +* **PR Link:** [Omniverse DLT](https://github.com/w3f/Grants-Program/pull/1431), [update proposal](https://github.com/w3f/Grants-Program/pull/1475) +* **Milestone Number:** 2 + +**Context** (optional) +> Please provide a short paragraph or two connecting the deliverables in this milestone and describing their purpose. + +* In this milestone, we have finished create `Swap` pallet, user can add liquidity and make exchanges for two different o-tokens. +* In this milestone, we have finished the `Omniverse-DLT` protocol in `Ink!` technology stack for fungible token, it have the same functions as the `assets pallet` in milestone 1. +* We have enhanced the related off-chain tools to operate `o-tokens` both on the Parachain of Polkadot and EVM chains. +* We have provided incredibly convenient testing tools for deploying and testing the entire process. + +**Deliverables** +> Please provide a list of all deliverables of the milestone extracted from the initial application and a link to the deliverable itself. Ideally all links inside the below table should include a commit hash, which will be used for testing. If you don't provide a commit hash, we will work off the default branch of your repository. Thus, if you plan on continuing work after delivery, we suggest you create a separate branch for either the delivery or your continuing work. +> +> If there is anything particular about any of the deliverables we or a future reader should know, use the respective `Notes` column. + +| Number | Deliverable | Link | Notes | +| ------------- | ------------- | ------------- |------------- | +| 0a. | License | [GPLv3](https://github.com/Omniverse-Web3-Labs/omniverse-swap/blob/milestone-2/LICENSE) | GPLv3 | +| 0b. | Documentation | - [A high-level Introduction](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/README.md) - [Tutorial of how to use](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/README.md) | | +| 0c. | Testing Guide | [The test guide for milestone 2](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/test-guide/m2-test-guide.md) | We have provided a detailed introduction of [how to test](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/README.md), for this milestone we have provided incredibly convenient testing tools for deploying and testing the entire process in just a few steps. | +| 0d. | Docker | [Synchronizer docker](https://github.com/Omniverse-Web3-Labs/omniverse-synchronizer/tree/milestone-2/docker)| We have provide a Dockerfile to run Synchronizers and [test tool](https://github.com/Omniverse-Web3-Labs/omniverse-system-test/blob/milestone-2/src/index.js#L120) launch Synchronizer| +| 0e. | Article | [link]() | | +| 1. | Substrate module: swap | [Pallet for Omniverse Swap](https://github.com/Omniverse-Web3-Labs/omniverse-swap/tree/milestone-2/pallets/omni-swap) | We made out Omniverse Swap which can exchanges two different omniverse fungible tokens| +| 2. | Substrate chain | [Parachain itself](https://github.com/Omniverse-Web3-Labs/omniverse-swap/tree/milestone-2) | Bbuilding a Parachain is very easy. We have provided an implementation example mentioned in milestone 1 | +| 3. | Ink! smart contract implementation | [Ink! tech stacks](https://github.com/Omniverse-Web3-Labs/omniverse-ink) | We deploy the omniverse Ink! smart contract on [substrate-contracts-node-v0.25.1](https://github.com/paritytech/substrate-contracts-node/releases/tag/v0.25.1) | +| 4. | Off-Chain Synchronizer | [link](https://github.com/Omniverse-Web3-Labs/omniverse-synchronizer/tree/milestone-2) | We have optimized the synchronizer, improving its efficiency, added support for ink! parachain, and provided deployment through Docker. | + +**Additional Information** +* Here is the [GitHub of O-DLT](https://github.com/Omniverse-Web3-Labs). + +#### **Works until now** + +Currently, we have finished the basic functions of `O-DLT` protocol, and provided four tech stack implementations: + +- [Ethereum (EVMs)](https://github.com/Omniverse-Web3-Labs/omniverse-evm/tree/web3-grant) +- Polkadot + - [Pallet](https://github.com/Omniverse-Web3-Labs/omniverse-swap/tree/web3-grant) + - [Ink!](https://github.com/Omniverse-Web3-Labs/omniverse-ink) + - [Flow](https://github.com/Omniverse-Web3-Labs/omniverse-flow) + +And an application of `O-DLT` protocol: + +- [Omniverse Swap](https://github.com/Omniverse-Web3-Labs/omniverse-swap/tree/milestone-2/pallets/omni-swap) + +#### **Future Work** + +We will continue to dedicate ourselves to the improvement of `O-DLT` protocol and explore further applications based on it. From 266d3431bb1e06d051c212cf50fd13d508689400 Mon Sep 17 00:00:00 2001 From: xiyu1984 Date: Mon, 19 Jun 2023 13:42:16 +0800 Subject: [PATCH 2/5] update submission docs --- deliveries/Omniverse_DLT_milestone_2.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/deliveries/Omniverse_DLT_milestone_2.md b/deliveries/Omniverse_DLT_milestone_2.md index 7304e38b3..67d96c966 100644 --- a/deliveries/Omniverse_DLT_milestone_2.md +++ b/deliveries/Omniverse_DLT_milestone_2.md @@ -14,9 +14,9 @@ > Please provide a short paragraph or two connecting the deliverables in this milestone and describing their purpose. * In this milestone, we have finished create `Swap` pallet, user can add liquidity and make exchanges for two different o-tokens. -* In this milestone, we have finished the `Omniverse-DLT` protocol in `Ink!` technology stack for fungible token, it have the same functions as the `assets pallet` in milestone 1. +* In this milestone, we have finished the `Omniverse-DLT` protocol in `Ink!` technology stack, it have the same functions as the `assets pallet` in milestone 1. * We have enhanced the related off-chain tools to operate `o-tokens` both on the Parachain of Polkadot and EVM chains. -* We have provided incredibly convenient testing tools for deploying and testing the entire process. +* We have provided **incredibly convenient** **deployment** and **testing** tools for deploying and testing the entire process, which was complex and suffering in the previous milestone. **Deliverables** > Please provide a list of all deliverables of the milestone extracted from the initial application and a link to the deliverable itself. Ideally all links inside the below table should include a commit hash, which will be used for testing. If you don't provide a commit hash, we will work off the default branch of your repository. Thus, if you plan on continuing work after delivery, we suggest you create a separate branch for either the delivery or your continuing work. @@ -25,13 +25,13 @@ | Number | Deliverable | Link | Notes | | ------------- | ------------- | ------------- |------------- | -| 0a. | License | [GPLv3](https://github.com/Omniverse-Web3-Labs/omniverse-swap/blob/milestone-2/LICENSE) | GPLv3 | -| 0b. | Documentation | - [A high-level Introduction](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/README.md) - [Tutorial of how to use](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/README.md) | | -| 0c. | Testing Guide | [The test guide for milestone 2](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/test-guide/m2-test-guide.md) | We have provided a detailed introduction of [how to test](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/README.md), for this milestone we have provided incredibly convenient testing tools for deploying and testing the entire process in just a few steps. | -| 0d. | Docker | [Synchronizer docker](https://github.com/Omniverse-Web3-Labs/omniverse-synchronizer/tree/milestone-2/docker)| We have provide a Dockerfile to run Synchronizers and [test tool](https://github.com/Omniverse-Web3-Labs/omniverse-system-test/blob/milestone-2/src/index.js#L120) launch Synchronizer| -| 0e. | Article | [link]() | | -| 1. | Substrate module: swap | [Pallet for Omniverse Swap](https://github.com/Omniverse-Web3-Labs/omniverse-swap/tree/milestone-2/pallets/omni-swap) | We made out Omniverse Swap which can exchanges two different omniverse fungible tokens| -| 2. | Substrate chain | [Parachain itself](https://github.com/Omniverse-Web3-Labs/omniverse-swap/tree/milestone-2) | Bbuilding a Parachain is very easy. We have provided an implementation example mentioned in milestone 1 | +| 0a. | License | - [Omniverse Swap](https://github.com/Omniverse-Web3-Labs/omniverse-swap/blob/milestone-2/LICENSE)
-[Omniverse Ink!]() | GPLv3 | +| 0b. | Documentation | - [A high-level Priciple of the Omniverse Swap](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/High-Level%20Principle%20of%20Omniverse%20Swap.md)
- [How to dev with `Ink!`](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/dev-for-Ink!.md)
- [Tutorial of how to auto-deploy](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/Auto-Deployment.md)
- [Tutorial of how to operate](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/Auto-Tutorial.md) | The documentation for this milestone include the high-level introduction of the swap, how to dev with `Ink!`, and the tutorial of how to use. We provide the tutorial for two parts, the one is the deployment that is made **automatically**, and the other is the operation. | +| 0c. | Testing Guide | [The test guide for milestone 2](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/test-guide/m2-test-guide.md) | For this milestone we have provided incredibly convenient testing tools for testing the entire process in just a few steps. We think it brings much convenient and really makes sense. | +| 0d. | Docker | [Synchronizer docker](https://github.com/Omniverse-Web3-Labs/omniverse-synchronizer/tree/milestone-2/docker)| We provide a Dockerfile to auto-run synchronizers. The related document can be found in the [Auto-Deployment]() | +| 0e. | Article | [link](https://medium.com/@xiyuzheng1984/the-ink-tech-stack-along-with-a-swap-for-o-dlt-tokens-be128bb955e6) | The Ink! Tech Stack along with a Swap for O-DLT Tokens | +| 1. | Substrate module: swap | - [Pallet for Omniverse Swap](https://github.com/Omniverse-Web3-Labs/omniverse-swap/tree/milestone-2/pallets/omni-swap)
-[the simulation of the o-amm](https://github.com/Omniverse-Web3-Labs/o-amm)
- [off-chain calc and on-chain verify](https://github.com/Omniverse-Web3-Labs/O-AMM-ParaSim/tree/main) | - We made out Omniverse Swap which can exchanges two different omniverse fungible tokens.
- Besides, to make a intuitive comprehension of the o-amm model, we provide a simulation based on python (not included in the milestone but makes sense).
- Also for intuitive understanding of the off-chain calc and on-chain verification mechanism, we provide a parachain to show the details, and developers can build their own mechanism based on it. | +| 2. | Substrate chain | [Parachain itself](https://github.com/Omniverse-Web3-Labs/omniverse-swap/tree/milestone-2) | Building a Parachain is very easy. We have provided an implementation example mentioned in milestone 1 | | 3. | Ink! smart contract implementation | [Ink! tech stacks](https://github.com/Omniverse-Web3-Labs/omniverse-ink) | We deploy the omniverse Ink! smart contract on [substrate-contracts-node-v0.25.1](https://github.com/paritytech/substrate-contracts-node/releases/tag/v0.25.1) | | 4. | Off-Chain Synchronizer | [link](https://github.com/Omniverse-Web3-Labs/omniverse-synchronizer/tree/milestone-2) | We have optimized the synchronizer, improving its efficiency, added support for ink! parachain, and provided deployment through Docker. | @@ -54,4 +54,4 @@ And an application of `O-DLT` protocol: #### **Future Work** -We will continue to dedicate ourselves to the improvement of `O-DLT` protocol and explore further applications based on it. +We will continue to dedicate ourselves to the improvement of `O-DLT` protocol and explore further applications based on it. Currently we just provide CLI tools, and the front-ui is on the way. Besides, a `zk-synchronization` platform rolluping the transactions will be made out to save most of the gas fees. From fe3aa7be03e75cd30a77ead213f91bca819c8b23 Mon Sep 17 00:00:00 2001 From: xiyu1984 Date: Mon, 19 Jun 2023 23:57:47 +0800 Subject: [PATCH 3/5] update auto-deployment --- deliveries/Omniverse_DLT_milestone_2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deliveries/Omniverse_DLT_milestone_2.md b/deliveries/Omniverse_DLT_milestone_2.md index 67d96c966..2c84aacd1 100644 --- a/deliveries/Omniverse_DLT_milestone_2.md +++ b/deliveries/Omniverse_DLT_milestone_2.md @@ -28,7 +28,7 @@ | 0a. | License | - [Omniverse Swap](https://github.com/Omniverse-Web3-Labs/omniverse-swap/blob/milestone-2/LICENSE)
-[Omniverse Ink!]() | GPLv3 | | 0b. | Documentation | - [A high-level Priciple of the Omniverse Swap](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/High-Level%20Principle%20of%20Omniverse%20Swap.md)
- [How to dev with `Ink!`](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/dev-for-Ink!.md)
- [Tutorial of how to auto-deploy](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/Auto-Deployment.md)
- [Tutorial of how to operate](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/Auto-Tutorial.md) | The documentation for this milestone include the high-level introduction of the swap, how to dev with `Ink!`, and the tutorial of how to use. We provide the tutorial for two parts, the one is the deployment that is made **automatically**, and the other is the operation. | | 0c. | Testing Guide | [The test guide for milestone 2](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/test-guide/m2-test-guide.md) | For this milestone we have provided incredibly convenient testing tools for testing the entire process in just a few steps. We think it brings much convenient and really makes sense. | -| 0d. | Docker | [Synchronizer docker](https://github.com/Omniverse-Web3-Labs/omniverse-synchronizer/tree/milestone-2/docker)| We provide a Dockerfile to auto-run synchronizers. The related document can be found in the [Auto-Deployment]() | +| 0d. | Docker | [Synchronizer docker](https://github.com/Omniverse-Web3-Labs/omniverse-synchronizer/tree/milestone-2/docker)| We provide a Dockerfile to auto-run synchronizers. The related document can be found in the [Auto-Deployment](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/Auto-Deployment.md#launch-the-auto-synchronizer) | | 0e. | Article | [link](https://medium.com/@xiyuzheng1984/the-ink-tech-stack-along-with-a-swap-for-o-dlt-tokens-be128bb955e6) | The Ink! Tech Stack along with a Swap for O-DLT Tokens | | 1. | Substrate module: swap | - [Pallet for Omniverse Swap](https://github.com/Omniverse-Web3-Labs/omniverse-swap/tree/milestone-2/pallets/omni-swap)
-[the simulation of the o-amm](https://github.com/Omniverse-Web3-Labs/o-amm)
- [off-chain calc and on-chain verify](https://github.com/Omniverse-Web3-Labs/O-AMM-ParaSim/tree/main) | - We made out Omniverse Swap which can exchanges two different omniverse fungible tokens.
- Besides, to make a intuitive comprehension of the o-amm model, we provide a simulation based on python (not included in the milestone but makes sense).
- Also for intuitive understanding of the off-chain calc and on-chain verification mechanism, we provide a parachain to show the details, and developers can build their own mechanism based on it. | | 2. | Substrate chain | [Parachain itself](https://github.com/Omniverse-Web3-Labs/omniverse-swap/tree/milestone-2) | Building a Parachain is very easy. We have provided an implementation example mentioned in milestone 1 | From d90b471c38b39a7ac47077ecff482517c6c96518 Mon Sep 17 00:00:00 2001 From: xiyu1984 Date: Wed, 21 Jun 2023 21:35:07 +0800 Subject: [PATCH 4/5] update delivery --- deliveries/Omniverse_DLT_milestone_2.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/deliveries/Omniverse_DLT_milestone_2.md b/deliveries/Omniverse_DLT_milestone_2.md index 2c84aacd1..5a80d3f38 100644 --- a/deliveries/Omniverse_DLT_milestone_2.md +++ b/deliveries/Omniverse_DLT_milestone_2.md @@ -25,7 +25,7 @@ | Number | Deliverable | Link | Notes | | ------------- | ------------- | ------------- |------------- | -| 0a. | License | - [Omniverse Swap](https://github.com/Omniverse-Web3-Labs/omniverse-swap/blob/milestone-2/LICENSE)
-[Omniverse Ink!]() | GPLv3 | +| 0a. | License | - [Omniverse Swap](https://github.com/Omniverse-Web3-Labs/omniverse-swap/blob/milestone-2/LICENSE)
-[Omniverse Ink!](https://github.com/Omniverse-Web3-Labs/omniverse-ink/blob/main/LICENSE) | GPLv3 | | 0b. | Documentation | - [A high-level Priciple of the Omniverse Swap](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/High-Level%20Principle%20of%20Omniverse%20Swap.md)
- [How to dev with `Ink!`](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/dev-for-Ink!.md)
- [Tutorial of how to auto-deploy](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/Auto-Deployment.md)
- [Tutorial of how to operate](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/Auto-Tutorial.md) | The documentation for this milestone include the high-level introduction of the swap, how to dev with `Ink!`, and the tutorial of how to use. We provide the tutorial for two parts, the one is the deployment that is made **automatically**, and the other is the operation. | | 0c. | Testing Guide | [The test guide for milestone 2](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/test-guide/m2-test-guide.md) | For this milestone we have provided incredibly convenient testing tools for testing the entire process in just a few steps. We think it brings much convenient and really makes sense. | | 0d. | Docker | [Synchronizer docker](https://github.com/Omniverse-Web3-Labs/omniverse-synchronizer/tree/milestone-2/docker)| We provide a Dockerfile to auto-run synchronizers. The related document can be found in the [Auto-Deployment](https://github.com/Omniverse-Web3-Labs/Omniverse-DLT-Introduction/blob/main/docs/Auto-Deployment.md#launch-the-auto-synchronizer) | @@ -42,9 +42,9 @@ Currently, we have finished the basic functions of `O-DLT` protocol, and provided four tech stack implementations: -- [Ethereum (EVMs)](https://github.com/Omniverse-Web3-Labs/omniverse-evm/tree/web3-grant) +- [Ethereum (EVMs)](https://github.com/Omniverse-Web3-Labs/omniverse-evm/tree/main) - Polkadot - - [Pallet](https://github.com/Omniverse-Web3-Labs/omniverse-swap/tree/web3-grant) + - [Pallet](https://github.com/Omniverse-Web3-Labs/omniverse-swap/tree/milestone-2/pallets) - [Ink!](https://github.com/Omniverse-Web3-Labs/omniverse-ink) - [Flow](https://github.com/Omniverse-Web3-Labs/omniverse-flow) From f15564cf473aa9ac1aa4c4326f8a66c0466480a4 Mon Sep 17 00:00:00 2001 From: xiyu1984 Date: Wed, 21 Jun 2023 21:57:12 +0800 Subject: [PATCH 5/5] update the delivery --- deliveries/Omniverse_DLT_milestone_2.md | 1 + 1 file changed, 1 insertion(+) diff --git a/deliveries/Omniverse_DLT_milestone_2.md b/deliveries/Omniverse_DLT_milestone_2.md index 5a80d3f38..9cd905355 100644 --- a/deliveries/Omniverse_DLT_milestone_2.md +++ b/deliveries/Omniverse_DLT_milestone_2.md @@ -17,6 +17,7 @@ * In this milestone, we have finished the `Omniverse-DLT` protocol in `Ink!` technology stack, it have the same functions as the `assets pallet` in milestone 1. * We have enhanced the related off-chain tools to operate `o-tokens` both on the Parachain of Polkadot and EVM chains. * We have provided **incredibly convenient** **deployment** and **testing** tools for deploying and testing the entire process, which was complex and suffering in the previous milestone. +* In addition, thanks to the suggestions by the [reviewers](https://github.com/w3f/Grant-Milestone-Delivery/pull/800#issuecomment-1502611594), according to previous experience, we provide **videos** for [auto-testing for basic points of `Ink!`](https://omniversedlt.s3.amazonaws.com/token-swap-test/token-test.mp4), [auto-testing for swap](https://omniversedlt.s3.amazonaws.com/token-swap-test/swap-test.mp4), [auto-deployment](https://omniversedlt.s3.amazonaws.com/auto-deploy-tutorial/Auto-Deployment.mp4), and [operations](https://omniversedlt.s3.amazonaws.com/auto-deploy-tutorial/Auto-Tutorial.mp4) to improve efficiency. **Deliverables** > Please provide a list of all deliverables of the milestone extracted from the initial application and a link to the deliverable itself. Ideally all links inside the below table should include a commit hash, which will be used for testing. If you don't provide a commit hash, we will work off the default branch of your repository. Thus, if you plan on continuing work after delivery, we suggest you create a separate branch for either the delivery or your continuing work.