Overseer

The Overseer contract is responsible for storing key protocol parameters and the whitelisting of new bAsset collaterals. The borrow limit of users are calculated here, as the Overseer keeps track of locked collateral amounts for all users.

This contract is the recipient for collected bAsset rewards claimed by Custody contracts. The Overseer calculates the amount of depositor subsidies that has to be distributed, and the resulting amount is sent to the Market contract.

The Overseer halts borrow-related operations if the Oracle's price data is older than 60 seconds (price_timeframe). Operations are resumed when new price data is fed-in.

Config

Key	Type	Description
owner_addr	CanonicalAddr	Address of contract owner that can update config
oracle_contract	CanonicalAddr	Contract address of Oracle
market_contract	CanonicalAddr	Contract address of Market
liquidation_contract	CanonicalAddr	Contract address of Liquidation Contract
collector_contract	CanonicalAddr	Contract address of Collector
stable_denom	String	Native token denomination for stablecoin
epoch_period	u64	Minimum time delay between epoch operations [blocks]
threshold_deposit_rate	Decimal256	Threshold per-block deposit rate before triggering interest buffer distribution
target_deposit_rate	Decimal256	Target per-block stablecoin deposit rate of Anchor
buffer_distribution_factor	Decimal256	Maximum portion of interest buffer that can be distributed in an epoch
anc_purchase_factor	Decimal256	Portion of bAsset rewards used to purchase ANC
price_timeframe	u64	Window of time before price data is considered outdated [seconds]

InstantiateMsg

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub struct InstantiateMsg {
    pub owner_addr: String, 
    pub oracle_contract: String, 
    pub market_contract: String, 
    pub liquidation_contract: String, 
    pub collector_contract: String, 
    pub stable_denom: String, 
    pub epoch_period: u64, 
    pub threshold_deposit_rate: Decimal256, 
    pub target_deposit_rate: Decimal256, 
    pub buffer_distribution_factor: Decimal256, 
    pub anc_purchase_factor: Decimal256, 
    pub price_timeframe: u64, 
}

JSON

{
  "owner_addr": "terra1...", 
  "oracle_contract": "terra1...", 
  "market_contract": "terra1...", 
  "liquidation_contract": "terra1...", 
  "collector_contract": "terra1...", 
  "stable_denom": "uusd", 
  "epoch_period": 86400, 
  "threshold_deposit_rate": "0.1", 
  "target_deposit_rate": "0.15", 
  "buffer_distribution_factor": "0.1", 
  "anc_purchase_factor": "0.5", 
  "price_timeframe": 60 
}

Key	Type	Description
owner_addr	String	Address of contract owner that can update config
oracle_contract	String	Contract address of Oracle
market_contract	String	Contract address of Market
liquidation_contract	String	Contract address of Liquidation Contract
collector_contract	String	Contract address of Collector
stable_denom	String	Native token denomination for stablecoin
epoch_period	u64	Minimum time delay between epoch operations [blocks]
threshold_deposit_rate	Decimal256	Threshold per-block deposit rate to trigger interest buffer distribution
target_deposit_rate	Decimal256	Target per-block stablecoin deposit rate of Anchor
buffer_distribution_factor	Decimal256	Maximum portion of interest buffer that can be distributed in an epoch
anc_purchase_factor	Decimal256	Portion of bAsset rewards used to purchase ANC
price_timeframe	u64	Window of time before price data is considered outdated [seconds]

ExecuteMsg

UpdateConfig

Updates the configuration of the contract. Can only be issued by the owner.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
    UpdateConfig {
        owner_addr: Option<String>, 
        oracle_contract: Option<String>, 
        liquidation_contract: Option<String>, 
        threshold_deposit_rate: Option<Decimal256>, 
        target_deposit_rate: Option<Decimal256>, 
        buffer_distribution_factor: Option<Decimal256>, 
        anc_purchase_factor: Option<Decimal256>, 
        epoch_period: Option<u64>, 
        price_timeframe: Option<u64>, 
    }
}

JSON

{
  "update_config": { 
    "owner_addr": "terra1...", 
    "oracle_contract": "terra1...", 
    "liquidation_contract": "terra1...", 
    "threshold_deposit_rate": "0.1", 
    "target_deposit_rate": "0.15", 
    "buffer_distribution_factor": "0.1", 
    "anc_purchase_factor": "0.5", 
    "epoch_period": 86400, 
    "price_timeframe": 60 
  }
}

