VaultsClient | @xbacked-dao/xbacked-sdk

Hierarchy

Account
- VaultsClient

Constructors

constructor

new VaultsClient(params: AccountInterface): VaultsClient

Overrides Account.constructor
- Defined in VaultsClient.ts:9
Parameters
- params: AccountInterface
Returns VaultsClient

Properties

backend

backend: any

Optional mnemonic

mnemonic?: string

property: An optional string of 25 words seperated by spaces that can be used to recover an algorand account

Optional network

network?: "LocalHost" | "MainNet" | "TestNet"

property: The desired network to connect to, the default value is LocalHost

Optional networkAccount

networkAccount?: any

property: An optional instance of an account from the reach standard library. Used to reconnect via a frontend

Optional provider

provider?: any

property: An instance of the provider object for the signer specified

Optional providerEnv

providerEnv?: any

property: providerEnv for indexer

reachAccount

reachAccount: any

property: An account created from the reach sdk

reachStdLib

reachStdLib: any

property: An instance of the reach standard library

Optional secretKey

secretKey?: number[]

property: An optional array of numbers that can be used to recover an algorand account

Optional signer

signer?: string

propertyan: optional name of a signer or wallet provider that can be used to sign transactions, should be set along with the provider property. Only required when not using a mnemonic or secretKey

Methods

collectFees

