AppCallParams

@algorandfoundation/algokit-utils / types/app / AppCallParams

types/app.AppCallParams

Parameters representing a call to an app.

Hierarchy

• SendTransactionParams

  ↳ AppCallParams

Table of contents

Properties

• appId
• args
• atc
• callType
• fee
• from
• maxFee
• maxRoundsToWaitForConfirmation
• note
• populateAppCallResources
• skipSending
• skipWaiting
• suppressLog
• transactionParams

Properties

appId

• appId: number | bigint

The id of the app to call

Defined in

src/types/app.ts:185

---

args

• Optional args: AppCallArgs

The arguments passed in to the app call

Defined in

src/types/app.ts:195

---

atc

• Optional atc: AtomicTransactionComposer

An optional AtomicTransactionComposer to add the transaction to, if specified then skipSending: undefined has the same effect as skipSending: true

Inherited from

SendTransactionParams.atc

Defined in

src/types/transaction.ts:36

---

callType

• callType: "no_op" | "opt_in" | "close_out" | "clear_state" | "delete_application" | NoOpOC | OptInOC | CloseOutOC | ClearStateOC | DeleteApplicationOC

The type of call, everything except create (see createApp) and update (see updateApp)

Defined in

src/types/app.ts:187

---

fee

• Optional fee: AlgoAmount

The flat fee you want to pay, useful for covering extra fees in a transaction group or app call

Inherited from

SendTransactionParams.fee

Defined in

src/types/transaction.ts:40

---

from

• from: SendTransactionFrom

The account to make the call from

Defined in

src/types/app.ts:189

---

maxFee

• Optional maxFee: AlgoAmount

The maximum fee that you are happy to pay (default: unbounded) - if this is set it’s possible the transaction could get rejected during network congestion

Inherited from

SendTransactionParams.maxFee

Defined in

src/types/transaction.ts:42

---

maxRoundsToWaitForConfirmation

• Optional maxRoundsToWaitForConfirmation: number

The maximum number of rounds to wait for confirmation, only applies if skipWaiting is undefined or false, default: wait up to 5 rounds

Inherited from

SendTransactionParams.maxRoundsToWaitForConfirmation

Defined in

src/types/transaction.ts:44

---

note

• Optional note: TransactionNote

The (optional) transaction note

Defined in

src/types/app.ts:193

---

populateAppCallResources

• Optional populateAppCallResources: boolean

Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group.

Inherited from

SendTransactionParams.populateAppCallResources

Defined in

src/types/transaction.ts:46

---

skipSending

• Optional skipSending: boolean

Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless atc specified) and instead just return the raw transaction, e.g. so you can add it to a group of transactions

Inherited from

SendTransactionParams.skipSending

Defined in

src/types/transaction.ts:32

---

skipWaiting

• Optional skipWaiting: boolean

Whether to skip waiting for the submitted transaction (only relevant if skipSending is false or unset)

Inherited from

SendTransactionParams.skipWaiting

Defined in

src/types/transaction.ts:34

---

suppressLog

• Optional suppressLog: boolean

Whether to suppress log messages from transaction send, default: do not suppress

Inherited from

SendTransactionParams.suppressLog

Defined in

src/types/transaction.ts:38

---

transactionParams

• Optional transactionParams: SuggestedParams

Optional transaction parameters

Defined in

src/types/app.ts:191