Class AppParams

AppParams stores the global information associated with an application

Implements

Constructors

  • Parameters

    • params: {
          approvalProgram: Uint8Array;
          clearStateProgram: Uint8Array;
          extraProgramPages: number;
          familyBoxAccess?: boolean;
          foreignBoxReads?: boolean;
          globalState: Map<Uint8Array, TealValue>;
          globalStateSchema: StateSchema;
          localStateSchema: StateSchema;
          sizeSponsor?: Address;
          version?: bigint;
      }
      • approvalProgram: Uint8Array
      • clearStateProgram: Uint8Array
      • extraProgramPages: number
      • Optional familyBoxAccess?: boolean
      • Optional foreignBoxReads?: boolean
      • globalState: Map<Uint8Array, TealValue>
      • globalStateSchema: StateSchema
      • localStateSchema: StateSchema
      • Optional sizeSponsor?: Address
      • Optional version?: bigint

    Returns AppParams

Properties

approvalProgram: Uint8Array
clearStateProgram: Uint8Array
extraProgramPages: number
familyBoxAccess: boolean

When true, apps with the same creator may read and write this app's boxes.

foreignBoxReads: boolean

When true, any app may read this app's boxes.

globalState: Map<Uint8Array, TealValue>
globalStateSchema: StateSchema
localStateSchema: StateSchema
sizeSponsor: Address

If non-zero, the account that must hold MBR for extra program pages and the global schema.

version: bigint
encodingSchema: NamedMapSchema = ...

Methods

  • Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

    Returns Map<string, unknown>

Generated using TypeDoc