Skip to content

Commit

Permalink
Merge pull request #32 from vechain/feat/gm-and-node-delegation
Browse files Browse the repository at this point in the history 
Feat/gm and node delegation
  • Loading branch information
@Agilulfo1820
Agilulfo1820 authored Dec 2, 2024
2 parents 3a2fd28 + 09fa6c3 commit f463f13
Show file tree
Hide file tree
Showing 39 changed files with 8,459 additions and 226 deletions.
197 changes: 165 additions & 32 deletions CONTRACTS_CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,151 @@ This document provides a detailed log of upgrades to the smart contract suite, e

## Version History

| Date | Contract(s) | Summary |
| ------------------- | --------------------------------------------------------- | ----------------------------------------------------------- |
| 15th November 2024 | `X2EarnApps` version `2` | Added X2Earn Apps Vechain Node Endorsement feature |
| 21th October 2024 | `VeBetterPassport` version `2` | Check if the entity is a delegatee when request is created |
| 11th October 2024 | `XAllocationVoting` version `2` | Check isPerson when casting vote & fixed weight during vote |
| 11th October 2024 | `B3TRGovernor` version `4` | Check isPerson when casting vote |
| 11th October 2024 | `X2EarnRewardsPool` version `3` | Register action in VeBetter Passport contract |
| 27th September 2024 | `Emissions` version `2` | Aligned emissions with the expected schedule |
| 13th September 2024 | `B3TRGovernor` version `3`, `XAllocationPool` version `2` | - Added toggling of quadratic voting and funding |
| 4th September 2024 | `X2EarnRewardsPool` version `2` | - Added impact key management and proof building |
| 31st August 2024 | `VoterRewards` version `2` | - Added quadratic rewarding features |
| 29th August 2024 | `B3TRGovernor` version `2` | Updated access control modifiers |
| Date | Contract(s) | Summary |
| ------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| 29th November 2024 | `VeBetterPassport` version `3`, `GalaxyMember` version `3`, and `VoterRewards` version 4 | Added GM level as personhood check in VeBetter passport. |
| 28th November 2024 | `NodeManagement` version `2` | Added new functions to check node delegation status and improved node management capabilities. |
| 15th November 2024 | `GalaxyMember` version `2`, `VoterRewards` version `3`, `B3TRGovernor` version `5` | Added Vechain Node Binding with Galaxy Member feature |
| 15th November 2024 | `X2EarnApps` version `2` | Added X2Earn Apps Vechain Node Endorsement feature |
| 21th October 2024 | `VeBetterPassport` version `2` | Check if the entity is a delegatee when request is created |
| 11th October 2024 | `XAllocationVoting` version `2` | Check isPerson when casting vote & fixed weight during vote |
| 11th October 2024 | `B3TRGovernor` version `4` | Check isPerson when casting vote |
| 11th October 2024 | `X2EarnRewardsPool` version `3` | Register action in VeBetter Passport contract |
| 27th September 2024 | `Emissions` version `2` | Aligned emissions with the expected schedule |
| 13th September 2024 | `B3TRGovernor` version `3`, `XAllocationPool` version `2` | - Added toggling of quadratic voting and funding |
| 4th September 2024 | `X2EarnRewardsPool` version `2` | - Added impact key management and proof building |
| 31st August 2024 | `VoterRewards` version `2` | - Added quadratic rewarding features |
| 29th August 2024 | `B3TRGovernor` version `2` | Updated access control modifiers |

---

## Upgrade `VeBetterPassport` to Version 3, `GalaxyMember` to Version 3, and `VoterRewards` version 4

Added new personhood check in VeBetter passport, if a user owns a GM with a level greater than 1 they are considered a person.
<br>
Updated `GalaxyMember` to checkpoint selected GM NFT and allow admin to select token for user for GM levels go live.
<br>
Updated `VoterRewards` to use version `3` of `GalaxyMember` interface.

### Changes 🚀

- **Upgraded Contract(s):**
- `VeBetterPassport.sol` to version `3`
- `GalaxyMember.sol` to version `3`
- `VoterRewards.sol` to version `4`

### Storage Changes 📦

- **`GalaxyMember`**:
- Added `_selectedTokenIDCheckpoints` to store checkpoints for selected GM token ID of the user.

### New Features 🚀

- **`VeBetterPassport`**:
- Updated `PassportPersonhoodLogic.sol` library's function `_checkPassport()` to include check for GM level.
- **`GalaxyMember`**:
- Added `selectFor()` function to allow the admin to select a token for the user.
- Added `clock()` and `CLOCK_MODE()` functions to allow for custom time tracking.
- Added `getSelectedTokenIdAtBlock()` to get the selected GM token ID for the user at a specific block number.
- Updated Node Management interface to include new getters of Node Management V2 contract.

