Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Vault

An abstraction of an Xusd contract

Hierarchy

  • Vault

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Vault(params: VaultParameters): Vault

Properties

Optional asaVault

asaVault?: AsaVault

backend

backend: any

Readonly id

id: undefined | number
property

Unique identifier for the contract

Methods

getState

  • getState(params: { account: Account }): Promise<VaultReturnParams>

  • Used to get the state of the contract

    Parameters

    • params: { account: Account }

      Contains key account of type Account that will be used to read state from the contract

    Returns Promise<VaultReturnParams>

    State information of type [[VaultReturnParams]]

getUserInfo

  • getUserInfo(params: { account: Account; address: string }): Promise<UserVaultReturnParams>

  • Parameters

    • params: { account: Account; address: string }

      Contains keys account that indicates the account that will be used to read the information from the contract and address that indicates the address of the contract to be read from

    Returns Promise<UserVaultReturnParams>

    User information of type [[UserVaultReturnParams]]

Static parseUserInfo

  • parseUserInfo(vaultState: any): ReachUserVault

  • Parameters

    • vaultState: any

      type of [[UserVaultReturnParams]]

    Returns ReachUserVault

    type of [[ReachUserVault]]

Generated using TypeDoc