Global lock

global_lock

Indicator of the state of shutdown, will be set to one if entire system gets undercollateralized

Time shift

time_shift

Used for testing when we shift time to accrue fees.

Liquidator account

liquidator_account

Reference to liquidator contract

Oraclize account

oraclize_account

Reference to rates provider contract

EOSDT token

sttoken_account

Reference to EOSDT token contract

NUT token

nutoken_account

Reference to NUT token contract

Admin fee

governance_fee

This is set to 0% per year by default, payable in NUT utility tokens. This mechanism permanently reduces the NUT supply when EOSDT is repaid.

Equilibrium fee

stability_fee

This is 1% per year by default, payable in EOSDT stablecoins as an interest rate on EOSDT.

Critical collateralization ratio

critical_ltv

The minimum acceptable ratio of pledged collateral to loan value. This is set to 130% by default.

Liquidation penalty

liquidation_penalty

The system charges a 15% liquidation penalty by default, taking that percentage of the position’s collateral.

Liquidator discount

liquidator_discount

Liquidated EOSDT and collateral gets a 3% discount to incentivize arbitrators to redeem it from the liquidation contract.

Liquidation price

liquidation_price

The final price set when the system undergoes global settlement and the position contract is locked for further user fund settlements.

NUT liquidation weight

nut_auct_ratio

This parameter defines what fraction of the liquidation penalty will go to separate collateral balance on the liquidator for buying out with NUT. This parameter is set to 12% currently.

NUT discount

nut_discount

Liquidated collateral and profit from REX is available to buy from the liquidator for NUT at a 6% discount from the current NUT oracle price.

REX Profit Factor

profit_factor

This parameter defines the profit distribution from REX. Currently, 88% of REX profit goes to collateral holders and another 12% goes to the liquidator contract to buy NUT. Applicable only for EOS-collateral contract.

Voting period

vote_period

The number of seconds the system votes to reset vote decay. Will be used in BP voting/REX functionality. Currently not used, as voting happens in real-time. This is 10 days (in seconds) by default. Applicable only for EOS-collateral contract.

Stake period

stake_period

This specifies the interval at which the system stakes collateral to the REX, as well as collects profit from REX. It’s set to 5 days (in seconds) by default.

Reserve ratio

reserve_ratio

Shows what percentage of total EOS collateral ends up inside the REX. Applicable only for EOS-collateral contract.

Staking weight

staking_weight

Defines the fraction of total system collateral being staked every stake period into the REX. Applicable only for EOS-collateral contract.

Proxy account

bpproxy_account

Reference to voting proxy account. Applicable only for EOS-collateral contract.

Governance account

governc_account

Reference to governance contract.

Referral stake

referral_min_stake

This parameter specifies the amount of NUT tokens participants in our referral program need to stake to positions contract to be able to funnel users to the contract on their behalf and get fraction of equilibrium fees.

Referral ratio

referral_ratio

Fraction of equilibrium fee attributable to referrals when users terminate positions through their web interfaces. By default = 50%

Collateral token account

collateral_account

Specifies the account of the collateral token. For EOS its eosio.token.

Collateral token

collateral_token

Specifies the ticker and precision of collateral token. For example, “4,EOS” means that collateral is EOS token with 4 digits of precision.

User invoked actions

Create an empty position entity and set the caller to be the owner.

cleos push action eosdtcntract positionadd -p testtesttest@active

Create a position used by referrals.

cleos push action eosdtcntract posandrefadd '{"referral_id":"2"}' -p testtesttest@active

Check that a position is EOSDT-free. Return collateral to a position owner. Close the position.

cleos push action eosdtcntract positiondel '{"position_id":"1"}' -p testtesttest@active

Transfer position ownership to a new account.

cleos push action eosdtcntract positiongive '{"position_id":"1","to":"blablablabla"}' -p testtesttest@active

Add collateral to the position.

cleos push action eosio.token transfer '{"from":"testtesttest", "to":"eosdtcntract", "quantity":"10.0000 EOS", "memo": "position_id:0"}' -p testtesttest@active

Remove collateral from the position.

cleos push action eosdtcntract colateraldel '{"position_id":"1","collateral":"1.0000 EOS"}' -p testtesttest@active

Generate stablecoins on the position.

cleos push action eosdtcntract debtgenerate '{"position_id":"1","debt":"1.000000000

Pay back and burn EOSDT

cleos push action eosdtsttoken transfer '{"from":"testtesttest", "to":"eosdtcntract", "quantity":"0.500000000 EOSDT", "memo": "position_id:0"}' -p testtesttest@active

Close existing position

cleos push action eosdtcntract close '{"position_id":"1"}'

Close an undercollateralized position, move a position’s EOSDT, and transfer collateral with a penalty to the liquidator.

cleos push action eosdtcntract margincall '{"position_id": "30"}' -p testtesttest@active

