Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LeaseAccount

A Switchboard account representing a lease for managing funds for oracle payouts for fulfilling feed updates.

Hierarchy

  • LeaseAccount

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional keypair

keypair?: Keypair

program

program: Program<Idl>

publicKey

publicKey: PublicKey

Methods

estimatedLeaseTimeRemaining

  • estimatedLeaseTimeRemaining(): Promise<number>

  • Estimate the time remaining on a given lease

    params

    void

    Returns Promise<number>

    number milliseconds left in lease (estimate)

extend

  • Adds fund to a LeaseAccount. Note that funds can always be withdrawn by the withdraw authority if one was set on lease initialization.

    Parameters

    Returns Promise<string>

getBalance

  • getBalance(): Promise<number>

loadData

  • loadData(): Promise<any>

  • Load and parse LeaseAccount data based on the program IDL.

    Returns Promise<any>

    LeaseAccount data parsed in accordance with the Switchboard IDL.

size

  • size(): number

  • Get the size of a LeaseAccount on chain.

    Returns number

    size.

withdraw

Static create

  • Create and initialize the LeaseAccount.

    Parameters

    • program: Program<Idl>

      Switchboard program representation holding connection and IDL.

    • params: LeaseInitParams

    Returns Promise<LeaseAccount>

    newly generated LeaseAccount.

Static fromSeed

Generated using TypeDoc