### Bug Fixes 🐛

- None.

---

## Upgrade `NodeManagement` to Version 2

Added new functions to check node delegation status and improved node management capabilities.

### Changes 🚀

- **Upgraded Contract(s):**
- `NodeManagement.sol` to version `2`

### Storage Changes 📦

- None.

### New Features 🚀

- **`NodeManagement`**:
- Added `isNodeDelegated()` to check if a specific node ID is delegated
- Added `isNodeDelegator()` to check if a user has delegated their node
- Added `getDirectNodeOwnership()` to check direct node ownership without delegation
- Added `isNodeHolder()` to check if a user is a node holder (both directly owned and indirectly through delegation)
- Added `getUserNodes()` to get comprehensive node information including:
- Node ID
- Node level
- Owner address
- Node holder status
- Delegation status
- Delegator status
- Delegatee status
- Delegatee address

### Bug Fixes 🐛

- None.

---

## Upgrade `GalaxyMember` to Version 2

Introduced a composition pattern to attach and detach Vechain nodes to/from Galaxy Member (GM) NFTs. This feature allows GM NFTs to dynamically acquire or lose levels based on the attached node's capabilities.

### Changes 🚀

- **Upgraded Contract(s):**
- `GalaxyMember.sol` to version `2`
- `VoterRewards.sol` to version `3`
- `B3TRGovernor.sol` to version `5`

### Storage Changes 📦

- **`GalaxyMember.sol`**:
- Added `vechainNodes` to store the address of the Vechain Nodes contract.
- Added `nodeManagement` to store the address of the Node Management contract.
- Added `_nodeToTokenId` to track the XNode tied to the GM token ID.
- Added `_tokenIdToNode` to track the GM token ID tied to the XNode token ID.
- Added `_nodeToFreeUpgradeLevel` to track the GM level that can be upgraded for free for a given Vechain node level.
- Added `_tokenIdToB3TRdonated` to store the mapping from GM Token ID to B3TR donated for upgrading.
- Added `_selectedTokenID` to store the mapping from user address to selected GM token ID.
- **`VoterRewards.sol`**:
- Added `proposalToGalaxyMemberToHasVoted` to keep track of whether a galaxy member has voted in a proposal.
- Added `proposalToNodeToHasVoted` to keep track of whether a vechain node has been used while attached to a galaxy member NFT when voting for a proposal.

### New Features 🚀

- **`GalaxyMember.sol`**:
- Added `attachNode()` function to attach Vechain Node to GM NFT.
- Added `detachNode()` function to detach Vechain Node from GM NFT.
- Added `setVechainNodes()` function to update the Vechain Nodes contract address.
- Added `setNodeToFreeUpgradeLevel()` to set the levelin which a Vechain Node can upgrade to for free.
- Added `levelOf()` to get the level of GM token.
- Added `getB3TRtoUpgradeToLevel()` to get the required B3TR to upgrade GM NFT to certain level.
- Added `getB3TRtoUpgrade()` to get the required B3TR to upgrade GM NFT to the next level.
- Added `getNodeLevelOf()` to get the level of a give Vechain node.
- Added `getLevelAfterAttachingNode()` to get level of GM NFT after attaching particular GM NFT.
- Added `getIdAttachedToNode()` to get GM NFT attached to Vechain node.
- Added `getIdAttachedToNode()` to get Vechain node attached to GM NFT.
- Added `getNodeToFreeLevel()` to get level in which GM NFT can be upgraded to for free if particular Vechain node is attached.
- Added `getB3TRdonated()` to get the B3TR donated by a GM NFT so far to reach ther aquired level.
- Added `getTokenInfoByTokenId()` to get infomation on particular GM NFT.
- Added `getSelectedTokenInfoByOwner()` to get GM NFT user is using for rewards boosts.
- Added `getTokensInfoByOwner()` to get infomation on GM NFTs owned by a particular address.
- **`VoterRewards.sol`**:
- Added `getMultiplier()` to get the reward multiplier for a user in a specific proposal.
- Added `hasNodeVoted()` to check if a Vechain Node has voted on a proposal.
- Added `hasTokenVoted()` to check if a GM NFT has voted on a proposal.
- **`GovernorVotesLogic.sol`**:
- Updated `castVote()` to pass proposalId instead of snapshot to Voter Rewards `registerVote()` function.

