Class PendingGroup

Hierarchy

PendingGroup

Index

Constructors

Methods

addAppCall addAssetConfig addAssetCreation addAssetFreeze addAssetTransfer addMethodCall addOfflineKeyRegistration addOnlineKeyRegistration addPayment submit

Constructors

constructor

new PendingGroup(): PendingGroup
Returns PendingGroup

Methods

addAppCall

addAppCall(params: {
    accounts?: Address[];
    applicationArgs?: bytes[];
    applicationID?: Application;
    applications?: Application[];
    approvalProgram?: NewableFunction | bytes;
    assets?: Asset[];
    clearStateProgram?: bytes;
    extraProgramPages?: uint64;
    fee?: uint64;
    globalNumByteSlice?: uint64;
    globalNumUint?: uint64;
    localNumByteSlice?: uint64;
    localNumUint?: uint64;
    note?: string;
    onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication";
    rekeyTo?: Address;
    sender?: Address;
}): void
Parameters
- params: {
      accounts?: Address[];
      applicationArgs?: bytes[];
      applicationID?: Application;
      applications?: Application[];
      approvalProgram?: NewableFunction | bytes;
      assets?: Asset[];
      clearStateProgram?: bytes;
      extraProgramPages?: uint64;
      fee?: uint64;
      globalNumByteSlice?: uint64;
      globalNumUint?: uint64;
      localNumByteSlice?: uint64;
      localNumUint?: uint64;
      note?: string;
      onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication";
      rekeyTo?: Address;
      sender?: Address;
  }
  - Optional accounts?: Address[]
  - Optional applicationArgs?: bytes[]
  - Optional applicationID?: Application
  - Optional applications?: Application[]
  - Optional approvalProgram?: NewableFunction | bytes
  - Optional assets?: Asset[]
  - Optional clearStateProgram?: bytes
  - Optional extraProgramPages?: uint64
  - Optional fee?: uint64
  - Optional globalNumByteSlice?: uint64
  - Optional globalNumUint?: uint64
  - Optional localNumByteSlice?: uint64
  - Optional localNumUint?: uint64
  - Optional note?: string
  - Optional onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication"
  - Optional rekeyTo?: Address
  - Optional sender?: Address
Returns void
- Defined in src/lib/contract.ts:25

addAssetConfig

addAssetConfig(params: {
    configAsset: Asset;
    configAssetClawback?: Address;
    configAssetFreeze?: Address;
    configAssetManager?: Address;
    configAssetReserve?: Address;
    fee?: uint64;
    note?: string;
    rekeyTo?: Address;
    sender?: Address;
}): void
Parameters
- params: {
      configAsset: Asset;
      configAssetClawback?: Address;
      configAssetFreeze?: Address;
      configAssetManager?: Address;
      configAssetReserve?: Address;
      fee?: uint64;
      note?: string;
      rekeyTo?: Address;
      sender?: Address;
  }
  - configAsset: Asset
  - Optional configAssetClawback?: Address
  - Optional configAssetFreeze?: Address
  - Optional configAssetManager?: Address
  - Optional configAssetReserve?: Address
  - Optional fee?: uint64
  - Optional note?: string
  - Optional rekeyTo?: Address
  - Optional sender?: Address
Returns void
- Defined in src/lib/contract.ts:35

addAssetCreation

