diff --git a/x/cdp/spec/06_params.md b/x/cdp/spec/06_params.md index f43bce88..7c1fdfc2 100644 --- a/x/cdp/spec/06_params.md +++ b/x/cdp/spec/06_params.md @@ -5,10 +5,10 @@ The cdp module contains the following parameters: | Key | Type | Example | Description | |------------------------------|-------------------------|------------------------------------|------------------------------------------------------------------| | CollateralParams | array (CollateralParam) | [{see below}] | array of params for each enabled collateral type | -| DebtParams | DebtParam | {see below} | array of params for each enabled pegged asset | -| GlobalDebtLimit | coin | {"denom":"usdx","amount":"1000"} | maximum pegged assets that can be minted across the whole system | +| DebtParams | DebtParam | `{see below}` | array of params for each enabled pegged asset | +| GlobalDebtLimit | coin | `{"denom":"usdx","amount":"1000"}` | maximum pegged assets that can be minted across the whole system | | SavingsDistributionFrequency | string (int) | "84600" | number of seconds between distribution of the savings rate | -| GlobalDebtLimit | coin | {"denom":"usdx","amount":"1000"} | maximum pegged assets that can be minted across the whole system | +| GlobalDebtLimit | coin | `{"denom":"usdx","amount":"1000"}` | maximum pegged assets that can be minted across the whole system | | DebtAuctionThreshold | string (int) | "100000000000" | amount of system debt before a debt auction is triggered | | SurplusAuctionThreshold | string (int) | "100000000000" | amount of system surplus before a surplus auction is triggered | | DebtAuctionLot | string (int) | "10000000000" | amount of debt that each debt auction will attempt to recoup | @@ -16,16 +16,16 @@ The cdp module contains the following parameters: Each CollateralParam has the following parameters: -| Key | Type | Example | Description | -|---------------------|---------------|------------------------------------------|-------------------------------------------------------------------------------| -| Denom | string | "bnb" | collateral coin denom | -| LiquidationRatio | string (dec) | "1.500000000000000000" | the ratio under which a cdp with this collateral type will be liquidated | -| DebtLimit | coin | {"denom":"bnb","amount":"1000000000000"} | maximum pegged asset that can be minted backed by this collateral type | -| StabilityFee | string (dec) | "1.000000001547126" | per second fee | -| Prefix | number (byte) | "34" | identifier used in store keys - **must** be unique across collateral types | -| SpotMarketID | string | "bnb:usd" | price feed identifier for the spot price of this collateral type | -| LiquidationMarketID | string | "bnb:usd:30" | price feed identifier for the liquidation price of this collateral type | -| ConversionFactor | string (int) | "6" | 10^_ multiplier for external (BTC1.50) to internal (150000000) representation | +| Key | Type | Example | Description | +|---------------------|---------------|--------------------------------------------|-------------------------------------------------------------------------------| +| Denom | string | "bnb" | collateral coin denom | +| LiquidationRatio | string (dec) | "1.500000000000000000" | the ratio under which a cdp with this collateral type will be liquidated | +| DebtLimit | coin | `{"denom":"bnb","amount":"1000000000000"}` | maximum pegged asset that can be minted backed by this collateral type | +| StabilityFee | string (dec) | "1.000000001547126" | per second fee | +| Prefix | number (byte) | "34" | identifier used in store keys - **must** be unique across collateral types | +| SpotMarketID | string | "bnb:usd" | price feed identifier for the spot price of this collateral type | +| LiquidationMarketID | string | "bnb:usd:30" | price feed identifier for the liquidation price of this collateral type | +| ConversionFactor | string (int) | "6" | 10^_ multiplier for external (BTC1.50) to internal (150000000) representation | DebtParam has the following parameters: diff --git a/x/incentive/spec/05_params.md b/x/incentive/spec/05_params.md index ce0b1ac9..857ba1ef 100644 --- a/x/incentive/spec/05_params.md +++ b/x/incentive/spec/05_params.md @@ -9,11 +9,11 @@ The incentive module contains the following parameters: Each `Reward` has the following parameters -| Key | Type | Example | Description | -|------------------|--------------------|----------------------------------|----------------------------------------------------------------| -| Active | bool | "true | boolean for if rewards for this collateral are active | -| Denom | string | "bnb" | the collateral for which rewards are eligible | -| AvailableRewards | object (coin) | {"denom":"kava","amount":"1000"} | the rewards available per reward period | -| Duration | string (time ns) | "172800000000000" | the duration of each reward period | -| TimeLock | string (time ns) | "172800000000000" | the duration for which claimed rewards will be vesting | -| ClaimDuration | string (time ns) | "172800000000000" | how long users have to claim rewards before they expire | +| Key | Type | Example | Description | +|------------------|--------------------|------------------------------------|----------------------------------------------------------------| +| Active | bool | "true | boolean for if rewards for this collateral are active | +| Denom | string | "bnb" | the collateral for which rewards are eligible | +| AvailableRewards | object (coin) | `{"denom":"kava","amount":"1000"}` | the rewards available per reward period | +| Duration | string (time ns) | "172800000000000" | the duration of each reward period | +| TimeLock | string (time ns) | "172800000000000" | the duration for which claimed rewards will be vesting | +| ClaimDuration | string (time ns) | "172800000000000" | how long users have to claim rewards before they expire |