Class TransactionApplication

Fields for application transactions. Definition: data/transactions/application.go : ApplicationCallTxnFields

Implements

Constructors

constructor

Properties

accounts? applicationArgs? applicationId approvalProgram? boxReferences? clearStateProgram? extraProgramPages? foreignApps? foreignAssets? globalStateSchema? localStateSchema? onCompletion? rejectVersion? encodingSchemaValue

Accessors

encodingSchema

Methods

getEncodingSchema toEncodingData fromEncodingData

Constructors

constructor

  • new TransactionApplication(__namedParameters): TransactionApplication

  • Creates a new TransactionApplication object.

    Parameters

    • __namedParameters: {
          accounts?: (string | Address)[];
          applicationArgs?: Uint8Array[];
          applicationId: number | bigint;
          approvalProgram?: string | Uint8Array;
          boxReferences?: indexerModels.BoxReference[];
          clearStateProgram?: string | Uint8Array;
          extraProgramPages?: number | bigint;
          foreignApps?: (number | bigint)[];
          foreignAssets?: (number | bigint)[];
          globalStateSchema?: indexerModels.StateSchema;
          localStateSchema?: indexerModels.StateSchema;
          onCompletion?: string;
          rejectVersion?: number | bigint;
      }
      • Optional accounts?: (string | Address)[]
      • Optional applicationArgs?: Uint8Array[]
      • applicationId: number | bigint
      • Optional approvalProgram?: string | Uint8Array
      • Optional boxReferences?: indexerModels.BoxReference[]
      • Optional clearStateProgram?: string | Uint8Array
      • Optional extraProgramPages?: number | bigint
      • Optional foreignApps?: (number | bigint)[]
      • Optional foreignAssets?: (number | bigint)[]
      • Optional globalStateSchema?: indexerModels.StateSchema
      • Optional localStateSchema?: indexerModels.StateSchema
      • Optional onCompletion?: string
      • Optional rejectVersion?: number | bigint

    Returns TransactionApplication

Properties

Optional accounts

accounts?: Address[]

(apat) List of accounts in addition to the sender that may be accessed from the application's approval-program and clear-state-program.

Optional applicationArgs

applicationArgs?: Uint8Array[]

(apaa) transaction specific arguments accessed from the application's approval-program and clear-state-program.

applicationId

applicationId: bigint

(apid) ID of the application being configured or empty if creating.

Optional approvalProgram

approvalProgram?: Uint8Array

(apap) Logic executed for every application transaction, except when on-completion is set to "clear". It can read and write global state for the application, as well as account-specific local state. Approval programs may reject the transaction.

Optional boxReferences

boxReferences?: indexerModels.BoxReference[]

(apbx) the boxes that can be accessed by this transaction (and others in the same group).

Optional clearStateProgram

clearStateProgram?: Uint8Array

(apsu) Logic executed for application transactions with on-completion set to "clear". It can read and write global state for the application, as well as account-specific local state. Clear state programs cannot reject the transaction.

Optional extraProgramPages

extraProgramPages?: number

(epp) specifies the additional app program len requested in pages.

Optional foreignApps

foreignApps?: bigint[]

(apfa) Lists the applications in addition to the application-id whose global states may be accessed by this application's approval-program and clear-state-program. The access is read-only.

Optional foreignAssets

foreignAssets?: bigint[]

(apas) lists the assets whose parameters may be accessed by this application's ApprovalProgram and ClearStateProgram. The access is read-only.

Optional globalStateSchema

globalStateSchema?: indexerModels.StateSchema

Represents a (apls) local-state or (apgs) global-state schema. These schemas determine how much storage may be used in a local-state or global-state for an application. The more space used, the larger minimum balance must be maintained in the account holding the data.

Optional localStateSchema

localStateSchema?: indexerModels.StateSchema

Represents a (apls) local-state or (apgs) global-state schema. These schemas determine how much storage may be used in a local-state or global-state for an application. The more space used, the larger minimum balance must be maintained in the account holding the data.

Optional onCompletion

onCompletion?: string

(apan) defines the what additional actions occur with the transaction. Valid types:

  • noop
  • optin
  • closeout
  • clear
  • update
  • update
  • delete

Optional rejectVersion

rejectVersion?: number

(aprv) the lowest application version for which this transaction should immediately fail. 0 indicates that no version check should be performed.

Static Private encodingSchemaValue

encodingSchemaValue: undefined | Schema

Accessors

Static encodingSchema

Methods

getEncodingSchema

toEncodingData

Static fromEncodingData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc