CreateAppParams
@algorandfoundation/algokit-utils / types/app / CreateAppParams
types/app.CreateAppParams
Deprecated
Use TransactionComposer to construct create app transactions instead.
Parameters that are passed in when creating an app.
Hierarchy
Section titled “Hierarchy”-
CreateOrUpdateAppParams↳
CreateAppParams
Table of contents
Section titled “Table of contents”Properties
Section titled “Properties”- approvalProgram
- args
- atc
- clearStateProgram
- fee
- from
- maxFee
- maxRoundsToWaitForConfirmation
- note
- onCompleteAction
- populateAppCallResources
- schema
- skipSending
- skipWaiting
- suppressLog
- transactionParams
Properties
Section titled “Properties”approvalProgram
Section titled “approvalProgram”• approvalProgram: string | Uint8Array
The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array)
Inherited from
Section titled “Inherited from”CreateOrUpdateAppParams.approvalProgram
Defined in
Section titled “Defined in”• Optional args: AppCallArgs
The arguments passed in to the app call
Inherited from
Section titled “Inherited from”CreateOrUpdateAppParams.args
Defined in
Section titled “Defined in”• 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
Section titled “Inherited from”CreateOrUpdateAppParams.atc
Defined in
Section titled “Defined in”clearStateProgram
Section titled “clearStateProgram”• clearStateProgram: string | Uint8Array
The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array)
Inherited from
Section titled “Inherited from”CreateOrUpdateAppParams.clearStateProgram
Defined in
Section titled “Defined in”• Optional fee: AlgoAmount
The flat fee you want to pay, useful for covering extra fees in a transaction group or app call
Inherited from
Section titled “Inherited from”CreateOrUpdateAppParams.fee
Defined in
Section titled “Defined in”• from: SendTransactionFrom
The account (with private key loaded) that will send the transaction
Inherited from
Section titled “Inherited from”CreateOrUpdateAppParams.from
Defined in
Section titled “Defined in”maxFee
Section titled “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
Section titled “Inherited from”CreateOrUpdateAppParams.maxFee
Defined in
Section titled “Defined in”maxRoundsToWaitForConfirmation
Section titled “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
Section titled “Inherited from”CreateOrUpdateAppParams.maxRoundsToWaitForConfirmation
Defined in
Section titled “Defined in”• Optional note: TransactionNote
The (optional) transaction note
Inherited from
Section titled “Inherited from”CreateOrUpdateAppParams.note
Defined in
Section titled “Defined in”onCompleteAction
Section titled “onCompleteAction”• Optional onCompleteAction: "no_op" | "opt_in" | "close_out" | "update_application" | "delete_application" | NoOpOC | OptInOC | CloseOutOC | UpdateApplicationOC | DeleteApplicationOC
Override the on-completion action for the create call; defaults to NoOp
Defined in
Section titled “Defined in”populateAppCallResources
Section titled “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
Section titled “Inherited from”CreateOrUpdateAppParams.populateAppCallResources
Defined in
Section titled “Defined in”schema
Section titled “schema”• schema: AppStorageSchema
The storage schema to request for the created app
Defined in
Section titled “Defined in”skipSending
Section titled “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
Section titled “Inherited from”CreateOrUpdateAppParams.skipSending
Defined in
Section titled “Defined in”skipWaiting
Section titled “skipWaiting”• Optional skipWaiting: boolean
Whether to skip waiting for the submitted transaction (only relevant if skipSending is false or unset)
Inherited from
Section titled “Inherited from”CreateOrUpdateAppParams.skipWaiting
Defined in
Section titled “Defined in”suppressLog
Section titled “suppressLog”• Optional suppressLog: boolean
Whether to suppress log messages from transaction send, default: do not suppress
Inherited from
Section titled “Inherited from”CreateOrUpdateAppParams.suppressLog
Defined in
Section titled “Defined in”transactionParams
Section titled “transactionParams”• Optional transactionParams: SuggestedParams
Optional transaction parameters
Inherited from
Section titled “Inherited from”CreateOrUpdateAppParams.transactionParams