AlgorandClientTransactionCreator

Access references unifies accountReferences, appReferences, assetReferences, and boxReferences under a single list. If non-empty, these other reference lists must be empty. If access is empty, those other reference lists may be non-empty.

accountReferences?

Any account addresses to add to the accounts array.

appId

bigint

ID of the application; 0 if the application is being created.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

args?

(Transaction | ABIValue | Promise<Transaction> | TransactionWithSigner | AppMethodCall<{ accessReferences?: ResourceReference[]; accountReferences?: ReadableAddress[]; appId?: 0; appReferences?: bigint[]; approvalProgram: string | Uint8Array<ArrayBufferLike>; args?: Uint8Array<ArrayBufferLike>[]; assetReferences?: bigint[]; boxReferences?: BoxIdentifier | BoxReference[]; clearStateProgram: string | Uint8Array<ArrayBufferLike>; extraFee?: AlgoAmount; extraProgramPages?: number; firstValidRound?: bigint; lastValidRound?: bigint; lease?: string | Uint8Array<ArrayBufferLike>; maxFee?: AlgoAmount; note?: string | Uint8Array<ArrayBufferLike>; onComplete?: NoOp | OptIn | CloseOut | UpdateApplication | DeleteApplication; rejectVersion?: number; rekeyTo?: ReadableAddress | undefined; schema?: { globalByteSlices: number; globalInts: number; localByteSlices: number; localInts: number; }; sender: SendingAddress; signer?: AddressWithTransactionSigner | TransactionSigner; staticFee?: AlgoAmount; validityWindow?: number | bigint; }> | AppMethodCall<{ accessReferences?: ResourceReference[]; accountReferences?: ReadableAddress[]; appId: bigint; appReferences?: bigint[]; approvalProgram: string | Uint8Array<ArrayBufferLike>; args?: Uint8Array<ArrayBufferLike>[]; assetReferences?: bigint[]; boxReferences?: BoxIdentifier | BoxReference[]; clearStateProgram: string | Uint8Array<ArrayBufferLike>; extraFee?: AlgoAmount; firstValidRound?: bigint; lastValidRound?: bigint; lease?: string | Uint8Array<ArrayBufferLike>; maxFee?: AlgoAmount; note?: string | Uint8Array<ArrayBufferLike>; onComplete?: UpdateApplication; rejectVersion?: number; rekeyTo?: ReadableAddress | undefined; sender: SendingAddress; signer?: AddressWithTransactionSigner | TransactionSigner; staticFee?: AlgoAmount; validityWindow?: number | bigint; }> | AppMethodCall<AppMethodCallParams> | undefined)[]

Arguments to the ABI method, either:

An ABI value
A transaction with explicit signer
A transaction (where the signer will be automatically assigned)
An unawaited transaction (e.g. from algorand.createTransaction.{transactionType}())
Another method call (via method call params object)
undefined (this represents a placeholder transaction argument that is fulfilled by another method call argument)

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

extraFee?

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

method

The ABI method to call

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

onComplete?

NoOp | OptIn | CloseOut | DeleteApplication

The on-complete action of the call; defaults to no-op.

rejectVersion?

number

If set, the transaction will be rejected when the app’s version is greater than or equal to this value. This can be used to prevent calling an app after it has been updated. Set to 0 or leave undefined to skip the version check.

rekeyTo?

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender

AddressWithTransactionSigner | TransactionSigner

The address sending the transaction, optionally with an attached signer.

signer?

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

The application ABI method call transaction

Examples

const method = new ABIMethod({
  name: 'method',
  args: [{ name: 'arg1', type: 'string' }],
  returns: { type: 'string' },
})
await algorand.createTransaction.appCallMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] })

const method = new ABIMethod({
  name: 'method',
  args: [{ name: 'arg1', type: 'string' }],
  returns: { type: 'string' },
})
await algorand.createTransaction.appCallMethodCall({
 sender: 'CREATORADDRESS',
 method: method,
 args: ["arg1_value"],
 onComplete: OnApplicationComplete.OptIn,
 args: [new Uint8Array(1, 2, 3, 4)]
 accountReferences: ["ACCOUNT_1"]
 appReferences: [123n, 1234n]
 assetReferences: [12345n]
 boxReferences: ["box1", {appId: 1234n, name: "box2"}]
 accessReferences: [{ appId: 1234n }]
 lease: 'lease',
 note: 'note',
 // You wouldn't normally set this field
 firstValidRound: 1000n,
 validityWindow: 10,
 extraFee: (1000).microAlgo(),
 staticFee: (1000).microAlgo(),
 // Max fee doesn't make sense with extraFee AND staticFee
 //  already specified, but here for completeness
 maxFee: (3000).microAlgo(),
 rejectVersion: 1,
})

