Class ContractAbstract

Hierarchy

  • Contract

Constructors

constructor

Properties

app itxn pendingGroup txn txnGroup

Methods

clearState closeOutOfApplication createApplication deleteApplication optInToApplication updateApplication

Constructors

constructor

Properties

app

app: Application

itxn

itxn: {
    accounts?: Address[];
    amount?: uint64;
    applicationArgs?: bytes[];
    applicationID: Application;
    applications?: Application[];
    approvalProgram?: NewableFunction | bytes;
    assetAmount?: uint64;
    assetCloseTo?: Address;
    assetReceiver?: Address;
    assetSender?: Address;
    assets?: Asset[];
    clearStateProgram?: bytes;
    closeRemainderTo?: Address;
    configAssetClawback?: Address;
    configAssetDecimals?: uint64;
    configAssetDefaultFrozen?: uint64;
    configAssetFreeze?: Address;
    configAssetManager?: Address;
    configAssetMetadataHash?: bytes;
    configAssetName?: bytes;
    configAssetReserve?: Address;
    configAssetTotal?: uint64;
    configAssetURL?: bytes;
    configAssetUnitName?: bytes;
    createdApplicationID: Application;
    createdAssetID: Asset;
    extraProgramPages?: uint64;
    fee: Object;
    globalNumByteSlice?: uint64;
    globalNumUint?: uint64;
    groupIndex: uint64;
    lastLog: bytes;
    localNumByteSlice?: uint64;
    localNumUint?: uint64;
    note: string;
    numAccounts: uint64;
    numAppArgs: uint64;
    numApplicatons: uint64;
    numApprovalProgrammPages: uint64;
    numAssets: uint64;
    numClearStateProgramPages: uint64;
    numLogs: uint64;
    onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication";
    receiver?: Address;
    rekeyTo: Address;
    sender: Address;
    txID: string;
    xferAsset?: Asset;
}

Type declaration

  • Optional accounts?: Address[]
  • Optional amount?: uint64
  • Optional applicationArgs?: bytes[]
  • applicationID: Application
  • Optional applications?: Application[]
  • Optional approvalProgram?: NewableFunction | bytes
  • Optional assetAmount?: uint64
  • Optional assetCloseTo?: Address
  • Optional assetReceiver?: Address
  • Optional assetSender?: Address
  • Optional assets?: Asset[]
  • Optional clearStateProgram?: bytes
  • Optional closeRemainderTo?: Address
  • Optional configAssetClawback?: Address
  • Optional configAssetDecimals?: uint64
  • Optional configAssetDefaultFrozen?: uint64
  • Optional configAssetFreeze?: Address
  • Optional configAssetManager?: Address
  • Optional configAssetMetadataHash?: bytes
  • Optional configAssetName?: bytes
  • Optional configAssetReserve?: Address
  • Optional configAssetTotal?: uint64
  • Optional configAssetURL?: bytes
  • Optional configAssetUnitName?: bytes
  • createdApplicationID: Application
  • createdAssetID: Asset
  • Optional extraProgramPages?: uint64
  • fee: Object
  • Optional globalNumByteSlice?: uint64
  • Optional globalNumUint?: uint64
  • groupIndex: uint64
  • lastLog: bytes
  • Optional localNumByteSlice?: uint64
  • Optional localNumUint?: uint64
  • note: string
  • numAccounts: uint64
  • numAppArgs: uint64
  • numApplicatons: uint64
  • numApprovalProgrammPages: uint64
  • numAssets: uint64
  • numClearStateProgramPages: uint64
  • numLogs: uint64
  • Optional onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication"
  • Optional receiver?: Address
  • rekeyTo: Address
  • sender: Address
  • txID: string
  • Optional xferAsset?: Asset

pendingGroup

pendingGroup: PendingGroup

txn

txn: {
    accounts?: Address[];
    applicationArgs?: bytes[];
    applicationID: Application;
    applications?: Application[];
    approvalProgram?: NewableFunction | bytes;
    assets?: Asset[];
    clearStateProgram?: bytes;
    createdApplicationID: Application;
    createdAssetID: Asset;
    extraProgramPages?: uint64;
    fee: Object;
    globalNumByteSlice?: uint64;
    globalNumUint?: uint64;
    groupIndex: uint64;
    lastLog: bytes;
    localNumByteSlice?: uint64;
    localNumUint?: uint64;
    note: string;
    numAccounts: uint64;
    numAppArgs: uint64;
    numApplicatons: uint64;
    numApprovalProgrammPages: uint64;
    numAssets: uint64;
    numClearStateProgramPages: uint64;
    numLogs: uint64;
    onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication";
    rekeyTo: Address;
    sender: Address;
    txID: string;
}

Type declaration

  • Optional accounts?: Address[]
  • Optional applicationArgs?: bytes[]
  • applicationID: Application
  • Optional applications?: Application[]
  • Optional approvalProgram?: NewableFunction | bytes
  • Optional assets?: Asset[]
  • Optional clearStateProgram?: bytes
  • createdApplicationID: Application
  • createdAssetID: Asset
  • Optional extraProgramPages?: uint64
  • fee: Object
  • Optional globalNumByteSlice?: uint64
  • Optional globalNumUint?: uint64
  • groupIndex: uint64
  • lastLog: bytes
  • Optional localNumByteSlice?: uint64
  • Optional localNumUint?: uint64
  • note: string
  • numAccounts: uint64
  • numAppArgs: uint64
  • numApplicatons: uint64
  • numApprovalProgrammPages: uint64
  • numAssets: uint64
  • numClearStateProgramPages: uint64
  • numLogs: uint64
  • Optional onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication"
  • rekeyTo: Address
  • sender: Address
  • txID: string

txnGroup

txnGroup: Txn[]

Methods

clearState

  • The method called when an account clears their local state. The default ClearState method does nothing. ClearState will always allow a user to delete their local state, reagrdless of logic.

    Returns void

closeOutOfApplication

  • The method called when an account closes out their local state. The default close-out method will always throw an error

    Parameters

    • Rest ...args: any[]

    Returns void

createApplication

  • The method called when creating the application. The default create method will allow the contract to be created via a bare NoOp appcall and throw an error if called with any arguments.

    Parameters

    • Rest ...args: any[]

    Returns void

deleteApplication

  • The method called when attempting to delete the application. The default delete method will always throw an error

    Parameters

    • Rest ...args: any[]

    Returns void

optInToApplication

  • The method called when an account opts-in to the application. The default opt-in method will always throw an error

    Parameters

    • Rest ...args: any[]

    Returns void

updateApplication

  • The method called when attempting to update the application. The default update method will always throw an error

    Parameters

    • Rest ...args: any[]

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc