@goplausible/algorand-mcp 3.0.7

package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_manager.AppManager.md

@@ -0,0 +1,527 @@
+[@algorandfoundation/algokit-utils](../README.md) / [types/app-manager](../modules/types_app_manager.md) / AppManager
+
+# Class: AppManager
+
+[types/app-manager](../modules/types_app_manager.md).AppManager
+
+Allows management of application information.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](types_app_manager.AppManager.md#constructor)
+
+### Properties
+
+- [\_algod](types_app_manager.AppManager.md#_algod)
+- [\_compilationResults](types_app_manager.AppManager.md#_compilationresults)
+
+### Methods
+
+- [compileTeal](types_app_manager.AppManager.md#compileteal)
+- [compileTealTemplate](types_app_manager.AppManager.md#compiletealtemplate)
+- [getBoxNames](types_app_manager.AppManager.md#getboxnames)
+- [getBoxValue](types_app_manager.AppManager.md#getboxvalue)
+- [getBoxValueFromABIType](types_app_manager.AppManager.md#getboxvaluefromabitype)
+- [getBoxValues](types_app_manager.AppManager.md#getboxvalues)
+- [getBoxValuesFromABIType](types_app_manager.AppManager.md#getboxvaluesfromabitype)
+- [getById](types_app_manager.AppManager.md#getbyid)
+- [getCompilationResult](types_app_manager.AppManager.md#getcompilationresult)
+- [getGlobalState](types_app_manager.AppManager.md#getglobalstate)
+- [getLocalState](types_app_manager.AppManager.md#getlocalstate)
+- [decodeAppState](types_app_manager.AppManager.md#decodeappstate)
+- [getABIReturn](types_app_manager.AppManager.md#getabireturn)
+- [getBoxReference](types_app_manager.AppManager.md#getboxreference)
+- [replaceTealTemplateDeployTimeControlParams](types_app_manager.AppManager.md#replacetealtemplatedeploytimecontrolparams)
+- [replaceTealTemplateParams](types_app_manager.AppManager.md#replacetealtemplateparams)
+- [stripTealComments](types_app_manager.AppManager.md#striptealcomments)
+
+## Constructors
+
+### constructor
+
+• **new AppManager**(`algod`): [`AppManager`](types_app_manager.AppManager.md)
+
+Creates an `AppManager`
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `algod` | `AlgodClient` | An algod instance |
+
+#### Returns
+
+[`AppManager`](types_app_manager.AppManager.md)
+
+#### Defined in
+
+[src/types/app-manager.ts:106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L106)
+
+## Properties
+
+### \_algod
+
+• `Private` **\_algod**: `AlgodClient`
+
+#### Defined in
+
+[src/types/app-manager.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L99)
+
+___
+
+### \_compilationResults
+
+• `Private` **\_compilationResults**: `Record`\<`string`, [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\> = `{}`
+
+#### Defined in
+
+[src/types/app-manager.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L100)
+
+## Methods
+
+### compileTeal
+
+▸ **compileTeal**(`tealCode`): `Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\>
+
+Compiles the given TEAL using algod and returns the result, including source map.
+
+The result of this compilation is also cached keyed by the TEAL
+ code so it can be retrieved via `getCompilationResult`.
+
+This function is re-entrant; it will only compile the same code once.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `tealCode` | `string` | The TEAL code |
+
+#### Returns
+
+`Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\>
+
+The information about the compiled file
+
+#### Defined in
+
+[src/types/app-manager.ts:121](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L121)
+
+___
+
+### compileTealTemplate
+
+▸ **compileTealTemplate**(`tealTemplateCode`, `templateParams?`, `deploymentMetadata?`): `Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\>
+
+Performs template substitution of a teal template and compiles it, returning the compiled result.
+
+Looks for `TMPL_{parameter}` for template replacements and replaces AlgoKit deploy-time control parameters
+if deployment metadata is specified.
+
+* `TMPL_UPDATABLE` for updatability / immutability control
+* `TMPL_DELETABLE` for deletability / permanence control
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `tealTemplateCode` | `string` | The TEAL logic to compile |
+| `templateParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Any parameters to replace in the .teal file before compiling |
+| `deploymentMetadata?` | `Object` | The deployment metadata the app will be deployed with |
+| `deploymentMetadata.deletable?` | `boolean` | - |
+| `deploymentMetadata.updatable?` | `boolean` | - |
+
+#### Returns
+
+`Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\>
+
+The information about the compiled code
+
+#### Defined in
+
+[src/types/app-manager.ts:153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L153)
+
+___
+
+### getBoxNames
+
+▸ **getBoxNames**(`appId`): `Promise`\<[`BoxName`](../interfaces/types_app.BoxName.md)[]\>
+
+Returns the names of the current boxes for the given app.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `appId` | `bigint` | The ID of the app return box names for |
+
+#### Returns
+
+`Promise`\<[`BoxName`](../interfaces/types_app.BoxName.md)[]\>
+
+The current box names
+
+#### Defined in
+
+[src/types/app-manager.ts:239](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L239)
+
+___
+
+### getBoxValue
+
+▸ **getBoxValue**(`appId`, `boxName`): `Promise`\<`Uint8Array`\>
+
+Returns the value of the given box name for the given app.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `appId` | `bigint` | The ID of the app return box names for |
+| `boxName` | [`BoxName`](../interfaces/types_app.BoxName.md) \| [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) | The name of the box to return either as a string, binary array or `BoxName` |
+
+#### Returns
+
+`Promise`\<`Uint8Array`\>
+
+The current box value as a byte array
+
+#### Defined in
+
+[src/types/app-manager.ts:256](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L256)
+
+___
+
+### getBoxValueFromABIType
+
+▸ **getBoxValueFromABIType**(`request`): `Promise`\<`ABIValue`\>
+
+Returns the value of the given box name for the given app decoded based on the given ABI type.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `request` | [`BoxValueRequestParams`](../interfaces/types_app_manager.BoxValueRequestParams.md) | The parameters for the box value request |
+
+#### Returns
+
+`Promise`\<`ABIValue`\>
+
+The current box value as an ABI value
+
+#### Defined in
+
+[src/types/app-manager.ts:278](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L278)
+
+___
+
+### getBoxValues
+
+▸ **getBoxValues**(`appId`, `boxNames`): `Promise`\<`Uint8Array`[]\>
+
+Returns the value of the given box names for the given app.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `appId` | `bigint` | The ID of the app return box names for |
+| `boxNames` | ([`BoxName`](../interfaces/types_app.BoxName.md) \| [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier))[] | The names of the boxes to return either as a string, binary array or `BoxName` |
+
+#### Returns
+
+`Promise`\<`Uint8Array`[]\>
+
+The current box values as a byte array in the same order as the passed in box names
+
+#### Defined in
+
+[src/types/app-manager.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L269)
+
+___
+
+### getBoxValuesFromABIType
+
+▸ **getBoxValuesFromABIType**(`request`): `Promise`\<`ABIValue`[]\>
+
+Returns the value of the given box names for the given app decoded based on the given ABI type.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `request` | [`BoxValuesRequestParams`](../interfaces/types_app_manager.BoxValuesRequestParams.md) | The parameters for the box value request |
+
+#### Returns
+
+`Promise`\<`ABIValue`[]\>
+
+The current box values as an ABI value in the same order as the passed in box names
+
+#### Defined in
+
+[src/types/app-manager.ts:289](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L289)
+
+___
+
+### getById
+
+▸ **getById**(`appId`): `Promise`\<[`AppInformation`](../interfaces/types_app_manager.AppInformation.md)\>
+
+Returns the current app information for the app with the given ID.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `appId` | `bigint` | The ID of the app |
+
+#### Returns
+
+`Promise`\<[`AppInformation`](../interfaces/types_app_manager.AppInformation.md)\>
+
+The app information
+
+**`Example`**
+
+```typescript
+const appInfo = await appManager.getById(12353n);
+```
+
+#### Defined in
+
+[src/types/app-manager.ts:190](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L190)
+
+___
+
+### getCompilationResult
+
+▸ **getCompilationResult**(`tealCode`): `undefined` \| [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)
+
+Returns a previous compilation result.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `tealCode` | `string` | The TEAL code |
+
+#### Returns
+
+`undefined` \| [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)
+
+The information about the previously compiled file
+ or `undefined` if that TEAL code wasn't previously compiled
+
+#### Defined in
+
+[src/types/app-manager.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L175)
+
+___
+
+### getGlobalState
+
+▸ **getGlobalState**(`appId`): `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\>
+
+Returns the current global state values for the given app ID and account address
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `appId` | `bigint` | The ID of the app to return global state for |
+
+#### Returns
+
+`Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\>
+
+The current global state for the given app
+
+#### Defined in
+
+[src/types/app-manager.ts:213](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L213)
+
+___
+
+### getLocalState
+
+▸ **getLocalState**(`appId`, `address`): `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\>
+
+Returns the current local state values for the given app ID and account address
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `appId` | `bigint` | The ID of the app to return local state for |
+| `address` | `string` \| `Address` | The string address of the account to get local state for the given app |
+
+#### Returns
+
+`Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\>
+
+The current local state for the given (app, account) combination
+
+#### Defined in
+
+[src/types/app-manager.ts:224](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L224)
+
+___
+
+### decodeAppState
+
+▸ **decodeAppState**(`state`): [`AppState`](../interfaces/types_app.AppState.md)
+
+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.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `state` | \{ `key`: `Uint8Array` ; `value`: `TealValue` \| `EvalDelta`  }[] | A `global-state`, `local-state`, `global-state-deltas` or `local-state-deltas` |
+
+#### Returns
+
+[`AppState`](../interfaces/types_app.AppState.md)
+
+An object keyeed by the UTF-8 representation of the key with various parsings of the values
+
+#### Defined in
+
+[src/types/app-manager.ts:313](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L313)
+
+___
+
+### getABIReturn
+
+▸ **getABIReturn**(`confirmation`, `method`): `undefined` \| [`ABIReturn`](../modules/types_app.md#abireturn)
+
+Returns any ABI return values for the given app call arguments and transaction confirmation.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `confirmation` | `undefined` \| `PendingTransactionResponse` | The transaction confirmation from algod |
+| `method` | `undefined` \| `ABIMethod` | The ABI method |
+
+#### Returns
+
+`undefined` \| [`ABIReturn`](../modules/types_app.md#abireturn)
+
+The return value for the method call
+
+#### Defined in
+
+[src/types/app-manager.ts:362](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L362)
+
+___
+
+### getBoxReference
+
+▸ **getBoxReference**(`boxId`): `BoxReference`
+
+Returns a `algosdk.BoxReference` given a `BoxIdentifier` or `BoxReference`.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `boxId` | [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md) | The box to return a reference for |
+
+#### Returns
+
+`BoxReference`
+
+The box reference ready to pass into a `algosdk.Transaction`
+
+#### Defined in
+
+[src/types/app-manager.ts:299](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L299)
+
+___
+
+### replaceTealTemplateDeployTimeControlParams
+
+▸ **replaceTealTemplateDeployTimeControlParams**(`tealTemplateCode`, `params`): `string`
+
+Replaces AlgoKit deploy-time deployment control parameters within the given TEAL template code.
+
+* `TMPL_UPDATABLE` for updatability / immutability control
+* `TMPL_DELETABLE` for deletability / permanence control
+
+Note: If these values are defined, but the corresponding `TMPL_*` value
+ isn't in the teal code it will throw an exception.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `tealTemplateCode` | `string` | The TEAL template code to substitute |
+| `params` | `Object` | The deploy-time deployment control parameter value to replace |
+| `params.deletable?` | `boolean` | - |
+| `params.updatable?` | `boolean` | - |
+
+#### Returns
+
+`string`
+
+The replaced TEAL code
+
+#### Defined in
+
+[src/types/app-manager.ts:392](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L392)
+
+___
+
+### replaceTealTemplateParams
+
+▸ **replaceTealTemplateParams**(`tealTemplateCode`, `templateParams?`): `string`
+
+Performs template substitution of a teal file.
+
+Looks for `TMPL_{parameter}` for template replacements.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `tealTemplateCode` | `string` | The TEAL template code to make parameter replacements in |
+| `templateParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Any parameters to replace in the teal code |
+
+#### Returns
+
+`string`
+
+The TEAL code with replacements
+
+#### Defined in
+
+[src/types/app-manager.ts:423](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L423)
+
+___
+
+### stripTealComments
+
+▸ **stripTealComments**(`tealCode`): `string`
+
+Remove comments from TEAL code (useful to reduce code size before compilation).
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `tealCode` | `string` | The TEAL logic to strip |
+
+#### Returns
+
+`string`
+
+The TEAL without comments
+
+#### Defined in
+
+[src/types/app-manager.ts:458](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L458)