# Fund The Fund is a derivative version of Synthetix Staking Rewards, distributing protocol revenue to veSEILOR stakers. ## Config ```rust #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)] pub struct FundConfig { pub gov: Addr, pub ve_seilor_addr: Addr, pub seilor_addr: Addr, pub kusd_denom: String, pub kusd_reward_addr: Addr, pub kusd_reward_total_amount: Uint128, pub kusd_reward_total_paid_amount: Uint128, // Sum of (reward rate * dt * 1e18 / total supply) pub reward_per_token_stored: Uint128, // uint256 immutable exitCycle = 30 days; pub exit_cycle: Uint64, // uint256 public claimAbleTime; pub claim_able_time: Uint64, pub new_gov: Option, pub token_cap: Option, } ```
KeyTypeDescription
govAddrThe address of the governance contract
ve_seilor_addrAddrThe address of the veSEILOR contract
seilor_addrAddrThe address of SEILOR token contract
kusd_denomStringStablecoin kUSD denomination
kusd_reward_addrAddrThe address of the token contract for kUSD rewards
kusd_reward_total_amountUint128The total amount of kUSD rewards
kusd_reward_total_paid_amountUint128The total amount of kUSD rewards paid
reward_per_token_storedUint128Reward per token stored
exit_cycleUint64Exit cycle
claim_able_timeUint64Claim able time
new_govAddrThe address of the new governance contract
token_capUint128Token amount limit
## InitMsg ### InstantiateMsg ```rust #[cw_serde] pub struct InstantiateMsg { pub gov: Option, pub ve_seilor_addr: Addr, pub seilor_addr: Addr, pub kusd_denom: String, pub kusd_reward_addr: Addr, pub exit_cycle: Uint64, pub claim_able_time: Uint64, } ``` ```json { "gov": "sei1...", "ve_seilor_addr": "sei1...", "seilor_addr": "sei1...", "kusd_denom": "factor/sei1.../KUSD", "kusd_reward_addr": "sei2...", "exit_cycle": "2592000", "claim_able_time": "1687190400" } ```
KeyTypeDescription
govAddrThe address of the governance contract
ve_seilor_addrAddrThe address of the veSEILOR contract
seilor_addrAddrThe address of SEILOR token contract
kusd_denomStringStablecoin kUSD denomination
kusd_reward_addrAddrThe address of the token contract for kUSD rewards
exit_cycleUint64Exit cycle
claim_able_timeUint64Claim able time
## ExecuteMsg ### UpdateFundConfig ```rust #[cw_serde] pub enum ExecuteMsg { UpdateFundConfig { update_config_msg: UpdateConfigMsg }, } #[cw_serde] pub struct UpdateConfigMsg { pub gov: Option, pub ve_seilor_addr: Option, pub seilor_addr: Option, pub kusd_denom: Option, pub kusd_reward_addr: Option, pub claim_able_time: Option, } ``` ```json { "update_fund_config": { "update_config_msg": { "gov": "sei1...", "ve_seilor_addr": "sei1...", "seilor_addr": "sei1...", "kusd_denom": "factor/sei1.../KUSD", "kusd_reward_addr": "sei2...", "claim_able_time": "1687190400" } } } ```
KeyTypeDescription
update_fund_configUpdateConfigMsgFund contract configuration structure
KeyTypeDescription
gov*AddrThe address of the governance contract
ve_seilor_addr*AddrThe address of the veSEILOR contract
seilor_addr*AddrThe address of SEILOR token contract
kusd_denom*StringStablecoin kUSD denomination
kusd_reward_addr*AddrThe address of the token contract for kUSD rewards
claim_able_time*Uint64Claim able time
### RefreshReward Update user reward. ```rust #[cw_serde] pub enum ExecuteMsg { RefreshReward { account: Addr }, } ``` ```json { "refresh_reward": { "account": "sei1..." } } ```
KeyTypeDescription
accountAddrThe user's address
### Stake Stake SEILOR. ```rust #[cw_serde] pub enum ExecuteMsg { Stake { amount: Uint128 }, } ``` ```json { "stake": { "amount": "1000000000000000000" } } ```
KeyTypeDescription
amountUint128The amount of SEILOR to stake
### Withdraw ```rust #[cw_serde] pub enum ExecuteMsg { Withdraw { amount: Uint128 }, } ``` ```json { "withdraw": { "amount": "1000000000000000000" } } ```
KeyTypeDescription
amountUint128The amount of SEILOR to withdraw
### ReStake ```rust #[cw_serde] pub enum ExecuteMsg { ReStake {}, } ``` ``` { "re_stake": {} } ``` ### GetReward ```rust #[cw_serde] pub enum ExecuteMsg { GetReward {}, } ``` ```json { "get_reward": {} } ``` ### NotifyRewardAmount ```rust #[cw_serde] pub enum ExecuteMsg { NotifyRewardAmount { reward: Uint128 }, } ``` ```json { "notify_reward_amount": { "reward": "1000000000000000000" } } ``` ### SetVeFundMinter ```rust #[cw_serde] pub enum ExecuteMsg { SetVeFundMinter { minter: Addr, is_ve_minter: bool, }, } ``` ```json { "set_ve_fund_minter": { "minter": "sei1...", "is_ve_minter": true } } ```
KeyTypeDescription
minterAddrThe minter's address
is_ve_minterboolWhether the user is a ve-minter
### VeFundMint ```rust #[cw_serde] pub enum ExecuteMsg { VeFundMint { user: Addr, amount: Uint128, }, } ``` ```json { "ve_fund_mint": { "user": "sei1...", "amount": "1000000000000000000" } } ```
KeyTypeDescription
userAddrThe user's address
amoutUint128mint amount
## QueryMsg ### FundConfig ```rust #[cw_serde] #[derive(QueryResponses)] pub enum QueryMsg { #[returns(FundConfigResponse)] FundConfig {}, } ``` ``` { "fund_config": {} } ``` ### FundConfigResponse ```rust #[cw_serde] pub struct FundConfigResponse { pub gov: Addr, pub ve_seilor_addr: Addr, pub seilor_addr: Addr, pub kusd_denom: String, pub kusd_reward_addr: Addr, pub kusd_reward_total_amount: Uint128, pub kusd_reward_total_paid_amount: Uint128, // Sum of (reward rate * dt * 1e18 / total supply) pub reward_per_token_stored: Uint128, // uint256 immutable exitCycle = 30 days; pub exit_cycle: Uint64, // uint256 public claimAbleTime; pub claim_able_time: Uint64, } ``` ```json { "gov": "sei1...", "ve_seilor_addr": "sei1...", "seilor_addr": "sei1...", "kusd_denom": "factor/sei1.../kUSD", "kusd_reward_addr": "sei2...", "kusd_reward_total_amount": "1000000000000000000", "kusd_reward_total_paid_amount": "1000000000000000000", "reward_per_token_stored": "1000000000000000000", "exit_cycle": "2592000", "claim_able_time": "1687190400" } ```
KeyTypeDescription
govAddrThe address of the governance contract
ve_seilor_addrAddrThe address of the veSEILOR contract
seilor_addrAddrThe address of SEILOR token contract
kusd_denomStringStablecoin kUSD denomination
kusd_reward_addrAddrThe address of the token contract for kUSD rewards
kusd_reward_total_amountUint128The total amount of kUSD rewards
kusd_reward_total_paid_amountUint128The total amount of kUSD rewards paid
reward_per_token_storedUint128Reward per token stored
exit_cycleUint64Exit cycle
claim_able_timeUint64Claim able time
### GetClaimAbleSeilor ```rust #[cw_serde] #[derive(QueryResponses)] pub enum QueryMsg { #[returns(GetClaimAbleSeilorResponse)] GetClaimAbleSeilor { user: Addr }, } ``` ```json { "get_claim_able_seilor": { "user": "sei1..." } } ```
KeyTypeDescription
userAddrThe user's address
### GetClaimAbleSeilorResponse ```rust #[cw_serde] pub struct GetClaimAbleSeilorResponse { pub amount: Uint128, } ``` ```json { "amount": "1000000000000000000" } ```
KeyTypeDescription
amountUint128The amount of SEILOR that can be claimed
### GetReservedSeilorForVesting ```rust #[cw_serde] #[derive(QueryResponses)] pub enum QueryMsg { #[returns(GetReservedSeilorForVestingResponse)] GetReservedSeilorForVesting { user: Addr }, } ``` ```json { "get_reserved_seilor_for_vesting": { "user": "sei1..." } } ```
KeyTypeDescription
userAddrThe user's address
### GetReservedSeilorForVestingResponse ```rust #[cw_serde] pub struct GetReservedSeilorForVestingResponse { pub amount: Uint128, } ``` ```rust { "amount": "1000000000000000000" } ```
KeyTypeDescription
amountUnit128The remaining amount of veSEILOR that is vested for the user
### Earned ```rust #[cw_serde] #[derive(QueryResponses)] pub enum QueryMsg { #[returns(EarnedResponse)] Earned { account: Addr }, } ``` ```json { "earned": { "account": "sei1..." } } ```
KeyTypeDescription
accountAddrThe user's address
### EarnedResponse ```rust #[cw_serde] pub struct EarnedResponse { pub amount: Uint128, } ``` ```json { "amount": "1000000000000000000" } ```
KeyTypeDescription
amountUnit128The amount of veSEILOR that is earned by the user
### GetClaimAbleKusd ```rust #[cw_serde] #[derive(QueryResponses)] pub enum QueryMsg { #[returns(GetClaimAbleKusdResponse)] GetClaimAbleKusd { account: Addr }, } ``` ```json { "get_claim_able_kusd": { "account": "sei1..." } } ```
KeyTypeDescription
accountAddrThe user's address
### GetClaimAbleKusdResponse ```rust #[cw_serde] pub struct GetClaimAbleKusdResponse { pub amount: Uint128, } ``` ```json { "amount": "1000000000000000000" } ```
KeyTypeDescription
amountUint128The amount of kUSD that the user is able to claim
### GetUserRewardPerTokenPaid ```rust #[cw_serde] #[derive(QueryResponses)] pub enum QueryMsg { #[returns(UserRewardPerTokenPaidResponse)] GetUserRewardPerTokenPaid { account: Addr }, } ``` ```json { "get_user_reward_per_token_paid": { "account": "sei1..." } } ```
KeyTypeDescription
accountAddrThe user's address
### GetUserRewardPerTokenPaidResponse ```rust #[cw_serde] pub struct UserRewardPerTokenPaidResponse { pub user_reward_per_token_paid: Uint128, } ``` ```json { "user_reward_per_token_paid": "1000000000000000000" } ```
KeyTypeDescription
user_reward_per_token_paidUint128The rate of reward allocation per token for the user
### GetUserRewards ```rust #[cw_serde] #[derive(QueryResponses)] pub enum QueryMsg { #[returns(UserRewardsResponse)] GetUserRewards { account: Addr }, } ``` ```json { "get_user_rewards": { "account": "sei1..." } } ```
KeyTypeDescription
accountAddrThe user's address
### UserRewardsResponse ```rust #[cw_serde] pub struct UserRewardsResponse { pub user_rewards: Uint128, } ``` ```json { "user_rewards": "1000000000000000000" } ```
KeyTypeDescription
user_rewardsUint128The amount of rewards that the user is able to claim
### GetUserTime2fullRedemption ```rust #[cw_serde] #[derive(QueryResponses)] pub enum QueryMsg { #[returns(UserTime2fullRedemptionResponse)] GetUserTime2fullRedemption { account: Addr }, } ``` ```json { "get_user_time2full_redemption": { "account": "sei1..." } } ```
KeyTypeDescription
accountAddrThe user's address
### UserTime2fullRedemptionResponse ```rust #[cw_serde] pub struct UserTime2fullRedemptionResponse { pub user_time2full_redemption: Uint64, } ``` ``` { "user_time2full_redemption": "1000000000000000000" } ```
KeyTypeDescription
user_time2full_redemptionUint64
### GetUserUnstakeRate ```rust #[cw_serde] #[derive(QueryResponses)] pub enum QueryMsg { #[returns(UserUnstakeRateResponse)] GetUserUnstakeRate { account: Addr }, } ``` ```json { "get_user_unstake_rate": { "account": "sei1..." } } ```
KeyTypeDescription
accountAddrThe user's address
### UserUnstakeRateResponse ```rust #[cw_serde] pub struct UserUnstakeRateResponse { pub user_unstake_rate: Uint256, } ``` ``` { "user_unstake_rate": "1000000000000000000" } ```
KeyTypeDescription
user_unstake_rateUint256
### GetUserLastWithdrawTime ```rust #[cw_serde] #[derive(QueryResponses)] pub enum QueryMsg { #[returns(UserLastWithdrawTimeResponse)] GetUserLastWithdrawTime { account: Addr }, } ``` ```json { "get_user_last_withdraw_time": { "account": "sei1..." } } ```
KeyTypeDescription
accountAddrThe user's address
### UserLastWithdrawTimeResponse ```rust #[cw_serde] pub struct UserLastWithdrawTimeResponse { pub user_last_withdraw_time: Uint64, } ``` ```json { "user_last_withdraw_time": "1000000000000000000" } ```
KeyTypeDescription
user_last_withdraw_timeUint64The time when the user last withdrew
### IsVeFundMinter ```rust #[cw_serde] #[derive(QueryResponses)] pub enum QueryMsg { #[returns(bool)] IsVeFundMinter { minter: Addr }, } ``` ```json { "is_ve_fund_minter": { "minter": "sei1..." } } ```
KeyTypeDescription
minterAddrThe user's address
Return true or false.