Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 4.29 KB

lib-ethers.readableethersliquity.md

File metadata and controls

50 lines (38 loc) · 4.29 KB

Home > @sovryn-zero/lib-ethers > ReadableEthersLiquity

ReadableEthersLiquity class

Ethers-based implementation of ReadableLiquity.

Signature:

export declare class ReadableEthersLiquity implements ReadableLiquity 

Implements: ReadableLiquity

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ReadableEthersLiquity class.

Properties

Property Modifiers Type Description
connection EthersLiquityConnection

Methods

Method Modifiers Description
connect(signerOrProvider, optionalParams) static
getCollateralSurplusBalance(address, overrides) Get the amount of leftover collateral available for withdrawal by an address.
getFees(overrides) Get a calculator for current fees.
getFrontendStatus(address, overrides) Check whether an address is registered as a Zero frontend, and what its kickback rate is.
getNumberOfTroves(overrides) Get number of Troves that are currently open.
getPrice(overrides) Get the current price of the native currency (e.g. Ether) in USD.
getRemainingStabilityPoolZEROReward(overrides) Get the remaining ZERO that will be collectively rewarded to stability depositors.
getStabilityDeposit(address, overrides) Get the current state of a Stability Deposit.
getTotal(overrides) Get the total amount of collateral and debt in the Zero system.
getTotalRedistributed(overrides) Get the total collateral and debt per stake that has been liquidated through redistribution.
getTotalStakedZERO(overrides) Get the total amount of ZERO currently staked.
getTrove(address, overrides) Get the current state of a Trove.
getTroveBeforeRedistribution(address, overrides) Get a Trove in its state after the last direct modification.
getTroves(params, overrides) Get a slice from the list of Troves.
getZEROBalance(address, overrides) Get the amount of ZERO held by an address.
getZEROStake(address, overrides) Get the current state of an ZERO Stake.
getZUSDBalance(address, overrides) Get the amount of ZUSD held by an address.
getZUSDInStabilityPool(overrides) Get the total amount of ZUSD currently deposited in the Stability Pool.
hasStore() Check whether this ReadableEthersLiquity is a ReadableEthersLiquityWithStore.
hasStore(store) Check whether this ReadableEthersLiquity is a ReadableEthersLiquityWithStore<BlockPolledLiquityStore>.