@unizen-io/unizen-dmas v1.0.53

unizen-dmas

Smart contracts of the Dynamic Multi Asset Staking (DMAS) of Unizen.

A modified version of the Synthetix and Curve.fi staking rewards contracts, allowing for multiple rewards tokens.

Overview

The Staking contract in this repository enables distribution of multiple reward tokens for staked users. It is a flattened and modified version of the Curve.fi staking rewards contract.

How it Works

As an example, assume we desire users to stake an ERC20 Token Base Token ($BASE). As a reward for staking their token, we may wish to offer users multiple different tokens. For the sake of this example, we'll assume we have two different amount of governance tokens, Reward Token 1 ($ONE) and Reward Token 2 ($TWO), which we want to release over different schedules.

• We begin by deploying the Staking contract with a link to $BASE as our staking token.
• For both token $ONE and $TWO the contract's Owner calls addReward
  • When calling addReward, Owner also specifies the duration of the reward period (in seconds)
• To begin the reward period, Owner will call notifyRewardAmount, which transfers the specified amount of reward tokens from their address to the contract and begins the reward cycle.
• Users can stake the $BASE token by calling stake, and will then accrue $ONE and $TWO throughout the duration of the rewards period.
• Users can claim their rewards at any time by calling getReward.
• Users can also withdraw their $BASE token at any point by calling withdraw. At this point they can still claim any accumulated unclaimed $ONE and $TWO rewards through the getReward endpoint but will not longer accrue rewards.

Considerations

Keep the following in mind when using the Staking contract:

• The duration and amounts of $ONE and $TWO may be different, and the contract will support any number of additional tokens you may wish to provide.
• The Owner may update the duration of the reward schedule by calling setRewardsDuration only after the active reward cycle has completed.
• While the rewards period is active, the contract will automatically update all reward balances anytime most mutative functions are called (stake, withdraw, , getReward, or notifyRewardAmount)
• The Owner may call recoverERC20 to transfer reward tokens, but not the staking token. Claiming rewards may fail if this function drains the balance.
• In order to transfer ERC20 tokens to the contract, you must first call the approve function on the token's contract and authorize Staking to transfer the correct amount.

Configuration of .env file

To see the mnemonic or seed phrase in Metamask, follow this instruction.

The Metamask account (mnemonic in the .env) needs to have enough funds in the network where you want to interact with the smart contracts.

To add test funds:

• Rinkeby test network: Rinkeby Faucet
• BSC test network: BSC Faucet
• Matic Mumbai test network: Polygon Faucet

cp .env.example .env
vi .env # add an account's mnemonic and an Infura API key

Deploying the smart contracts to the Hardhat local network

yarn install
yarn build
yarn hardhat:node

Deploying the membership system smart contracts to the Rinkeby test network

yarn install
yarn build
yarn deploy:rinkeby

Publishing to NPM

npm login
yarn publish --access public

Creating test reward pools

yarn create-reward-pools

Integrating the project into a Dapp (e.g. create-react-app or Next.js)

Installing via npm package:

yarn add @unizen-io/unizen-dmas

Import in a UI component like so:

import { UZStakingV1, UZStakingV1__factory } from "unizen-dmas";