CW20 Staking
Introduction
This CW20 Staking ADO allows users to stake a specified CW20 token and to receive rewards in any number of other tokens in proportion to their share. The reward token does not need to be the token they stake with but it can be. The contract allows for two types of rewards:
Non-allocated rewards: These are rewards that get deposited periodically into the contract and get distributed proportionally to stakers. Rewards that are deposited are instantly granted to the stakers.
Allocated rewards: The owner deposits a number of tokens to be distributed over the course of a set time. The rewards get distributed the same way, except all of the reward tokens are already deposited in the contract.
The added rewards are distributed proportionally between the stakers that are already staked.
Example
We assume that we instantiated the contract and there are no stakers as of yet. Then the following series of events happen:
First user stakes 100 tokens
Second user stakes 500 tokens
Third user stakes 400 tokens
100 tokens are sent to the contract as rewards
Fourth user stakes 1000 tokens
1000 tokens are sent as rewards
In this case, when the 100 coins are sent the pending rewards are as following for each user:
10 tokens for user 1
50 tokens for user 2
40 tokens for user 3
0 tokens for user 4 since he staked after the rewards were sent
After the 1000 tokens are sent to the contract as rewards, it is split as follows:
50 tokens for user 1 (60 in total)
250 tokens for user 2 (300 in total)
200 tokens for user 3 (240 in total)
500 tokens for user 4 (500 in total since did not receive rewards from first batch)
After the rewards have been sent, the stakers would not receive any extra rewards until a next batch of rewards are sent.
Ado_type: cw20-staking
Version: 2.0.1-beta.1
InstantiateMsg
The additional rewards should not include the staking token.
Name | Type | Description |
---|---|---|
| Reference to the CW20 token that can be staked. Can be either the contract address or a VFS path. | |
| Option<Vec<RewardTokenUnchecked>> | Any rewards in addition to the staking token. This list cannot include the staking token since it is used as a reward by default. Can have a maximum of 10 reward tokens. |
| String | Contract address of the kernel contract to be used for AMP messaging. Kernel contract address can be found in our deployed contracts. |
| Option<String> | Optional address to specify as the owner of the ADO being created. Defaults to the sender if not specified. |
RewardTokenUnchecked
Name | Type | Description |
---|---|---|
| The asset used as a reward. | |
| Timestamp from which Rewards will start getting accrued against the staked LP tokens. Specified in milliseconds. | |
| Option<AllocationConfig> | How to allocate the |
AssetInfoUnchecked
AssetInfoBase
Cw20: To create an asset info instance of this type, provide the contract address
Native: To create an asset info instance of this type, provide the denomination
AllocationConfig
Name | Type | Description |
---|---|---|
| Timestamp in milliseconds till which rewards will be accrued. No staking rewards are accrued beyond this timestamp. | |
| Uint128 | Rewards distributed during the 1st cycle. |
| Cycle duration in milliseconds. | |
| Optional<Decimal> | Percent increase in Rewards per cycle. |
ExecuteMsg
Receive
Receives CW20 tokens which can be staked, or used to update the global index depending on the attached Cw20HookMsg.
Cw20ReceiveMsg
The msg
in the Cw20ReceiveMsg
should be a Cw20HookMsg
.
Cw20HookMsg
These messages need to be attached as a base64 encoded msg when sending CW20 tokens.
StakeTokens: Stake the sent tokens. Address must match the staking_token
given on instantiation. The user's pending rewards and indexes are updated for each additional reward token.
UpdateGlobalIndex: Updates the global reward index on deposit of a valid cw20 token. Called whenever new CW20 rewards other than the staked token are added. Funds may be sent along with this.
AddRewardToken
Add reward_token
as another reward token. A maximum of 10 reward tokens can be added.
Only available to the contract owner.
Name | Type | Description |
---|---|---|
| The token to be added as a reward. |
RemoveRewardToken
Removes the token set as a reward.
Only available to the contract owner.
Name | Type | Description |
---|---|---|
| String | The token set as reward to remove. Specify the contract address for CW20 and the denomination for native. |
ReplaceRewardToken
Replace a token set as reward with another one.
Only available to the contract owner.
Name | Type | Description |
---|---|---|
| String | The token set as reward to replace. Specify the contract address for CW20 and the denomination for native. |
| The new token to be set as a reward. |
UnstakeTokens
Unstakes the specified amount of assets, or all if not specified. The user's pending rewards and indexes are updated for each additional reward token.
Name | Type | Description |
---|---|---|
| Option<Uint128> | Optional amount to unstake. Defaults to the maximum amount. |
ClaimRewards
Claims any outstanding rewards from the additional reward tokens.
UpdateGlobalIndexes
Updates the global reward index for the specified assets or all of the specified ones if none is specified. Funds may be sent along with this. Usually called when new allocated rewards are deposited to update the rewards accordingly.
Name | Type | Description |
---|---|---|
| Option<Vec<AssetInfoUnchecked>> | Optional vector to specify the assets to update the global index for. |
AndrReceive
The rest of the executes can be found in the AndrReceive
section.
QueryMsg
Config
Gets the config of the contract.
Config
Returns the config structure.
Name | Type | Description |
---|---|---|
| The token accepted for staking. | |
| u32 | The current number of reward tokens, cannot exceed the maximum of 10. |
State
Gets the state of the contract. Returns the total share of the staking token in the contract
State
Returns the State structure.
Name | Type | Description |
---|---|---|
| Uint128 | The total share/amount of the staking token in the contract. |
Staker
Returns a StakerResponse
for the given staker. The pending rewards are updated to the present index.
Name | Type | Description |
---|---|---|
| String | The address of the staker to check |
StakerResponse
Name | Type | Description |
---|---|---|
| String | The address of the staker. |
| Uint128 | The staker's share of the staked tokens. |
| Uint128 | How many staking tokens the user has which is the staked amount + rewarded tokens. |
| Vec<(String,Uint)> | The staker's pending rewards represented as [(token_1, amount_1), ..., (token_n, amount_n)] |
Stakers
Returns a Vec<StakerResponse>
for range of stakers. The pending rewards are updated to the present index for each staker.
| Option<String> | An optional address to start after. Used for pagination. |
| Optional<u32> | An optional limit to the number of stakers to query. Defaults to 10 and can be set to a maximum of 30. |
Returns a vector of StakerResponse.
AndrQuery
A set of base queries common to all Andromeda ADOs. Check AndrQuery.