Key	Type	Description
owner_addr*	String	Address of new contract owner
oracle_contract*	String	Contract address of new Oracle
liquidation_contract*	String	Contract address of new Liquidation Contract
threshold_deposit_rate*	Decimal256	New threshold per-block deposit rate to trigger interest buffer distribution
target_deposit_rate*	Decimal256	New target per-block stablecoin deposit rate of Anchor
buffer_distribution_factor*	Decimal256	New maximum portion of interest buffer that can be distributed in an epoch
anc_purchase_factor*	Decimal256	New portion of bAsset rewards used to purchase ANC
epoch_period*	u64	New minimum time delay between epoch operations [blocks]
price_timeframe*	u64	New window of time before price data is considered outdated [seconds]

* = optional

Whitelist

Whitelists a new collateral accepted in the money market. Can only be issued by the owner.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
    Whitelist {
        name: String, 
        symbol: String, 
        collateral_token: String, 
        custody_contract: String, 
        max_ltv: Decimal256,  
    }
}

JSON

{
  "whitelist": { 
    "name": "bonded luna", 
    "symbol": "ubluna", 
    "collateral_token": "terra1...", 
    "custody_contract": "terra1...", 
    "max_ltv": "0.75" 
  }
}

Key	Type	Description
name	String	Name of collateral bAsset
symbol	String	Token symbol of collateral bAsset
collateral_token	String	Cw20 token contract address of collateral
custody_contract	String	Custody contract address of collateral
max_ltv	Decimal256	Maximum loan-to-value ratio allowed for collateral

UpdateWhitelist

Updates information for an already whitelisted collateral. Can only be issued by the owner.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
    UpdateWhitelist {
        collateral_token: String, 
        custody_contract: Option<String>, 
        max_ltv: Option<Decimal256>,  
    }
}

JSON

{
  "update_whitelist": {
    "collateral_token": "terra1...", 
    "custody_contract": "terra1...", 
    "max_ltv": "0.75" 
  }
}

Key	Type	Description
collateral_token	String	Cw20 token contract address of collateral
custody_contract*	String	New Custody contract address of collateral
max_ltv*	Decimal256	New maximum loan-to-value ratio allowed for collateral

* = optional

ExecuteEpochOperations

Executes epoch operations. Distributes interest buffers if necessary, and requests Custody contracts to claim bAsset rewards and distribute depositor subsidies.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
    ExecuteEpochOperations {}
}

JSON

{
  "execute_epoch_operations": {}
}

Key	Type	Description

[Internal] UpdateEpochState

Updates state related to epoch operations. Can only be issued by Overseer.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
    UpdateEpochState {
        interest_buffer: Uint256, 
        distributed_interest: Uint256, 
    }
}

JSON

{
  "update_epoch_state": {
    "interest_buffer": "100000000", 
    "distributed_interest": "100000000" 
  }
}

Key	Type	Description
interest_buffer	Uint256	Amount of yield reserve left after distributing subsidies
distributed_interest	Uint256	Amount of depositor subsidies distributed in this epoch

LockCollateral

Locks specified amount of collateral deposited by message sender. Requests Custody contracts to reduce spendable collateral balance.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
    LockCollateral {
        collaterals: TokensHuman, 
    }
}

pub type TokensHuman = Vec<(String, Uint256)>;

JSON

{
  "lock_collateral": { 
    "collaterals": [
      ["terra1...", "100000000"], // (CW20 contract address, Amount to lock)
      ["terra1...", "100000000"] 
    ]
  }
}

Key	Type	Description
collaterals	TokensHuman	List of collaterals and their lock amounts

Key	Type	Description
TokensHuman	Vec<(String, Uint256)>	Vector of (Collateral token address, Amount to lock)

UnlockCollateral

Unlocks specified amount of collateral unlocked by message sender. Requests Custody contracts to increase spendable collateral balance.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
    UnlockCollateral {
        collaterals: TokensHuman, 
    }
}

pub type TokensHuman = Vec<(String, Uint256)>;

JSON

{
  "unlock_collateral": {
    "collaterals": [
      ["terra1...", "100000000"], // (CW20 contract address, Amount to unlock)
      ["terra1...", "100000000"] 
    ]
  }
}

Key	Type	Description
collaterals	TokensHuman	List of collaterals and their unlock amounts