A method that gets called when the oracle service calls our contract with a rates update. If there are positions to be liquidated, deferred margin calls will be created and positions will be liquidated in the next blockchain transaction.

cleos push action eosdtcntract margincallde -p testtesttest@active

Internal system actions

Close multiple positions by sorting ltvratios table in order of ascending ltv_ratio

This private system function calculates the accrued fees between consecutive calls before transferring it to the liquidator contract. This function is called every time a position method is called.

This authenticates a liquidator account and transfers a requested quantity of collateral token to the liquidator contract.

This authenticates a liquidator account and transfers a requested quantity of EOSDT to the liquidator contract. (used in surplus auctions when the equilibrium fee isn’t zero)

Populate ctrltvratios contract table

Clean ctrltvratios table

deprecated

Returns current build version for debug purposes

This locks the positions contract, disabling all methods related to position management except close().

It also fixes the Collateral/USD price, which facilitates user reimbursements. It sets the liquidation penalty and discount to 0%, and the critical collateralization ratio to 1.

This method is used in global shutdown mechanics.

Used to set liquidator contract settings when contract deployment happens.

Unstake and withdraw all collateral from REX (manually in case of emergency with REX)
This actions should be called in specified order. Applicable only for EOS-collateral contract.

Action that every voting_period votes for eosdtbpproxy. Applicable only for EOS-collateral contract.

Transfer EOS

This transfer buys surplus EOSDT from the liquidator contract at a discount on the peg price by supplying collateral.

cleos push action eosio.token transfer '{"from":"testtesttest", "to":"eosdtliqdatr", "quantity":"1.0000 EOS"}' -p testtesttest@active

Transfer EOSDT

This transfer lets you buy collateral from the liquidator contract at a discount on the current market price. It supplies surplus EOSDT to the liquidator contract.

cleos push action eosdtsttoken transfer '{"from":"testtesttest", "to":"eosdtliqdatr", "quantity":"0.500000000 EOSDT"}' -p testtesttest@active

Transfer NUT

This transfer buys EOS collateral from the liquidator nut_collat_balance pool for NUT at a discount.

cleos push action eosio.token transfer '{"from":"testtesttest", "to":"eosdtliqdatr", "quantity":"1.000000000 NUT", "memo": "EOSDT"}' -p testtesttest@active

Transfer NUT

This transfer buys collateral from the liquidator nut_collat_balance pool for NUT at a discount.

cleos push action eosdtnutoken transfer '{"from":"testtesttest", "to":"eosdtliqdatr", "quantity":"1.000000000 NUT", "memo": "EOS"}' -p testtesttest@active

Internal system actions

reducedebts

This action burns a minimum current “bad” EOSDT and surplus EOSDT on the liquidator contract. This internal function cancels out bad EOSDT by burning it and decreasing its supply.

N/A

settingset

Used to set liquidator contract settings when contract deployment happens.

N/A

transbaddebt

When any position gets liquidated, the positions contract calls this method to increase the amount of “bad debt” on the liquidator contract.

N/A

unlockliqdtr

This method checks that there are no positions left and it calculates a final auction price, the liquidator contract’s bad EOSDT divided by its EOS balance. It unlocks liquidator methods.

N/A

currentver

Returns current build version for debug purposes.

N/A

paraminit

Initializes empty parameters table

N/A

Minimum proposal theshold

min_proposal_weigh

Only users with NUT holdings of more than min_proposal_weigh may submit proposals to the governance contract.

Freeze period

freeze_period

Freeze time for expired / finished proposals, by default = 3 days.

Minimum participation rate

min_participation_rate

A minimum of 51% of the current NUT supply to have been cast in the voting process for a proposal to be valid, like a simple majority shareholder vote.

Succes margin

success_margin

At least 55% of all votes were "Yes” for a proposal to pass.

Top holders count

top_holders_amount

Top 10 holders of NUT by token count should participate in proposal voting for it to be a valid proposal.

Maximum number of block producers

max_bp_count

Number of Block Producers equilibrium proxy is voting for. Currently 30 BPs get Equilibrium votes.

Maximum BP votes

max_bp_votes

Maximum number of block producers one user may vote with his stake. By default = 3

Minimum vote

min_vote_stake

Minimum amount of NUT required to vote for Block Producers. By default = 2 NUT.

Unstake period

unstake_period

The time voter has to wait before unstaking his NUT tokens from the governance contract. By default = 10 days.

Reward sharing percent

reward_weight

88% of profits from BP rewards goes to collateral holders, 12% goes to NUT holders

Staking reward

stake_reward

Shows what fraction of profits from Equilibrium proxy block producers will share with collateral and NUT holders.

User invoked actions

bpregister

Register block producer on governance contract to participate in reward sharing program

cleos push action eosdtgovernc bpregister '{"bp_name":"bpaccntname1","reward_amount":"7.0000 EOS"}' -p testtesttest@active

bpunregister

Unregister block producer from reward sharing program