appCreate()

appCreate: (params) => Promise<Transaction>

Defined in: src/algorand-client-transaction-creator.ts:354

Create an application create transaction.

Note: you may prefer to use algorand.client to get an app client for more advanced functionality.

Parameters

params

The parameters for the app creation transaction

accessReferences?

accountReferences?

Any account addresses to add to the accounts array.

appId?

0

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

approvalProgram

string | Uint8Array<ArrayBufferLike>

The program to execute for all OnCompletes other than ClearState as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)).

args?

Uint8Array<ArrayBufferLike>[]

Any arguments to pass to the smart contract call.

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

clearStateProgram

string | Uint8Array<ArrayBufferLike>

The program to execute for ClearState OnComplete as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)).

extraFee?

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

extraProgramPages?

number

Number of extra pages required for the programs. Defaults to the number needed for the programs in this call if not specified. This is immutable once the app is created.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

onComplete?

NoOp | OptIn | CloseOut | UpdateApplication | DeleteApplication

The on-complete action of the call; defaults to no-op.

rejectVersion?

number

rekeyTo?

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

schema?

{ globalByteSlices: number; globalInts: number; localByteSlices: number; localInts: number; }

The state schema for the app. This is immutable once the app is created.

schema.globalByteSlices

number

The number of byte slices saved in global state.

schema.globalInts

number

The number of integers saved in global state.

schema.localByteSlices

number

The number of byte slices saved in local state.

schema.localInts

number

The number of integers saved in local state.

sender

AddressWithTransactionSigner | TransactionSigner

The address sending the transaction, optionally with an attached signer.

signer?

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

Promise<Transaction>

The application create transaction

Examples

await algorand.createTransaction.appCreate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' })

await algorand.createTransaction.appCreate({
 sender: 'CREATORADDRESS',
 approvalProgram: "TEALCODE",
 clearStateProgram: "TEALCODE",
 schema: {
   globalInts: 1,
   globalByteSlices: 2,
   localInts: 3,
   localByteSlices: 4
 },
 extraProgramPages: 1,
 onComplete: OnApplicationComplete.OptIn,
 args: [new Uint8Array(1, 2, 3, 4)]
 accountReferences: ["ACCOUNT_1"]
 appReferences: [123n, 1234n]
 assetReferences: [12345n]
 boxReferences: ["box1", {appId: 1234n, name: "box2"}]
 accessReferences: [{ appId: 1234n }]
 lease: 'lease',
 note: 'note',
 // You wouldn't normally set this field
 firstValidRound: 1000n,
 validityWindow: 10,
 extraFee: (1000).microAlgo(),
 staticFee: (1000).microAlgo(),
 // Max fee doesn't make sense with extraFee AND staticFee
 //  already specified, but here for completeness
 maxFee: (3000).microAlgo(),
 rejectVersion: 1,
})

appCreateMethodCall()

appCreateMethodCall: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Defined in: src/algorand-client-transaction-creator.ts:521

Create an application create call with ABI method call transaction.

Note: you may prefer to use algorand.client to get an app client for more advanced functionality.

Parameters

params

The parameters for the app creation transaction

accessReferences?

accountReferences?

Any account addresses to add to the accounts array.

appId?

0

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

approvalProgram

string | Uint8Array<ArrayBufferLike>

The program to execute for all OnCompletes other than ClearState as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)).

args?

Arguments to the ABI method, either:

An ABI value
A transaction with explicit signer
A transaction (where the signer will be automatically assigned)
An unawaited transaction (e.g. from algorand.createTransaction.{transactionType}())
Another method call (via method call params object)
undefined (this represents a placeholder transaction argument that is fulfilled by another method call argument)

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

clearStateProgram

string | Uint8Array<ArrayBufferLike>

The program to execute for ClearState OnComplete as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)).

extraFee?

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

extraProgramPages?

number

Number of extra pages required for the programs. Defaults to the number needed for the programs in this call if not specified. This is immutable once the app is created.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

method

The ABI method to call

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

onComplete?

NoOp | OptIn | CloseOut | UpdateApplication | DeleteApplication

The on-complete action of the call; defaults to no-op.

rejectVersion?

number

rekeyTo?

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

schema?

{ globalByteSlices: number; globalInts: number; localByteSlices: number; localInts: number; }

The state schema for the app. This is immutable once the app is created.