Key	Type	Description
TokensHuman	Vec<(String, Uint256)>	Vector of (Collateral token address, Amount to lock)

LiquidateCollateral

Liquidates loan position of the specified borrower. Requests Custody contracts to process collateral liquidation.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
    LiquidateCollateral {
        borrower: String, 
    }
}

JSON

{
  "liquidate_collateral": {
    "borrower": "terra1..."
  }
}

Key	Type	Description
borrower	String	Address of borrower to liquidate loan position

QueryMsg

Config

Gets the configuration of the Overseer contract.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
    Config {}
}

JSON

{
  "config": {}
}

Key	Type	Description

ConfigResponse

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
pub struct ConfigResponse {
    pub owner_addr: String, 
    pub oracle_contract: String, 
    pub market_contract: String, 
    pub liquidation_contract: String, 
    pub collector_contract: String, 
    pub threshold_deposit_rate: Decimal256, 
    pub target_deposit_rate: Decimal256, 
    pub buffer_distribution_factor: Decimal256, 
    pub anc_purchase_factor: Decimal256, 
    pub stable_denom: String, 
    pub epoch_period: u64, 
    pub price_timeframe: u64, 
}

JSON

{
  "owner_addr": "terra1...", 
  "oracle_contract": "terra1...", 
  "market_contract": "terra1...", 
  "liquidation_contract": "terra1...", 
  "collector_contract": "terra1...", 
  "distribution_threshold": "0.1", 
  "target_deposit_rate": "0.15", 
  "buffer_distribution_rate": "0.1", 
  "anc_purchase_factor": "0.5", 
  "stable_denom": "uusd", 
  "epoch_period": 86400, 
  "price_timeframe": 60 
}

Key	Type	Description
owner_addr	String	Address of contract owner
oracle_contract	String	Contract address of Oracle
market_contract	String	Contract address of Market
liquidation_contract	String	Contract address of Liquidation Contract
collector_contract	String	Contract address of Collector
threshold_deposit_rate	Decimal256	Threshold per-block deposit rate before triggering interest buffer distribution
target_deposit_rate	Decimal256	Target per-block stablecoin deposit rate of Anchor
buffer_distribution_factor	Decimal256	Maximum portion of interest buffer that can be distributed in an epoch
anc_purchase_factor	Decimal256	Portion of bAsset rewards used to purchase ANC
stable_denom	String	Native token denomination for stablecoin
epoch_period	u64	Minimum time delay between epoch operations [blocks]
price_timeframe	u64	Window of time before price data is considered outdated [seconds]

EpochState

Gets information related to the current epoch.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
    EpochState {}
}

JSON

{
  "epoch_state": {}
}

Key	Type	Description

EpochStateResponse

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
pub struct EpochState {
    pub deposit_rate: Decimal256, 
    pub prev_aterra_supply: Uint256, 
    pub prev_exchange_rate: Decimal256, 
    pub prev_interest_buffer: Uint256, 
    pub last_executed_height: u64, 
}

JSON

{
  "deposit_rate": "0.13", 
  "prev_aterra_supply": "100000000", 
  "prev_exchange_rate": "1.2", 
  "prev_interest_buffer": "100000000", 
  "last_executed_height": 123456 
}

Key	Type	Description
deposit_rate	Decimal256	Average per-block deposit rate during the last epoch
prev_aterra_supply	Uint256	Total aTerra supply at when epoch operations were last executed
prev_exchange_rate	Decimal256	aTerra exchange rate when epoch operations were last executed
prev_interest_buffer	Uint256	Amount of yield reserves when epoch operations were last executed
last_executed_height	u64	Block number when epoch operations were last executed

Whitelist

Gets information about the specified collateral if the collateral_token field is filled. Gets information about all collaterals if the collateral_token field is not filled.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
    Whitelist {
        collateral_token: Option<String>, 
        start_after: Option<String>, 
        limit: Option<u32>, 
    }
}

JSON

{
  "whitelist": { 
    "collateral_token": null, 
    "start_after": "terra1...", 
    "limit": 3 
  }
}

Key	Type	Description
collateral_token*	String	Cw20 Token address of collateral to query information
start_after*	String	Collateral Cw20 Token address to start query
limit*	u32	Maximum number of query entries

* = optional