### Bug Fixes 🐛

- **`GalaxyMember.sol`**:
- In Version 1, transfers that occur from an approved address are subject to underflow issues when updating the `_ownedLevels` map. This is fixed with Version 2 by also asserting updates are made on the owner of the token ID rather than the auth of the internal `_update` function.

---

Expand All @@ -31,35 +164,35 @@ Added Vechain Node XApp Endorsement feature.
### Storage Changes 📦

- **`EndorsementUpgradeable.sol`**:
- Added `_unendorsedApps` to store the list of apps pending endorsement.
- Added `_unendorsedAppsIndex` to store mapping from app ID to index in the _unendorsedApps array.
- Added `_appEndorsers` to store the mapping of each app ID to an array of node IDs that have endorsed it.
- Added `_nodeEnodorsmentScore` to score the endorsement score for each node level.
- Added `_appGracePeriodStart` to store the grace period elapsed by the app since endorsed.
- Added `_nodeToEndorsedApp` to store the mapping of a node ID to the app it currently endorses.
- Added `_gracePeriodDuration` to store the grace period threshold for no endorsement in blocks.
- Added `_endorsementScoreThreshold` to store the endorsement score threshold for an app to be eligible for voting.
- Added `_appScores` to store the score of each app.
- Added `_appSecurity` to store the security score of each app.
- Added `_nodeManagementContract` to store the node management contract address.
- Added `_veBetterPassport` to store the VeBetterPassport contract address.
- **`EndorsementUpgradeable.sol`**:
- Added `_creators` to store a mapping of addresses that have a creators NFT and can manage interactions with Node holders for a specifc XApp.
- Added `_creatorApps` to store the number of apps created by a creator.
- Added `_x2EarnCreatorContract` to store the address of the X2Earn Creators contract.
- **`VoteEligibilityUpgradeable.sol`**:
- Added `_blackList` to store a record blacklisted X2Earn appIds.
- Added `_unendorsedApps` to store the list of apps pending endorsement.
- Added `_unendorsedAppsIndex` to store mapping from app ID to index in the \_unendorsedApps array.
- Added `_appEndorsers` to store the mapping of each app ID to an array of node IDs that have endorsed it.
- Added `_nodeEnodorsmentScore` to score the endorsement score for each node level.
- Added `_appGracePeriodStart` to store the grace period elapsed by the app since endorsed.
- Added `_nodeToEndorsedApp` to store the mapping of a node ID to the app it currently endorses.
- Added `_gracePeriodDuration` to store the grace period threshold for no endorsement in blocks.
- Added `_endorsementScoreThreshold` to store the endorsement score threshold for an app to be eligible for voting.
- Added `_appScores` to store the score of each app.
- Added `_appSecurity` to store the security score of each app.
- Added `_nodeManagementContract` to store the node management contract address.
- Added `_veBetterPassport` to store the VeBetterPassport contract address.
- **`EndorsementUpgradeable.sol`**:
- Added `_creators` to store a mapping of addresses that have a creators NFT and can manage interactions with Node holders for a specifc XApp.
- Added `_creatorApps` to store the number of apps created by a creator.
- Added `_x2EarnCreatorContract` to store the address of the X2Earn Creators contract.
- **`VoteEligibilityUpgradeable.sol`**:
- Added `_blackList` to store a record blacklisted X2Earn appIds.

### New Features 🚀

- Added `EndorsementUpgradeable.sol` module which makes up all X2EarnApps endorsement logic and functions (see docs for more info).
- Replaced `appApp()` with `submitApp()`.
- Added getter `isBlacklisted()` to check if XApp is blacklisted.
- Added `removeAppCreator()`, `appCreators()`, `isAppCreator()` and `creatorApps()` to manage and get info on X2Earn app creators.
- Added `removeAppCreator()`, `appCreators()`, `isAppCreator()` and `creatorApps()` to manage and get info on X2Earn app creators.

### Bug Fixes 🐛

- - Added libraries `AdministrationUtils.sol`, `EndorsementUtils.sol`, `AppStorageUtils.sol` and `VoteEligibilityUtils.sol` to store some of the logic for the X2EarnApps contracts modules to reduce contract size.
- - Added libraries `AdministrationUtils.sol`, `EndorsementUtils.sol`, `AppStorageUtils.sol` and `VoteEligibilityUtils.sol` to store some of the logic for the X2EarnApps contracts modules to reduce contract size.

---

Expand Down
Loading

0 comments on commit f463f13

Please sign in to comment.