Skip to content

CreateAppParams

Defined in: algokit-utils-ts/src/types/app.ts:150

  • CreateOrUpdateAppParams

approvalProgram: string | Uint8Array<ArrayBufferLike>

Defined in: algokit-utils-ts/src/types/app.ts:135

The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array)

CreateOrUpdateAppParams.approvalProgram


optional args?: AppCallArgs

Defined in: algokit-utils-ts/src/types/app.ts:143

The arguments passed in to the app call

CreateOrUpdateAppParams.args


optional atc?: AtomicTransactionComposer

Defined in: algokit-utils-ts/src/types/transaction.ts:36

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

CreateOrUpdateAppParams.atc


clearStateProgram: string | Uint8Array<ArrayBufferLike>

Defined in: algokit-utils-ts/src/types/app.ts:137

The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array)

CreateOrUpdateAppParams.clearStateProgram


optional fee?: AlgoAmount

Defined in: algokit-utils-ts/src/types/transaction.ts:40

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

CreateOrUpdateAppParams.fee


from: SendTransactionFrom

Defined in: algokit-utils-ts/src/types/app.ts:133

The account (with private key loaded) that will send the transaction

CreateOrUpdateAppParams.from


optional maxFee?: AlgoAmount

Defined in: algokit-utils-ts/src/types/transaction.ts:42

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

CreateOrUpdateAppParams.maxFee


optional maxRoundsToWaitForConfirmation?: number

Defined in: algokit-utils-ts/src/types/transaction.ts:44

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

CreateOrUpdateAppParams.maxRoundsToWaitForConfirmation


optional note?: TransactionNote

Defined in: algokit-utils-ts/src/types/app.ts:141

The (optional) transaction note

CreateOrUpdateAppParams.note


optional onCompleteAction?: NoOpOC | OptInOC | CloseOutOC | UpdateApplicationOC | DeleteApplicationOC | "no_op" | "opt_in" | "close_out" | "update_application" | "delete_application"

Defined in: algokit-utils-ts/src/types/app.ts:154

Override the on-completion action for the create call; defaults to NoOp


optional populateAppCallResources?: boolean

Defined in: algokit-utils-ts/src/types/transaction.ts:46

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.

CreateOrUpdateAppParams.populateAppCallResources


schema: AppStorageSchema

Defined in: algokit-utils-ts/src/types/app.ts:152

The storage schema to request for the created app


optional skipSending?: boolean

Defined in: algokit-utils-ts/src/types/transaction.ts:32

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

CreateOrUpdateAppParams.skipSending


optional skipWaiting?: boolean

Defined in: algokit-utils-ts/src/types/transaction.ts:34

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

CreateOrUpdateAppParams.skipWaiting


optional suppressLog?: boolean

Defined in: algokit-utils-ts/src/types/transaction.ts:38

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

CreateOrUpdateAppParams.suppressLog


optional transactionParams?: SuggestedParams

Defined in: algokit-utils-ts/src/types/app.ts:139

Optional transaction parameters

CreateOrUpdateAppParams.transactionParams