schema.globalByteSlices

number

The number of byte slices saved in global state.

schema.globalInts

number

The number of integers saved in global state.

schema.localByteSlices

number

The number of byte slices saved in local state.

schema.localInts

number

The number of integers saved in local state.

sender

AddressWithTransactionSigner | TransactionSigner

The address sending the transaction, optionally with an attached signer.

signer?

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

The application ABI method create transaction

Examples

const method = new ABIMethod({
  name: 'method',
  args: [{ name: 'arg1', type: 'string' }],
  returns: { type: 'string' },
})
await algorand.createTransaction.appCreateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] })

const method = new ABIMethod({
  name: 'method',
  args: [{ name: 'arg1', type: 'string' }],
  returns: { type: 'string' },
})
await algorand.createTransaction.appCreateMethodCall({
 sender: 'CREATORADDRESS',
 method: method,
 args: ["arg1_value"],
 approvalProgram: "TEALCODE",
 clearStateProgram: "TEALCODE",
 schema: {
   globalInts: 1,
   globalByteSlices: 2,
   localInts: 3,
   localByteSlices: 4
 },
 extraProgramPages: 1,
 onComplete: OnApplicationComplete.OptIn,
 args: [new Uint8Array(1, 2, 3, 4)]
 accountReferences: ["ACCOUNT_1"]
 appReferences: [123n, 1234n]
 assetReferences: [12345n]
 boxReferences: ["box1", {appId: 1234n, name: "box2"}]
 accessReferences: [{ appId: 1234n }]
 lease: 'lease',
 note: 'note',
 // You wouldn't normally set this field
 firstValidRound: 1000n,
 validityWindow: 10,
 extraFee: (1000).microAlgo(),
 staticFee: (1000).microAlgo(),
 // Max fee doesn't make sense with extraFee AND staticFee
 //  already specified, but here for completeness
 maxFee: (3000).microAlgo(),
 rejectVersion: 1,
})

appDelete()

appDelete: (params) => Promise<Transaction>

Defined in: src/algorand-client-transaction-creator.ts:428

Create an application delete transaction.

Note: you may prefer to use algorand.client to get an app client for more advanced functionality.

Parameters

params

AppDeleteParams

The parameters for the app deletion transaction

Returns

Promise<Transaction>

The application delete transaction

Examples

await algorand.createTransaction.appDelete({ sender: 'CREATORADDRESS' })

await algorand.createTransaction.appDelete({
 sender: 'CREATORADDRESS',
 onComplete: OnApplicationComplete.DeleteApplication,
 args: [new Uint8Array(1, 2, 3, 4)]
 accountReferences: ["ACCOUNT_1"]
 appReferences: [123n, 1234n]
 assetReferences: [12345n]
 boxReferences: ["box1", {appId: 1234n, name: "box2"}]
 accessReferences: [{ appId: 1234n }]
 lease: 'lease',
 note: 'note',
 // You wouldn't normally set this field
 firstValidRound: 1000n,
 validityWindow: 10,
 extraFee: (1000).microAlgo(),
 staticFee: (1000).microAlgo(),
 // Max fee doesn't make sense with extraFee AND staticFee
 //  already specified, but here for completeness
 maxFee: (3000).microAlgo(),
 rejectVersion: 1,
})

appDeleteMethodCall()

appDeleteMethodCall: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Defined in: src/algorand-client-transaction-creator.ts:619

Create an application delete call with ABI method call transaction.

Note: you may prefer to use algorand.client to get an app client for more advanced functionality.

Parameters

params

The parameters for the app deletion transaction

accessReferences?

accountReferences?

Any account addresses to add to the accounts array.

appId

bigint

ID of the application; 0 if the application is being created.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

args?

Arguments to the ABI method, either:

An ABI value
A transaction with explicit signer
A transaction (where the signer will be automatically assigned)
An unawaited transaction (e.g. from algorand.createTransaction.{transactionType}())
Another method call (via method call params object)
undefined (this represents a placeholder transaction argument that is fulfilled by another method call argument)

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

extraFee?

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

method

The ABI method to call

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

onComplete?

DeleteApplication

The on-complete action of the call; defaults to no-op.

rejectVersion?

number

rekeyTo?

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender

AddressWithTransactionSigner | TransactionSigner

The address sending the transaction, optionally with an attached signer.

signer?

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

The application ABI method delete transaction

Examples

const method = new ABIMethod({
  name: 'method',
  args: [{ name: 'arg1', type: 'string' }],
  returns: { type: 'string' },
})
await algorand.createTransaction.appDeleteMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] })