collectFees(params: { vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:249
Used by an account to collect fees from the contract

Parameters
- params: { vault: Vault }
  
  Contains key vault which indicates the contract this function should interact with
  - vault: Vault
Returns Promise<boolean>
A boolean indicating of fees were collected or not

createVault

createVault(params: { collateral: number; maximumPrice: number; minimumPrice: number; mintAmount: number; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:225
Used to create a vault in the contract

Parameters
- params: { collateral: number; maximumPrice: number; minimumPrice: number; mintAmount: number; vault: Vault }
  
  Contains keys collateral that indicates the amount of collateral that will be used to create the vault, mintAmount that indicates the amount of xusd tokens to be minted, vault that indicates the contract we are communicating with, minimumPrice that indicates the minimum price allowed for this transaction and maximumPrice that indicates the maximum price allowed for this transaction
  - collateral: number
  - maximumPrice: number
  - minimumPrice: number
  - mintAmount: number
  - vault: Vault
Returns Promise<boolean>
A boolean indicating if the vault was created or not

depositCollateral

depositCollateral(params: { amount: number; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:155
Parameters
- params: { amount: number; vault: Vault }
  
  Contains the amount of tokens to be deposited as collateral as well as the vault
  - amount: number
  - vault: Vault
Returns Promise<boolean>
A boolean indicating if the collateral was deposited successfully

dripInterest

dripInterest(params: { address: string; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:262
Will trigger interest to accrue on a specific user vault

Parameters
- params: { address: string; vault: Vault }
  
  Contains address of vault to accrue interest for. Also includes vault which indicates the contract this function should interact with.
  - address: string
  - vault: Vault
Returns Promise<boolean>
A boolean indicating of fees were collected or not

fundFromFaucet

fundFromFaucet(): Promise<boolean>

Inherited from Account.fundFromFaucet
- Defined in Account.ts:112
Allows you to fund this account from the faucet when on the Reach devnet

Returns Promise<boolean>
A boolean indicating if this account was successfully funded or not

getAddress

getAddress(): Promise<any>

Inherited from Account.getAddress
- Defined in Account.ts:126
Returns Promise<any>
The formatted adress of this account

getBalance

getBalance(params: { tokenId: number }): Promise<number>

Inherited from Account.getBalance
- Defined in Account.ts:162
Parameters
- params: { tokenId: number }
  
  An object with key tokenId that indicates the ASA id whose balance this function must return, this key's value should be set to zero for the native token balance
  - tokenId: number
Returns Promise<number>
The balance of the specified tokenId

getContractAbi

getContractAbi(params: { backend: any; contractId: number }): Promise<AbiInterface>

Inherited from Account.getContractAbi
- Defined in Account.ts:151
Parameters
- params: { backend: any; contractId: number }
  
  contractId which indicates the contract we want to interact with, and the backend to use (see utils.ts for backend options)
  - backend: any
  - contractId: number
Returns Promise<AbiInterface>

getContractAddress

getContractAddress(params: { backend: any; contractId: number }): Promise<string>

Inherited from Account.getContractAddress
- Defined in Account.ts:140
Returns the contract address

Parameters
- params: { backend: any; contractId: number }
  
  An object with key vault that indicates the contract whose address is to be retrieved, and the backend to use (see utils.ts for backend options)
  - backend: any
  - contractId: number
Returns Promise<string>
A formatted address of the specified contract as a string

getSecret

getSecret(): Promise<any>

Inherited from Account.getSecret
- Defined in Account.ts:103
Returns Promise<any>
A UInt8 array which is the secretKey of this Reach account

getUserInfo

getUserInfo(params: { address: string; vault: Vault }): Promise<UserVaultReturnParams>

- Defined in VaultsClient.ts:276
Parameters
- params: { address: string; vault: Vault }
  
  Contains key address which indicates the vault we want to retrieve the info of as well as key vault that indicates the contract we want to interact with
  - address: string
  - vault: Vault
Returns Promise<UserVaultReturnParams>
the information for the specified vault

getVaultState

getVaultState(params: { vault: Vault }): Promise<VaultReturnParams>

- Defined in VaultsClient.ts:212
Used to get the state of the contract

Parameters
- params: { vault: Vault }
  
  An object with key vault that indicates the contract whose state is to be retrieved
  - vault: Vault
Returns Promise<VaultReturnParams>
The state of the vault of type [[VaultReturnParams]]

initialiseReachAccount

initialiseReachAccount(): Promise<void>

Inherited from Account.initialiseReachAccount
- Defined in Account.ts:57
Initialises the reachAccount property

Returns Promise<void>

liquidateDuringShutdown

liquidateDuringShutdown(params: { address: string; debtAmount: number; dripInterest: false; maximumPrice: number; minimumPrice: number; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:48
Parameters
- params: { address: string; debtAmount: number; dripInterest: false; maximumPrice: number; minimumPrice: number; vault: Vault }
  
  Contains keys address, debtAmount, vault, dripInterest, minimumPrice allowed for this transaction and maximumPrice allowed for this transaction. Include dripInterest if you would like the vault debt to be updated before liquidation
  - address: string
  - debtAmount: number
  - dripInterest: false
  - maximumPrice: number
  - minimumPrice: number
  - vault: Vault
Returns Promise<boolean>
A boolean indicating if the vault was liquidated or not

liquidateVault

liquidateVault(params: { address: string; debtAmount: number; dripInterest: false; maximumPrice: number; minimumPrice: number; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:19
Parameters
- params: { address: string; debtAmount: number; dripInterest: false; maximumPrice: number; minimumPrice: number; vault: Vault }
  
  Contains keys address, debtAmount, vault, dripInterest, minimumPrice allowed for this transaction and maximumPrice allowed for this transaction. Include dripInterest if you would like the vault debt to be updated before liquidation
  - address: string
  - debtAmount: number
  - dripInterest: false
  - maximumPrice: number
  - minimumPrice: number
  - vault: Vault
Returns Promise<boolean>
A boolean indicating if the vault was liquidated or not

mintToken

mintToken(params: { amount: number; maximumPrice: number; minimumPrice: number; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:133
Parameters
- params: { amount: number; maximumPrice: number; minimumPrice: number; vault: Vault }
  
  Contains the amount of xUsd tokens to be minted, the vault in which the token should be minted, minimumPrice that indicates the minimum price allowed for this transaction and maximumPrice that indicates the maximum price allowed for this transaction
  - amount: number
  - maximumPrice: number
  - minimumPrice: number
  - vault: Vault
Returns Promise<boolean>
A boolean indicating if the xUsd tokens were successfully minted or not

optIntoToken

optIntoToken(tokenID: number): Promise<void>

Inherited from Account.optIntoToken
- Defined in Account.ts:94
Allows an instance of the account class to opt into an Algorand standard Asset

Parameters
- tokenID: number
  
  The asa ID to opt into
Returns Promise<void>

proposeVaultForRedemption

proposeVaultForRedemption(params: { address: string; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:105
Propose the address of a vault that could be redeemable, to qualify the vault must be 'less healthy' than any of the other proposed vaults, or there must be a free slot.

Parameters
- params: { address: string; vault: Vault }
  
  Address of vault to propose, and target vault contract.
  - address: string
  - vault: Vault
Returns Promise<boolean>
A boolean indicating success of call.

redeemVault

redeemVault(params: { amountToRedeem: number; maximumPrice: number; minimumPrice: number; targetVault: string; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:79
Attempt to redeem some of the Vault asset against a redeemable vault, to receive vault collateral.

Parameters
- params: { amountToRedeem: number; maximumPrice: number; minimumPrice: number; targetVault: string; vault: Vault }
  
  Contains the amount of xUSD to redeem, the vault to redeem it from, minimumPrice that indicates the minimum price allowed for this transaction and maximumPrice that indicates the maximum price allowed for this transaction
  - amountToRedeem: number
  - maximumPrice: number
  - minimumPrice: number
  - targetVault: string
  - vault: Vault
Returns Promise<boolean>
A boolean indicating success of call.

replenishSupply

replenishSupply(params: { supplyAmt: number; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:336
Used to relplenish the supply on the treasury address

Parameters
- params: { supplyAmt: number; vault: Vault }
  
  An object that contains the supply amount and the target Vault.
  - supplyAmt: number
  - vault: Vault
Returns Promise<boolean>
A boolean indicating if the supply was replenished or not

returnVaultDebt

returnVaultDebt(params: { address: string; amount: number; close?: boolean; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:195
Parameters
- params: { address: string; amount: number; close?: boolean; vault: Vault }
  
  An object with key amount signifying the amount of debt tokens to return, key vault indicating the Contract and key close indicating if the vault should be closed
  - address: string
  - amount: number
  - Optional close?: boolean
  - vault: Vault
Returns Promise<boolean>
A boolean indicating if the vault debt was returned or not

setAdminProperties

setAdminProperties(params: { adminProperties: AdminProperties; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:349
Used to set the admin properties of a vault

Parameters
- params: { adminProperties: AdminProperties; vault: Vault }
  
  An object that contains an [[AdminProperties]] object and the target Vault.
  - adminProperties: AdminProperties
  - vault: Vault
Returns Promise<boolean>
A boolean indicating if the properties were set or not

subscribeToEvents

subscribeToEvents(params: { vault: Vault; createCallback: any; transactionCallback: any; updatePriceCallback: any }): Promise<void>

- Defined in VaultsClient.ts:298
Subscribes to all vault events and calls the provided callbacks when the event is fired

Parameters
- params: { vault: Vault; createCallback: any; transactionCallback: any; updatePriceCallback: any }
  
  An object that contains key vaultId, key createCallback and key transactionCallback
  - vault: Vault
    property
    a uint that uniquely identifies the contract
  - createCallback:function
    - createCallback(address: string, state: UserVaultReturnParams): void
    - Defined in VaultsClient.ts:302
      property
      callback that is called when a vault is created, it is called with the address that created the vault as well as its user vault state
      
      Parameters
      - address: string
      - state: UserVaultReturnParams
      Returns void
  - transactionCallback:function
    - transactionCallback(address: string, state: UserVaultReturnParams): void
    - Defined in VaultsClient.ts:304
      property
      callback that is called when a transaction is made in any vault in the contract, it is called with the address that made the transaction as well as its uservault state
      
      Parameters
      - address: string
      - state: UserVaultReturnParams
      Returns void
  - updatePriceCallback:function
    - updatePriceCallback(address: string, newPrice: number): void
    - Defined in VaultsClient.ts:305
      Parameters
      - address: string
      - newPrice: number
      Returns void
Returns Promise<void>

updateAdminAddress

updateAdminAddress(params: { address: string; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:364
Used to update the admin address of a vault

Parameters
- params: { address: string; vault: Vault }
  
  An object that contains an address and the target Vault.
  - address: string
  - vault: Vault
Returns Promise<boolean>
A boolean indicating if the address was updated.

updatePrice

updatePrice(params: { price: number; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:118
Parameters
- params: { price: number; vault: Vault }
  
  Contains the new price and the vault whose price should be updated
  - price: number
  - vault: Vault
Returns Promise<boolean>
A boolean indicating if the price was successfully updated or not

withdrawCollateral

withdrawCollateral(params: { amount: number; maximumPrice: number; minimumPrice: number; vault: Vault }): Promise<boolean>

- Defined in VaultsClient.ts:172
Parameters
- params: { amount: number; maximumPrice: number; minimumPrice: number; vault: Vault }
  
  Contains amount of collateral to be withdrawn, the vault they should be withdrawn from, minimumPrice that indicates the minimum price allowed for this transaction and maximumPrice that indicates the maximum price allowed for this transaction
  - amount: number
  - maximumPrice: number
  - minimumPrice: number
  - vault: Vault
Returns Promise<boolean>
A boolean indicating if the collaterals were successfully withdrawn or not

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: AccountInterface

Returns VaultsClient

Properties

backend

Optional mnemonic

Optional network

Optional networkAccount

Optional provider

Optional providerEnv

reachAccount

reachStdLib

Optional secretKey

Optional signer

Methods

collectFees

Parameters

params: { vault: Vault }

vault: Vault

Returns Promise<boolean>

createVault

Parameters

params: { collateral: number; maximumPrice: number; minimumPrice: number; mintAmount: number; vault: Vault }

collateral: number

maximumPrice: number

minimumPrice: number

mintAmount: number

vault: Vault

Returns Promise<boolean>

depositCollateral

Parameters

params: { amount: number; vault: Vault }

amount: number

vault: Vault

Returns Promise<boolean>

dripInterest

Parameters

params: { address: string; vault: Vault }

address: string

vault: Vault

Returns Promise<boolean>

fundFromFaucet

Returns Promise<boolean>

getAddress

Returns Promise<any>

getBalance

Parameters

params: { tokenId: number }

tokenId: number

Returns Promise<number>

getContractAbi

Parameters

params: { backend: any; contractId: number }

backend: any

contractId: number

Returns Promise<AbiInterface>

getContractAddress

Parameters

params: { backend: any; contractId: number }

backend: any

contractId: number

Returns Promise<string>

getSecret

Returns Promise<any>

getUserInfo

Parameters

params: { address: string; vault: Vault }

address: string

vault: Vault

Returns Promise<UserVaultReturnParams>

getVaultState

Parameters

params: { vault: Vault }