cleos push action eosdtgovernc bpunregister '{"bp_name":"bpaccntname1"}' -p testtesttest@active

bpsetparams

Change reward amount for a particular BP, can’t be less than a govparams.min_reward number.

cleos push action eosdtgovernc bpsetparams '{"bp_name":"bpaccntname1","reward_amount":"7.0000 EOS"}' -p testtesttest@active

propose

Propose a new proposal to the eosdtgovernc contract. There are 3 general proposal types:

0 - parameter change proposal

1 - general proposal

2 - BP voting

2nd type is reserved for BP voting and is never used by external proposers.

cleos push action eosdtgovernc propose '{"proposer":"testtesttest","proposal_name":"NUT to the moon!","title":"let’s launch Equilibrium’s NUT to the moon","proposal_json":"", ,"expires_at":"2020-04-20T04:20:00","proposal_type":"1"}' -p testtesttest@active

expire

Expires proposal. Only the creator of the proposal may expire it.

cleos push action eosdtgovernc expire '{"proposal_name":"NUT to the moon!"}' -p testtesttest@active

transfer

Transfer(stake) NUT to the contract to vote for proposals (voter entity is created in govvoters table)

cleos push action eosdtnutoken transfer '{"from":"testtesttest", "to":"eosdtgovernc", "quantity":"2.000000000 NUT"}' -p testtesttest@active

unstake

Unstake NUT tokens from the governance contract

cleos push action eosdtgovernc unstake '{"voter":"testtesttest", "quantity":"2.000000000 NUT"}' -p testtesttest@active

vote

Vote for given proposal

0 - means "NO!"

1 - means "YES!"

cleos push action eosdtgovernc vote '{"voter":"testtesttest","proposal_name":"NUT to the moon!", "vote":"1", "vote_json":""}' -p testtesttest@active

unvote

Remove vote from a given proposal

cleos push action eosdtgovernc unvote '{"voter":"testtesttest","proposal_name":"NUT to the moon!"}' -p testtesttest@active

Internal/Private system actions

addposcntr

Add positions contract of additional collateral type to the governance contract reference table so it may govern its parameters

N/A

remposcntr

Remove positions contract of additional collateral type.

N/A

reinit

This private system function calculates the accrued rewards between consecutive calls before transferring it to collateral holders and liquidator contract. This function is called every time vote/unvote action is called and also is called regularly by an external cron service

N/A

clnproposal

Clean proposals table - removes expired proposals

N/A

currentver

Returns current build version for debug purposes

N/A

settingsset

Used to set liquidator contract settings when contract deployment happens

N/A

apply

Applies changes in proposal that has been voted for and approved.

N/A

applybpproxy

Re-votes with eosdtbpproxy for block producers on each reinit on positions contract (this is done to keep vote_weight intact)

N/A

bpvotescount

Service action for debug purposes (deprecated)

N/A

calcnutbal

Service action for debug purposes (deprecated)

N/A

voterreborn

Service action for debug purposes (deprecated)

N/A

globallock

This locks the positions contract, disabling all methods related to position management except close().
It also fixes the EOS/USD price pair, which facilitates user reimbursements. It sets the liquidation penalty and discount to 0%, and the critical collateralization ratio to 1.

N/A

close

This method only works when the system is locked. It transfers bad EOSDT and position collateral after winding down all positions to a collateralization ratio of 1.

cleos push action eosdtcntract close '{"position_id":"2"}' -p testtesttest@active

unlockliqdtr

This checks that there are no positions left and it calculates a final auction price, the liquidator contract’s bad EOSDT divided by its EOS balance. It unlocks liquidator methods.

N/A

generatedebt

An auxiliary method to generate EOSDT at auction price when that EOSDT is needed to fulfill obligations elsewhere.

from:'eosaccname11'

quantity:'1.0000 EOS'

to:'eosdtliqdatr'

type:'generatedebt'

unstake_period

This parameter governs how long a user must wait before withdrawing EOS from the funds contract. This is set to 30 days (in seconds) by default.

mindeposit

Minimum deposit acceptable by the fund contract. By default = 10 EOS.

maxdepositors

Number of depositors per contract. By default = 1000

deposit / Transfer EOS

deposits EOS into the emergency fund contract.

cleos push action eosio.token transfer '{"from":"testtesttest", "to":"eosdtstfund1", "quantity":"100.0000 EOS"}' -p testtesttest@active

withdraw

Withdraws EOS from the emergency fund contract. Withdrawals are subject to a 30-day lockup period.

cleos push action eosdtstfund1 withdraw '{"depositor":"testtesttest"}' -p testtesttest@active

sendeos

Calculates how much EOS needs to be transferred to the liquidator contract to align the liquidator’s auction_price with liquidation_price. Reduces each position on the funds contract based on its relative weight.

N/A

settingsset

Used to set contract settings when contract deployment happens.

N/A

paraminit

Initializes empty parameters table

N/A