WhitelistResponse

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
pub struct WhitelistResponse {
    pub elems: Vec<WhitelistResponseElem>, 
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
pub struct WhitelistResponseElem {
    pub name: String, 
    pub symbol: String, 
    pub max_ltv: Decimal256, 
    pub custody_contract: String, 
    pub collateral_token: String, 
}

JSON

{
  "elems": [
    {
      "name": "bonded luna", 
      "symbol": "ubluna", 
      "max_ltv": "0.5", 
      "custody_contract": "terra1...", 
      "collateral_token": "terra1..." 
    }, 
    {
      "name": "bonded atom", 
      "symbol": "ubatom", 
      "max_ltv": "0.4", 
      "custody_contract": "terra1...", 
      "collateral_token": "terra1..." 
    }
  ]
}

Key	Type	Description
elems	Vec<WhitelistResponseElem>	Vector of whitelisted collateral information

Key	Type	Description
name	String	Name of bAsset collateral
symbol	String	Token symbol of bAsset collateral
max_ltv	Decimal256	Loan-to-value ratio allowed for collateral
custody_contract	String	Custody contract address of this collateral
collateral_token	String	Cw20 Token contract address of this collateral

Collaterals

Gets locked collateral information for the specified borrower.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
    Collaterals {
        borrower: String, 
    }
}

JSON

{
  "collaterals": {
    "borrower": "terra1..." 
  }
{

Key	Type	Description
borrower	String	Address of borrower that locked collateral

CollateralsResponse

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
pub struct CollateralsResponse {
    pub borrower: String, 
    pub collaterals: TokensHuman, 
}

pub type TokensHuman = Vec<(String, Uint256)>;

JSON

{
  "borrower": "terra1...", 
  "collaterals": [
    ["terra1...", "100000000"],  // (CW20 contract address, Locked amount)
    ["terra1...", "100000000"]
  ] 
}

Key	Type	Description
borrower	String	Address of borrower that locked collateral
collaterals	TokensHuman	List of collaterals and locked amounts

Key	Type	Description
TokensHuman	Vec<(String, Uint256)>	Vector of (Collateral token address, Amount locked)

AllCollaterals

Gets locked collateral information for all borrowers.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
    AllCollaterals {
        start_after: Option<String>, 
        limit: Option<u32>, 
    }
}

JSON

{
  "all_collaterals": {
    "start_after": "terra1...", 
    "limit": 8 
  }
}

Key	Type	Description
start_after*	String	Borrower address of start query
limit*	u32	Maximum number of query entries

* = optional

AllCollateralsResponse

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
pub struct AllCollateralsResponse {
    pub all_collaterals: Vec<CollateralsResponse>, 
}

pub struct CollateralsResponse {
    pub borrower: String, 
    pub collaterals: TokensHuman, 
}

pub type TokensHuman = Vec<(String, Uint256)>;

JSON

{
  "all_collaterals": [
    {
      "borrower": "terra1...", 
      "collaterals": [
        ["terra1...", "100000000"], // (CW20 contract address, Locked amount)
        ["terra1...", "100000000"] 
      ]
    }, 
    {
      "borrower": "terra1...", 
      "collaterals": [
        ["terra1...", "100000000"], // (CW20 contract address, Locked amount)
        ["terra1...", "100000000"] 
      ]
    }
  ]
}

Key	Type	Description
all_collaterals	Vec<CollateralsResponse>	List of collaterals and locked amounts

Key	Type	Description
borrower	String	Address of user that locked collateral
collaterals	TokensHuman	List of collaterals and locked amounts

Key	Type	Description
TokensHuman	Vec<(String, Uint256)>	Vector of (Contract address of collateral token, Locked amount)

BorrowLimit

Gets the borrow limit for the specified borrower. Fails if the oracle price is expired.

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
    BorrowLimit {
        borrower: String, 
        block_time: Option<u64>, 
    }
}

JSON

{
  "borrow_limit": { 
    "borrower": "terra1...", 
    "block_time": 123456 
  }
}

Key	Type	Description
borrower	String	Address of borrower
block_time*	u64	Current block timestamp

* = optional

BorrowLimitResponse

Rust

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
pub struct BorrowLimitResponse {
    pub borrower: String, 
    pub borrow_limit: Uint128, 
}

JSON

{
  "borrower": "terra1...", 
  "borrow_limit": "100000000" 
}

Key	Type	Description
borrower	String	Address of borrower
borrow_limit	Uint256	Borrow limit of borrower