cjhare / separate-staking-reward-erc4626-vault Goto Github PK

Feature Description

New function to allow the staker to withdraw their stake and forfeit any and all rewards for their time staking that are owed.

The contract has a trust assumption that the admin will transfer adequate rewards in a timely fashion (as withdraw will revert when there aren't enough rewards), this function will keep the users stake safu.

Mutation of emergency withdraw on asset and shares is identical to a normal withdraw.

Additional Information

Feature Description

Avoid re-entrancy and reduce gas overhead by having a private harvest function, with a public pass on (exposer(

Additional Information

Feature Description

On a GitHub release, using GitHub actions create a NPM release and push to NPM (using secret tokens).

Additional Information

Feature Description

Rename the GitHub repo to include the term ERC 4626

Additional Information

The vault being a specialization of the ERC4626 implementation, including that term in the title gives a better intuitive description.

Feature Description

Some public function can be made 'external' and others 'private', besides better encapsulation, 'external' costs less gas that 'public', ...'private' even less.

Additional Information

Feature Description

The rewards split amongst shareholders is currently hardcoded as one per a block, have this value be an input argument for the constructor.

Additional Information

Feature Description

ERC20 Token sweeper; a mechanism for recovering tokens that have been transferred to the contract.

Restriction: the asset may only be recovered when there are no shares remaining.

Security: contract to have a owner (Ownable) with the recovery function being guarded by isOwner` modifier.

Additional Information

@CjHare Very good idea, this is probably the first ERC-4626 vault implementation where the reward token is different from the underlying token!

Is it production ready yet, or are there still things to be added? 🙂

Feature Description

Get rid of the mock ERC20 and use the Waffle mock ERC20!

Also verify events are emitted.

Additional Information

https://ethereum-waffle.readthedocs.io/en/latest/getting-started.html#writing-tests

Feature Description

Convert the usage of msg.sender to OZ Context's sender() to support gasless operations using a paymaster.

Additional Information

Feature Description

Add Slither to the project, as dependency, with sensible configuration and as part of CI.

Additional Information