# index

[@algorandfoundation/algokit-utils](https://dev.algorand.co/reference/algokit-utils-ts/api/readme/) / index

## Table of contents

[Section titled “Table of contents”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#table-of-contents)

### References

[Section titled “References”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#references)

- [ALGOKIT\_DIR](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#algokit_dir)
- [AVMTracesEventData](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#avmtraceseventdata)
- [AlgorandClient](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#algorandclient)
- [DEFAULT\_MAX\_SEARCH\_DEPTH](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#default_max_search_depth)
- [EventDataMap](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#eventdatamap)
- [EventType](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#eventtype)
- [SOURCES\_DIR](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#sources_dir)
- [SearchForTransactions](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#searchfortransactions)
- [TEAL\_FILE\_EXT](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#teal_file_ext)
- [TEAL\_SOURCEMAP\_EXT](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#teal_sourcemap_ext)
- [TealSourceDebugEventData](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#tealsourcedebugeventdata)
- [TealSourcesDebugEventData](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#tealsourcesdebugeventdata)
- [executePaginatedRequest](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#executepaginatedrequest)
- [lookupAccountByAddress](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#lookupaccountbyaddress)
- [lookupAccountCreatedApplicationByAddress](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#lookupaccountcreatedapplicationbyaddress)
- [lookupAssetHoldings](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#lookupassetholdings)
- [lookupTransactionById](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#lookuptransactionbyid)
- [searchTransactions](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#searchtransactions)

### Namespaces

[Section titled “Namespaces”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#namespaces)

- [indexer](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/indexindexer/)

### Type Aliases

[Section titled “Type Aliases”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#type-aliases)

- [AccountInformation](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#accountinformation)
- [NumberConverter](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#numberconverter)

### Variables

[Section titled “Variables”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#variables)

- [ALGORAND\_MIN\_TX\_FEE](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#algorand_min_tx_fee)
- [Config](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#config)
- [MAX\_APP\_CALL\_ACCOUNT\_REFERENCES](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#max_app_call_account_references)
- [MAX\_APP\_CALL\_FOREIGN\_REFERENCES](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#max_app_call_foreign_references)
- [MAX\_TRANSACTION\_GROUP\_SIZE](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#max_transaction_group_size)

### Functions

[Section titled “Functions”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#functions)

- [algo](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#algo)
- [algos](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#algos)
- [assetBulkOptIn](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#assetbulkoptin)
- [assetBulkOptOut](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#assetbulkoptout)
- [assetOptIn](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#assetoptin)
- [assetOptOut](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#assetoptout)
- [callApp](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#callapp)
- [capTransactionFee](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#captransactionfee)
- [compileTeal](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#compileteal)
- [controlFees](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#controlfees)
- [createApp](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#createapp)
- [createAsset](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#createasset)
- [decodeAppState](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#decodeappstate)
- [deployApp](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#deployapp)
- [encodeLease](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#encodelease)
- [encodeTransactionNote](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#encodetransactionnote)
- [ensureFunded](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#ensurefunded)
- [getABIMethodSignature](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getabimethodsignature)
- [getABIReturn](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getabireturn)
- [getABIReturnValue](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getabireturnvalue)
- [getAccount](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getaccount)
- [getAccountAddressAsString](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getaccountaddressasstring)
- [getAccountAddressAsUint8Array](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getaccountaddressasuint8array)
- [getAccountAssetInformation](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getaccountassetinformation)
- [getAccountConfigFromEnvironment](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getaccountconfigfromenvironment)
- [getAccountInformation](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getaccountinformation)
- [getAlgoClient](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getalgoclient)
- [getAlgoIndexerClient](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getalgoindexerclient)
- [getAlgoKmdClient](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getalgokmdclient)
- [getAlgoNodeConfig](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getalgonodeconfig)
- [getAlgodConfigFromEnvironment](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getalgodconfigfromenvironment)
- [getAppArgsForABICall](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappargsforabicall)
- [getAppArgsForTransaction](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappargsfortransaction)
- [getAppBoxNames](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappboxnames)
- [getAppBoxValue](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappboxvalue)
- [getAppBoxValueFromABIType](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappboxvaluefromabitype)
- [getAppBoxValues](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappboxvalues)
- [getAppBoxValuesFromABIType](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappboxvaluesfromabitype)
- [getAppById](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappbyid)
- [getAppClient](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappclient)
- [getAppClientByCreatorAndName](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappclientbycreatorandname)
- [getAppClientById](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappclientbyid)
- [getAppDeploymentTransactionNote](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappdeploymenttransactionnote)
- [getAppGlobalState](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappglobalstate)
- [getAppLocalState](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getapplocalstate)
- [getAppOnCompleteAction](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getapponcompleteaction)
- [getAtomicTransactionComposerTransactions](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getatomictransactioncomposertransactions)
- [getBoxReference](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getboxreference)
- [getConfigFromEnvOrDefaults](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getconfigfromenvordefaults)
- [getCreatorAppsByName](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getcreatorappsbyname)
- [getDefaultLocalNetConfig](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getdefaultlocalnetconfig)
- [getDispenserAccount](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getdispenseraccount)
- [getIndexerConfigFromEnvironment](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getindexerconfigfromenvironment)
- [getKmdWalletAccount](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getkmdwalletaccount)
- [getLocalNetDispenserAccount](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getlocalnetdispenseraccount)
- [getOrCreateKmdWalletAccount](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getorcreatekmdwalletaccount)
- [getSenderAddress](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getsenderaddress)
- [getSenderTransactionSigner](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getsendertransactionsigner)
- [getTestNetDispenserApiClient](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#gettestnetdispenserapiclient)
- [getTransactionParams](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#gettransactionparams)
- [getTransactionWithSigner](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#gettransactionwithsigner)
- [isLocalNet](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#islocalnet)
- [isMainNet](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#ismainnet)
- [isSchemaIsBroken](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#isschemaisbroken)
- [isTestNet](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#istestnet)
- [microAlgo](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#microalgo)
- [microAlgos](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#microalgos)
- [mnemonicAccount](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#mnemonicaccount)
- [mnemonicAccountFromEnvironment](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#mnemonicaccountfromenvironment)
- [multisigAccount](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#multisigaccount)
- [performAtomicTransactionComposerSimulate](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#performatomictransactioncomposersimulate)
- [performTemplateSubstitution](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#performtemplatesubstitution)
- [performTemplateSubstitutionAndCompile](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#performtemplatesubstitutionandcompile)
- [persistSourceMaps](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#persistsourcemaps)
- [populateAppCallResources](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#populateappcallresources)
- [prepareGroupForSending](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#preparegroupforsending)
- [randomAccount](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#randomaccount)
- [rekeyAccount](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#rekeyaccount)
- [rekeyedAccount](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#rekeyedaccount)
- [replaceDeployTimeControlParams](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#replacedeploytimecontrolparams)
- [sendAtomicTransactionComposer](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#sendatomictransactioncomposer)
- [sendGroupOfTransactions](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#sendgroupoftransactions)
- [sendTransaction](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#sendtransaction)
- [signTransaction](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#signtransaction)
- [stripTealComments](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#striptealcomments)
- [transactionFees](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#transactionfees)
- [transactionSignerAccount](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#transactionsigneraccount)
- [transferAlgos](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#transferalgos)
- [transferAsset](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#transferasset)
- [updateApp](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#updateapp)
- [waitForConfirmation](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#waitforconfirmation)

## References

[Section titled “References”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#references-1)

### ALGOKIT\_DIR

[Section titled “ALGOKIT\_DIR”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#algokit_dir)

Re-exports [ALGOKIT\_DIR](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_debugging/#algokit_dir)

* * *

### AVMTracesEventData

[Section titled “AVMTracesEventData”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#avmtraceseventdata)

Re-exports [AVMTracesEventData](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_debuggingavmtraceseventdata/)

* * *

### AlgorandClient

[Section titled “AlgorandClient”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#algorandclient)

Re-exports [AlgorandClient](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_algorand_clientalgorandclient/)

* * *

### DEFAULT\_MAX\_SEARCH\_DEPTH

[Section titled “DEFAULT\_MAX\_SEARCH\_DEPTH”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#default_max_search_depth)

Re-exports [DEFAULT\_MAX\_SEARCH\_DEPTH](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_debugging/#default_max_search_depth)

* * *

### EventDataMap

[Section titled “EventDataMap”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#eventdatamap)

Re-exports [EventDataMap](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_lifecycle_events/#eventdatamap)

* * *

### EventType

[Section titled “EventType”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#eventtype)

Re-exports [EventType](https://dev.algorand.co/reference/algokit-utils-ts/api/enums/types_lifecycle_eventseventtype/)

* * *

### SOURCES\_DIR

[Section titled “SOURCES\_DIR”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#sources_dir)

Re-exports [SOURCES\_DIR](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_debugging/#sources_dir)

* * *

### SearchForTransactions

[Section titled “SearchForTransactions”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#searchfortransactions)

Re-exports [SearchForTransactions](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/indexindexer/#searchfortransactions)

* * *

### TEAL\_FILE\_EXT

[Section titled “TEAL\_FILE\_EXT”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#teal_file_ext)

Re-exports [TEAL\_FILE\_EXT](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_debugging/#teal_file_ext)

* * *

### TEAL\_SOURCEMAP\_EXT

[Section titled “TEAL\_SOURCEMAP\_EXT”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#teal_sourcemap_ext)

Re-exports [TEAL\_SOURCEMAP\_EXT](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_debugging/#teal_sourcemap_ext)

* * *

### TealSourceDebugEventData

[Section titled “TealSourceDebugEventData”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#tealsourcedebugeventdata)

Re-exports [TealSourceDebugEventData](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_debuggingtealsourcedebugeventdata/)

* * *

### TealSourcesDebugEventData

[Section titled “TealSourcesDebugEventData”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#tealsourcesdebugeventdata)

Re-exports [TealSourcesDebugEventData](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_debuggingtealsourcesdebugeventdata/)

* * *

### executePaginatedRequest

[Section titled “executePaginatedRequest”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#executepaginatedrequest)

Re-exports [executePaginatedRequest](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/indexindexer/#executepaginatedrequest)

* * *

### lookupAccountByAddress

[Section titled “lookupAccountByAddress”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#lookupaccountbyaddress)

Re-exports [lookupAccountByAddress](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/indexindexer/#lookupaccountbyaddress)

* * *

### lookupAccountCreatedApplicationByAddress

[Section titled “lookupAccountCreatedApplicationByAddress”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#lookupaccountcreatedapplicationbyaddress)

Re-exports [lookupAccountCreatedApplicationByAddress](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/indexindexer/#lookupaccountcreatedapplicationbyaddress)

* * *

### lookupAssetHoldings

[Section titled “lookupAssetHoldings”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#lookupassetholdings)

Re-exports [lookupAssetHoldings](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/indexindexer/#lookupassetholdings)

* * *

### lookupTransactionById

[Section titled “lookupTransactionById”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#lookuptransactionbyid)

Re-exports [lookupTransactionById](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/indexindexer/#lookuptransactionbyid)

* * *

### searchTransactions

[Section titled “searchTransactions”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#searchtransactions)

Re-exports [searchTransactions](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/indexindexer/#searchtransactions)

## Type Aliases

[Section titled “Type Aliases”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#type-aliases-1)

### AccountInformation

[Section titled “AccountInformation”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#accountinformation)

Ƭ **AccountInformation**: `Omit`< [`NumberConverter`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#numberconverter) <`AccountInformationModel`>, `"getEncodingSchema"` \| `"toEncodingData"` \| `"authAddr"`\> & { `authAddr?`: `string` }

**`Deprecated`**

Account information at a given round.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in)

[src/account/account.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L135)

* * *

### NumberConverter

[Section titled “NumberConverter”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#numberconverter)

Ƭ **NumberConverter** <`T`>: { \[key in keyof T\]: ToNumberIfExtends<T\[key\], number \| bigint> }

#### Type parameters

[Section titled “Type parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#type-parameters)

| Name | Type |
| :-- | :-- |
| `T` | extends `AccountInformationModel` |

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-1)

[src/account/account.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L132)

## Variables

[Section titled “Variables”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#variables-1)

### ALGORAND\_MIN\_TX\_FEE

[Section titled “ALGORAND\_MIN\_TX\_FEE”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#algorand_min_tx_fee)

• `Const` **ALGORAND\_MIN\_TX\_FEE**: [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-2)

[src/amount.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L93)

* * *

### Config

[Section titled “Config”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#config)

• `Const` **Config**: [`UpdatableConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_configupdatableconfig/)

The AlgoKit config. To update it use the configure method.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-3)

[src/config.ts:4](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/config.ts#L4)

* * *

### MAX\_APP\_CALL\_ACCOUNT\_REFERENCES

[Section titled “MAX\_APP\_CALL\_ACCOUNT\_REFERENCES”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#max_app_call_account_references)

• `Const` **MAX\_APP\_CALL\_ACCOUNT\_REFERENCES**: `4`

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-4)

[src/transaction/transaction.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L39)

* * *

### MAX\_APP\_CALL\_FOREIGN\_REFERENCES

[Section titled “MAX\_APP\_CALL\_FOREIGN\_REFERENCES”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#max_app_call_foreign_references)

• `Const` **MAX\_APP\_CALL\_FOREIGN\_REFERENCES**: `8`

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-5)

[src/transaction/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L38)

* * *

### MAX\_TRANSACTION\_GROUP\_SIZE

[Section titled “MAX\_TRANSACTION\_GROUP\_SIZE”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#max_transaction_group_size)

• `Const` **MAX\_TRANSACTION\_GROUP\_SIZE**: `16`

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-6)

[src/transaction/transaction.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L37)

## Functions

[Section titled “Functions”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#functions-1)

### algo

[Section titled “algo”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#algo)

▸ **algo**(`algos`): [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/)

Returns an amount of Algo using AlgoAmount

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters)

| Name | Type | Description |
| :-- | :-- | :-- |
| `algos` | `number` \| `bigint` | The amount of Algo |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns)

[`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-7)

[src/amount.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L68)

* * *

### algos

[Section titled “algos”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#algos)

▸ **algos**(`algos`): [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/)

Returns an amount of Algo using AlgoAmount

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-1)

| Name | Type | Description |
| :-- | :-- | :-- |
| `algos` | `number` \| `bigint` | The amount of Algo |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-1)

[`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-8)

[src/amount.ts:61](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L61)

* * *

### assetBulkOptIn

[Section titled “assetBulkOptIn”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#assetbulkoptin)

▸ **assetBulkOptIn**(`optIn`, `algod`): `Promise`<`Record`<`number`, `string`>>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-2)

| Name | Type | Description |
| :-- | :-- | :-- |
| `optIn` | [`AssetBulkOptInOutParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_assetassetbulkoptinoutparams/) | The bulk opt-in request. |
| `algod` | `AlgodClient` | An instance of the Algodv2 class from the `algosdk` library. |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-2)

`Promise`<`Record`<`number`, `string`>>

A record object where the keys are the asset IDs and the values are the corresponding transaction IDs for successful opt-ins.

**`Deprecated`**

use `algorand.asset.bulkOptIn()` instead

Opt in to a list of assets on the Algorand blockchain.

**`Throws`**

If there is an error during the opt-in process.

**`Example`**

```
algokit.bulkOptIn({ account: account, assetIds: [12345, 67890] }, algod);
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-9)

[src/asset.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L130)

* * *

### assetBulkOptOut

[Section titled “assetBulkOptOut”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#assetbulkoptout)

▸ **assetBulkOptOut**(`optOut`, `algod`): `Promise`<`Record`<`number`, `string`>>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-3)

| Name | Type | Description |
| :-- | :-- | :-- |
| `optOut` | [`AssetBulkOptInOutParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_assetassetbulkoptinoutparams/) | The bulk opt-out request. |
| `algod` | `AlgodClient` | An instance of the Algodv2 client used to interact with the Algorand blockchain. |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-3)

`Promise`<`Record`<`number`, `string`>>

A record object containing asset IDs as keys and their corresponding transaction IDs as values.

**`Deprecated`**

use `algorand.asset.bulkOptOut()` instead

Opt out of multiple assets in Algorand blockchain.

**`Throws`**

If there is an error during the opt-out process.

**`Example`**

```
algokit.bulkOptOut({ account: account, assetIds: [12345, 67890] }, algod);
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-10)

[src/asset.ts:157](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L157)

* * *

### assetOptIn

[Section titled “assetOptIn”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#assetoptin)

▸ **assetOptIn**(`optIn`, `algod`): `Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-4)

| Name | Type | Description |
| :-- | :-- | :-- |
| `optIn` | [`AssetOptInParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_assetassetoptinparams/) | The opt-in definition |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-4)

`Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) >

The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)

**`Deprecated`**

use `algorand.send.assetOptIn()` / `algorand.createTransaction.assetOptIn()` instead

Opt-in an account to an asset.

**`Example`**

```
await algokit.assetOptIn({ account, assetId }, algod);
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-11)

[src/asset.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L67)

* * *

### assetOptOut

[Section titled “assetOptOut”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#assetoptout)

▸ **assetOptOut**(`optOut`, `algod`): `Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-5)

| Name | Type | Description |
| :-- | :-- | :-- |
| `optOut` | [`AssetOptOutParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_assetassetoptoutparams/) | The opt-in definition |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-5)

`Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) >

The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)

**`Deprecated`**

use `algorand.send.assetOptOut()` / `algorand.createTransaction.assetOptOut()` instead

Opt-out an account from an asset.

**`Example`**

```
await algokit.assetOptOut({ account, assetId, assetCreatorAddress }, algod);
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-12)

[src/asset.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L98)

* * *

### callApp

[Section titled “callApp”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#callapp)

▸ **callApp**(`call`, `algod`): `Promise`< [`AppCallTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#appcalltransactionresult) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-6)

| Name | Type | Description |
| :-- | :-- | :-- |
| `call` | [`AppCallParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappcallparams/) | The call details. |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-6)

`Promise`< [`AppCallTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#appcalltransactionresult) >

The result of the call

**`Deprecated`**

Use `algorand.send.appUpdate()` / `algorand.createTransaction.appUpdate()` / `algorand.send.appUpdateMethodCall()`
/ `algorand.createTransaction.appUpdateMethodCall()` instead

Issues a call to a given app.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-13)

[src/app.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L187)

* * *

### capTransactionFee

[Section titled “capTransactionFee”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#captransactionfee)

▸ **capTransactionFee**(`transaction`, `maxAcceptableFee`): `void`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-7)

| Name | Type | Description |
| :-- | :-- | :-- |
| `transaction` | `Transaction` \| `SuggestedParams` | The transaction to cap or suggested params object about to be used to create a transaction |
| `maxAcceptableFee` | [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/) | The maximum acceptable fee to pay |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-7)

`void`

**`Deprecated`**

Use `TransactionComposer` and the `maxFee` field in the transaction params instead.

Limit the acceptable fee to a defined amount of µAlgo.
This also sets the transaction to be flatFee to ensure the transaction only succeeds at
the estimated rate.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-14)

[src/transaction/transaction.ts:1056](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1056)

* * *

### compileTeal

[Section titled “compileTeal”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#compileteal)

▸ **compileTeal**(`tealCode`, `algod`): `Promise`< [`CompiledTeal`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appcompiledteal/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-8)

| Name | Type | Description |
| :-- | :-- | :-- |
| `tealCode` | `string` | The TEAL code |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-8)

`Promise`< [`CompiledTeal`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appcompiledteal/) >

The information about the compiled file

**`Deprecated`**

Use `algorand.app.compileTeal` instead.

Compiles the given TEAL using algod and returns the result, including source map.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-15)

[src/app.ts:419](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L419)

* * *

### controlFees

[Section titled “controlFees”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#controlfees)

▸ **controlFees** <`T`>(`transaction`, `feeControl`): `T`

#### Type parameters

[Section titled “Type parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#type-parameters-1)

| Name | Type |
| :-- | :-- |
| `T` | extends `Transaction` \| `SuggestedParams` |

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-9)

| Name | Type | Description |
| :-- | :-- | :-- |
| `transaction` | `T` | The transaction or suggested params |
| `feeControl` | `Object` | The fee control parameters |
| `feeControl.fee?` | [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/) | - |
| `feeControl.maxFee?` | [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/) | - |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-9)

`T`

**`Deprecated`**

Use `TransactionComposer` and the `maxFee` and `staticFee` fields in the transaction params instead.

Allows for control of fees on a `Transaction` or `SuggestedParams` object

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-16)

[src/transaction/transaction.ts:1083](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1083)

* * *

### createApp

[Section titled “createApp”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#createapp)

▸ **createApp**(`create`, `algod`): `Promise`<`Partial`< [`AppCompilationResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappcompilationresult/) \> & [`AppCallTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#appcalltransactionresult) & [`AppReference`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappreference/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-10)

| Name | Type | Description |
| :-- | :-- | :-- |
| `create` | [`CreateAppParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appcreateappparams/) | The parameters to create the app with |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-10)

`Promise`<`Partial`< [`AppCompilationResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappcompilationresult/) \> & [`AppCallTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#appcalltransactionresult) & [`AppReference`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappreference/) >

The details of the created app, or the transaction to create it if `skipSending` and the compilation result

**`Deprecated`**

Use `algorand.send.appCreate()` / `algorand.createTransaction.appCreate()` / `algorand.send.appCreateMethodCall()`
/ `algorand.createTransaction.appCreateMethodCall()` instead

Creates a smart contract app, returns the details of the created app.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-17)

[src/app.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L44)

* * *

### createAsset

[Section titled “createAsset”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#createasset)

▸ **createAsset**(`create`, `algod`): `Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) & { `confirmation?`: { `assetIndex`: `number` \| `bigint` } }>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-11)

| Name | Type | Description |
| :-- | :-- | :-- |
| `create` | [`CreateAssetParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_assetcreateassetparams/) | The asset creation definition |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-11)

`Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) & { `confirmation?`: { `assetIndex`: `number` \| `bigint` } }>

The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)

**`Deprecated`**

use `algorand.send.assetCreate()` / `algorand.createTransaction.assetCreate()` instead

Create an Algorand Standard Asset (ASA).

**`Example`**

```
await algokit.createAsset({ creator: account, total: 1, decimals: 0, name: 'My asset' }, algod);
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-18)

[src/asset.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L23)

* * *

### decodeAppState

[Section titled “decodeAppState”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#decodeappstate)

▸ **decodeAppState**(`state`): [`AppState`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappstate/)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-12)

| Name | Type | Description |
| :-- | :-- | :-- |
| `state` | { `key`: `string` ; `value`: `TealValue` \| `EvalDelta` }\[\] | A `global-state`, `local-state`, `global-state-deltas` or `local-state-deltas` |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-12)

[`AppState`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappstate/)

An object keyeed by the UTF-8 representation of the key with various parsings of the values

**`Deprecated`**

Use `AppManager.decodeAppState` instead.

Converts an array of global/local state values from the algod api to a more friendly
generic object keyed by the UTF-8 value of the key.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-19)

[src/app.ts:345](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L345)

* * *

### deployApp

[Section titled “deployApp”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#deployapp)

▸ **deployApp**(`deployment`, `algod`, `indexer?`): `Promise`<`Partial`< [`AppCompilationResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappcompilationresult/) \> & [`ConfirmedTransactionResults`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionconfirmedtransactionresults/) & [`AppMetadata`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappmetadata/) & { `operationPerformed`: `"create"` \| `"update"` ; `return?`: [`ABIReturn`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#abireturn) } \| [`ConfirmedTransactionResults`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionconfirmedtransactionresults/) & [`AppMetadata`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappmetadata/) & { `deleteResult`: [`ConfirmedTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionconfirmedtransactionresult/) ; `deleteReturn?`: [`ABIReturn`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#abireturn) ; `operationPerformed`: `"replace"` ; `return?`: [`ABIReturn`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#abireturn) } \| [`AppMetadata`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappmetadata/) & { `operationPerformed`: `"nothing"` }>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-13)

| Name | Type | Description |
| :-- | :-- | :-- |
| `deployment` | [`AppDeploymentParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappdeploymentparams/) | The arguments to control the app deployment |
| `algod` | `AlgodClient` | An algod client |
| `indexer?` | `IndexerClient` | An indexer client, needed if `existingDeployments` not passed in |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-13)

`Promise`<`Partial`< [`AppCompilationResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappcompilationresult/) \> & [`ConfirmedTransactionResults`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionconfirmedtransactionresults/) & [`AppMetadata`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappmetadata/) & { `operationPerformed`: `"create"` \| `"update"` ; `return?`: [`ABIReturn`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#abireturn) } \| [`ConfirmedTransactionResults`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionconfirmedtransactionresults/) & [`AppMetadata`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappmetadata/) & { `deleteResult`: [`ConfirmedTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionconfirmedtransactionresult/) ; `deleteReturn?`: [`ABIReturn`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#abireturn) ; `operationPerformed`: `"replace"` ; `return?`: [`ABIReturn`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#abireturn) } \| [`AppMetadata`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappmetadata/) & { `operationPerformed`: `"nothing"` }>

The app reference of the new/existing app

**`Deprecated`**

Use `algorand.appDeployer.deploy` instead.

Idempotently deploy (create, update/delete if changed) an app against the given name via the given creator account, including deploy-time template placeholder substitutions.

To understand the architecture decisions behind this functionality please see [https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12\_smart-contract-deployment.md](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md)

**Note:** When using the return from this function be sure to check `operationPerformed` to get access to various return properties like `transaction`, `confirmation` and `deleteResult`.

**Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created.

**Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-20)

[src/app-deploy.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L51)

* * *

### encodeLease

[Section titled “encodeLease”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#encodelease)

▸ **encodeLease**(`lease?`): `Uint8Array` \| `undefined`

Encodes a transaction lease into a 32-byte array ready to be included in an Algorand transaction.

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-14)

| Name | Type | Description |
| :-- | :-- | :-- |
| `lease?` | `string` \| `Uint8Array` | The transaction lease as a string or binary array or null/undefined if there is no lease |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-14)

`Uint8Array` \| `undefined`

the transaction lease ready for inclusion in a transaction or `undefined` if there is no lease

**`Throws`**

if the length of the data is > 32 bytes or empty

**`Example`**

```
algokit.encodeLease('UNIQUE_ID');
```

**`Example`**

```
algokit.encodeLease(new Uint8Array([1, 2, 3]));
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-21)

[src/transaction/transaction.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L80)

* * *

### encodeTransactionNote

[Section titled “encodeTransactionNote”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#encodetransactionnote)

▸ **encodeTransactionNote**(`note?`): `Uint8Array` \| `undefined`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-15)

| Name | Type | Description |
| :-- | :-- | :-- |
| `note?` | [`TransactionNote`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#transactionnote) | The transaction note |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-15)

`Uint8Array` \| `undefined`

the transaction note ready for inclusion in a transaction

Case on the value of `data` this either be:

- `null` \| `undefined`: `undefined`
- `string`: The string value
- Uint8Array: passthrough
- Arc2TransactionNote object: ARC-0002 compatible transaction note
- Else: The object/value converted into a JSON string representation

**`Deprecated`**

Convert your data to a `string` or `Uint8Array`, if using ARC-2 use `TransactionComposer.arc2Note`.

Encodes a transaction note into a byte array ready to be included in an Algorand transaction.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-22)

[src/transaction/transaction.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L56)

* * *

### ensureFunded

[Section titled “ensureFunded”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#ensurefunded)

▸ **ensureFunded** <`T`>(`funding`, `algod`, `kmd?`): `Promise`< [`EnsureFundedReturnType`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transferensurefundedreturntype/) \| `undefined`>

#### Type parameters

[Section titled “Type parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#type-parameters-2)

| Name | Type |
| :-- | :-- |
| `T` | extends [`EnsureFundedParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transferensurefundedparams/) |

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-16)

| Name | Type | Description |
| :-- | :-- | :-- |
| `funding` | `T` | The funding configuration of type `EnsureFundedParams`, including the account to fund, minimum spending balance, and optional parameters. If you set `useDispenserApi` to true, you must also set `ALGOKIT_DISPENSER_ACCESS_TOKEN` in your environment variables. |
| `algod` | `AlgodClient` | An instance of the Algodv2 client. |
| `kmd?` | `KmdClient` | An optional instance of the Kmd client. |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-16)

`Promise`< [`EnsureFundedReturnType`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transferensurefundedreturntype/) \| `undefined`>

- `EnsureFundedReturnType` if funds were transferred.
- `undefined` if no funds were needed.

**`Deprecated`**

Use `algorand.account.ensureFunded()` / `algorand.account.ensureFundedFromEnvironment()`
/ `algorand.account.ensureFundedFromTestNetDispenserApi()` instead

Funds a given account using a funding source such that it has a certain amount of Algo free to spend (accounting for Algo locked in minimum balance requirement).

[https://dev.algorand.co/concepts/smart-contracts/costs-constraints#mbr](https://dev.algorand.co/concepts/smart-contracts/costs-constraints#mbr)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-23)

[src/transfer/transfer.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer.ts#L26)

* * *

### getABIMethodSignature

[Section titled “getABIMethodSignature”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getabimethodsignature)

▸ **getABIMethodSignature**(`method`): `string`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-17)

| Name | Type | Description |
| :-- | :-- | :-- |
| `method` | `ABIMethodParams` \| `ABIMethod` | The method to return a signature for |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-17)

`string`

The encoded ABI method spec e.g. `method_name(uint64,string)string`

**`Deprecated`**

Use `abiMethod.getSignature()` or `new ABIMethod(abiMethodParams).getSignature()` instead.

Returns the encoded ABI spec for a given ABI Method

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-24)

[src/app.ts:430](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L430)

* * *

### getABIReturn

[Section titled “getABIReturn”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getabireturn)

▸ **getABIReturn**(`args?`, `confirmation?`): [`ABIReturn`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#abireturn) \| `undefined`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-18)

| Name | Type | Description |
| :-- | :-- | :-- |
| `args?` | [`AppCallArgs`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#appcallargs) | The arguments that were used for the call |
| `confirmation?` | `PendingTransactionResponse` | The transaction confirmation from algod |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-18)

[`ABIReturn`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#abireturn) \| `undefined`

The return value for the method call

**`Deprecated`**

Use `AppManager.getABIReturn` instead.

Returns any ABI return values for the given app call arguments and transaction confirmation.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-25)

[src/app.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L235)

* * *

### getABIReturnValue

[Section titled “getABIReturnValue”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getabireturnvalue)

▸ **getABIReturnValue**(`result`, `type`): [`ABIReturn`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#abireturn)

Takes an algosdk `ABIResult` and converts it to an `ABIReturn`.
Converts `bigint`’s for Uint’s < 64 to `number` for easier use.

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-19)

| Name | Type | Description |
| :-- | :-- | :-- |
| `result` | `ABIResult` | The `ABIReturn` |
| `type` | `ABIReturnType` | - |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-19)

[`ABIReturn`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#abireturn)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-26)

[src/transaction/transaction.ts:922](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L922)

* * *

### getAccount

[Section titled “getAccount”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getaccount)

▸ **getAccount**(`account`, `algod`, `kmdClient?`): `Promise`<`Account` \| [`SigningAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_accountsigningaccount/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-20)

| Name | Type | Description |
| :-- | :-- | :-- |
| `account` | `string` \| { `fundWith?`: [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/) ; `name`: `string` } | The details of the account to get, either the name identifier (string) or an object with: \_ `name`: The name identifier of the account \_ `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account |
| `algod` | `AlgodClient` | An algod client |
| `kmdClient?` | `KmdClient` | An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-20)

`Promise`<`Account` \| [`SigningAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_accountsigningaccount/) >

The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account)

**`Deprecated`**

use `algorand.account.fromEnvironment()` instead

Returns an Algorand account with private key loaded by convention based on the given name identifier.

Note: This function expects to run in a Node.js environment.

## Convention:

[Section titled “Convention:”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#convention)

- **Non-LocalNet:** will load process.env\[‘{NAME}\_MNEMONIC’\] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**,
never commit it into source control and ideally load it via a secret storage service rather than the file system.
If process.env\[‘{NAME}\_SENDER’\] is defined then it will use that for the sender address (i.e. to support rekeyed accounts)
- **LocalNet:** will load the account from a KMD wallet called {NAME} and if that wallet doesn’t exist it will create it and fund the account for you

This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet).

**`Example`**

If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object:

```
const account = await getAccount('ACCOUNT', algod);
```

If that code runs against LocalNet then a wallet called `ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-27)

[src/account/get-account.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-account.ts#L41)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-21)

| Name | Type | Description |
| :-- | :-- | :-- |
| `account` | `Object` | The details of the account to get, an object with: \_ `config`: Account configuration. To get from environment use getAccountConfigFromEnvironment(accountName) \_ `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account |
| `account.config` | [`AccountConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_accountaccountconfig/) | - |
| `account.fundWith?` | [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/) | - |
| `algod` | `AlgodClient` | An algod client |
| `kmdClient?` | `KmdClient` | An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-21)

`Promise`<`Account` \| [`SigningAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_accountsigningaccount/) >

**`Deprecated`**

use `algorand.account.fromEnvironment()` instead
Returns an Algorand account with private key loaded by convention based on the given name identifier.

Note: This function expects to run in a Node.js environment.

**`Example`**

If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object:

```
const account = await getAccount({ config: getAccountConfigFromEnvironment('ACCOUNT') }, algod);
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-28)

[src/account/get-account.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-account.ts#L68)

* * *

### getAccountAddressAsString

[Section titled “getAccountAddressAsString”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getaccountaddressasstring)

▸ **getAccountAddressAsString**(`addressEncodedInB64`): `string`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-22)

| Name | Type | Description |
| :-- | :-- | :-- |
| `addressEncodedInB64` | `string` | The base64 encoded version of the underlying byte array of the address public key |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-22)

`string`

**`Deprecated`**

Use `algosdk.encodeAddress` instead.

Returns the string address of an Algorand account from a base64 encoded version of the underlying byte array of the address public key

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-29)

[src/account/account.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L128)

* * *

### getAccountAddressAsUint8Array

[Section titled “getAccountAddressAsUint8Array”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getaccountaddressasuint8array)

▸ **getAccountAddressAsUint8Array**(`account`): `Uint8Array`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-23)

| Name | Type | Description |
| :-- | :-- | :-- |
| `account` | `string` \| [`SendTransactionFrom`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#sendtransactionfrom) | Either an account (with private key loaded) or the string address of an account |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-23)

`Uint8Array`

**`Deprecated`**

Use `algosdk.decodeAddress` instead.

Returns an account’s address as a byte array

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-30)

[src/account/account.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L117)

* * *

### getAccountAssetInformation

[Section titled “getAccountAssetInformation”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getaccountassetinformation)

▸ **getAccountAssetInformation**(`sender`, `assetId`, `algod`): `Promise`< [`AccountAssetInformation`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_account/#accountassetinformation) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-24)

| Name | Type | Description |
| :-- | :-- | :-- |
| `sender` | `string` \| [`SendTransactionFrom`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#sendtransactionfrom) | The address of the sender/account to look up |
| `assetId` | `number` \| `bigint` | The ID of the asset to return a holding for |
| `algod` | `AlgodClient` | The algod instance |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-24)

`Promise`< [`AccountAssetInformation`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_account/#accountassetinformation) >

The account asset holding information

**`Deprecated`**

Use `algorand.asset.getAccountInformation(sender, assetId)` or `new AssetManager(...).getAccountInformation(sender, assetId)` instead.

Returns the given sender account’s asset holding for a given asset.

**`Example`**

```
const address = 'XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA';

const assetId = 123345;

const accountInfo = await account.getAccountAssetInformation(address, assetId, algod);
```

[Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountassetinformation)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-31)

[src/account/account.ts:201](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L201)

* * *

### getAccountConfigFromEnvironment

[Section titled “getAccountConfigFromEnvironment”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getaccountconfigfromenvironment)

▸ **getAccountConfigFromEnvironment**(`accountName`): [`AccountConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_accountaccountconfig/)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-25)

| Name | Type | Description |
| :-- | :-- | :-- |
| `accountName` | `string` | account name |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-25)

[`AccountConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_accountaccountconfig/)

**`Deprecated`**

Use algokit.mnemonicAccountFromEnvironment, which doesn’t need this function
Returns the Account configuration from environment variables

**`Example`**

```
environment variables

{accountName}_MNEMONIC

{accountName}_SENDER
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-32)

[src/account/get-account-config-from-environment.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-account-config-from-environment.ts#L13)

* * *

### getAccountInformation

[Section titled “getAccountInformation”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getaccountinformation)

▸ **getAccountInformation**(`sender`, `algod`): `Promise`< [`AccountInformation`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#accountinformation) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-26)

| Name | Type | Description |
| :-- | :-- | :-- |
| `sender` | `string` \| [`SendTransactionFrom`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#sendtransactionfrom) | The address of the sender/account to look up |
| `algod` | `AlgodClient` | The algod instance |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-26)

`Promise`< [`AccountInformation`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#accountinformation) >

The account information

**`Deprecated`**

Use `algorand.account.getInformation(sender)` or `new AccountManager(clientManager).getInformation(sender)` instead.

Returns the given sender account’s current status, balance and spendable amounts.

**`Example`**

```
const address = 'XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA';

const accountInfo = await account.getInformation(address, algod);
```

[Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountinformation)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-33)

[src/account/account.ts:156](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L156)

* * *

### getAlgoClient

[Section titled “getAlgoClient”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getalgoclient)

▸ **getAlgoClient**(`config?`): `Algodv2`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-27)

| Name | Type | Description |
| :-- | :-- | :-- |
| `config?` | [`AlgoClientConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_network_clientalgoclientconfig/) | The config if you want to override the default (getting config from process.env) |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-27)

`Algodv2`

**`Deprecated`**

Use `ClientManager.getAlgodClient(config)` or `ClientManager.getAlgodClientFromEnvironment()` instead.

Returns an algod SDK client that automatically retries transient failures on idempotent calls

**`Example`**

```
// Uses process.env.ALGOD_SERVER, process.env.ALGOD_PORT and process.env.ALGOD_TOKEN

// Automatically detects if you are using PureStake to switch in the right header name for ALGOD_TOKEN

const algod = getAlgoClient();

await algod.healthCheck().do();
```

**`Example`**

```
const algod = getAlgoClient(getAlgoNodeConfig('testnet', 'algod'));

await algod.healthCheck().do();
```

**`Example`**

```
const algod = getAlgoClient(getAlgoNodeConfig('mainnet', 'algod'));

await algod.healthCheck().do();
```

**`Example`**

```
const algod = getAlgoClient({

server: 'http://localhost',

port: '4001',

token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',

});

await algod.healthCheck().do();
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-34)

[src/network-client.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L88)

* * *

### getAlgoIndexerClient

[Section titled “getAlgoIndexerClient”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getalgoindexerclient)

▸ **getAlgoIndexerClient**(`config?`): `Indexer`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-28)

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-28)

`Indexer`

**`Deprecated`**

Use `ClientManager.getIndexerClient(config, overrideIntDecoding)` or `ClientManager.getIndexerClientFromEnvironment(overrideIntDecoding)` instead.

Returns an indexer SDK client that automatically retries transient failures on idempotent calls

**`Example`**

```
// Uses process.env.INDEXER_SERVER, process.env.INDEXER_PORT and process.env.INDEXER_TOKEN

const indexer = getAlgoIndexerClient();

await indexer.makeHealthCheck().do();
```

**`Example`**

```
const indexer = getAlgoIndexerClient(getAlgoNodeConfig('testnet', 'indexer'));

await indexer.makeHealthCheck().do();
```

**`Example`**

```
const indexer = getAlgoIndexerClient(getAlgoNodeConfig('mainnet', 'indexer'));

await indexer.makeHealthCheck().do();
```

**`Example`**

```
const indexer = getAlgoIndexerClient({

server: 'http://localhost',

port: '8980',

token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',

});

await indexer.makeHealthCheck().do();
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-35)

[src/network-client.ts:121](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L121)

* * *

### getAlgoKmdClient

[Section titled “getAlgoKmdClient”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getalgokmdclient)

▸ **getAlgoKmdClient**(`config?`): `Kmd`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-29)

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-29)

`Kmd`

**`Deprecated`**

Use `ClientManager.getKmdClient(config)` or `ClientManager.getKmdClientFromEnvironment()` instead.

Returns a KMD SDK client that automatically retries transient failures on idempotent calls.

KMD client allows you to export private keys, which is useful to get the default account in a LocalNet network.

**`Example`**

```
// Uses process.env.ALGOD_SERVER, process.env.KMD_PORT (or if not specified: port 4002) and process.env.ALGOD_TOKEN

const kmd = getAlgoKmdClient();
```

**`Example`**

```
const kmd = getAlgoKmdClient({

server: 'http://localhost',

port: '4002',

token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',

});
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-36)

[src/network-client.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L144)

* * *

### getAlgoNodeConfig

[Section titled “getAlgoNodeConfig”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getalgonodeconfig)

▸ **getAlgoNodeConfig**(`network`, `config`): [`AlgoClientConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_network_clientalgoclientconfig/)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-30)

| Name | Type | Description |
| :-- | :-- | :-- |
| `network` | `"testnet"` \| `"mainnet"` | Which network to connect to - TestNet or MainNet |
| `config` | `"algod"` \| `"indexer"` | Which algod config to return - Algod or Indexer |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-30)

[`AlgoClientConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_network_clientalgoclientconfig/)

**`Deprecated`**

Use `ClientManager.getAlgoNodeConfig(network, config)` instead.

Returns the Algorand configuration to point to the AlgoNode service

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-37)

[src/network-client.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L43)

* * *

### getAlgodConfigFromEnvironment

[Section titled “getAlgodConfigFromEnvironment”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getalgodconfigfromenvironment)

▸ **getAlgodConfigFromEnvironment**(): [`AlgoClientConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_network_clientalgoclientconfig/)

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-31)

[`AlgoClientConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_network_clientalgoclientconfig/)

**`Deprecated`**

Use `ClientManager.getAlgodConfigFromEnvironment()` instead.

Retrieve the algod configuration from environment variables (expects to be called from a Node.js environment not algod-side)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-38)

[src/network-client.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L22)

* * *

### getAppArgsForABICall

[Section titled “getAppArgsForABICall”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappargsforabicall)

▸ **getAppArgsForABICall**(`args`, `from`): `Promise`<{ `appAccounts`: `undefined` \| `string`\[\] ; `appForeignApps`: `undefined` \| `number`\[\] = args.apps; `appForeignAssets`: `undefined` \| `number`\[\] = args.assets; `boxes`: `undefined` \| `BoxReference`\[\] ; `lease`: `undefined` \| `Uint8Array` ; `method`: `ABIMethod` ; `methodArgs`: (`string` \| `number` \| `bigint` \| `boolean` \| `Uint8Array` \| `ABIValue`\[\] \| `TransactionWithSigner`)\[\] = methodArgs; `rekeyTo`: `undefined` \| `string` ; `sender`: `string` ; `signer`: `TransactionSigner` = signer }>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-31)

| Name | Type | Description |
| :-- | :-- | :-- |
| `args` | [`ABIAppCallArgs`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#abiappcallargs) | The ABI app call args |
| `from` | [`SendTransactionFrom`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#sendtransactionfrom) | The transaction signer |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-32)

`Promise`<{ `appAccounts`: `undefined` \| `string`\[\] ; `appForeignApps`: `undefined` \| `number`\[\] = args.apps; `appForeignAssets`: `undefined` \| `number`\[\] = args.assets; `boxes`: `undefined` \| `BoxReference`\[\] ; `lease`: `undefined` \| `Uint8Array` ; `method`: `ABIMethod` ; `methodArgs`: (`string` \| `number` \| `bigint` \| `boolean` \| `Uint8Array` \| `ABIValue`\[\] \| `TransactionWithSigner`)\[\] = methodArgs; `rekeyTo`: `undefined` \| `string` ; `sender`: `string` ; `signer`: `TransactionSigner` = signer }>

The parameters ready to pass into `addMethodCall` within AtomicTransactionComposer

**`Deprecated`**

Use `TransactionComposer` methods to construct transactions instead.

Returns the app args ready to load onto an ABI method call in `AtomicTransactionComposer`

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-39)

[src/app.ts:378](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L378)

* * *

### getAppArgsForTransaction

[Section titled “getAppArgsForTransaction”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappargsfortransaction)

▸ **getAppArgsForTransaction**(`args?`): `undefined` \| { `accounts`: `undefined` \| `string`\[\] ; `appArgs`: `undefined` \| `Uint8Array`\[\] ; `boxes`: `undefined` \| `BoxReference`\[\] ; `foreignApps`: `undefined` \| `number`\[\] = args.apps; `foreignAssets`: `undefined` \| `number`\[\] = args.assets; `lease`: `undefined` \| `Uint8Array` }

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-32)

| Name | Type | Description |
| :-- | :-- | :-- |
| `args?` | [`RawAppCallArgs`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_apprawappcallargs/) | The app call args |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-33)

`undefined` \| { `accounts`: `undefined` \| `string`\[\] ; `appArgs`: `undefined` \| `Uint8Array`\[\] ; `boxes`: `undefined` \| `BoxReference`\[\] ; `foreignApps`: `undefined` \| `number`\[\] = args.apps; `foreignAssets`: `undefined` \| `number`\[\] = args.assets; `lease`: `undefined` \| `Uint8Array` }

The args ready to load into a `Transaction`

**`Deprecated`**

Use `TransactionComposer` methods to construct transactions instead.

Returns the app args ready to load onto an app `Transaction` object

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-40)

[src/app.ts:356](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L356)

* * *

### getAppBoxNames

[Section titled “getAppBoxNames”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappboxnames)

▸ **getAppBoxNames**(`appId`, `algod`): `Promise`< [`BoxName`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appboxname/)\[\]>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-33)

| Name | Type | Description |
| :-- | :-- | :-- |
| `appId` | `number` \| `bigint` | The ID of the app return box names for |
| `algod` | `AlgodClient` | An algod client instance |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-34)

`Promise`< [`BoxName`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appboxname/)\[\]>

The current box names

**`Deprecated`**

Use `algorand.app.getBoxNames` instead.
Returns the names of the boxes for the given app.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-41)

[src/app.ts:276](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L276)

* * *

### getAppBoxValue

[Section titled “getAppBoxValue”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappboxvalue)

▸ **getAppBoxValue**(`appId`, `boxName`, `algod`): `Promise`<`Uint8Array`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-34)

| Name | Type | Description |
| :-- | :-- | :-- |
| `appId` | `number` \| `bigint` | The ID of the app return box names for |
| `boxName` | `string` \| `Uint8Array` \| [`BoxName`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appboxname/) | The name of the box to return either as a string, binary array or `BoxName` |
| `algod` | `AlgodClient` | An algod client instance |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-35)

`Promise`<`Uint8Array`>

The current box value as a byte array

**`Deprecated`**

Use `algorand.app.getBoxValue` instead.
Returns the value of the given box name for the given app.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-42)

[src/app.ts:288](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L288)

* * *

### getAppBoxValueFromABIType

[Section titled “getAppBoxValueFromABIType”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappboxvaluefromabitype)

▸ **getAppBoxValueFromABIType**(`request`, `algod`): `Promise`<`ABIValue`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-35)

| Name | Type | Description |
| :-- | :-- | :-- |
| `request` | [`BoxValueRequestParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appboxvaluerequestparams/) | The parameters for the box value request |
| `algod` | `AlgodClient` | An algod client instance |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-36)

`Promise`<`ABIValue`>

The current box value as an ABI value

**`Deprecated`**

Use `algorand.app.getBoxValueFromABIType` instead.
Returns the value of the given box name for the given app decoded based on the given ABI type.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-43)

[src/app.ts:314](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L314)

* * *

### getAppBoxValues

[Section titled “getAppBoxValues”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappboxvalues)

▸ **getAppBoxValues**(`appId`, `boxNames`, `algod`): `Promise`<`Uint8Array`\[\]>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-36)

| Name | Type | Description |
| :-- | :-- | :-- |
| `appId` | `number` | The ID of the app return box names for |
| `boxNames` | (`string` \| `Uint8Array` \| [`BoxName`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appboxname/))\[\] | The names of the boxes to return either as a string, binary array or `BoxName` |
| `algod` | `AlgodClient` | An algod client instance |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-37)

`Promise`<`Uint8Array`\[\]>

The current box values as a byte array in the same order as the passed in box names

**`Deprecated`**

Use `algorand.app.getBoxValues` instead.
Returns the value of the given box names for the given app.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-44)

[src/app.ts:300](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L300)

* * *

### getAppBoxValuesFromABIType

[Section titled “getAppBoxValuesFromABIType”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappboxvaluesfromabitype)

▸ **getAppBoxValuesFromABIType**(`request`, `algod`): `Promise`<`ABIValue`\[\]>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-37)

| Name | Type | Description |
| :-- | :-- | :-- |
| `request` | [`BoxValuesRequestParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appboxvaluesrequestparams/) | The parameters for the box value request |
| `algod` | `AlgodClient` | An algod client instance |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-38)

`Promise`<`ABIValue`\[\]>

The current box values as an ABI value in the same order as the passed in box names

**`Deprecated`**

Use `algorand.app.getBoxValuesFromABIType` instead.
Returns the value of the given box names for the given app decoded based on the given ABI type.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-45)

[src/app.ts:329](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L329)

* * *

### getAppById

[Section titled “getAppById”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappbyid)

▸ **getAppById**(`appId`, `algod`): `Promise`<`Application`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-38)

| Name | Type | Description |
| :-- | :-- | :-- |
| `appId` | `number` \| `bigint` | The id of the app |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-39)

`Promise`<`Application`>

The data about the app

**`Deprecated`**

Use `algorand.app.getById` instead.

Gets the current data for the given app from algod.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-46)

[src/app.ts:406](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L406)

* * *

### getAppClient

[Section titled “getAppClient”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappclient)

▸ **getAppClient**(`appDetails`, `algod`): [`ApplicationClient`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_app_clientapplicationclient/)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-39)

| Name | Type | Description |
| :-- | :-- | :-- |
| `appDetails` | [`AppSpecAppDetails`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app_client/#appspecappdetails) | The details of the app |
| `algod` | `AlgodClient` | An algod instance |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-40)

[`ApplicationClient`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_app_clientapplicationclient/)

The application client

**`Deprecated`**

Use `AppClient` instead e.g. via `algorand.client.getAppClientById` or
`algorand.client.getAppClientByCreatorAndName`.
If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,
which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.

Create a new ApplicationClient instance

**`Example`**

```
Resolve by creator and name

const client = algokit.getAppClient(

{

resolveBy: 'creatorAndName',

app: {appSpec},

sender: {account},

creatorAddress: {creator},

findExistingUsing: indexerClient,

},

algodClient,

)
```

**`Example`**

```
Resolve by id:

const client = algokit.getAppClient(

{

resolveBy: 'id',

app: {appSpec},

sender: {account},

id: {id},

},

algodClient,

)
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-47)

[src/app-client.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-client.ts#L40)

* * *

### getAppClientByCreatorAndName

[Section titled “getAppClientByCreatorAndName”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappclientbycreatorandname)

▸ **getAppClientByCreatorAndName**(`appDetails`, `algod`): [`ApplicationClient`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_app_clientapplicationclient/)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-40)

| Name | Type | Description |
| :-- | :-- | :-- |
| `appDetails` | [`AppSpecAppDetailsByCreatorAndName`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app_client/#appspecappdetailsbycreatorandname) | The details of the app by creator and name |
| `algod` | `AlgodClient` | An algod instance |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-41)

[`ApplicationClient`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_app_clientapplicationclient/)

The application client

**`Deprecated`**

Use `AppClient` instead e.g. via `algorand.client.getAppClientByCreatorAndName`.
If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,
which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.

Create a new ApplicationClient instance by creator and name

**`Example`**

```
const client = algokit.getAppClientByCreatorAndName(

{

app: appSpec,

sender: account,

creatorAddress: account,

findExistingUsing: indexerClient,

},

algodClient,

);
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-48)

[src/app-client.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-client.ts#L93)

* * *

### getAppClientById

[Section titled “getAppClientById”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappclientbyid)

▸ **getAppClientById**(`appDetails`, `algod`): [`ApplicationClient`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_app_clientapplicationclient/)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-41)

| Name | Type | Description |
| :-- | :-- | :-- |
| `appDetails` | [`AppSpecAppDetailsById`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app_client/#appspecappdetailsbyid) | The details of the app |
| `algod` | `AlgodClient` | An algod instance |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-42)

[`ApplicationClient`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_app_clientapplicationclient/)

The application client

**`Deprecated`**

Use `AppClient` instead e.g. via `algorand.client.getAppClientById`.
If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,
which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.

Create a new ApplicationClient instance by id

**`Example`**

```
const client = algokit.getAppClientById(

{

app: { appSpec },

sender: { account },

id: { id },

},

algodClient,

);
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-49)

[src/app-client.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-client.ts#L66)

* * *

### getAppDeploymentTransactionNote

[Section titled “getAppDeploymentTransactionNote”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappdeploymenttransactionnote)

▸ **getAppDeploymentTransactionNote**(`metadata`): [`Arc2TransactionNote`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#arc2transactionnote)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-42)

| Name | Type | Description |
| :-- | :-- | :-- |
| `metadata` | [`AppDeployMetadata`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappdeploymetadata/) | The metadata of the deployment |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-43)

[`Arc2TransactionNote`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#arc2transactionnote)

The transaction note as a utf-8 string

**`Deprecated`**

Use `{ dAppName: APP_DEPLOY_NOTE_DAPP, data: metadata, format: 'j' }` instead.

Return the transaction note for an app deployment.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-50)

[src/app-deploy.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L271)

* * *

### getAppGlobalState

[Section titled “getAppGlobalState”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getappglobalstate)

▸ **getAppGlobalState**(`appId`, `algod`): `Promise`< [`AppState`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappstate/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-43)

| Name | Type | Description |
| :-- | :-- | :-- |
| `appId` | `number` \| `bigint` | The ID of the app return global state for |
| `algod` | `AlgodClient` | An algod client instance |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-44)

`Promise`< [`AppState`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappstate/) >

The current global state

**`Deprecated`**

Use `algorand.app.getGlobalState` instead.

Returns the current global state values for the given app ID

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-51)

[src/app.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L252)

* * *

### getAppLocalState

[Section titled “getAppLocalState”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getapplocalstate)

▸ **getAppLocalState**(`appId`, `account`, `algod`): `Promise`< [`AppState`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappstate/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-44)

| Name | Type | Description |
| :-- | :-- | :-- |
| `appId` | `number` \| `bigint` | The ID of the app return global state for |
| `account` | `string` \| [`SendTransactionFrom`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#sendtransactionfrom) | Either the string address of an account or an account object for the account to get local state for the given app |
| `algod` | `AlgodClient` | An algod client instance |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-45)

`Promise`< [`AppState`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappstate/) >

The current local state for the given (app, account) combination

**`Deprecated`**

Use `algorand.app.getLocalState` instead.

Returns the current global state values for the given app ID and account

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-52)

[src/app.ts:265](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L265)

* * *

### getAppOnCompleteAction

[Section titled “getAppOnCompleteAction”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getapponcompleteaction)

▸ **getAppOnCompleteAction**(`onCompletionAction?`): `OnApplicationComplete`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-45)

| Name | Type | Description |
| :-- | :-- | :-- |
| `onCompletionAction?` | [`AppCallType`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#appcalltype) \| `OnApplicationComplete` | The on completion action |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-46)

`OnApplicationComplete`

The `algosdk.OnApplicationComplete`

**`Deprecated`**

Use `algosdk.OnApplicationComplete` directly instead.

Returns a `algosdk.OnApplicationComplete` for the given onCompleteAction.

If given `undefined` will return `OnApplicationComplete.NoOpOC`.

If given an `AppCallType` will convert the string enum to the correct underlying `algosdk.OnApplicationComplete`.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-53)

[src/app.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L154)

* * *

### getAtomicTransactionComposerTransactions

[Section titled “getAtomicTransactionComposerTransactions”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getatomictransactioncomposertransactions)

▸ **getAtomicTransactionComposerTransactions**(`atc`): `TransactionWithSigner`\[\]

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-46)

| Name | Type | Description |
| :-- | :-- | :-- |
| `atc` | `AtomicTransactionComposer` | The atomic transaction composer |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-47)

`TransactionWithSigner`\[\]

The array of transactions with signers

**`Deprecated`**

Use `atc.clone().buildGroup()` instead.

Returns the array of transactions currently present in the given `AtomicTransactionComposer`

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-54)

[src/transaction/transaction.ts:1132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1132)

* * *

### getBoxReference

[Section titled “getBoxReference”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getboxreference)

▸ **getBoxReference**(`box`): `algosdk.BoxReference`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-47)

| Name | Type | Description |
| :-- | :-- | :-- |
| `box` | [`BoxReference`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appboxreference/) \| [`BoxIdentifier`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#boxidentifier) \| `BoxReference` | The box to return a reference for |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-48)

`algosdk.BoxReference`

The box reference ready to pass into a `Transaction`

**`Deprecated`**

Use `AppManager.getBoxReference()` instead.

Returns a `algosdk.BoxReference` given a `BoxIdentifier` or `BoxReference`.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-55)

[src/app.ts:389](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L389)

* * *

### getConfigFromEnvOrDefaults

[Section titled “getConfigFromEnvOrDefaults”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getconfigfromenvordefaults)

▸ **getConfigFromEnvOrDefaults**(): [`AlgoConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_network_clientalgoconfig/)

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-49)

[`AlgoConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_network_clientalgoconfig/)

**`Deprecated`**

Use `ClientManager.getConfigFromEnvironmentOrLocalNet()` instead.

Retrieve configurations from environment variables when defined or get defaults (expects to be called from a Node.js environment not algod-side)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-56)

[src/network-client.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L13)

* * *

### getCreatorAppsByName

[Section titled “getCreatorAppsByName”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getcreatorappsbyname)

▸ **getCreatorAppsByName**(`creatorAccount`, `indexer`): `Promise`< [`AppLookup`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appapplookup/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-48)

| Name | Type | Description |
| :-- | :-- | :-- |
| `creatorAccount` | `string` \| [`SendTransactionFrom`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#sendtransactionfrom) | The account (with private key loaded) or string address of an account that is the creator of the apps you want to search for |
| `indexer` | `IndexerClient` | An indexer client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-50)

`Promise`< [`AppLookup`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appapplookup/) >

A name-based lookup of the app information (id, address)

**`Deprecated`**

Use `algorand.appDeployer.getCreatorAppsByName` instead.

Returns a lookup of name => app metadata (id, address, …metadata) for all apps created by the given account that have an `AppDeployNote` in the transaction note of the creation transaction.

**Note:** It’s recommended this is only called once and then stored since it’s a somewhat expensive operation (multiple indexer calls).

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-57)

[src/app-deploy.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L244)

* * *

### getDefaultLocalNetConfig

[Section titled “getDefaultLocalNetConfig”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getdefaultlocalnetconfig)

▸ **getDefaultLocalNetConfig**(`configOrPort`): [`AlgoClientConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_network_clientalgoclientconfig/)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-49)

| Name | Type | Description |
| :-- | :-- | :-- |
| `configOrPort` | `number` \| `"algod"` \| `"indexer"` \| `"kmd"` | Which algod config to return - algod, kmd, or indexer OR a port number |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-51)

[`AlgoClientConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_network_clientalgoclientconfig/)

**`Deprecated`**

Use `ClientManager.getDefaultLocalNetConfig(configOrPort)` instead.

Returns the Algorand configuration to point to the default LocalNet

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-58)

[src/network-client.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L54)

* * *

### getDispenserAccount

[Section titled “getDispenserAccount”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getdispenseraccount)

▸ **getDispenserAccount**(`algod`, `kmd?`): `Promise`<`Address` & [`TransactionSignerAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_accounttransactionsigneraccount/) & { `account`: [`SigningAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_accountsigningaccount/) }>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-50)

| Name | Type | Description |
| :-- | :-- | :-- |
| `algod` | `AlgodClient` | An algod client |
| `kmd?` | `KmdClient` | A KMD client, if not specified then a default KMD client will be loaded from environment variables |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-52)

`Promise`<`Address` & [`TransactionSignerAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_accounttransactionsigneraccount/) & { `account`: [`SigningAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_accountsigningaccount/) }>

**`Deprecated`**

Use `algorand.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead

Returns an account (with private key loaded) that can act as a dispenser

If running on LocalNet then it will return the default dispenser account automatically,
otherwise it will load the account mnemonic stored in process.env.DISPENSER\_MNEMONIC

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-59)

[src/account/get-dispenser-account.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-dispenser-account.ts#L19)

* * *

### getIndexerConfigFromEnvironment

[Section titled “getIndexerConfigFromEnvironment”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getindexerconfigfromenvironment)

▸ **getIndexerConfigFromEnvironment**(): [`AlgoClientConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_network_clientalgoclientconfig/)

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-53)

[`AlgoClientConfig`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_network_clientalgoclientconfig/)

**`Deprecated`**

Use `ClientManager.getIndexerConfigFromEnvironment()` instead.

Retrieve the indexer configuration from environment variables (expects to be called from a Node.js environment not algod-side)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-60)

[src/network-client.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L31)

* * *

### getKmdWalletAccount

[Section titled “getKmdWalletAccount”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getkmdwalletaccount)

▸ **getKmdWalletAccount**(`walletAccount`, `algod`, `kmdClient?`): `Promise`<`Account` \| `undefined`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-51)

| Name | Type | Description |
| :-- | :-- | :-- |
| `walletAccount` | `Object` | The details of the wallet, with: \_ `name`: The name of the wallet to retrieve an account from \_ `predicate`: An optional filter to use to find the account (otherwise it will return a random account from the wallet) |
| `walletAccount.name` | `string` | - |
| `walletAccount.predicate?` | (`account`: `Record`<`string`, `any`>) =\> `boolean` | - |
| `algod` | `AlgodClient` | An algod client |
| `kmdClient?` | `KmdClient` | A KMD client, if not specified then a default KMD client will be loaded from environment variables |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-54)

`Promise`<`Account` \| `undefined`>

**`Deprecated`**

use `algorand.account.kmd.getWalletAccount(name, predicate)` or `new KMDAccountManager(clientManager).getWalletAccount(name, predicate)` instead.

Returns an Algorand account with private key loaded from the given KMD wallet (identified by name).

**`Example`**

```
const defaultDispenserAccount = await getKmdWalletAccount(

algod,

'unencrypted-default-wallet',

a => a.status !== 'Offline' && a.amount > 1_000_000_000,

);
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-61)

[src/localnet/get-kmd-wallet-account.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/get-kmd-wallet-account.ts#L27)

* * *

### getLocalNetDispenserAccount

[Section titled “getLocalNetDispenserAccount”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getlocalnetdispenseraccount)

▸ **getLocalNetDispenserAccount**(`algod`, `kmd?`): `Promise`<`Account`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-52)

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-55)

`Promise`<`Account`>

**`Deprecated`**

Use `algorand.account.kmd.getLocalNetDispenserAccount()` instead.

Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-62)

[src/localnet/get-localnet-dispenser-account.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/get-localnet-dispenser-account.ts#L15)

* * *

### getOrCreateKmdWalletAccount

[Section titled “getOrCreateKmdWalletAccount”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getorcreatekmdwalletaccount)

▸ **getOrCreateKmdWalletAccount**(`walletAccount`, `algod`, `kmdClient?`): `Promise`<`Account`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-53)

| Name | Type | Description |
| :-- | :-- | :-- |
| `walletAccount` | `Object` | The wallet details with: \_ `name`: The name of the wallet to retrieve / create \_ `fundWith`: The number of Algo to fund the account with when it gets created, if not specified then 1000 ALGO will be funded from the dispenser account |
| `walletAccount.fundWith?` | [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/) | - |
| `walletAccount.name` | `string` | - |
| `algod` | `AlgodClient` | An algod client |
| `kmdClient?` | `KmdClient` | A KMD client, if not specified then a default KMD client will be loaded from environment variables |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-56)

`Promise`<`Account`>

An Algorand account with private key loaded - either one that already existed in the given KMD wallet, or a new one that is funded for you

**`Deprecated`**

use `algorand.account.kmd.getOrCreateWalletAccount(name, fundWith)` or `new KMDAccountManager(clientManager).getOrCreateWalletAccount(name, fundWith)` instead.

Gets an account with private key loaded from a KMD wallet of the given name, or alternatively creates one with funds in it via a KMD wallet of the given name.

This is useful to get idempotent accounts from LocalNet without having to specify the private key (which will change when resetting the LocalNet).

This significantly speeds up local dev time and improves experience since you can write code that _just works_ first go without manual config in a fresh LocalNet.

If this is used via `mnemonicAccountFromEnvironment`, then you can even use the same code that runs on production without changes for local development!

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-63)

[src/localnet/get-or-create-kmd-wallet-account.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/get-or-create-kmd-wallet-account.ts#L28)

* * *

### getSenderAddress

[Section titled “getSenderAddress”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getsenderaddress)

▸ **getSenderAddress**(`sender`): `string`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-54)

| Name | Type | Description |
| :-- | :-- | :-- |
| `sender` | `string` \| [`SendTransactionFrom`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#sendtransactionfrom) | A transaction sender |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-57)

`string`

The public address

**`Deprecated`**

Use `algorand.client` to interact with accounts, and use `.addr` to get the address
and/or move from using `SendTransactionFrom` to `TransactionSignerAccount` and use `.addr` instead.

Returns the public address of the given transaction sender.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-64)

[src/transaction/transaction.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L116)

* * *

### getSenderTransactionSigner

[Section titled “getSenderTransactionSigner”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#getsendertransactionsigner)

▸ **getSenderTransactionSigner**(`val`): `TransactionSigner`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-55)

| Name | Type |
| :-- | :-- |
| `val` | [`SendTransactionFrom`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#sendtransactionfrom) |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-58)

`TransactionSigner`

A transaction signer

**`Deprecated`**

Use `TransactionSignerAccount` instead of `SendTransactionFrom` or use
`algosdk.makeBasicAccountTransactionSigner` / `algosdk.makeLogicSigAccountTransactionSigner`.

Returns a `TransactionSigner` for the given transaction sender.
This function has memoization, so will return the same transaction signer for a given sender.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-65)

[src/transaction/transaction.ts:174](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L174)

* * *

### getTestNetDispenserApiClient

[Section titled “getTestNetDispenserApiClient”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#gettestnetdispenserapiclient)

▸ **getTestNetDispenserApiClient**(`params?`): [`TestNetDispenserApiClient`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_dispenser_clienttestnetdispenserapiclient/)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-56)

| Name | Type | Default value | Description |
| :-- | :-- | :-- | :-- |
| `params` | `null` \| [`TestNetDispenserApiClientParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_dispenser_clienttestnetdispenserapiclientparams/) | `null` | An object containing parameters for the TestNetDispenserApiClient class. Or null if you want the client to load the access token from the environment variable `ALGOKIT_DISPENSER_ACCESS_TOKEN`. |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-59)

[`TestNetDispenserApiClient`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_dispenser_clienttestnetdispenserapiclient/)

An instance of the TestNetDispenserApiClient class.

**`Deprecated`**

Use `clientManager.getTestNetDispenser` or `clientManager.getTestNetDispenserFromEnvironment` instead

Create a new TestNetDispenserApiClient instance.
Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token.

**`Example`**

```
const client = algokit.getTestNetDispenserApiClient({

authToken: 'your_auth_token',

requestTimeout: 15,

});
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-66)

[src/dispenser-client.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/dispenser-client.ts#L21)

* * *

### getTransactionParams

[Section titled “getTransactionParams”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#gettransactionparams)

▸ **getTransactionParams**(`params`, `algod`): `Promise`<`SuggestedParams`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-57)

| Name | Type | Description |
| :-- | :-- | :-- |
| `params` | `undefined` \| `SuggestedParams` | Optionally provide parameters to use |
| `algod` | `AlgodClient` | Algod algod |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-60)

`Promise`<`SuggestedParams`>

The suggested transaction parameters

**`Deprecated`**

Use `suggestedParams ? { ...suggestedParams } : await algod.getTransactionParams().do()` instead

Returns suggested transaction parameters from algod unless some are already provided.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-67)

[src/transaction/transaction.ts:1110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1110)

* * *

### getTransactionWithSigner

[Section titled “getTransactionWithSigner”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#gettransactionwithsigner)

▸ **getTransactionWithSigner**(`transaction`, `defaultSender?`): `Promise`<`TransactionWithSigner`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-58)

| Name | Type | Description |
| :-- | :-- | :-- |
| `transaction` | `Transaction` \| [`TransactionToSign`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactiontransactiontosign/) \| `Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) \> \| `TransactionWithSigner` | One of: A TransactionWithSigner object (returned as is), a TransactionToSign object (signer is obtained from the signer property), a Transaction object (signer is extracted from the defaultSender parameter), an async SendTransactionResult returned by one of algokit utils’ helpers (signer is obtained from the defaultSender parameter) |
| `defaultSender?` | [`SendTransactionFrom`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#sendtransactionfrom) | The default sender to be used to obtain a signer where the object provided to the transaction parameter does not include a signer. |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-61)

`Promise`<`TransactionWithSigner`>

A TransactionWithSigner object.

**`Deprecated`**

Use `AlgorandClient` / `TransactionComposer` to construct transactions instead or
construct an `algosdk.TransactionWithSigner` manually instead.

Given a transaction in a variety of supported formats, returns a TransactionWithSigner object ready to be passed to an
AtomicTransactionComposer’s addTransaction method.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-68)

[src/transaction/transaction.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L133)

* * *

### isLocalNet

[Section titled “isLocalNet”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#islocalnet)

▸ **isLocalNet**(`algod`): `Promise`<`boolean`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-59)

| Name | Type |
| :-- | :-- |
| `algod` | `AlgodClient` |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-62)

`Promise`<`boolean`>

**`Deprecated`**

Use `await algorand.client.isLocalNet()` or `await new ClientManager({ algod }).isLocalNet()` instead.

Returns true if the algod client is pointing to a LocalNet Algorand network

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-69)

[src/localnet/is-localnet.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/is-localnet.ts#L9)

* * *

### isMainNet

[Section titled “isMainNet”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#ismainnet)

▸ **isMainNet**(`algod`): `Promise`<`boolean`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-60)

| Name | Type |
| :-- | :-- |
| `algod` | `AlgodClient` |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-63)

`Promise`<`boolean`>

**`Deprecated`**

Use `await algorand.client.isMainNet()` or `await new ClientManager({ algod }).isMainNet()` instead.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-70)

[src/network-client.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L154)

* * *

### isSchemaIsBroken

[Section titled “isSchemaIsBroken”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#isschemaisbroken)

▸ **isSchemaIsBroken**(`before`, `after`): `boolean`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-61)

| Name | Type | Description |
| :-- | :-- | :-- |
| `before` | `ApplicationStateSchema` | The existing schema |
| `after` | `ApplicationStateSchema` | The new schema |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-64)

`boolean`

Whether or not there is a breaking change

**`Deprecated`**

Use `before.numByteSlice < after.numByteSlice || before.numUint < after.numUint` instead.

Returns true is there is a breaking change in the application state schema from before to after.
i.e. if the schema becomes larger, since applications can’t ask for more schema after creation.
Otherwise, there is no error, the app just doesn’t store data in the extra schema :(

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-71)

[src/app-deploy.ts:229](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L229)

* * *

### isTestNet

[Section titled “isTestNet”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#istestnet)

▸ **isTestNet**(`algod`): `Promise`<`boolean`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-62)

| Name | Type |
| :-- | :-- |
| `algod` | `AlgodClient` |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-65)

`Promise`<`boolean`>

**`Deprecated`**

Use `await algorand.client.isTestNet()` or `await new ClientManager({ algod }).isTestNet()` instead.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-72)

[src/network-client.ts:149](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L149)

* * *

### microAlgo

[Section titled “microAlgo”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#microalgo)

▸ **microAlgo**(`microAlgos`): [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/)

Returns an amount of µAlgo using AlgoAmount

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-63)

| Name | Type | Description |
| :-- | :-- | :-- |
| `microAlgos` | `number` \| `bigint` | The amount of µAlgo |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-66)

[`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-73)

[src/amount.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L82)

* * *

### microAlgos

[Section titled “microAlgos”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#microalgos)

▸ **microAlgos**(`microAlgos`): [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/)

Returns an amount of µAlgo using AlgoAmount

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-64)

| Name | Type | Description |
| :-- | :-- | :-- |
| `microAlgos` | `number` \| `bigint` | The amount of µAlgo |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-67)

[`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-74)

[src/amount.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L75)

* * *

### mnemonicAccount

[Section titled “mnemonicAccount”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#mnemonicaccount)

▸ **mnemonicAccount**(`mnemonicSecret`): `Account`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-65)

| Name | Type | Description |
| :-- | :-- | :-- |
| `mnemonicSecret` | `string` | The mnemonic secret representing the private key of an account; **Note: Be careful how the mnemonic is handled**, never commit it into source control and ideally load it from the environment (ideally via a secret storage service) rather than the file system. |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-68)

`Account`

**`Deprecated`**

Use `algorand.account.fromMnemonic(mnemonicSecret)` or `algosdk.mnemonicToSecretKey(mnemonicSecret)` instead.

Returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret.

This is a wrapper around algosdk.mnemonicToSecretKey to provide a more friendly/obvious name.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-75)

[src/account/mnemonic-account.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/mnemonic-account.ts#L14)

* * *

### mnemonicAccountFromEnvironment

[Section titled “mnemonicAccountFromEnvironment”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#mnemonicaccountfromenvironment)

▸ **mnemonicAccountFromEnvironment**(`account`, `algod`, `kmdClient?`): `Promise`<`Account` \| [`SigningAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_accountsigningaccount/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-66)

| Name | Type | Description |
| :-- | :-- | :-- |
| `account` | `string` \| { `fundWith?`: [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/) ; `name`: `string` } | The details of the account to get, either the name identifier (string) or an object with: \_ `name`: string: The name identifier of the account \_ `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account |
| `algod` | `AlgodClient` | An algod client |
| `kmdClient?` | `KmdClient` | An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-69)

`Promise`<`Account` \| [`SigningAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_accountsigningaccount/) >

**`Deprecated`**

Use `algorand.account.fromEnvironment(name, fundWith)` or `new AccountManager(clientManager).fromEnvironment()` instead.

Returns an Algorand account with private key loaded by convention from environment variables based on the given name identifier.

Note: This function expects to run in a Node.js environment.

## Convention:

[Section titled “Convention:”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#convention-1)

**`Example`**

If you have a mnemonic secret loaded into `process.env.MY_ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object:

```
const account = await mnemonicAccountFromEnvironment('MY_ACCOUNT', algod);
```

If that code runs against LocalNet then a wallet called `MY_ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser.
If not running against LocalNet then it will use proces.env.MY\_ACCOUNT\_MNEMONIC as the private key and (if present) process.env.MY\_ACCOUNT\_SENDER as the sender address.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-76)

[src/account/account.ts:97](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L97)

* * *

### multisigAccount

[Section titled “multisigAccount”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#multisigaccount)

▸ **multisigAccount**(`multisigParams`, `signingAccounts`): [`MultisigAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_accountmultisigaccount/)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-67)

| Name | Type | Description |
| :-- | :-- | :-- |
| `multisigParams` | `MultisigMetadata` | The parameters that define the multisig account |
| `signingAccounts` | (`default` \| [`SigningAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_accountsigningaccount/))\[\] | The signers that are currently present |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-70)

[`MultisigAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_accountmultisigaccount/)

A multisig account wrapper

**`Deprecated`**

Use `algorand.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead.

Returns an account wrapper that supports partial or full multisig signing.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-77)

[src/account/account.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L24)

* * *

### performAtomicTransactionComposerSimulate

[Section titled “performAtomicTransactionComposerSimulate”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#performatomictransactioncomposersimulate)

▸ **performAtomicTransactionComposerSimulate**(`atc`, `algod`, `options?`): `Promise`<`SimulateResponse`>

Performs a simulation of the transactions loaded into the given AtomicTransactionComposer.
Uses empty transaction signers for all transactions.

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-68)

| Name | Type | Description |
| :-- | :-- | :-- |
| `atc` | `AtomicTransactionComposer` | The AtomicTransactionComposer with transaction(s) loaded. |
| `algod` | `AlgodClient` | An Algod client to perform the simulation. |
| `options?` | `Omit`<{ `allowEmptySignatures?`: `boolean` ; `allowMoreLogging?`: `boolean` ; `allowUnnamedResources?`: `boolean` ; `execTraceConfig?`: `SimulateTraceConfig` ; `extraOpcodeBudget?`: `number` \| `bigint` ; `fixSigners?`: `boolean` ; `round?`: `number` \| `bigint` ; `txnGroups`: `SimulateRequestTransactionGroup`\[\] }, `"txnGroups"`> | - |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-71)

`Promise`<`SimulateResponse`>

The simulation result, which includes various details about how the transactions would be processed.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-78)

[src/transaction/perform-atomic-transaction-composer-simulate.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/perform-atomic-transaction-composer-simulate.ts#L14)

* * *

### performTemplateSubstitution

[Section titled “performTemplateSubstitution”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#performtemplatesubstitution)

▸ **performTemplateSubstitution**(`tealCode`, `templateParams?`): `string`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-69)

| Name | Type | Description |
| :-- | :-- | :-- |
| `tealCode` | `string` | The TEAL logic to compile |
| `templateParams?` | [`TealTemplateParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_apptealtemplateparams/) | Any parameters to replace in the .teal file before compiling |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-72)

`string`

The TEAL code with replacements

**`Deprecated`**

Use `AppManager.replaceTealTemplateParams` instead

Performs template substitution of a teal file.

Looks for `TMPL_{parameter}` for template replacements.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-79)

[src/app-deploy.ts:309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L309)

* * *

### performTemplateSubstitutionAndCompile

[Section titled “performTemplateSubstitutionAndCompile”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#performtemplatesubstitutionandcompile)

▸ **performTemplateSubstitutionAndCompile**(`tealCode`, `algod`, `templateParams?`, `deploymentMetadata?`): `Promise`< [`CompiledTeal`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appcompiledteal/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-70)

| Name | Type | Description |
| :-- | :-- | :-- |
| `tealCode` | `string` | The TEAL logic to compile |
| `algod` | `AlgodClient` | An algod client |
| `templateParams?` | [`TealTemplateParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_apptealtemplateparams/) | Any parameters to replace in the .teal file before compiling |
| `deploymentMetadata?` | [`AppDeployMetadata`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappdeploymetadata/) | The deployment metadata the app will be deployed with |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-73)

`Promise`< [`CompiledTeal`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appcompiledteal/) >

The information about the compiled code

**`Deprecated`**

Use `algorand.appManager.compileTealTemplate` instead.

Performs template substitution of a teal file and compiles it, returning the compiled result.

Looks for `TMPL_{parameter}` for template replacements.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-80)

[src/app-deploy.ts:326](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L326)

* * *

### persistSourceMaps

[Section titled “persistSourceMaps”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#persistsourcemaps)

▸ **persistSourceMaps**(`_params`): `Promise`<`void`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-71)

| Name | Type |
| :-- | :-- |
| `_params` | `unknown` |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-74)

`Promise`<`void`>

A promise that resolves when the source maps have been persisted.

**`Deprecated`**

Use latest version of `AlgoKit AVM Debugger` VSCode extension instead. It will automatically manage your sourcemaps.

This function persists the source maps for the given sources.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-81)

[src/debugging/debugging.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/debugging/debugging.ts#L8)

* * *

### populateAppCallResources

[Section titled “populateAppCallResources”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#populateappcallresources)

▸ **populateAppCallResources**(`atc`, `algod`): `Promise`<`AtomicTransactionComposer`>

Take an existing Atomic Transaction Composer and return a new one with the required
app call resources populated into it

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-72)

| Name | Type | Description |
| :-- | :-- | :-- |
| `atc` | `AtomicTransactionComposer` | The ATC containing the txn group |
| `algod` | `AlgodClient` | The algod client to use for the simulation |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-75)

`Promise`<`AtomicTransactionComposer`>

A new ATC with the resources populated into the transactions

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-82)

[src/transaction/transaction.ts:388](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L388)

* * *

### prepareGroupForSending

[Section titled “prepareGroupForSending”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#preparegroupforsending)

▸ **prepareGroupForSending**(`atc`, `algod`, `sendParams`, `additionalAtcContext?`): `Promise`<`AtomicTransactionComposer`>

Take an existing Atomic Transaction Composer and return a new one with changes applied to the transactions
based on the supplied sendParams to prepare it for sending.
Please note, that before calling `.execute()` on the returned ATC, you must call `.buildGroup()`.

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-73)

| Name | Type | Description |
| :-- | :-- | :-- |
| `atc` | `AtomicTransactionComposer` | The ATC containing the txn group |
| `algod` | `AlgodClient` | The algod client to use for the simulation |
| `sendParams` | [`SendParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendparams/) | The send params for the transaction group |
| `additionalAtcContext?` | [`AdditionalAtomicTransactionComposerContext`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionadditionalatomictransactioncomposercontext/) | Additional ATC context used to determine how best to change the transactions in the group |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-76)

`Promise`<`AtomicTransactionComposer`>

A new ATC with the changes applied

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-83)

[src/transaction/transaction.ts:407](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L407)

* * *

### randomAccount

[Section titled “randomAccount”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#randomaccount)

▸ **randomAccount**(): `Account`

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-77)

`Account`

**`Deprecated`**

Use `algorand.account.random()` or `algosdk.generateAccount()` instead.

Returns a new, random Algorand account with secret key loaded.

This is a wrapper around algosdk.generateAccount to provide a more friendly/obvious name.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-84)

[src/account/account.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L60)

* * *

### rekeyAccount

[Section titled “rekeyAccount”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#rekeyaccount)

▸ **rekeyAccount**(`rekey`, `algod`): `Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-74)

| Name | Type | Description |
| :-- | :-- | :-- |
| `rekey` | [`AlgoRekeyParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transferalgorekeyparams/) | The rekey definition |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-78)

`Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) >

The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)

**`Deprecated`**

Use `algorand.account.rekeyAccount()` instead

Rekey an account to a new address.

**Note:** Please be careful with this function and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying).

**`Example`**

```
await algokit.rekeyAccount({ from, rekeyTo }, algod);
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-85)

[src/transfer/transfer.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer.ts#L125)

* * *

### rekeyedAccount

[Section titled “rekeyedAccount”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#rekeyedaccount)

▸ **rekeyedAccount**(`signer`, `sender`): [`SigningAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_accountsigningaccount/)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-75)

| Name | Type | Description |
| :-- | :-- | :-- |
| `signer` | `default` | The account, with private key loaded, that is signing |
| `sender` | `string` | The address of the rekeyed account that will act as a sender |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-79)

[`SigningAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_accountsigningaccount/)

The SigningAccount wrapper

**`Deprecated`**

Use `algorand.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead.

Returns an account wrapper that supports a rekeyed account.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-86)

[src/account/account.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L36)

* * *

### replaceDeployTimeControlParams

[Section titled “replaceDeployTimeControlParams”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#replacedeploytimecontrolparams)

▸ **replaceDeployTimeControlParams**(`tealCode`, `params`): `string`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-76)

| Name | Type | Description |
| :-- | :-- | :-- |
| `tealCode` | `string` | The TEAL code to substitute |
| `params` | `Object` | The deploy-time deployment control parameter value to replace |
| `params.deletable?` | `boolean` | - |
| `params.updatable?` | `boolean` | - |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-80)

`string`

The replaced TEAL code

**`Deprecated`**

Use `AppManager.replaceTealTemplateDeployTimeControlParams` instead

Replaces deploy-time deployment control parameters within the given teal code.

- `TMPL_UPDATABLE` for updatability / immutability control
- `TMPL_DELETABLE` for deletability / permanence control

Note: If these values are not undefined, but the corresponding `TMPL_*` value
isn’t in the teal code it will throw an exception.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-87)

[src/app-deploy.ts:294](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L294)

* * *

### sendAtomicTransactionComposer

[Section titled “sendAtomicTransactionComposer”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#sendatomictransactioncomposer)

▸ **sendAtomicTransactionComposer**(`atcSend`, `algod`): `Promise`< [`SendAtomicTransactionComposerResults`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendatomictransactioncomposerresults/) >

Signs and sends transactions that have been collected by an `AtomicTransactionComposer`.

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-77)

| Name | Type | Description |
| :-- | :-- | :-- |
| `atcSend` | [`AtomicTransactionComposerToSend`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionatomictransactioncomposertosend/) | The parameters controlling the send, including `atc` The `AtomicTransactionComposer` and params to control send behaviour |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-81)

`Promise`< [`SendAtomicTransactionComposerResults`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendatomictransactioncomposerresults/) >

An object with transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-88)

[src/transaction/transaction.ts:782](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L782)

* * *

### sendGroupOfTransactions

[Section titled “sendGroupOfTransactions”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#sendgroupoftransactions)

▸ **sendGroupOfTransactions**(`groupSend`, `algod`): `Promise`<`Omit`< [`SendAtomicTransactionComposerResults`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendatomictransactioncomposerresults/), `"returns"`>>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-78)

| Name | Type | Description |
| :-- | :-- | :-- |
| `groupSend` | [`TransactionGroupToSend`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactiontransactiongrouptosend/) | The group details to send, with: \_ `transactions`: The array of transactions to send along with their signing account \_ `sendParams`: The parameters to dictate how the group is sent |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-82)

`Promise`<`Omit`< [`SendAtomicTransactionComposerResults`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendatomictransactioncomposerresults/), `"returns"`>>

**`Deprecated`**

Use `TransactionComposer` (`algorand.newGroup()`) or `AtomicTransactionComposer` to construct and send group transactions instead.

Signs and sends a group of [up to 16](https://dev.algorand.co/concepts/transactions/atomic-txn-groups/#create-transactions) transactions to the chain

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-89)

[src/transaction/transaction.ts:955](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L955)

* * *

### sendTransaction

[Section titled “sendTransaction”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#sendtransaction)

▸ **sendTransaction**(`send`, `algod`): `Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-79)

| Name | Type | Description |
| :-- | :-- | :-- |
| `send` | `Object` | The details for the transaction to prepare/send, including: \_ `transaction`: The unsigned transaction \_ `from`: The account to sign the transaction with: either an account with private key loaded or a logic signature account \* `config`: The sending configuration for this transaction |
| `send.from` | [`SendTransactionFrom`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#sendtransactionfrom) | - |
| `send.sendParams?` | [`SendTransactionParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionparams/) | - |
| `send.transaction` | `Transaction` | - |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-83)

`Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) >

An object with transaction (`transaction`) and (if `skipWaiting` is `false` or `undefined`) confirmation (`confirmation`)

**`Deprecated`**

Use `AlgorandClient` / `TransactionComposer` to send transactions.

Prepares a transaction for sending and then (if instructed) signs and sends the given transaction to the chain.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-90)

[src/transaction/transaction.ts:215](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L215)

* * *

### signTransaction

[Section titled “signTransaction”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#signtransaction)

▸ **signTransaction**(`transaction`, `signer`): `Promise`<`Uint8Array`>

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-80)

| Name | Type | Description |
| :-- | :-- | :-- |
| `transaction` | `Transaction` | The transaction to sign |
| `signer` | [`SendTransactionFrom`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_transaction/#sendtransactionfrom) | The signer to sign |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-84)

`Promise`<`Uint8Array`>

The signed transaction as a `Uint8Array`

**`Deprecated`**

Use `AlgorandClient` / `TransactionComposer` to sign transactions
or use the relevant underlying `account.signTxn` / `algosdk.signLogicSigTransactionObject`
/ `multiSigAccount.sign` / `TransactionSigner` methods directly.

Signs a single transaction by the given signer.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-91)

[src/transaction/transaction.ts:192](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L192)

* * *

### stripTealComments

[Section titled “stripTealComments”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#striptealcomments)

▸ **stripTealComments**(`tealCode`): `string`

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-81)

| Name | Type | Description |
| :-- | :-- | :-- |
| `tealCode` | `string` | The TEAL logic to compile |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-85)

`string`

The TEAL without comments

**`Deprecated`**

Use `AppManager.stripTealComments` instead.

Remove comments from TEAL Code

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-92)

[src/app-deploy.ts:351](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L351)

* * *

### transactionFees

[Section titled “transactionFees”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#transactionfees)

▸ **transactionFees**(`numberOfTransactions`): [`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/)

Returns an amount of µAlgo to cover standard fees for the given number of transactions using AlgoAmount

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-82)

| Name | Type | Description |
| :-- | :-- | :-- |
| `numberOfTransactions` | `number` | The of standard transaction fees to return the amount of Algo |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-86)

[`AlgoAmount`](https://dev.algorand.co/reference/algokit-utils-ts/api/classes/types_amountalgoamount/)

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-93)

[src/amount.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L89)

* * *

### transactionSignerAccount

[Section titled “transactionSignerAccount”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#transactionsigneraccount)

▸ **transactionSignerAccount**(`signer`, `sender`): [`TransactionSignerAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_accounttransactionsigneraccount/)

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-83)

| Name | Type | Description |
| :-- | :-- | :-- |
| `signer` | `TransactionSigner` | The transaction signer |
| `sender` | `string` | The address of sender account |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-87)

[`TransactionSignerAccount`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_accounttransactionsigneraccount/)

The SigningAccount wrapper

**`Deprecated`**

Use `algorand.account.getSigner(sender)` (after previously registering the signer with `setSigner`) or `{ addr: sender, signer }` instead.

Returns an account wrapper that supports a transaction signer with associated sender address.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-94)

[src/account/account.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L48)

* * *

### transferAlgos

[Section titled “transferAlgos”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#transferalgos)

▸ **transferAlgos**(`transfer`, `algod`): `Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-84)

| Name | Type | Description |
| :-- | :-- | :-- |
| `transfer` | [`AlgoTransferParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transferalgotransferparams/) | The transfer definition |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-88)

`Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) >

The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)

**`Deprecated`**

Use `algorand.send.payment()` / `algorand.createTransaction.payment()` instead

Transfer Algo between two accounts.

**`Example`**

```
await algokit.transferAlgos({ from, to, amount: algokit.algo(1) }, algod);
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-95)

[src/transfer/transfer-algos.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer-algos.ts#L22)

* * *

### transferAsset

[Section titled “transferAsset”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#transferasset)

▸ **transferAsset**(`transfer`, `algod`): `Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-85)

| Name | Type | Description |
| :-- | :-- | :-- |
| `transfer` | [`TransferAssetParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transfertransferassetparams/) | The transfer definition |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-89)

`Promise`< [`SendTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_transactionsendtransactionresult/) >

The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)

**`Deprecated`**

Use `algorand.send.assetTransfer()` / `algorand.createTransaction.assetTransfer()` instead

Transfer asset between two accounts.

**`Example`**

```
await algokit.transferAsset({ from, to, assetId, amount }, algod);
```

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-96)

[src/transfer/transfer.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer.ts#L90)

* * *

### updateApp

[Section titled “updateApp”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#updateapp)

▸ **updateApp**(`update`, `algod`): `Promise`<`Partial`< [`AppCompilationResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappcompilationresult/) \> & [`AppCallTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#appcalltransactionresult) >

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-86)

| Name | Type | Description |
| :-- | :-- | :-- |
| `update` | [`UpdateAppParams`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appupdateappparams/) | The parameters to update the app with |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-90)

`Promise`<`Partial`< [`AppCompilationResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/interfaces/types_appappcompilationresult/) \> & [`AppCallTransactionResult`](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/types_app/#appcalltransactionresult) >

The transaction send result and the compilation result

**`Deprecated`**

Updates a smart contract app.

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-97)

[src/app.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L104)

* * *

### waitForConfirmation

[Section titled “waitForConfirmation”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#waitforconfirmation)

▸ **waitForConfirmation**(`transactionId`, `maxRoundsToWait`, `algod`): `Promise`<`PendingTransactionResponse`>

Wait until the transaction is confirmed or rejected, or until `timeout`
number of rounds have passed.

#### Parameters

[Section titled “Parameters”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#parameters-87)

| Name | Type | Description |
| :-- | :-- | :-- |
| `transactionId` | `string` | The transaction ID to wait for |
| `maxRoundsToWait` | `number` \| `bigint` | Maximum number of rounds to wait |
| `algod` | `AlgodClient` | An algod client |

#### Returns

[Section titled “Returns”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#returns-91)

`Promise`<`PendingTransactionResponse`>

Pending transaction information

**`Throws`**

Throws an error if the transaction is not confirmed or rejected in the next `timeout` rounds

#### Defined in

[Section titled “Defined in”](https://dev.algorand.co/reference/algokit-utils-ts/api/modules/#defined-in-98)

[src/transaction/transaction.ts:999](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L999)

Ask AI

reCAPTCHA

Recaptcha requires verification.

protected by **reCAPTCHA**