Staking

Search…
Staking
The Staking Contract contains the logic for LP Token staking and reward distribution. Staking rewards for LP stakers come from the new VKR tokens generated at each block by the Factory Contract and are split between all combined staking pools. 
InstantiateMsg
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
pub struct InstantiateMsg {
3
    pub token: String,
4
    pub pair: String,
5
    pub lp_token: String,
6
}
Copied!
Key
Type
Description
token
String
Contract address of the Valkyrie Token (VKR)
pair
String
Terraswap pairs (TerraUSD)
lp_token
String
Contract address of the LP token to be staked
ExecuteMsg
Receive
Can be called during a CW20 token transfer when the Mint contract is the recipient. Allows the token transfer to execute a Receive Hook as a subsequent action within the same transaction.
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    Receive {
5
        amount: Uint128,
6
        sender: Addr,
7
        msg: Option<Binary>,
8
    }
9
}
Copied!
1
{
2
  "receive": {
3
    "amount": "10000000",
4
    "sender": "terra1...",
5
    "msg": "eyAiZXhlY3V0ZV9tc2ciOiAiYmxhaCBibGFoIiB9"
6
  }
7
}
Copied!
Key
Type
Description
amount
Uint128
Token amount received
sender
Addr
Sender of token transaction
msg*
Binary
Base64-encoded JSON of Receive Hook message
* = optional
Unbond
Users can issue the unbond message at any time to remove their staked LP tokens from a staking position.
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    Unbond {
5
        amount: Uint128,
6
    }
7
}
Copied!
1
{
2
  "unbond": {
3
    "amount": "10000000",
4
  }
5
}
Copied!
Key
Type
Description
amount
Uint128
Amount of LP tokens to unbond
Withdraw
Withdraws a user's rewards for a specific staking position.
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    Withdraw {}
5
}
Copied!
1
{
2
  "withdraw": { }
3
}
Copied!
AutoStake
When providing liquidity in Valkyrie Protocol, asset pair is first sent to Staking contract, and it acts as a relay. When defined assets are sent to the contract, the contract provides liquidity to receive LP tokens and starts AutoStakeHook
Note: Executor of the transaction should first increase allowance to spend CW20 tokens
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    AutoStake {
5
        token_amount: Uint128,
6
        slippage_tolerance: Option<Decimal>,
7
    }
8
}
Copied!
1
{
2
  "AutoStake": {
3
    "token_amount": 10000,
4
    "slippage_tolerance": 100,    
5
  }
6
}
Copied!
Key
Type
Description
token_amount
Uint128
Amount of VKR token that are provided into liquidity pool
slippage_tolerance*
Decimal
Maximum price slippage allowed to execute this transaction
* = optional
AutoStakeHook
[INTERNAL]
Hook to stake the minted LP tokens from providing liquidity.
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    AutoStakeHook {
5
        staker_addr: String,
6
        prev_staking_token_amount: Uint128,
7
    }
8
}
Copied!
1
{
2
  "auto_stake_hook": {
3
    "staker_addr": "terra1...",
4
    "already_staked_amount": 10000,    
5
  }
6
}
Copied!
Key
Type
Description
staker_addr
String
Address of the staker
prev_staking_token_amount
Uint128
LP staking balance of the staker before this transaction
Receive Hooks
Bond
WARNING
If you send LP Tokens to the Staking contract without issuing this hook, they will not be staked and will BE LOST FOREVER.
Can be issued when the user sends LP Tokens to the Staking contract. The LP token must be recognized by the staking pool of the specified asset token.
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum Cw20HookMsg {
4
    Bond {}
5
}
Copied!
1
{
2
  "bond": {
3
  }
4
}
Copied!
DepositReward
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum Cw20HookMsg {
4
    DepositReward {}
5
}
Copied!
1
{
2
  "deposit_reward": {
3
  }
4
}
Copied!
QueryMsg
Config
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum QueryMsg {
4
    Config {}
5
}
Copied!
1
{
2
  "config": {}
3
}
Copied!
State
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum QueryMsg {
4
    State {}
5
}
Copied!
1
{
2
  "state": {}
3
}
Copied!
StakerInfo
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum QueryMsg {
4
    StakerInfo {
5
      staker_addr: String 
6
    }
7
}
Copied!
1
{
2
  "staker_info": {
3
    "staker_addr" : "terra1..."
4
  }
5
}
Copied!
Key
Type
Description
staker_addr
String
Wallet address of Lp staker
Response
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, PartialEq, JsonSchema)]
2
pub struct StakerInfoResponse {
3
    pub staker: String,
4
    pub bond_amount: Uint128,
5
    pub pending_reward: Uint128,
6
}
Copied!
1
{
2
    "staker_info_response": {
3
        "staker":"terra1...",
4
        "bond_amount": 1000,        
5
        "pending_reward": 1000
6
    }
7
}
Copied!
Key
Type
Description
staker
String
Address of the staker
bond_amount
Uint128
Amount of LP or sLP tokens staked
pending_reward
Uint128
Amount of reward that are not claimed