Mint
The Mint Contract implements the logic for Collateralized Debt Positions (CDPs), through which users can mint new mAsset tokens against their deposited collateral (UST or mAssets). Current prices of collateral and minted mAssets are read from the Oracle Contract determine the C-ratio of each CDP. The Mint Contract also contains the logic for liquidating CDPs with C-ratios below the minimum for their minted mAsset through auction.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]pub struct InitMsg {pub owner: HumanAddr,pub oracle: HumanAddr,pub collector: HumanAddr,pub base_denom: String,pub token_code_id: u64,pub protocol_fee_rate: Decimal,}
{"owner": "terra1...","oracle": "terra1...","collector": "terra1...","token_code_id": 8,"protocol_fee_rate": "0.123",}
Key | Type | Description |
| HumanAddr | Owner of contract |
| HumanAddr | Contract address of Mirror Oracle |
| HumanAddr | Contract address of Mirror Collector |
| String | Native token denomination for stablecoin (TerraUSD) |
| u64 | Code ID for Terraswap CW20 Token |
| Decimal | Protocol fee |
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.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum HandleMsg {Receive {amount: Uint128,sender: HumanAddr,msg: Option<Binary>,}}
{"receive": {"amount": "10000000","sender": "terra1...","msg": "eyAiZXhlY3V0ZV9tc2ciOiAiYmxhaCBibGFoIiB9"}}
Key | Type | Description |
| Uint128 | Amount of tokens received |
| HumanAddr | Sender of the token transfer |
| Binary | Base64-encoded string of JSON of Receive Hook |
* = optional
Updates the configuration of the Mint contract. Can only be issued by the owner of the Mint contract.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum HandleMsg {UpdateConfig {owner: Option<HumanAddr>,oracle: Option<HumanAddr>,collector: Option<HumanAddr>,token_code_id: Option<u64>,protocol_fee_rate: Option<Decimal>,}}
{"update_config": {"owner": "terra1...","oracle": "terra1...","collector": "terra1...","token_code_id": 8,"protocol_fee_rate": "0.123",}}
Key | Type | Description |
| HumanAddr | New owner |
| u64 | New oracle contract address |
| HumanAddr | New collector contract address |
| u64 | New token code ID |
| Decimal | New protocol fee rate |
* = optional
Updates mAsset's minting and liquidation parameters. Can only be issued by the owner of the Mint contract.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum HandleMsg {UpdateAsset {asset_info: AssetInfo,auction_discount: Option<Decimal>,min_collateral_ratio: Option<Decimal>,}}
{"update_asset": {"asset_info": {"token": {"contract_addr": "terra1..."}},"auction_discount": "123.456789","min_collateral_ratio": "123.456789"}}
Key | Type | Description |
| AssetInfo | Asset to be updated |
| Decimal | New auction discount rate |
| Decimal | New minimum collateralization ratio |
* = optional
Registers a new mAsset to be mintable.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum HandleMsg {RegisterAsset {asset_token: HumanAddr,auction_discount: Decimal,min_collateral_ratio: Decimal,}}
{"register_asset": {"asset_token": "terra1...","auction_discount": "123.456789","min_collateral_ratio": "123.456789"}}
Key | Type | Description |
| HumanAddr | Asset to be registered |
| Decimal | Auction discount rate |
| Decimal | Minimum collateralization ratio |
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum HandleMsg {RegisterMigration {asset_token: HumanAddr,end_price: Decimal,}}
{"register_migration": {"asset_token": "terra1...","end_price": "123.456789"}}
Key | Type | Description |
| HumanAddr | Contract address of asset to be migrated |
| Decimal | Final price to freeze old mAsset |
Used for creating a new CDP with TerraUSD collateral. For creating a CDP using mAsset collateral, you need to use the Receive Hook variant.
Opens a new CDP with an initial deposit of collateral. The user specifies the target minted mAsset for the CDP, and sets the desired initial collateralization ratio, which must be greater or equal than the minimum for the mAsset. The initial amount of minted mAsset tokens are determined by:
let mint_amount = collateral.amount* collateral_price* reverse_decimal(asset_price)* reverse_decimal(collateral_ratio);
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum HandleMsg {OpenPosition {asset_info: AssetInfo,collateral: Asset,collateral_ratio: Decimal,}}pub struct Asset {pub info: AssetInfo,pub amount: Uint128,}#[serde(rename_all = "snake_case")]pub enum AssetInfo {Token { contract_addr: HumanAddr },NativeToken { denom: String },}
{"open_position": {"asset_info": {"token": {"contract_addr": "terra1..."}},"collateral": {"info": {"token": {"contract_address": "terra1..."}},"amount": "1000000"},"collateral_ratio": "123.456789"}}
Key | Type | Description |
| AssetInfo | Asset to be minted by CDP |
| Asset | Initial collateral deposit for the CDP |
| Decimal | Initial desired collateralization ratio |
Used for depositing TerraUSD collateral. For depositing mAsset collateral to a CDP, you need to use the Receive Hook variant.
Deposits additional collateral to an existing CDP to raise its C-ratio.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum HandleMsg {Deposit {collateral: Asset,position_idx: Uint128,}}
{"deposit": {"collateral": {"info": {"native_token": {"denom": "uusd",}},"amount": "1000000"},"position_idx": "10000000"}}
Key | Type | Description |
| Asset | Collateral amount to be deposited |
| Uint128 | Index of position |
Withdraws collateral from the CDP. Cannot withdraw more than an amount that would drop the CDP's C-ratio below the minted mAsset's mandated minimum.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum HandleMsg {Withdraw {collateral: Asset,position_idx: Uint128,}}
{"withdraw": {"collateral": {"info": {"token": {"contract_address": "terra1..."}},"amount": "1000000"},"position_idx": "10000000"}}
Key | Type | Description |
| Asset | Collateral to withdraw |
| Uint128 | Index of position |
Mints new mAssets against an existing CDP. Cannot mint more than what would bring the CDP's C-ratio below its minted mAsset's mandated minimum.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum HandleMsg {Mint {asset: Asset,position_idx: Uint128,}}
{"mint": {"asset": {"info": {"token": {"contract_address": "terra1..."}},"amount": "1000000"},"position_idx": "10000000"}}
Key | Type | Description |
| Asset | mAssets to be minted |
| Uint128 | Index of position |
Issued when a user sends mAsset tokens to the Mint contract.
Uses the sent amount to create a new CDP.
Used for creating a new CDP with mAsset collateral. For creating a CDP using TerraUSD collateral, you need to use the HandleMsg variant.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum Cw20HookMsg {OpenPosition {asset_info: AssetInfo,collateral_ratio: Decimal,}}
{"open_position": {"asset_info": {"token": {"contract_addr": "terra1..."}},"collateral_ratio": "123.456789"}}
Key | Type | Description |
| AssetInfo | mAsset to be minted by CDP |
| Decimal | Initial collateralization ratio to use |
Issued when a user sends mAsset tokens to the Mint contract.
Deposits the amount as collateral to an open CDP.
Used for depositing mAsset collateral. For depositing TerraUSD collateral to a CDP, you need to use the HandleMsg variant.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum Cw20HookMsg {Deposit {position_idx: Uint128,}}
{"deposit": {"position_idx": "10000000"}}
Key | Type | Description |
| Uint128 | Index of position |
Issued when a user sends mAsset tokens to the Mint contract.
Burns the sent tokens against a CDP and reduces the C-ratio. If all outstanding minted mAsset tokens are burned, the position is closed and the collateral is returned.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum Cw20HookMsg {Burn {position_idx: Uint128,}}
{"burn": {"position_idx": "10000000"}}
Key | Type | Description |
| Uint128 | Index of position |
Issued when a user sends mAsset tokens to the Mint contract.
Purchases the collateral of a CDP subject to liquidation (whose C-ratio has fallen under its minted mAsset's minimum). The buyer cannot pay more than the CDP's current minted mAsset balance.
The discounted price for the collateral is calculated as follows:
let discounted_price = price * (1 - config.auction_discount);
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum Cw20HookMsg {Auction {position_idx: Uint128,}}
{"auction": {"position_idx": "10000000"}}
Key | Type | Description |
| Uint128 | Index of position |
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum QueryMsg {Config {}}
{"config": {}}
Key | Type | Description |
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum QueryMsg {AssetConfig {asset_token: HumanAddr,}}
{"asset_config": {"asset_info": {"token": {"contract_addr": "terra1..."}}}}
Key | Type | Description |
| HumanAddr | Contract address of asset to query |
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum QueryMsg {Position {position_idx: Uint128,}}
{"position": {"position_idx": "10000000"}}
Key | Type | Description |
| Uint128 | Index of position to query |
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum QueryMsg {Positions {limit: Option<u32>,owner_addr: Option<HumanAddr>,asset_token: Option<HumanAddr>,start_after: Option<Uint128>,}}
{"positions": {"limit": 8,"owner_addr": "terra1...","start_after": "10000000"}}
Key | Type | Description |
| u32 | Upper bound of number of entries to query |
| HumanAddr | Owner of positions |
| HumanAddr | Contract address of asset token |
| Uint128 | Position index to start at |
* = optional
