Comment on page
MoCState

View Source: contracts/MoCState.sol​
↗ Extends: MoCLibConnection, MoCBase, MoCEMACalculator, IMoCState ↘ Derived Contracts: MoCStateMock​
MoCState - version: 0.1.12
Structs
InitializeParams
struct InitializeParams {
 address connectorAddress,
 address governor,
 address btcPriceProvider,
 uint256 liq,
 uint256 utpdu,
 uint256 maxDiscRate,
 uint256 dayBlockSpan,
 uint256 ema,
 uint256 smoothFactor,
 uint256 emaBlockSpan,
 uint256 maxMintBPro,
 address mocPriceProvider,
 address mocTokenAddress,
 address mocVendorsAddress,
 bool liquidationEnabled,
 uint256 protected
}
Contract Members
Constants & Variables
enum IMoCState.States public state;
uint256 public dayBlockSpan;
uint256 public peg;
uint256 public bproMaxDiscountRate;
uint256 public liq;
uint256 public utpdu;
uint256 public rbtcInSystem;
uint256 public liquidationPrice;
bool public liquidationEnabled;
uint256 public protected;
uint256 public maxMintBPro;
contract PriceProvider internal btcPriceProvider;
contract IMoCSettlement internal mocSettlement;
address internal DEPRECATED_mocConverter;
contract DocToken internal docToken;
contract BProToken internal bproToken;
contract MoCBProxManager internal bproxManager;
contract PriceProvider internal mocPriceProvider;
contract MoCToken internal mocToken;
address internal mocVendors;
uint256[50] private upgradeGap;
StateTransition
Parameters
Name
Type
Description
newState
enum IMoCState.States
​
BtcPriceProviderUpdated
Parameters
Name
Type
Description
oldAddress
address
​
newAddress
address
​
MoCPriceProviderUpdated
Parameters
Name
Type
Description
oldAddress
address
​
newAddress
address
​
MoCTokenChanged
Parameters
Name
Type
Description
mocTokenAddress
address
​
MoCVendorsChanged
Parameters
Name
Type
Description
mocVendorsAddress
address
​
Functions
​initialize(struct MoCState.InitializeParams params)​
​setMaxDiscountRate(uint256 rate)​
​getMaxDiscountRate()​
​setDayBlockSpan(uint256 blockSpan)​
​setBtcPriceProvider(address btcProviderAddress)​
​getBtcPriceProvider()​
​getDayBlockSpan()​
​subtractRbtcFromSystem(uint256 btcAmount)​
​addToRbtcInSystem(uint256 btcAmount)​
​bproTotalSupply()​
​docTotalSupply()​
​cobj()​
​collateralRbtcInSystem()​
​globalCoverage()​
​lockedBitcoin(bytes32 bucket)​
​getRbtcInBitPro(bytes32 bucket)​
​getRbtcRemainder()​
​coverage(bytes32 bucket)​
​abundanceRatio(uint256 doc0)​
​currentAbundanceRatio()​
​leverage(bytes32 bucket)​
​globalMaxDoc()​
​freeDoc()​
​maxDoc(bytes32 bucket)​
​globalMaxBPro()​
​absoluteMaxDoc()​
​maxBPro(bytes32 bucket)​
​maxBProx(bytes32 bucket)​
​maxBProxBtcValue(bytes32 bucket)​
​absoluteMaxBPro()​
​maxBProWithDiscount()​
​globalLockedBitcoin()​
​bproTecPrice()​
​bucketBProTecPrice(bytes32 bucket)​
​bucketBProTecPriceHelper(bytes32 bucket)​
​bproDiscountPrice()​
​bproUsdPrice()​
​maxBProxBProValue(bytes32 bucket)​
​bproxBProPrice(bytes32 bucket)​
​bproSpotDiscountRate()​
​daysToSettlement()​
​blocksToSettlement()​
​isLiquidationReached()​
​getLiquidationPrice()​
​getBucketNBTC(bytes32 bucket)​
​getBucketNBPro(bytes32 bucket)​
​getBucketNDoc(bytes32 bucket)​
​getBucketCobj(bytes32 bucket)​
​getInrateBag(bytes32 bucket)​
​getBcons()​
​getBitcoinPrice()​
​calculateBitcoinMovingAverage()​
​getLiq()​
​setLiq(uint256 _liq)​
​getUtpdu()​
​setUtpdu(uint256 _utpdu)​
​getPeg()​
​setPeg(uint256 _peg)​
​getProtected()​
​setProtected(uint256 _protected)​
​getLiquidationEnabled()​
​setLiquidationEnabled(bool _liquidationEnabled)​
​nextState()​
​setMaxMintBPro(uint256 _maxMintBPro)​
​getMaxMintBPro()​
​setMoCPriceProvider(address mocProviderAddress)​
​getMoCPriceProvider()​
​getMoCPrice()​
​bproToBtc(uint256 amount)​
​docsToBtc(uint256 docAmount)​
​btcToDoc(uint256 btcAmount)​
​bproxToBtc(uint256 bproxAmount, bytes32 bucket)​
​bproxToBtcHelper(uint256 bproxAmount, bytes32 bucket)​
​btcToBProx(uint256 btcAmount, bytes32 bucket)​
​setMoCToken(address mocTokenAddress)​
​getMoCToken()​
​setMoCVendors(address mocVendorsAddress)​
​getMoCVendors()​
​setMoCTokenInternal(address mocTokenAddress)​
​setMoCVendorsInternal(address mocVendorsAddress)​
​setLiquidationPrice()​
​initializeValues(address _governor, address _btcPriceProvider, uint256 _liq, uint256 _utpdu, uint256 _maxDiscRate, uint256 _dayBlockSpan, uint256 _maxMintBPro, address _mocPriceProvider, bool _liquidationEnabled, uint256 _protected)​
​initializeContracts(address _mocTokenAddress, address _mocVendorsAddress)​
initialize
⤿ Overridden Implementation(s): MoCStateMock.initialize​
Initializes the contract
function initialize(struct MoCState.InitializeParams params) public nonpayable initializer 
Arguments
Name
Type
Description
params
struct MoCState.InitializeParams
Params defined in InitializeParams struct
setMaxDiscountRate
Sets the max discount rate.
function setMaxDiscountRate(uint256 rate) public nonpayable onlyAuthorizedChanger 
Arguments
Name
Type
Description
rate
uint256
Discount rate at liquidation level [using mocPrecision]
getMaxDiscountRate
Returns the value of the BPro max discount rate configuration param
function getMaxDiscountRate() public view
returns(uint256)
Returns
bproMaxDiscountRate BPro max discount rate
Arguments
setDayBlockSpan
Defines how many blocks there are in a day
function setDayBlockSpan(uint256 blockSpan) public nonpayable onlyAuthorizedChanger 
Arguments
Name
Type
Description
blockSpan
uint256
blocks there are in a day
setBtcPriceProvider
Sets a new BTCProvider contract
function setBtcPriceProvider(address btcProviderAddress) public nonpayable onlyAuthorizedChanger 
Arguments
Name
Type
Description
btcProviderAddress
address
address of the BTC price provider contract
getBtcPriceProvider
Gets the BTCPriceProviderAddress
function getBtcPriceProvider() public view
returns(address)
Returns
address of the BTC price provider contract
Arguments
getDayBlockSpan
Gets how many blocks there are in a day
function getDayBlockSpan() public view
returns(uint256)
Returns
blocks there are in a day
Arguments
subtractRbtcFromSystem
⤾ overrides IMoCState.subtractRbtcFromSystem
Subtract the btc amount passed by parameter to the total Bitcoin Amount
function subtractRbtcFromSystem(uint256 btcAmount) public nonpayable onlyWhitelisted 
Arguments
Name
Type
Description
btcAmount
uint256
Amount that will be subtract to rbtcInSystem
addToRbtcInSystem
⤾ overrides IMoCState.addToRbtcInSystem
btcAmount Add the btc amount passed by parameter to the total Bitcoin Amount
function addToRbtcInSystem(uint256 btcAmount) public nonpayable onlyWhitelisted 
Arguments
Name
Type
Description
btcAmount
uint256
Amount that will be added to rbtcInSystem
bproTotalSupply
All BPros in circulation
function bproTotalSupply() public view
returns(uint256)
Arguments
docTotalSupply
All docs in circulation
function docTotalSupply() public view
returns(uint256)
Arguments
cobj
Target coverage for complete system
function cobj() public view
returns(uint256)
Arguments
collateralRbtcInSystem
Amount of Bitcoins in the system excluding BTCx values and interests holdings
function collateralRbtcInSystem() public view
returns(uint256)
Arguments
globalCoverage
⤾ overrides IMoCState.globalCoverage
GLOBAL Coverage
function globalCoverage() public view
returns(uint256)
Returns
coverage [using mocPrecision]
Arguments
lockedBitcoin
BUCKET lockedBitcoin
function lockedBitcoin(bytes32 bucket) public view
returns(uint256)
Returns
lockedBitcoin amount [using reservePrecision]
Arguments
Name
Type
Description
bucket
bytes32
Name of the bucket used
getRbtcInBitPro
Gets RBTC in BitPro within specified bucket
function getRbtcInBitPro(bytes32 bucket) public view
returns(uint256)
Returns
Bitcoin amount of BitPro in Bucket [using reservePrecision]
Arguments
Name
Type
Description
bucket
bytes32
Name of the bucket used
getRbtcRemainder
⤾ overrides IMoCState.getRbtcRemainder
Gets the RBTC in the contract that not corresponds to Doc collateral
function getRbtcRemainder() public view
returns(uint256)
Returns
RBTC remainder [using reservePrecision]
Arguments
coverage
⤾ overrides IMoCState.coverage
BUCKET Coverage
function coverage(bytes32 bucket) public view
returns(uint256)
Returns
coverage [using coveragePrecision]
Arguments
Name
Type
Description
bucket
bytes32
Name of the bucket used
abundanceRatio
⤾ overrides IMoCState.abundanceRatio
Abundance ratio, receives tha amount of doc to use the value of doc0 and Doc total supply
function abundanceRatio(uint256 doc0) public view
returns(uint256)
Returns
abundance ratio [using mocPrecision]
Arguments
Name
Type
Description
doc0
uint256
​
currentAbundanceRatio
⤾ overrides IMoCState.currentAbundanceRatio
Relation between docs in bucket 0 and Doc total supply
function currentAbundanceRatio() public view
returns(uint256)
Returns
abundance ratio [using mocPrecision]
Arguments
leverage
⤾ overrides IMoCState.leverage
BUCKET Leverage
function leverage(bytes32 bucket) public view
returns(uint256)
Returns
coverage [using mocPrecision]
Arguments
Name
Type
Description
bucket
bytes32
Name of the bucket used
globalMaxDoc
GLOBAL maxDoc
function globalMaxDoc() public view
returns(uint256)
Returns
abundance ratio [using mocPrecision]
Arguments
freeDoc
⤾ overrides IMoCState.freeDoc
Returns the amount of DoCs in bucket 0, that can be redeemed outside of settlement
function freeDoc() public view
returns(uint256)
Returns
amount of docs in bucket 0, that can be redeemed outside of settlement [using mocPrecision]
Arguments
maxDoc
BUCKET maxDoc
function maxDoc(bytes32 bucket) public view
returns(uint256)
Returns
abundance ratio [using mocPrecision]
Arguments
Name
Type
Description
bucket
bytes32
​
globalMaxBPro
GLOBAL maxBPro
function globalMaxBPro() public view
returns(uint256)
Returns
maxBPro for redeem [using reservePrecision]
Arguments
absoluteMaxDoc
⤾ overrides IMoCState.absoluteMaxDoc
ABSOLUTE maxDoc
function absoluteMaxDoc() public view
returns(uint256)
Returns
maxDoc to issue [using mocPrecision]
Arguments
maxBPro
BUCKET maxBPro to redeem / mint
function maxBPro(bytes32 bucket) public view
returns(uint256)
Returns
maxBPro for redeem [using mocPrecision]
Arguments
Name
Type
Description
bucket
bytes32
Name of the bucket used
maxBProx
⚠ This has been deprecated since the Proposal to remove leveraged positions from the protocol was approved, however it is necessary to maintain the contracts and their documentation for legacy support.
GLOBAL max bprox to mint
function maxBProx(bytes32 bucket) public view
returns(uint256)
Returns
maxBProx [using reservePrecision]
Arguments
Name
Type
Description
bucket
bytes32
Name of the bucket used
maxBProxBtcValue
⚠ This has been deprecated since the Proposal to remove leveraged positions from the protocol was approved, however it is necessary to maintain the contracts and their documentation for legacy support.
⤾ overrides IMoCState.maxBProxBtcValue
GLOBAL max bprox to mint
function maxBProxBtcValue(bytes32 bucket) public view
returns(uint256)
Returns
maxBProx BTC value to mint [using reservePrecision]
Arguments
Name
Type
Description
bucket
bytes32
Name of the bucket used
absoluteMaxBPro
⤾ overrides IMoCState.absoluteMaxBPro
ABSOLUTE maxBPro
function absoluteMaxBPro() public view
returns(uint256)
Returns
maxDoc to issue [using mocPrecision]
Arguments
maxBProWithDiscount
⤾ overrides IMoCState.maxBProWithDiscount
DISCOUNT maxBPro
function maxBProWithDiscount() public view
returns(uint256)
Returns
maxBPro for mint with discount [using mocPrecision]
Arguments
globalLockedBitcoin
GLOBAL lockedBitcoin
function globalLockedBitcoin() public view
returns(uint256)
Returns
lockedBitcoin amount [using reservePrecision]
Arguments
bproTecPrice
⤾ overrides IMoCState.bproTecPrice
BTC price of BPro
function bproTecPrice() public view
returns(uint256)
Returns
the BPro Tec Price [using reservePrecision]
Arguments
bucketBProTecPrice
⤾ overrides IMoCState.bucketBProTecPrice
BUCKET BTC price of BPro
function bucketBProTecPrice(bytes32 bucket) public view
returns(uint256)
Returns
the BPro Tec Price [using reservePrecision]
Arguments
Name
Type
Description
bucket