addAssetCreation(params: {
    configAssetClawback?: Address;
    configAssetDecimals?: uint64;
    configAssetDefaultFrozen?: uint64;
    configAssetFreeze?: Address;
    configAssetManager?: Address;
    configAssetMetadataHash?: bytes;
    configAssetName?: bytes;
    configAssetReserve?: Address;
    configAssetTotal: uint64;
    configAssetURL?: bytes;
    configAssetUnitName?: bytes;
    fee?: uint64;
    note?: string;
    rekeyTo?: Address;
    sender?: Address;
}): void
Parameters
- params: {
      configAssetClawback?: Address;
      configAssetDecimals?: uint64;
      configAssetDefaultFrozen?: uint64;
      configAssetFreeze?: Address;
      configAssetManager?: Address;
      configAssetMetadataHash?: bytes;
      configAssetName?: bytes;
      configAssetReserve?: Address;
      configAssetTotal: uint64;
      configAssetURL?: bytes;
      configAssetUnitName?: bytes;
      fee?: uint64;
      note?: string;
      rekeyTo?: Address;
      sender?: 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
  - configAssetTotal: uint64
  - Optional configAssetURL?: bytes
  - Optional configAssetUnitName?: bytes
  - Optional fee?: uint64
  - Optional note?: string
  - Optional rekeyTo?: Address
  - Optional sender?: Address
Returns void
- Defined in src/lib/contract.ts:29

addAssetFreeze

addAssetFreeze(params: {
    fee?: uint64;
    freezeAsset: Asset;
    freezeAssetAccount: Address;
    freezeAssetFrozen: boolean;
    note?: string;
    rekeyTo?: Address;
    sender?: Address;
}): void
Parameters
- params: {
      fee?: uint64;
      freezeAsset: Asset;
      freezeAssetAccount: Address;
      freezeAssetFrozen: boolean;
      note?: string;
      rekeyTo?: Address;
      sender?: Address;
  }
  - Optional fee?: uint64
  - freezeAsset: Asset
  - freezeAssetAccount: Address
  - freezeAssetFrozen: boolean
  - Optional note?: string
  - Optional rekeyTo?: Address
  - Optional sender?: Address
Returns void
- Defined in src/lib/contract.ts:37

addAssetTransfer

addAssetTransfer(params: {
    assetAmount: uint64;
    assetCloseTo?: Address;
    assetReceiver: Address;
    assetSender?: Address;
    fee?: uint64;
    note?: string;
    rekeyTo?: Address;
    sender?: Address;
    xferAsset: Asset;
}): void
Parameters
- params: {
      assetAmount: uint64;
      assetCloseTo?: Address;
      assetReceiver: Address;
      assetSender?: Address;
      fee?: uint64;
      note?: string;
      rekeyTo?: Address;
      sender?: Address;
      xferAsset: Asset;
  }
  - assetAmount: uint64
  - Optional assetCloseTo?: Address
  - assetReceiver: Address
  - Optional assetSender?: Address
  - Optional fee?: uint64
  - Optional note?: string
  - Optional rekeyTo?: Address
  - Optional sender?: Address
  - xferAsset: Asset
Returns void
- Defined in src/lib/contract.ts:27

addMethodCall

addMethodCall<ArgsType, ReturnType>(params: {
    accounts?: Address[];
    applicationArgs?: bytes[];
    applicationID?: Application;
    applications?: Application[];
    approvalProgram?: NewableFunction | bytes;
    assets?: Asset[];
    clearStateProgram?: bytes;
    extraProgramPages?: uint64;
    fee?: uint64;
    globalNumByteSlice?: uint64;
    globalNumUint?: uint64;
    localNumByteSlice?: uint64;
    localNumUint?: uint64;
    methodArgs?: ArgsType;
    name: string;
    note?: string;
    onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication";
    rekeyTo?: Address;
    sender?: Address;
}): void
Adds ABI method to the pending transaction group. The two type arguments in combination with the name argument are used to form the the method signature to ensure typesafety.
Type Parameters
- ArgsType
  
  A tuple type corresponding to the types of the method arguments
- ReturnType
  
  The return type of the method
Parameters
- params: {
      accounts?: Address[];
      applicationArgs?: bytes[];
      applicationID?: Application;
      applications?: Application[];
      approvalProgram?: NewableFunction | bytes;
      assets?: Asset[];
      clearStateProgram?: bytes;
      extraProgramPages?: uint64;
      fee?: uint64;
      globalNumByteSlice?: uint64;
      globalNumUint?: uint64;
      localNumByteSlice?: uint64;
      localNumUint?: uint64;
      methodArgs?: ArgsType;
      name: string;
      note?: string;
      onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication";
      rekeyTo?: Address;
      sender?: Address;
  }
  
  The parameters of the method call
  - Optional accounts?: Address[]
  - Optional applicationArgs?: bytes[]
  - Optional applicationID?: Application
  - Optional applications?: Application[]
  - Optional approvalProgram?: NewableFunction | bytes
  - Optional assets?: Asset[]
  - Optional clearStateProgram?: bytes
  - Optional extraProgramPages?: uint64
  - Optional fee?: uint64
  - Optional globalNumByteSlice?: uint64
  - Optional globalNumUint?: uint64
  - Optional localNumByteSlice?: uint64
  - Optional localNumUint?: uint64
  - Optional methodArgs?: ArgsType
    
    ABI method arguments
  - name: string
    
    Name of the ABI method
  - Optional note?: string
  - Optional onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication"
  - Optional rekeyTo?: Address
  - Optional sender?: Address
Returns void
- Defined in src/lib/contract.ts:19

addOfflineKeyRegistration

addOfflineKeyRegistration(params: {
    fee?: uint64;
    note?: string;
    rekeyTo?: Address;
    sender?: Address;
}): void
Parameters
- params: {
      fee?: uint64;
      note?: string;
      rekeyTo?: Address;
      sender?: Address;
  }
  - Optional fee?: uint64
  - Optional note?: string
  - Optional rekeyTo?: Address
  - Optional sender?: Address
Returns void
- Defined in src/lib/contract.ts:33

addOnlineKeyRegistration

addOnlineKeyRegistration(params: {
    fee?: uint64;
    note?: string;
    rekeyTo?: Address;
    selectionPK: bytes;
    sender?: Address;
    stateProofPK: bytes;
    voteFirst: uint64;
    voteKeyDilution: uint64;
    voteLast: uint64;
    votePK: bytes;
}): void
Parameters
- params: {
      fee?: uint64;
      note?: string;
      rekeyTo?: Address;
      selectionPK: bytes;
      sender?: Address;
      stateProofPK: bytes;
      voteFirst: uint64;
      voteKeyDilution: uint64;
      voteLast: uint64;
      votePK: bytes;
  }
  - Optional fee?: uint64
  - Optional note?: string
  - Optional rekeyTo?: Address
  - selectionPK: bytes
  - Optional sender?: Address
  - stateProofPK: bytes
  - voteFirst: uint64
  - voteKeyDilution: uint64
  - voteLast: uint64
  - votePK: bytes
Returns void
- Defined in src/lib/contract.ts:31

addPayment

addPayment(params: {
    amount: uint64;
    closeRemainderTo?: Address;
    fee?: uint64;
    note?: string;
    receiver: Address;
    rekeyTo?: Address;
    sender?: Address;
}): void
Parameters
- params: {
      amount: uint64;
      closeRemainderTo?: Address;
      fee?: uint64;
      note?: string;
      receiver: Address;
      rekeyTo?: Address;
      sender?: Address;
  }
  - amount: uint64
  - Optional closeRemainderTo?: Address
  - Optional fee?: uint64
  - Optional note?: string
  - receiver: Address
  - Optional rekeyTo?: Address
  - Optional sender?: Address
Returns void
- Defined in src/lib/contract.ts:23

submit

submit(): void
Returns void
- Defined in src/lib/contract.ts:39

Class PendingGroup

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns PendingGroup

Methods

addAppCall

Parameters

Optional accounts?: Address[]

Optional applicationArgs?: bytes[]

Optional applicationID?: Application

Optional applications?: Application[]

Optional approvalProgram?: NewableFunction | bytes

Optional assets?: Asset[]

Optional clearStateProgram?: bytes

Optional extraProgramPages?: uint64

Optional fee?: uint64

Optional globalNumByteSlice?: uint64

Optional globalNumUint?: uint64

Optional localNumByteSlice?: uint64

Optional localNumUint?: uint64

Optional note?: string

Optional onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication"

Optional rekeyTo?: Address

Optional sender?: Address

Returns void

addAssetConfig

Parameters

params: { configAsset: Asset; configAssetClawback?: Address; configAssetFreeze?: Address; configAssetManager?: Address; configAssetReserve?: Address; fee?: uint64; note?: string; rekeyTo?: Address; sender?: Address; }

configAsset: Asset

Optional configAssetClawback?: Address

Optional configAssetFreeze?: Address

Optional configAssetManager?: Address

Optional configAssetReserve?: Address

Optional fee?: uint64

Optional note?: string

Optional rekeyTo?: Address

Optional sender?: Address

Returns void

addAssetCreation

Parameters

Optional configAssetClawback?: Address

Optional configAssetDecimals?: uint64

Optional configAssetDefaultFrozen?: uint64

Optional configAssetFreeze?: Address

Optional configAssetManager?: Address

Optional configAssetMetadataHash?: bytes

Optional configAssetName?: bytes

Optional configAssetReserve?: Address

configAssetTotal: uint64

Optional configAssetURL?: bytes

Optional configAssetUnitName?: bytes

Optional fee?: uint64

Optional note?: string

Optional rekeyTo?: Address

Optional sender?: Address

Returns void

addAssetFreeze

Parameters

params: { fee?: uint64; freezeAsset: Asset; freezeAssetAccount: Address; freezeAssetFrozen: boolean; note?: string; rekeyTo?: Address; sender?: Address; }

Optional fee?: uint64

freezeAsset: Asset

freezeAssetAccount: Address

freezeAssetFrozen: boolean

Optional note?: string

Optional rekeyTo?: Address

Optional sender?: Address

Returns void

addAssetTransfer

Parameters

params: { assetAmount: uint64; assetCloseTo?: Address; assetReceiver: Address; assetSender?: Address; fee?: uint64; note?: string; rekeyTo?: Address; sender?: Address; xferAsset: Asset; }

assetAmount: uint64

Optional assetCloseTo?: Address

assetReceiver: Address

Optional assetSender?: Address

Optional fee?: uint64

Optional note?: string

`Optional` accounts?: Address[]

`Optional` applicationArgs?: bytes[]

`Optional` applicationID?: Application

`Optional` applications?: Application[]

`Optional` approvalProgram?: NewableFunction | bytes

`Optional` assets?: Asset[]

`Optional` clearStateProgram?: bytes

`Optional` extraProgramPages?: uint64

`Optional` fee?: uint64

`Optional` globalNumByteSlice?: uint64

`Optional` globalNumUint?: uint64

`Optional` localNumByteSlice?: uint64

`Optional` localNumUint?: uint64

`Optional` note?: string

`Optional` onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication"

`Optional` rekeyTo?: Address

`Optional` sender?: Address

params: {
configAsset: Asset;
configAssetClawback?: Address;
configAssetFreeze?: Address;
configAssetManager?: Address;
configAssetReserve?: Address;
fee?: uint64;
note?: string;
rekeyTo?: Address;
sender?: Address;
}

`Optional` configAssetClawback?: Address

`Optional` configAssetFreeze?: Address

`Optional` configAssetManager?: Address

`Optional` configAssetReserve?: Address

`Optional` fee?: uint64

`Optional` note?: string

`Optional` rekeyTo?: Address

`Optional` sender?: 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` configAssetURL?: bytes

`Optional` configAssetUnitName?: bytes

`Optional` fee?: uint64

`Optional` note?: string

`Optional` rekeyTo?: Address

`Optional` sender?: Address

params: {
fee?: uint64;
freezeAsset: Asset;
freezeAssetAccount: Address;
freezeAssetFrozen: boolean;
note?: string;
rekeyTo?: Address;
sender?: Address;
}

`Optional` fee?: uint64

`Optional` note?: string

`Optional` rekeyTo?: Address

`Optional` sender?: Address

params: {
assetAmount: uint64;
assetCloseTo?: Address;
assetReceiver: Address;
assetSender?: Address;
fee?: uint64;
note?: string;
rekeyTo?: Address;
sender?: Address;
xferAsset: Asset;
}

`Optional` assetCloseTo?: Address

`Optional` assetSender?: Address

`Optional` fee?: uint64

`Optional` note?: string

`Optional` rekeyTo?: Address

`Optional` sender?: Address

`Optional` accounts?: Address[]

`Optional` applicationArgs?: bytes[]

`Optional` applicationID?: Application

`Optional` applications?: Application[]

`Optional` approvalProgram?: NewableFunction | bytes

`Optional` assets?: Asset[]

`Optional` clearStateProgram?: bytes

`Optional` extraProgramPages?: uint64

`Optional` fee?: uint64

`Optional` globalNumByteSlice?: uint64

`Optional` globalNumUint?: uint64

`Optional` localNumByteSlice?: uint64

`Optional` localNumUint?: uint64

`Optional` methodArgs?: ArgsType

`Optional` note?: string

`Optional` onCompletion?: "NoOp" | "OptIn" | "CloseOut" | "ClearState" | "UpdateApplication" | "DeleteApplication" | "CreateApplication"

`Optional` rekeyTo?: Address

`Optional` sender?: Address

params: {
fee?: uint64;
note?: string;
rekeyTo?: Address;
sender?: Address;
}

`Optional` fee?: uint64

`Optional` note?: string

`Optional` rekeyTo?: Address

`Optional` sender?: Address

params: {
fee?: uint64;
note?: string;
rekeyTo?: Address;
selectionPK: bytes;
sender?: Address;
stateProofPK: bytes;
voteFirst: uint64;
voteKeyDilution: uint64;
voteLast: uint64;
votePK: bytes;
}

`Optional` fee?: uint64

`Optional` note?: string

`Optional` rekeyTo?: Address

`Optional` sender?: Address