interbtc-api

@interlay/interbtc-api / Exports / VaultExt

Class: VaultExt

Table of contents

Constructors

• constructor

Properties

• api
• backingCollateral
• bannedUntil
• id
• issuedTokens
• liquidatedCollateral
• oracleAPI
• replaceCollateral
• secureCollateralThreshold
• status
• systemAPI
• toBeIssuedTokens
• toBeRedeemedTokens
• toBeReplacedTokens

Methods

• computeBackingCollateral
• getBackedTokens
• getFreeCollateral
• getIssuableTokens
• getRedeemableTokens
• getSecureCollateralThreshold
• getStakingPoolNonce
• getUsedCollateral
• isBanned

Constructors

constructor

• new VaultExt(api, oracleAPI, systemAPI, backingCollateral, id, status, bannedUntil, toBeIssuedTokens, issuedTokens, toBeRedeemedTokens, toBeReplacedTokens, replaceCollateral, liquidatedCollateral, secureCollateralThreshold): VaultExt

Parameters

Name	Type
api	ApiPromise
oracleAPI	OracleAPI
systemAPI	SystemAPI
backingCollateral	MonetaryAmount<CollateralCurrencyExt>
id	InterbtcPrimitivesVaultId
status	VaultStatusExt
bannedUntil	undefined | number
toBeIssuedTokens	MonetaryAmount<Currency>
issuedTokens	MonetaryAmount<Currency>
toBeRedeemedTokens	MonetaryAmount<Currency>
toBeReplacedTokens	MonetaryAmount<Currency>
replaceCollateral	MonetaryAmount<CollateralCurrencyExt>
liquidatedCollateral	MonetaryAmount<CollateralCurrencyExt>
secureCollateralThreshold	Big

Returns

VaultExt

Defined in

src/types/vault.ts:29

Properties

api

• Private api: ApiPromise

Defined in

src/types/vault.ts:30

---

backingCollateral

• backingCollateral: MonetaryAmount<CollateralCurrencyExt>

Defined in

src/types/vault.ts:17

---

bannedUntil

• bannedUntil: undefined | number

Defined in

src/types/vault.ts:20

---

id

• id: InterbtcPrimitivesVaultId

Defined in

src/types/vault.ts:18

---

issuedTokens

• issuedTokens: MonetaryAmount<Currency>

Defined in

src/types/vault.ts:22

---

liquidatedCollateral

• liquidatedCollateral: MonetaryAmount<CollateralCurrencyExt>

Defined in

src/types/vault.ts:26

---

oracleAPI

• Private oracleAPI: OracleAPI

Defined in

src/types/vault.ts:31

---

replaceCollateral

• replaceCollateral: MonetaryAmount<CollateralCurrencyExt>

Defined in

src/types/vault.ts:25

---

secureCollateralThreshold

• secureCollateralThreshold: Big

Defined in

src/types/vault.ts:27

---

status

• status: VaultStatusExt

Defined in

src/types/vault.ts:19

---

systemAPI

• Private systemAPI: SystemAPI

Defined in

src/types/vault.ts:32

---

toBeIssuedTokens

• toBeIssuedTokens: MonetaryAmount<Currency>

Defined in

src/types/vault.ts:21

---

toBeRedeemedTokens

• toBeRedeemedTokens: MonetaryAmount<Currency>

Defined in

src/types/vault.ts:23

---

toBeReplacedTokens

• toBeReplacedTokens: MonetaryAmount<Currency>

Defined in

src/types/vault.ts:24

Methods

computeBackingCollateral

▸ computeBackingCollateral(nonce?): Promise<MonetaryAmount<CollateralCurrencyExt>>

Parameters

Name	Type
nonce?	number

Returns

Promise<MonetaryAmount<CollateralCurrencyExt>>

Defined in

src/types/vault.ts:108

---

getBackedTokens

▸ getBackedTokens(): MonetaryAmount<Currency>

Returns

MonetaryAmount<Currency>

Defined in

src/types/vault.ts:79

---

getFreeCollateral

▸ getFreeCollateral(): Promise<MonetaryAmount<CollateralCurrencyExt>>

Returns

Promise<MonetaryAmount<CollateralCurrencyExt>>

Defined in

src/types/vault.ts:83

---

getIssuableTokens

▸ getIssuableTokens(): Promise<MonetaryAmount<Currency>>

Returns

Promise<MonetaryAmount<Currency>>

Defined in

src/types/vault.ts:62

---

getRedeemableTokens

▸ getRedeemableTokens(): MonetaryAmount<Currency>

Returns

MonetaryAmount<Currency>

Defined in

src/types/vault.ts:58

---

getSecureCollateralThreshold

▸ getSecureCollateralThreshold(): Big

Returns

Big

Defined in

src/types/vault.ts:102

---

getStakingPoolNonce

▸ getStakingPoolNonce(): Promise<number>

Returns

Promise<number>

Defined in

src/types/vault.ts:117

---

getUsedCollateral

▸ getUsedCollateral(): Promise<MonetaryAmount<CollateralCurrencyExt>>

Returns

Promise<MonetaryAmount<CollateralCurrencyExt>>

Defined in

src/types/vault.ts:89

---

isBanned

▸ isBanned(): Promise<boolean>

Returns

Promise<boolean>

Defined in

src/types/vault.ts:71

This site is open source. Improve this page.