Class LedgerContext

constructor

• new LedgerContext(): LedgerContext

  Returns LedgerContext

onlineStake

boxExists

• boxExists(app: BaseContract | Application, key: BytesCompat): boolean

  Checks if a box exists for an application by key.

  Parameters

  • app: BaseContract | Application

    The application.
  • key: BytesCompat

    The key.

  Returns boolean

  True if the box exists, false otherwise.

deleteBox

• deleteBox(app: BaseContract | Application, key: BytesCompat): boolean

  Deletes a box for an application by key.

  Parameters

  • app: BaseContract | Application

    The application.
  • key: BytesCompat

    The key.

  Returns boolean

  True if the box was deleted, false otherwise.

getAccount

• getAccount(address: BytesCompat | Account): Account

  Retrieves an account by address.

  Parameters

  • address: BytesCompat | Account

    The account address.

  Returns Account

  The account.

getApplication

• getApplication(applicationId: Uint64Compat): Application

  Retrieves an application by application ID.

  Parameters

  • applicationId: Uint64Compat

    The application ID.

  Returns Application

  The application.

  Throws

  If the application is unknown.

getApplicationForApprovalProgram

• getApplicationForApprovalProgram(
      approvalProgram: undefined | bytes | readonly bytes[],
  ): undefined | Application

  Retrieves an application for a given approval program.

  Parameters

  • approvalProgram: undefined | bytes | readonly bytes[]

    The approval program.

  Returns undefined | Application

  The application or undefined if not found.

getApplicationForContract

• getApplicationForContract(contract: BaseContract): Application

  Retrieves an application for a given contract.

  Parameters

  • contract: BaseContract

    The contract.

  Returns Application

  The application.

  Throws

  If the contract is unknown.

getAsset

• getAsset(assetId: Uint64Compat): Asset

  Retrieves an asset by asset ID.

  Parameters

  • assetId: Uint64Compat

    The asset ID.

  Returns Asset

  The asset.

  Throws

  If the asset is unknown.

getBlockData

• getBlockData(index: Uint64Compat): BlockData

  Retrieves block data by index.

  Parameters

  • index: Uint64Compat

    The block index.

  Returns BlockData

  The block data.

  Throws

  If the block is not set.

getBox

• getBox(app: BaseContract | Application, key: BytesCompat): Uint8Array

  Retrieves a box for an application by key.

  Parameters

  • app: BaseContract | Application

    The application.
  • key: BytesCompat

    The key.

  Returns Uint8Array

  The box data.

getGlobalState

• getGlobalState(
      app: BaseContract | Application,
      key: BytesCompat,
  ): [GlobalStateCls<unknown>, true] | [undefined, false]

  Retrieves global state for an application by key.

  Parameters

  • app: BaseContract | Application

    The application.
  • key: BytesCompat

    The key.

  Returns [GlobalStateCls<unknown>, true] | [undefined, false]

  The global state and a boolean indicating if it was found.

getLocalState

• getLocalState(
      app: uint64 | BaseContract | Application,
      account: Account,
      key: BytesCompat,
  ): [undefined, false] | [LocalStateForAccount<unknown>, true]

  Retrieves local state for an application and account by key.

  Parameters

  • app: uint64 | BaseContract | Application

    The application.
  • account: Account

    The account.
  • key: BytesCompat

    The key.

  Returns [undefined, false] | [LocalStateForAccount<unknown>, true]

  The local state and a boolean indicating if it was found.

patchAccountData

• patchAccountData(
      account: Account,
      data: Partial<Omit<AccountData, "account">> & Partial<
          PickPartial<AccountData, "account">,
      >,
  ): void

  Patches account data with the provided partial data.

  Parameters

  • account: Account

    The account.
  • data: Partial<Omit<AccountData, "account">> & Partial<
        PickPartial<AccountData, "account">,
    >

    The partial account data.

  Returns void

patchApplicationData

• patchApplicationData(
      app: Application,
      data: Partial<Omit<ApplicationData, "application">> & Partial<
          PickPartial<ApplicationData, "application">,
      >,
  ): void

  Patches application data with the provided partial data.

  Parameters

  • app: Application

    The application.
  • data: Partial<Omit<ApplicationData, "application">> & Partial<
        PickPartial<ApplicationData, "application">,
    >

    The partial application data.

  Returns void

patchAssetData

• patchAssetData(asset: Asset, data: Partial<AssetData>): void

  Patches asset data with the provided partial data.

  Parameters

  • asset: Asset

    The asset.
  • data: Partial<AssetData>

    The partial asset data.

  Returns void

patchBlockData

• patchBlockData(index: Uint64Compat, data: Partial<BlockData>): void

  Patches block data with the provided partial data.

  Parameters

  • index: Uint64Compat

    The block index.
  • data: Partial<BlockData>

    The partial block data.

  Returns void

patchGlobalData

• patchGlobalData(data: Partial<GlobalData>): void

  Patches global data with the provided partial data.

  Parameters

  • data: Partial<GlobalData>

    The partial global data.

  Returns void

patchVoterData

• patchVoterData(account: Account, data: Partial<VoterData>): void

  Patches voter data with the provided partial data.

  Parameters

  • account: Account

    The account.
  • data: Partial<VoterData>

    The partial voter data.

  Returns void

setBox

• setBox(
      app: BaseContract | Application,
      key: BytesCompat,
      value: Uint8Array<ArrayBufferLike> | BytesCompat,
  ): void

  Sets a box for an application by key.

  Parameters

  • app: BaseContract | Application

    The application.
  • key: BytesCompat

    The key.
  • value: Uint8Array<ArrayBufferLike> | BytesCompat

    The box data.

  Returns void

setGlobalState

• setGlobalState(
      app: BaseContract | Application,
      key: BytesCompat,
      value: undefined | BytesCompat | Uint64Compat,
  ): void

  Sets global state for an application by key.

  Parameters

  • app: BaseContract | Application

    The application.
  • key: BytesCompat

    The key.
  • value: undefined | BytesCompat | Uint64Compat

    The value (optional).

  Returns void

setLocalState

• setLocalState<T>(
      app: uint64 | BaseContract | Application,
      account: Account,
      key: BytesCompat,
      value: undefined | T,
  ): void

  Sets local state for an application and account by key.

  Type Parameters

  • T

  Parameters

  • app: uint64 | BaseContract | Application

    The application.
  • account: Account

    The account.
  • key: BytesCompat

    The key.
  • value: undefined | T

    The value (optional).

  Returns void

updateAssetHolding

• updateAssetHolding(
      account: Account,
      assetId: Uint64Compat | Asset,
      balance?: Uint64Compat,
      frozen?: boolean,
  ): void

  Update asset holdings for account, only specified values will be updated. AccountType will also be opted-in to asset

  Parameters

  • account: Account
  • assetId: Uint64Compat | Asset
  • Optionalbalance: Uint64Compat
  • Optionalfrozen: boolean

  Returns void