From 243039831ecbb5387a51c4e3ab601628b4cdbd76 Mon Sep 17 00:00:00 2001 From: xerod Date: Tue, 3 Oct 2023 15:48:39 +0700 Subject: [PATCH 1/5] add neutroswap milestone 1 --- ...mics_enhancement_neutroswap_milestone_1.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 deliveries/tokenomics_enhancement_neutroswap_milestone_1.md diff --git a/deliveries/tokenomics_enhancement_neutroswap_milestone_1.md b/deliveries/tokenomics_enhancement_neutroswap_milestone_1.md new file mode 100644 index 0000000..56eb145 --- /dev/null +++ b/deliveries/tokenomics_enhancement_neutroswap_milestone_1.md @@ -0,0 +1,25 @@ +# Milestone Delivery + +**The [invoice form](https://forms.gle/wLuAzXKa9qYrZQob9) has been filled out for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/eosnetworkfoundation/grant-framework/blob/master/docs/milestone-deliverables-guidelines.md).** + +* **Application Document:** [Tokenomics Enhancement Neutroswap + ](https://github.com/eosnetworkfoundation/grant-framework/blob/main/applications/tokenomics_enhancement_neutroswap.md) +* **Milestone Number:** 1 + +**Context:** +For execution of Milestone 1 - Requirement Analysis + +**Deliverables:** +- **Estimated duration:** 2 weeks +- **FTE:** 2 +- **Costs:** 5,000 USD + +| Number | Deliverable | Link | Notes | +| -----: | ----------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| 0a. | License | MIT | | +| 0b. | Threads | [Twitter Thread](https://typefully.com/t/GWAxzwj) | The link given here is just a typefully draft and will be released to the public at our marketing schedule | +| 1. | General Requirement and Migration Plan | [Document]() | Unpacking smart contract requirements, migration plan for both subgraph and frontend, and integration testing plan | +| 2. | Documentation | [Neutroswap V2 Docs](https://docs.neutroswap.io/neutroswap-v2-coming-soon/staked-positions-spnfts), [Neutroswap V2 Contract Docs](https://github.com/Nava-Labs/neutroswap-v2/blob/main/README.md) | For an extensive understanding of Neutroswap v2, please refer to our [Documentation](https://docs.neutroswap.io) | + + +> From c2fd1076521b6b589bf475c6c1c343567cc1f12b Mon Sep 17 00:00:00 2001 From: xerod Date: Tue, 3 Oct 2023 16:57:53 +0700 Subject: [PATCH 2/5] clear typo by renaming miletone_1 to milestone_0, and add General Requirement document --- ...mics_enhancement_neutroswap_milestone_0.md | 85 +++++++++++++++++++ ...mics_enhancement_neutroswap_milestone_1.md | 25 ------ 2 files changed, 85 insertions(+), 25 deletions(-) create mode 100644 deliveries/tokenomics_enhancement_neutroswap_milestone_0.md delete mode 100644 deliveries/tokenomics_enhancement_neutroswap_milestone_1.md diff --git a/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md b/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md new file mode 100644 index 0000000..4548cae --- /dev/null +++ b/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md @@ -0,0 +1,85 @@ +# Milestone Delivery + +**The [invoice form](https://forms.gle/wLuAzXKa9qYrZQob9) has been filled out for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/eosnetworkfoundation/grant-framework/blob/master/docs/milestone-deliverables-guidelines.md).** + +* **Application Document:** [Tokenomics Enhancement Neutroswap + ](https://github.com/eosnetworkfoundation/grant-framework/blob/main/applications/tokenomics_enhancement_neutroswap.md) +* **Milestone Number:** 0 + +**Context:** +For *Milestone 0 - Requirement Analysis* completion + +**Deliverables:** +- **Estimated duration:** 2 weeks +- **FTE:** 2 +- **Costs:** 5,000 USD + +| Number | Deliverable | Link | Notes | +| -----: | ----------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| 0a. | License | MIT | | +| 0b. | Threads | [Twitter Thread](https://typefully.com/t/GWAxzwj) | The link given here is just a typefully draft and will be released to the public at our marketing schedule | +| 1. | General Requirement and Migration Plan | Within this document | Unpacking smart contract requirements, migration plan for both subgraph and frontend, and integration testing plan | +| 2. | Documentation | [Neutroswap V2 Docs](https://docs.neutroswap.io/neutroswap-v2-coming-soon/staked-positions-spnfts), [Neutroswap V2 Contract Docs](https://github.com/Nava-Labs/neutroswap-v2/blob/main/README.md) | For an extensive understanding of Neutroswap v2, please refer to our [Documentation](https://docs.neutroswap.io) | + +## General Requirement and Migration Plan +This document serves as an introduction to the general requirements and migration plan for a decentralized application. It aims to provide an outline for developers, project managers, and stakeholders to navigate the complexities of building and migrating to Neutroswap V2 effectively. + +### Smart contract Requirement +Neutroswap V2 will introduce multiple contract that support our V2 tokenomics like plugins, NFT-based position, and launchpad. +For an extensive understanding of Neutroswap v2, please refer to our [Documentation](https://docs.neutroswap.io). +Below are the list of new Neutroswap V2 contract: + +- **xNEUTRO**
+ The locked version and non-transferrable token of $NEUTRO with the purpose of providing utility for users by allocating xNEUTRO to various provided Plugins. + +- **NeutroMaster**
+ Centralizes Neutro's yield incentives distribution. + +- **NFTPoolFactory**
+ Factory pattern for creating NFT Pool. + +- **NFTPool**
+ Wraps ERC20 assets into non-fungible staking positions called spNFTs. Yield-generating positions when the NFTPool contract has allocations from the Neutro Master. + +- **NitroPoolFactory**
+ Factory pattern for creating Nitro Pool. + +- **NitroPool**
+ spNFTs Pool for incentives position based on the determined position requirements and purposed for collaborating with other projects. + +- **Dividends**
+ Neutroswap Plugin to distribute dividends to xNEUTRO allocators. + +- **YieldBooster**
+ Neutroswap Plugin to boost spNFTs' yield (staking positions on NFTPools). + +- **FairAuctionFactory**
+ Factory pattern for creating Fair Auction (launchpad). + +- **NeutroHelper**
+ Serving data to the frontend, for example to calculate APR, dollar value of the pool, and etc. + +> No changes required on our legacy contract, but the introduction of V2 tokenomics require some adjustment on $NEUTRO emission stored in our ERC-20 variables + +### Subgraph Migration Plan +WIP + +### High Fidelity Prototype +Neutroswap V2 high fidelity prototype is available [here](https://www.figma.com/file/gkw76rgPT3CWqALsY51FEq/Neutroswap-V2-High-Fidelity-Prototype?type=design&node-id=0%3A1&mode=design&t=lZmmvo17eMou581J-1) + +### Front-end Migration Plan +After long code review, we found multiple changes that are required for the app maintanability. We acknowledge that everything listed below is non intrusive and not required for the Neutroswap V2 launch, it is better to list them here for the app maintanability + +- [ ] NextJS 13 introduced the `app` directory but `pages` directory isn’t deprecated yet +- [ ] Bump `wagmi` to latest (uses `viem` instead of `ethers`) +- [ ] Bump `viem` to latest +- [ ] Migrate all `ethers` to use `viem` +- [ ] Migrate all `BigNumber` to `BigInt` + +### Integration Testing Plan +- [ ] Prepare the test case that covers V2 features +- [ ] Prepare the test environtment and test data +- [ ] Launch V2 features on testnet, and integrate all existing contract to the V2 features +- [ ] Execute the integration testing and create a integration testing report + +> diff --git a/deliveries/tokenomics_enhancement_neutroswap_milestone_1.md b/deliveries/tokenomics_enhancement_neutroswap_milestone_1.md deleted file mode 100644 index 56eb145..0000000 --- a/deliveries/tokenomics_enhancement_neutroswap_milestone_1.md +++ /dev/null @@ -1,25 +0,0 @@ -# Milestone Delivery - -**The [invoice form](https://forms.gle/wLuAzXKa9qYrZQob9) has been filled out for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/eosnetworkfoundation/grant-framework/blob/master/docs/milestone-deliverables-guidelines.md).** - -* **Application Document:** [Tokenomics Enhancement Neutroswap - ](https://github.com/eosnetworkfoundation/grant-framework/blob/main/applications/tokenomics_enhancement_neutroswap.md) -* **Milestone Number:** 1 - -**Context:** -For execution of Milestone 1 - Requirement Analysis - -**Deliverables:** -- **Estimated duration:** 2 weeks -- **FTE:** 2 -- **Costs:** 5,000 USD - -| Number | Deliverable | Link | Notes | -| -----: | ----------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| -| 0a. | License | MIT | | -| 0b. | Threads | [Twitter Thread](https://typefully.com/t/GWAxzwj) | The link given here is just a typefully draft and will be released to the public at our marketing schedule | -| 1. | General Requirement and Migration Plan | [Document]() | Unpacking smart contract requirements, migration plan for both subgraph and frontend, and integration testing plan | -| 2. | Documentation | [Neutroswap V2 Docs](https://docs.neutroswap.io/neutroswap-v2-coming-soon/staked-positions-spnfts), [Neutroswap V2 Contract Docs](https://github.com/Nava-Labs/neutroswap-v2/blob/main/README.md) | For an extensive understanding of Neutroswap v2, please refer to our [Documentation](https://docs.neutroswap.io) | - - -> From 9e2cf43c3be8fef264385fadd801d92795f84413 Mon Sep 17 00:00:00 2001 From: xerod Date: Wed, 4 Oct 2023 11:43:35 +0700 Subject: [PATCH 3/5] add subgraph migration plan --- .../tokenomics_enhancement_neutroswap_milestone_0.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md b/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md index 4548cae..c576ee0 100644 --- a/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md +++ b/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md @@ -59,10 +59,16 @@ Below are the list of new Neutroswap V2 contract: - **NeutroHelper**
Serving data to the frontend, for example to calculate APR, dollar value of the pool, and etc. -> No changes required on our legacy contract, but the introduction of V2 tokenomics require some adjustment on $NEUTRO emission stored in our ERC-20 variables +> The legacy NeutroChef contract would stop its emission, and all $NEUTRO emission will be handled by the new NeutroMaster contract we mentioned above. ### Subgraph Migration Plan -WIP +No changes are required on our legacy subgraph, but there's two additional subgraph we should build: + +- **NFT Pool Subgraph**
+ This subgraph is responsible to index all NFT pool created by user from our contract. In relationship, this subgraph will also track the relationship between Nitro pool and NFT pool. + +- **FairAuction Subgraph**
+ The main use of this subgraph is to track contribution and index price change on our FairAuction contract. This subgraph also serve detailed information about the fair auction (launchpad). ### High Fidelity Prototype Neutroswap V2 high fidelity prototype is available [here](https://www.figma.com/file/gkw76rgPT3CWqALsY51FEq/Neutroswap-V2-High-Fidelity-Prototype?type=design&node-id=0%3A1&mode=design&t=lZmmvo17eMou581J-1) From ad169936ba633e6715c0a849503b7325e9b504a9 Mon Sep 17 00:00:00 2001 From: xerod Date: Thu, 5 Oct 2023 13:27:04 +0700 Subject: [PATCH 4/5] avoid broken link neutroswap documentation --- deliveries/tokenomics_enhancement_neutroswap_milestone_0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md b/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md index c576ee0..9d07017 100644 --- a/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md +++ b/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md @@ -19,7 +19,7 @@ For *Milestone 0 - Requirement Analysis* completion | 0a. | License | MIT | | | 0b. | Threads | [Twitter Thread](https://typefully.com/t/GWAxzwj) | The link given here is just a typefully draft and will be released to the public at our marketing schedule | | 1. | General Requirement and Migration Plan | Within this document | Unpacking smart contract requirements, migration plan for both subgraph and frontend, and integration testing plan | -| 2. | Documentation | [Neutroswap V2 Docs](https://docs.neutroswap.io/neutroswap-v2-coming-soon/staked-positions-spnfts), [Neutroswap V2 Contract Docs](https://github.com/Nava-Labs/neutroswap-v2/blob/main/README.md) | For an extensive understanding of Neutroswap v2, please refer to our [Documentation](https://docs.neutroswap.io) | +| 2. | Documentation | [Neutroswap V2 Docs](https://docs.neutroswap.io/neutroswap-v2/staked-positions-spnfts/yield-farming), [Neutroswap V2 Contract Docs](https://github.com/Nava-Labs/neutroswap-v2/blob/main/README.md) | For an extensive understanding of Neutroswap v2, please refer to our [Documentation](https://docs.neutroswap.io) | ## General Requirement and Migration Plan This document serves as an introduction to the general requirements and migration plan for a decentralized application. It aims to provide an outline for developers, project managers, and stakeholders to navigate the complexities of building and migrating to Neutroswap V2 effectively. From ff75a9b91c42ce630964e02724cb93cd5a694db4 Mon Sep 17 00:00:00 2001 From: jonassunandar Date: Wed, 25 Oct 2023 20:18:30 +0700 Subject: [PATCH 5/5] fix: broken links & update twitter post --- deliveries/tokenomics_enhancement_neutroswap_milestone_0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md b/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md index 9d07017..c654512 100644 --- a/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md +++ b/deliveries/tokenomics_enhancement_neutroswap_milestone_0.md @@ -17,9 +17,9 @@ For *Milestone 0 - Requirement Analysis* completion | Number | Deliverable | Link | Notes | | -----: | ----------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| | 0a. | License | MIT | | -| 0b. | Threads | [Twitter Thread](https://typefully.com/t/GWAxzwj) | The link given here is just a typefully draft and will be released to the public at our marketing schedule | +| 0b. | Threads | [Twitter Thread](https://twitter.com/Neutroswap/status/1717168444666519930) | The link given here is just a typefully draft and will be released to the public at our marketing schedule | | 1. | General Requirement and Migration Plan | Within this document | Unpacking smart contract requirements, migration plan for both subgraph and frontend, and integration testing plan | -| 2. | Documentation | [Neutroswap V2 Docs](https://docs.neutroswap.io/neutroswap-v2/staked-positions-spnfts/yield-farming), [Neutroswap V2 Contract Docs](https://github.com/Nava-Labs/neutroswap-v2/blob/main/README.md) | For an extensive understanding of Neutroswap v2, please refer to our [Documentation](https://docs.neutroswap.io) | +| 2. | Documentation | [Neutroswap V2 Docs](https://docs.neutroswap.io/neutroswap-v2/staked-positions-spnfts/yield-farming), [Neutroswap V2 Contract Docs](https://github.com/neutroswap/neutroswap-v2-contracts/blob/main/README.md) | For an extensive understanding of Neutroswap v2, please refer to our [Documentation](https://docs.neutroswap.io) | ## General Requirement and Migration Plan This document serves as an introduction to the general requirements and migration plan for a decentralized application. It aims to provide an outline for developers, project managers, and stakeholders to navigate the complexities of building and migrating to Neutroswap V2 effectively.