Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Vault

Holds the data for the Vault Account and provides de/serialization functionality for that data

Hierarchy

  • Vault

Implements

Index

Properties

Accessors

Methods

Properties

Readonly allowFurtherShareCreation

allowFurtherShareCreation: boolean

Readonly authority

authority: PublicKey

Readonly extraByte

extraByte: number

Readonly fractionMint

fractionMint: PublicKey

Readonly fractionTreasury

fractionTreasury: PublicKey

Readonly key

key: Key

Readonly lockedPricePerShare

lockedPricePerShare: bignum

Readonly pricingLookupAddress

pricingLookupAddress: PublicKey

Readonly redeemTreasury

redeemTreasury: PublicKey

Readonly state

state: VaultState

Readonly tokenProgram

tokenProgram: PublicKey

Readonly tokenTypeCount

tokenTypeCount: number

Accessors

Static byteSize

  • get byteSize(): number

Methods

pretty

  • pretty(): { allowFurtherShareCreation: boolean; authority: string; extraByte: number; fractionMint: string; fractionTreasury: string; key: string; lockedPricePerShare: bignum; pricingLookupAddress: string; redeemTreasury: string; state: string; tokenProgram: string; tokenTypeCount: number }

  • Returns a readable version of Vault properties and can be used to convert to JSON and/or logging

    Returns { allowFurtherShareCreation: boolean; authority: string; extraByte: number; fractionMint: string; fractionTreasury: string; key: string; lockedPricePerShare: bignum; pricingLookupAddress: string; redeemTreasury: string; state: string; tokenProgram: string; tokenTypeCount: number }

    • allowFurtherShareCreation: boolean
    • authority: string
    • extraByte: number
    • fractionMint: string
    • fractionTreasury: string
    • key: string
    • lockedPricePerShare: bignum
    • pricingLookupAddress: string
    • redeemTreasury: string
    • state: string
    • tokenProgram: string
    • tokenTypeCount: number

serialize

  • serialize(): [Buffer, number]

Static deserialize

  • deserialize(buf: Buffer, offset?: number): [Vault, number]

Static fromAccountAddress

  • fromAccountAddress(connection: Connection, address: PublicKey): Promise<Vault>

  • Retrieves the account info from the provided address and deserializes the Vault from its data.

    throws

    Error if no account info is found at the address or if deserialization fails

    Parameters

    • connection: Connection
    • address: PublicKey

    Returns Promise<Vault>

Static fromAccountInfo

  • fromAccountInfo(accountInfo: AccountInfo<Buffer>, offset?: number): [Vault, number]

  • Deserializes the Vault from the data of the provided {@link web3.AccountInfo}.

    Parameters

    • accountInfo: AccountInfo<Buffer>
    • offset: number = 0

    Returns [Vault, number]

    a tuple of the account data and the offset up to which the buffer was read to obtain it.

Static fromArgs

Static getMinimumBalanceForRentExemption

  • getMinimumBalanceForRentExemption(connection: Connection, commitment?: Commitment): Promise<number>

  • Fetches the minimum balance needed to exempt an account holding Vault data from rent

    Parameters

    • connection: Connection

      used to retrieve the rent exemption information

    • Optional commitment: Commitment

    Returns Promise<number>

Static hasCorrectByteSize

  • hasCorrectByteSize(buf: Buffer, offset?: number): boolean

Generated using TypeDoc