Forked, Upgradeable, and Pausable ID Staking Contract with Defined Ownership for Testnet Deployment

erichfi commented 8 months ago

User Story:

As a developer on the Gitcoin team, I want a fork of the existing ID staking contract to be upgradeable and pausable, with defined ownership, So that I can ensure continuity with current functionality, manage iterations, and maintain the ability to respond quickly in emergencies during the testing phase.

Acceptance Criteria

GIVEN I am configuring the ID staking contract on a testnet, WHEN I deploy the forked smart contract, THEN it should retain the existing contract's functionalities, be upgradeable for future updates without the need for a new deployment, AND it should be pausable, providing the capability to halt operations promptly in case of an emergency, AND it should have defined ownership that facilitates effective management and control, whether through a hot wallet or a multisig setup.

Product & Design Links:

N/A

Tech Details:

Fork the existing ID staking contract to maintain existing stakers’ functionality and compatibility.
Apply OpenZeppelin’s upgradeable contract patterns to ensure that future updates can be made seamlessly.
Integrate OpenZeppelin’s Pausable contract template to incorporate emergency stopping mechanisms.
Establish clear ownership in the smart contract to streamline management and enable swift response to operational needs or emergencies.

Open Questions:

What additional roles or permissions might be necessary for nuanced smart contract interactions beyond ownership control at this early stage?
Is it possible to 'claim' the contract on Etherscan and assign it a clear, descriptive name such as 'GTC Stake' or 'GTC Staking' for user-friendly interface identification?

Notes/Assumptions:

This request is specific to testnet deployment, allowing for extensive testing and iterative improvements before considering a mainnet release.
Initial ownership via a hot wallet or multisig is chosen to facilitate the development process, with the understanding that the ownership structure might be reevaluated as the project progresses.

nutrina commented 8 months ago

I would also add that the SC should be pauseable.

erichfi commented 7 months ago

Also covering https://github.com/gitcoinco/passport/issues/1837 and #1838 with this issue

digitalmnt commented 5 months ago

I created a new repo for the staking contracts here https://github.com/gitcoinco/id-staking-v2

Openzeppelin released breaking changes to their Upgrades contracts and the linked pr begins implementing those new contracts

lucianHymer commented 5 months ago

Waiting on review

gitcoinco / passport