Skip to content

PendingGroup

Constructors

new PendingGroup()

new PendingGroup(): PendingGroup

Returns

PendingGroup

Methods

addAppCall()

addAppCall(params): void

Parameters

params

params.accounts?: Address[]

params.applicationArgs?: BytesLike[]

params.applicationID?: AppID

params.applications?: AppID[]

params.approvalProgram?: BytesLike | BytesLike[]

params.assets?: AssetID[]

params.clearStateProgram?: BytesLike | BytesLike[]

params.extraProgramPages?: uint64

params.fee?: uint64

The fee paid for this transaction

params.globalNumByteSlice?: uint64

params.globalNumUint?: uint64

params.isFirstTxn?: boolean

params.localNumByteSlice?: uint64

params.localNumUint?: uint64

params.note?: string

The note field for this transaction

params.onCompletion?: OnCompletion

params.rekeyTo?: Address

If set, changes the authAddr of sender to the given address

params.sender?: Address

The sender of this transaction. This is the account that pays the fee (if non-zero)

Returns

void

Source

src/lib/contract.ts:24


addAssetConfig()

addAssetConfig(params): void

Parameters

params

params.configAsset: AssetID

params.configAssetClawback?: Address

params.configAssetFreeze?: Address

params.configAssetManager?: Address

params.configAssetReserve?: Address

params.fee?: uint64

The fee paid for this transaction

params.isFirstTxn?: boolean

params.note?: string

The note field for this transaction

params.rekeyTo?: Address

If set, changes the authAddr of sender to the given address

params.sender?: Address

The sender of this transaction. This is the account that pays the fee (if non-zero)

Returns

void

Source

src/lib/contract.ts:34


addAssetCreation()

addAssetCreation(params): void

Parameters

params

params.configAssetClawback?: Address

params.configAssetDecimals?: uint64

params.configAssetDefaultFrozen?: uint64

params.configAssetFreeze?: Address

params.configAssetManager?: Address

params.configAssetMetadataHash?: Brand<string, "bytes">

params.configAssetName?: Brand<string, "bytes">

params.configAssetReserve?: Address

params.configAssetTotal: uint64

params.configAssetURL?: Brand<string, "bytes">

params.configAssetUnitName?: Brand<string, "bytes">

params.fee?: uint64

The fee paid for this transaction

params.isFirstTxn?: boolean

params.note?: string

The note field for this transaction

params.rekeyTo?: Address

If set, changes the authAddr of sender to the given address

params.sender?: Address

The sender of this transaction. This is the account that pays the fee (if non-zero)

Returns

void

Source

src/lib/contract.ts:28


addAssetFreeze()

addAssetFreeze(params): void

Parameters

params

params.fee?: uint64

The fee paid for this transaction

params.freezeAsset: AssetID

params.freezeAssetAccount: Address

params.freezeAssetFrozen: boolean

params.isFirstTxn?: boolean

params.note?: string

The note field for this transaction

params.rekeyTo?: Address

If set, changes the authAddr of sender to the given address

params.sender?: Address

The sender of this transaction. This is the account that pays the fee (if non-zero)

Returns

void

Source

src/lib/contract.ts:36


addAssetTransfer()

addAssetTransfer(params): void

Parameters

params

params.assetAmount: uint64

The amount of the asset being transferred

params.assetCloseTo?: Address

The address to close the asset to

params.assetReceiver: Address

The receiver of the asset

params.assetSender?: Address

The clawback target

params.fee?: uint64

The fee paid for this transaction

params.isFirstTxn?: boolean

params.note?: string

The note field for this transaction

params.rekeyTo?: Address

If set, changes the authAddr of sender to the given address

params.sender?: Address

The sender of this transaction. This is the account that pays the fee (if non-zero)

params.xferAsset: AssetID

The asset being transfed

Returns

void

Source

src/lib/contract.ts:26


addMethodCall()

addMethodCall<ArgsType, ReturnType>(params): 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: Expand<AppParams & ArgsType extends Function ? Object : Object & Object>

The parameters of the method call

Returns

void

Source

src/lib/contract.ts:20


addOfflineKeyRegistration()

addOfflineKeyRegistration(params): void

Parameters

params

params.fee?: uint64

The fee paid for this transaction

params.isFirstTxn?: boolean

params.note?: string

The note field for this transaction

params.rekeyTo?: Address

If set, changes the authAddr of sender to the given address

params.sender?: Address

The sender of this transaction. This is the account that pays the fee (if non-zero)

Returns

void

Source

src/lib/contract.ts:32


addOnlineKeyRegistration()

addOnlineKeyRegistration(params): void

Parameters

params

params.fee?: uint64

The fee paid for this transaction

params.isFirstTxn?: boolean

params.note?: string

The note field for this transaction

params.rekeyTo?: Address

If set, changes the authAddr of sender to the given address

params.selectionPK: Brand<string, "bytes">

params.sender?: Address

The sender of this transaction. This is the account that pays the fee (if non-zero)

params.stateProofPK: Brand<string, "bytes">

params.voteFirst: uint64

params.voteKeyDilution: uint64

params.voteLast: uint64

params.votePK: Brand<string, "bytes">

Returns

void

Source

src/lib/contract.ts:30


addPayment()

addPayment(params): void

Parameters

params

params.amount?: uint64

The amount, in microALGO, to transfer

params.closeRemainderTo?: Address

If set, bring the sender balance to 0 and send all remaining balance to this address

params.fee?: uint64

The fee paid for this transaction

params.isFirstTxn?: boolean

params.note?: string

The note field for this transaction

params.receiver?: Address

The address of the receiver

params.rekeyTo?: Address

If set, changes the authAddr of sender to the given address

params.sender?: Address

The sender of this transaction. This is the account that pays the fee (if non-zero)

Returns

void

Source

src/lib/contract.ts:22


submit()

submit(): void

Returns

void

Source

src/lib/contract.ts:38