const method = new ABIMethod({
  name: 'method',
  args: [{ name: 'arg1', type: 'string' }],
  returns: { type: 'string' },
})
await algorand.createTransaction.appDeleteMethodCall({
 sender: 'CREATORADDRESS',
 method: method,
 args: ["arg1_value"],
 onComplete: OnApplicationComplete.DeleteApplication,
 args: [new Uint8Array(1, 2, 3, 4)]
 accountReferences: ["ACCOUNT_1"]
 appReferences: [123n, 1234n]
 assetReferences: [12345n]
 boxReferences: ["box1", {appId: 1234n, name: "box2"}]
 accessReferences: [{ appId: 1234n }]
 lease: 'lease',
 note: 'note',
 // You wouldn't normally set this field
 firstValidRound: 1000n,
 validityWindow: 10,
 extraFee: (1000).microAlgo(),
 staticFee: (1000).microAlgo(),
 // Max fee doesn't make sense with extraFee AND staticFee
 //  already specified, but here for completeness
 maxFee: (3000).microAlgo(),
 rejectVersion: 1,
})

appUpdate()

appUpdate: (params) => Promise<Transaction>

Defined in: src/algorand-client-transaction-creator.ts:392

Create an application update transaction.

Note: you may prefer to use algorand.client to get an app client for more advanced functionality.

Parameters

params

The parameters for the app update transaction

accessReferences?

accountReferences?

Any account addresses to add to the accounts array.

appId

bigint

ID of the application; 0 if the application is being created.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

approvalProgram

string | Uint8Array<ArrayBufferLike>

The program to execute for all OnCompletes other than ClearState as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array))

args?

Uint8Array<ArrayBufferLike>[]

Any arguments to pass to the smart contract call.

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

clearStateProgram

string | Uint8Array<ArrayBufferLike>

The program to execute for ClearState OnComplete as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array))

extraFee?

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

onComplete?

UpdateApplication

The on-complete action of the call; defaults to no-op.

rejectVersion?

number

rekeyTo?

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender

AddressWithTransactionSigner | TransactionSigner

The address sending the transaction, optionally with an attached signer.

signer?

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

Promise<Transaction>

The application update transaction

Examples

await algorand.createTransaction.appUpdate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' })

await algorand.createTransaction.appUpdate({
 sender: 'CREATORADDRESS',
 approvalProgram: "TEALCODE",
 clearStateProgram: "TEALCODE",
 onComplete: OnApplicationComplete.UpdateApplication,
 args: [new Uint8Array(1, 2, 3, 4)]
 accountReferences: ["ACCOUNT_1"]
 appReferences: [123n, 1234n]
 assetReferences: [12345n]
 boxReferences: ["box1", {appId: 1234n, name: "box2"}]
 accessReferences: [{ appId: 1234n }]
 lease: 'lease',
 note: 'note',
 // You wouldn't normally set this field
 firstValidRound: 1000n,
 validityWindow: 10,
 extraFee: (1000).microAlgo(),
 staticFee: (1000).microAlgo(),
 // Max fee doesn't make sense with extraFee AND staticFee
 //  already specified, but here for completeness
 maxFee: (3000).microAlgo(),
 rejectVersion: 1,
})

appUpdateMethodCall()

appUpdateMethodCall: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Defined in: src/algorand-client-transaction-creator.ts:571

Create an application update call with ABI method call transaction.

Note: you may prefer to use algorand.client to get an app client for more advanced functionality.

Parameters

params

The parameters for the app update transaction

accessReferences?

accountReferences?

Any account addresses to add to the accounts array.

appId

bigint

ID of the application; 0 if the application is being created.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

approvalProgram

string | Uint8Array<ArrayBufferLike>

The program to execute for all OnCompletes other than ClearState as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array))

args?

Arguments to the ABI method, either:

An ABI value
A transaction with explicit signer
A transaction (where the signer will be automatically assigned)
An unawaited transaction (e.g. from algorand.createTransaction.{transactionType}())
Another method call (via method call params object)
undefined (this represents a placeholder transaction argument that is fulfilled by another method call argument)

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

clearStateProgram

string | Uint8Array<ArrayBufferLike>

The program to execute for ClearState OnComplete as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array))

extraFee?

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

method

The ABI method to call

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

onComplete?

UpdateApplication

The on-complete action of the call; defaults to no-op.

rejectVersion?

number

rekeyTo?

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender

AddressWithTransactionSigner | TransactionSigner

The address sending the transaction, optionally with an attached signer.

signer?

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?