@algorandfoundation/algokit-utils 6.3.0-beta.1 → 7.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Algorand Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,4 +1,4 @@
-# AlgoKit TypeScript Utilities
+# AlgoKit TypeScript Utilities
 
 A set of core Algorand utilities written in TypeScript and released via npm that make it easier to build solutions on Algorand. This project is part of [AlgoKit](https://github.com/algorandfoundation/algokit-cli).
 
@@ -10,45 +10,41 @@ Note: If you prefer Python there's an equivalent [Python utility library](https:
 
 ## Install
 
-This library can be installed from NPM using your favourite npm client, e.g.:
+Before installing, you'll need to decide on the version you want to target. Version 7 and 8 have the same feature set, however v7 leverages algosdk@>=2.9.0<3.0, whereas v8 leverages algosdk@>=3.0.0. Your project and it's dependencies will help you decide which version to target.
+
+Once you've decided on the target version, this library can be installed from NPM using your favourite npm client, e.g.:
+
+To target algosdk@2 and use version 7 of AlgoKit Utils, run the below:
 
 ```
-npm install @algorandfoundation/algokit-utils
+npm install algosdk@^2.9.0 @algorandfoundation/algokit-utils@^7.0.0
 ```
 
-Then to import it:
+To target algosdk@3 and use the latest version of AlgoKit Utils, run the below:
 
-```typescript
-import { AlgorandClient, Config } from '@algorandfoundation/algokit-utils'
+```
+npm install algosdk@^3.0.0 @algorandfoundation/algokit-utils
 ```
 
-See [usage](./docs/README.md#usage) for more.
-
-## Guiding principles
+Now you can import the library:
 
-This library follows the [Guiding Principles of AlgoKit](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md#guiding-principles).
+```typescript
+import { AlgorandClient, Config } from '@algorandfoundation/algokit-utils'
+```
 
-## NextJS compatibility
+See [usage](./docs/README.md#usage) for more details.
 
-`algokit-utils-ts` has a set of `node` specific utilities used for simplifying aggregation of artifacts for [AlgoKit VSCode Debugger Extension](https://github.com/algorandfoundation/algokit-avm-vscode-debugger). Which causes Next.js based projects to fail on `fs` module not found. To fix this issue, you can add the following to your `next.config.js` file:
+## Migration
 
-```js
-  webpack: (config, { isServer }) => {
-    // Fix for Module not found: Can't resolve 'fs'
-    if (!isServer) {
-      config.resolve.fallback.fs = false;
-    }
-    return config;
-  },
-```
+Whilst we aim to minimise breaking changes, there are situations where they are required.
+JSDoc deprecations should guide you through most migration paths inside your IDE, however the migration guides will provide more detailed information should you need it.
 
-The root cause is due to the fact that, unlike many frameworks, Next.js allows you to import server-only (Node.js APIs that don't work in a browser) code into your page files. When Next.js builds your project, it removes server only code from your client-side bundle by checking which code exists inside one any of the following built-in methods (code splitting):
+If you're targetting v7, please refer to the [v7 migration guide](./docs/v7-migration.md).
+If you're targetting v8, please refer to the [v8 migration guide](./docs/v8-migration.md).
 
-- getServerSideProps
-- getStaticProps
-- getStaticPaths
+## Guiding principles
 
-The Module not found: can't resolve 'xyz' error happens when you try to use server only code outside of these methods. Despite `algokit-utils` lazy loading the node specific code dynamically, Next.js does not seem to correctly identify whether a dynamic import is specific to server or client side. Hence the above fix disables the fallback for `fs` module so it ignores polyfilling it on client side.
+This library follows the [Guiding Principles of AlgoKit](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md#guiding-principles).
 
 ## Contributing
 

package/account/account.d.ts

@@ -9,7 +9,7 @@ import MultisigMetadata = algosdk.MultisigMetadata;
 import TransactionSigner = algosdk.TransactionSigner;
 import AccountInformationModel = algosdk.modelsv2.Account;
 /**
- * @deprecated Use `algorandClient.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead.
+ * @deprecated Use `algorand.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead.
  *
  * Returns an account wrapper that supports partial or full multisig signing.
  * @param multisigParams The parameters that define the multisig account
@@ -18,7 +18,7 @@ import AccountInformationModel = algosdk.modelsv2.Account;
  */
 export declare function multisigAccount(multisigParams: MultisigMetadata, signingAccounts: (Account | SigningAccount)[]): MultisigAccount;
 /**
- * @deprecated Use `algorandClient.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead.
+ * @deprecated Use `algorand.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead.
  *
  * Returns an account wrapper that supports a rekeyed account.
  * @param signer The account, with private key loaded, that is signing
@@ -27,7 +27,7 @@ export declare function multisigAccount(multisigParams: MultisigMetadata, signin
  */
 export declare function rekeyedAccount(signer: Account, sender: string): SigningAccount;
 /**
- * @deprecated Use `algorandClient.account.getSigner(sender)` (after previously registering the signer with `setSigner`) or `{ addr: sender, signer }` instead.
+ * @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.
  * @param signer The transaction signer
@@ -36,7 +36,7 @@ export declare function rekeyedAccount(signer: Account, sender: string): Signing
  */
 export declare function transactionSignerAccount(signer: TransactionSigner, sender: string): TransactionSignerAccount;
 /**
- * @deprecated Use `algorandClient.account.random()` or `algosdk.generateAccount()` instead.
+ * @deprecated Use `algorand.account.random()` or `algosdk.generateAccount()` instead.
  *
  * Returns a new, random Algorand account with secret key loaded.
  *
@@ -45,7 +45,7 @@ export declare function transactionSignerAccount(signer: TransactionSigner, send
  */
 export declare function randomAccount(): Account;
 /**
- * @deprecated Use `algorandClient.account.fromEnvironment(name, fundWith)` or `new AccountManager(clientManager).fromEnvironment()` instead.
+ * @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.
  *
@@ -96,14 +96,17 @@ export declare function getAccountAddressAsUint8Array(account: SendTransactionFr
  * @param addressEncodedInB64 The base64 encoded version of the underlying byte array of the address public key
  */
 export declare function getAccountAddressAsString(addressEncodedInB64: string): string;
-type NumberConverter<T extends AccountInformationModel> = {
+export type NumberConverter<T extends AccountInformationModel> = {
     [key in keyof T]: ToNumberIfExtends<T[key], number | bigint>;
 };
 type ToNumberIfExtends<K, E> = K extends E ? number : K;
 /** @deprecated Account information at a given round. */
-export type AccountInformation = Omit<NumberConverter<AccountInformationModel>, 'get_obj_for_encoding'>;
+export type AccountInformation = Omit<NumberConverter<AccountInformationModel>, 'getEncodingSchema' | 'toEncodingData' | 'authAddr'> & {
+    /** (spend) the address against which signing should be checked. If empty, the address of the current account is used. This field can be updated in any transaction by setting the RekeyTo field. */
+    authAddr?: string;
+};
 /**
- * @deprecated Use `algorandClient.account.getInformation(sender)` or `new AccountManager(clientManager).getInformation(sender)` instead.
+ * @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.
  *
@@ -120,7 +123,7 @@ export type AccountInformation = Omit<NumberConverter<AccountInformationModel>,
  */
 export declare function getAccountInformation(sender: string | SendTransactionFrom, algod: Algodv2): Promise<AccountInformation>;
 /**
- * @deprecated Use `algorandClient.asset.getAccountInformation(sender, assetId)` or `new AssetManager(...).getAccountInformation(sender, assetId)` instead.
+ * @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.
  *
@@ -139,4 +142,3 @@ export declare function getAccountInformation(sender: string | SendTransactionFr
  */
 export declare function getAccountAssetInformation(sender: string | SendTransactionFrom, assetId: number | bigint, algod: Algodv2): Promise<AccountAssetInformation>;
 export {};
-//# sourceMappingURL=account.d.ts.map

package/account/get-account-config-from-environment.d.ts

@@ -10,4 +10,3 @@ import { AccountConfig } from '../types/account';
  *
  */
 export declare function getAccountConfigFromEnvironment(accountName: string): AccountConfig;
-//# sourceMappingURL=get-account-config-from-environment.d.ts.map

package/account/get-account.d.ts

@@ -4,7 +4,7 @@ import { AlgoAmount } from '../types/amount';
 import Account = algosdk.Account;
 import Algodv2 = algosdk.Algodv2;
 import Kmd = algosdk.Kmd;
-/**  @deprecated use `algorandClient.account.fromEnvironment()` instead
+/**  @deprecated use `algorand.account.fromEnvironment()` instead
  *
  * Returns an Algorand account with private key loaded by convention based on the given name identifier.
  *
@@ -38,7 +38,7 @@ export declare function getAccount(account: {
     name: string;
     fundWith?: AlgoAmount;
 } | string, algod: Algodv2, kmdClient?: Kmd): Promise<Account | SigningAccount>;
-/**  @deprecated use `algorandClient.account.fromEnvironment()` instead
+/**  @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.
@@ -63,4 +63,3 @@ export declare function getAccount(account: {
     config: AccountConfig;
     fundWith?: AlgoAmount;
 }, algod: Algodv2, kmdClient?: Kmd): Promise<Account | SigningAccount>;
-//# sourceMappingURL=get-account.d.ts.map

package/account/get-dispenser-account.d.ts

@@ -2,7 +2,7 @@ import algosdk from 'algosdk';
 import Algodv2 = algosdk.Algodv2;
 import Kmd = algosdk.Kmd;
 /**
- * @deprecated Use `algorandClient.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead
+ * @deprecated Use `algorand.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead
  *
  * Returns an account (with private key loaded) that can act as a dispenser
  *
@@ -12,7 +12,6 @@ import Kmd = algosdk.Kmd;
  * @param algod An algod client
  * @param kmd A KMD client, if not specified then a default KMD client will be loaded from environment variables
  */
-export declare function getDispenserAccount(algod: Algodv2, kmd?: Kmd): Promise<import("../types/account").TransactionSignerAccount & {
+export declare function getDispenserAccount(algod: Algodv2, kmd?: Kmd): Promise<algosdk.Address & import("../types/account").TransactionSignerAccount & {
     account: import("../types/account").SigningAccount;
 }>;
-//# sourceMappingURL=get-dispenser-account.d.ts.map

package/account/index.d.ts

@@ -3,4 +3,3 @@ export * from './get-account';
 export * from './get-account-config-from-environment';
 export * from './get-dispenser-account';
 export * from './mnemonic-account';
-//# sourceMappingURL=index.d.ts.map

package/account/mnemonic-account.d.ts

@@ -1,7 +1,7 @@
 import algosdk from 'algosdk';
 import Account = algosdk.Account;
 /**
- * @deprecated Use `algorandClient.account.fromMnemonic(mnemonicSecret)` or `algosdk.mnemonicToSecretKey(mnemonicSecret)` instead.
+ * @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.
  *
@@ -11,4 +11,3 @@ import Account = algosdk.Account;
  *  never commit it into source control and ideally load it from the environment (ideally via a secret storage service) rather than the file system.
  */
 export declare function mnemonicAccount(mnemonicSecret: string): Account;
-//# sourceMappingURL=mnemonic-account.d.ts.map

package/amount.d.ts

@@ -18,25 +18,35 @@ declare global {
          */
         algo(this: number): AlgoAmount;
     }
+    interface BigInt {
+        /**
+         * Returns an `AlgoAmount` using this number of microAlgo.
+         */
+        microAlgo(this: bigint): AlgoAmount;
+        /**
+         * Returns an `AlgoAmount` using this number of Algo.
+         */
+        algo(this: bigint): AlgoAmount;
+    }
 }
 /** Returns an amount of Algo using AlgoAmount
  * @param algos The amount of Algo
  */
-export declare const algos: (algos: number) => AlgoAmount;
+export declare const algos: (algos: number | bigint) => AlgoAmount;
 /** Returns an amount of Algo using AlgoAmount
  * @param algos The amount of Algo
  */
-export declare const algo: (algos: number) => AlgoAmount;
+export declare const algo: (algos: number | bigint) => AlgoAmount;
 /** Returns an amount of µAlgo using AlgoAmount
  * @param microAlgos The amount of µAlgo
  */
-export declare const microAlgos: (microAlgos: number) => AlgoAmount;
+export declare const microAlgos: (microAlgos: number | bigint) => AlgoAmount;
 /** Returns an amount of µAlgo using AlgoAmount
  * @param microAlgos The amount of µAlgo
  */
-export declare const microAlgo: (microAlgos: number) => AlgoAmount;
+export declare const microAlgo: (microAlgos: number | bigint) => AlgoAmount;
 /** Returns an amount of µAlgo to cover standard fees for the given number of transactions using AlgoAmount
  * @param numberOfTransactions The of standard transaction fees to return the amount of Algo
  */
 export declare const transactionFees: (numberOfTransactions: number) => AlgoAmount;
-//# sourceMappingURL=amount.d.ts.map
+export declare const ALGORAND_MIN_TX_FEE: AlgoAmount;

package/app-client.d.ts

@@ -2,6 +2,11 @@ import algosdk from 'algosdk';
 import { AppSpecAppDetails, AppSpecAppDetailsByCreatorAndName, AppSpecAppDetailsById, ApplicationClient } from './types/app-client';
 import Algodv2 = algosdk.Algodv2;
 /**
+ * @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
  * @param appDetails The details of the app
  * @param algod An algod instance
@@ -33,6 +38,11 @@ import Algodv2 = algosdk.Algodv2;
  */
 export declare function getAppClient(appDetails: AppSpecAppDetails, algod: Algodv2): ApplicationClient;
 /**
+ * @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
  * @param appDetails The details of the app
  * @param algod An algod instance
@@ -51,6 +61,11 @@ export declare function getAppClient(appDetails: AppSpecAppDetails, algod: Algod
  */
 export declare function getAppClientById(appDetails: AppSpecAppDetailsById, algod: Algodv2): ApplicationClient;
 /**
+ * @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
  * @param appDetails The details of the app by creator and name
  * @param algod An algod instance
@@ -58,10 +73,10 @@ export declare function getAppClientById(appDetails: AppSpecAppDetailsById, algo
  * @example
  * const client = algokit.getAppClientByCreatorAndName(
  *     {
- *       app: {appSpec},
- *       sender: {account},
- *       creatorAddress: {account.addr},
- *       findExistingUsing: {indexerClient},
+ *       app: appSpec,
+ *       sender: account,
+ *       creatorAddress: account,
+ *       findExistingUsing: indexerClient,
  *     },
  *     algodClient,
  *   )
@@ -69,4 +84,3 @@ export declare function getAppClientById(appDetails: AppSpecAppDetailsById, algo
  * @returns The application client
  */
 export declare function getAppClientByCreatorAndName(appDetails: AppSpecAppDetailsByCreatorAndName, algod: Algodv2): ApplicationClient;
-//# sourceMappingURL=app-client.d.ts.map

package/app-deploy.d.ts

@@ -5,6 +5,8 @@ import Algodv2 = algosdk.Algodv2;
 import Indexer = algosdk.Indexer;
 import modelsv2 = algosdk.modelsv2;
 /**
+ * @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
@@ -30,7 +32,10 @@ export declare function deployApp(deployment: AppDeploymentParams, algod: Algodv
 }) | (AppMetadata & {
     operationPerformed: 'nothing';
 }))>;
-/** Returns true is there is a breaking change in the application state schema from before to after.
+/**
+ * @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 :(
  *
@@ -40,6 +45,8 @@ export declare function deployApp(deployment: AppDeploymentParams, algod: Algodv
  */
 export declare function isSchemaIsBroken(before: modelsv2.ApplicationStateSchema, after: modelsv2.ApplicationStateSchema): boolean;
 /**
+ * @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).
@@ -50,12 +57,16 @@ export declare function isSchemaIsBroken(before: modelsv2.ApplicationStateSchema
  */
 export declare function getCreatorAppsByName(creatorAccount: SendTransactionFrom | string, indexer: Indexer): Promise<AppLookup>;
 /**
+ * @deprecated Use `{ dAppName: APP_DEPLOY_NOTE_DAPP, data: metadata, format: 'j' }` instead.
+ *
  * Return the transaction note for an app deployment.
  * @param metadata The metadata of the deployment
  * @returns The transaction note as a utf-8 string
  */
 export declare function getAppDeploymentTransactionNote(metadata: AppDeployMetadata): Arc2TransactionNote;
 /**
+ * @deprecated Use `AppManager.replaceTealTemplateDeployTimeControlParams` instead
+ *
  * Replaces deploy-time deployment control parameters within the given teal code.
  *
  * * `TMPL_UPDATABLE` for updatability / immutability control
@@ -73,6 +84,8 @@ export declare function replaceDeployTimeControlParams(tealCode: string, params:
     deletable?: boolean;
 }): string;
 /**
+ * @deprecated Use `AppManager.replaceTealTemplateParams` instead
+ *
  * Performs template substitution of a teal file.
  *
  * Looks for `TMPL_{parameter}` for template replacements.
@@ -83,6 +96,8 @@ export declare function replaceDeployTimeControlParams(tealCode: string, params:
  */
 export declare function performTemplateSubstitution(tealCode: string, templateParams?: TealTemplateParams): string;
 /**
+ * @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.
@@ -95,10 +110,11 @@ export declare function performTemplateSubstitution(tealCode: string, templatePa
  */
 export declare function performTemplateSubstitutionAndCompile(tealCode: string, algod: Algodv2, templateParams?: TealTemplateParams, deploymentMetadata?: AppDeployMetadata): Promise<CompiledTeal>;
 /**
+ * @deprecated Use `AppManager.stripTealComments` instead.
+ *
  * Remove comments from TEAL Code
  *
  * @param tealCode The TEAL logic to compile
  * @returns The TEAL without comments
  */
 export declare function stripTealComments(tealCode: string): string;
-//# sourceMappingURL=app-deploy.d.ts.map

package/app.d.ts

@@ -8,6 +8,9 @@ import Algodv2 = algosdk.Algodv2;
 import modelsv2 = algosdk.modelsv2;
 import OnApplicationComplete = algosdk.OnApplicationComplete;
 /**
+ * @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.
  * @param create The parameters to create the app with
  * @param algod An algod client
@@ -15,13 +18,19 @@ import OnApplicationComplete = algosdk.OnApplicationComplete;
  */
 export declare function createApp(create: CreateAppParams, algod: Algodv2): Promise<Partial<AppCompilationResult> & AppCallTransactionResult & AppReference>;
 /**
+ * @deprecated Use `algorand.send.appUpdate()` / `algorand.createTransaction.appUpdate()` / `algorand.send.appUpdateMethodCall()`
+ * / `algorand.createTransaction.appUpdateMethodCall()` instead
+ *
  * Updates a smart contract app.
  * @param update The parameters to update the app with
  * @param algod An algod client
  * @returns The transaction send result and the compilation result
  */
 export declare function updateApp(update: UpdateAppParams, algod: Algodv2): Promise<Partial<AppCompilationResult> & AppCallTransactionResult>;
-/** Returns an `algosdk.OnApplicationComplete` for the given onCompleteAction.
+/**
+ * @deprecated Use `algosdk.OnApplicationComplete` directly instead.
+ *
+ * Returns a `algosdk.OnApplicationComplete` for the given onCompleteAction.
  *
  * If given `undefined` will return `OnApplicationComplete.NoOpOC`.
  *
@@ -32,6 +41,9 @@ export declare function updateApp(update: UpdateAppParams, algod: Algodv2): Prom
  */
 export declare function getAppOnCompleteAction(onCompletionAction?: AppCallType | OnApplicationComplete): algosdk.OnApplicationComplete;
 /**
+ * @deprecated Use `algorand.send.appUpdate()` / `algorand.createTransaction.appUpdate()` / `algorand.send.appUpdateMethodCall()`
+ * / `algorand.createTransaction.appUpdateMethodCall()` instead
+ *
  * Issues a call to a given app.
  * @param call The call details.
  * @param algod An algod client
@@ -39,6 +51,8 @@ export declare function getAppOnCompleteAction(onCompletionAction?: AppCallType
  */
 export declare function callApp(call: AppCallParams, algod: Algodv2): Promise<AppCallTransactionResult>;
 /**
+ * @deprecated Use `AppManager.getABIReturn` instead.
+ *
  * Returns any ABI return values for the given app call arguments and transaction confirmation.
  * @param args The arguments that were used for the call
  * @param confirmation The transaction confirmation from algod
@@ -46,6 +60,8 @@ export declare function callApp(call: AppCallParams, algod: Algodv2): Promise<Ap
  */
 export declare function getABIReturn(args?: AppCallArgs, confirmation?: modelsv2.PendingTransactionResponse): ABIReturn | undefined;
 /**
+ * @deprecated Use `algorand.app.getGlobalState` instead.
+ *
  * Returns the current global state values for the given app ID
  * @param appId The ID of the app return global state for
  * @param algod An algod client instance
@@ -53,6 +69,8 @@ export declare function getABIReturn(args?: AppCallArgs, confirmation?: modelsv2
  */
 export declare function getAppGlobalState(appId: number | bigint, algod: Algodv2): Promise<AppState>;
 /**
+ * @deprecated Use `algorand.app.getLocalState` instead.
+ *
  * Returns the current global state values for the given app ID and account
  * @param appId The ID of the app return global state for
  * @param account Either the string address of an account or an account object for the account to get local state for the given app
@@ -61,6 +79,7 @@ export declare function getAppGlobalState(appId: number | bigint, algod: Algodv2
  */
 export declare function getAppLocalState(appId: number | bigint, account: string | SendTransactionFrom, algod: Algodv2): Promise<AppState>;
 /**
+ * @deprecated Use `algorand.app.getBoxNames` instead.
  * Returns the names of the boxes for the given app.
  * @param appId The ID of the app return box names for
  * @param algod An algod client instance
@@ -68,6 +87,7 @@ export declare function getAppLocalState(appId: number | bigint, account: string
  */
 export declare function getAppBoxNames(appId: number | bigint, algod: Algodv2): Promise<BoxName[]>;
 /**
+ * @deprecated Use `algorand.app.getBoxValue` instead.
  * Returns the value of the given box name for the given app.
  * @param appId The ID of the app return box names for
  * @param boxName The name of the box to return either as a string, binary array or `BoxName`
@@ -76,6 +96,7 @@ export declare function getAppBoxNames(appId: number | bigint, algod: Algodv2):
  */
 export declare function getAppBoxValue(appId: number | bigint, boxName: string | Uint8Array | BoxName, algod: Algodv2): Promise<Uint8Array>;
 /**
+ * @deprecated Use `algorand.app.getBoxValues` instead.
  * Returns the value of the given box names for the given app.
  * @param appId The ID of the app return box names for
  * @param boxNames The names of the boxes to return either as a string, binary array or `BoxName`
@@ -84,6 +105,7 @@ export declare function getAppBoxValue(appId: number | bigint, boxName: string |
  */
 export declare function getAppBoxValues(appId: number, boxNames: (string | Uint8Array | BoxName)[], algod: Algodv2): Promise<Uint8Array[]>;
 /**
+ * @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.
  * @param request The parameters for the box value request
  * @param algod An algod client instance
@@ -91,6 +113,7 @@ export declare function getAppBoxValues(appId: number, boxNames: (string | Uint8
  */
 export declare function getAppBoxValueFromABIType(request: BoxValueRequestParams, algod: Algodv2): Promise<ABIValue>;
 /**
+ * @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.
  * @param request The parameters for the box value request
  * @param algod An algod client instance
@@ -98,6 +121,8 @@ export declare function getAppBoxValueFromABIType(request: BoxValueRequestParams
  */
 export declare function getAppBoxValuesFromABIType(request: BoxValuesRequestParams, algod: Algodv2): Promise<ABIValue[]>;
 /**
+ * @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.
  * @param state A `global-state`, `local-state`, `global-state-deltas` or `local-state-deltas`
@@ -108,6 +133,8 @@ export declare function decodeAppState(state: {
     value: modelsv2.TealValue | modelsv2.EvalDelta;
 }[]): AppState;
 /**
+ * @deprecated Use `TransactionComposer` methods to construct transactions instead.
+ *
  * Returns the app args ready to load onto an app `Transaction` object
  * @param args The app call args
  * @returns The args ready to load into a `Transaction`
@@ -121,6 +148,8 @@ export declare function getAppArgsForTransaction(args?: RawAppCallArgs): {
     lease: Uint8Array | undefined;
 } | undefined;
 /**
+ * @deprecated Use `TransactionComposer` methods to construct transactions instead.
+ *
  * Returns the app args ready to load onto an ABI method call in `AtomicTransactionComposer`
  * @param args The ABI app call args
  * @param from The transaction signer
@@ -135,16 +164,20 @@ export declare function getAppArgsForABICall(args: ABIAppCallArgs, from: SendTra
     appForeignApps: number[] | undefined;
     appForeignAssets: number[] | undefined;
     appAccounts: string[] | undefined;
-    methodArgs: (string | number | bigint | boolean | algosdk.TransactionWithSigner | Uint8Array | algosdk.ABIValue[])[];
+    methodArgs: (string | number | bigint | boolean | Uint8Array | algosdk.ABIValue[] | algosdk.TransactionWithSigner)[];
     rekeyTo: string | undefined;
 }>;
 /**
+ * @deprecated Use `AppManager.getBoxReference()` instead.
+ *
  * Returns a `algosdk.BoxReference` given a `BoxIdentifier` or `BoxReference`.
  * @param box The box to return a reference for
  * @returns The box reference ready to pass into a `Transaction`
  */
 export declare function getBoxReference(box: BoxIdentifier | BoxReference | algosdk.BoxReference): algosdk.BoxReference;
 /**
+ * @deprecated Use `algorand.app.getById` instead.
+ *
  * Gets the current data for the given app from algod.
  *
  * @param appId The id of the app
@@ -153,6 +186,8 @@ export declare function getBoxReference(box: BoxIdentifier | BoxReference | algo
  */
 export declare function getAppById(appId: number | bigint, algod: Algodv2): Promise<algosdk.modelsv2.Application>;
 /**
+ * @deprecated Use `algorand.app.compileTeal` instead.
+ *
  * Compiles the given TEAL using algod and returns the result, including source map.
  *
  * @param algod An algod client
@@ -161,9 +196,10 @@ export declare function getAppById(appId: number | bigint, algod: Algodv2): Prom
  */
 export declare function compileTeal(tealCode: string, algod: Algodv2): Promise<CompiledTeal>;
 /**
+ * @deprecated Use `abiMethod.getSignature()` or `new ABIMethod(abiMethodParams).getSignature()` instead.
+ *
  * Returns the encoded ABI spec for a given ABI Method
  * @param method The method to return a signature for
  * @returns The encoded ABI method spec e.g. `method_name(uint64,string)string`
  */
 export declare const getABIMethodSignature: (method: ABIMethodParams | ABIMethod) => string;
-//# sourceMappingURL=app.d.ts.map

package/asset.d.ts

@@ -3,7 +3,7 @@ import { AssetBulkOptInOutParams, AssetOptInParams, AssetOptOutParams, CreateAss
 import { SendTransactionResult } from './types/transaction';
 import Algodv2 = algosdk.Algodv2;
 /**
- * @deprecated use `algorandClient.send.assetCreate()` / `algorandClient.transaction.assetCreate()` instead
+ * @deprecated use `algorand.send.assetCreate()` / `algorand.createTransaction.assetCreate()` instead
  *
  * Create an Algorand Standard Asset (ASA).
  * @param create The asset creation definition
@@ -21,7 +21,7 @@ export declare function createAsset(create: CreateAssetParams, algod: Algodv2):
     };
 }>;
 /**
- * @deprecated use `algorandClient.send.assetOptIn()` / `algorandClient.transaction.assetOptIn()` instead
+ * @deprecated use `algorand.send.assetOptIn()` / `algorand.createTransaction.assetOptIn()` instead
  *
  * Opt-in an account to an asset.
  * @param optIn The opt-in definition
@@ -35,7 +35,7 @@ export declare function createAsset(create: CreateAssetParams, algod: Algodv2):
  */
 export declare function assetOptIn(optIn: AssetOptInParams, algod: Algodv2): Promise<SendTransactionResult>;
 /**
- * @deprecated use `algorandClient.send.assetOptOut()` / `algorandClient.transaction.assetOptOut()` instead
+ * @deprecated use `algorand.send.assetOptOut()` / `algorand.createTransaction.assetOptOut()` instead
  *
  * Opt-out an account from an asset.
  * @param optOut The opt-in definition
@@ -49,7 +49,7 @@ export declare function assetOptIn(optIn: AssetOptInParams, algod: Algodv2): Pro
  */
 export declare function assetOptOut(optOut: AssetOptOutParams, algod: Algodv2): Promise<SendTransactionResult>;
 /**
- * @deprecated use `algorandClient.asset.bulkOptIn()` instead
+ * @deprecated use `algorand.asset.bulkOptIn()` instead
  *
  * Opt in to a list of assets on the Algorand blockchain.
  *
@@ -61,7 +61,7 @@ export declare function assetOptOut(optOut: AssetOptOutParams, algod: Algodv2):
  */
 export declare function assetBulkOptIn(optIn: AssetBulkOptInOutParams, algod: Algodv2): Promise<Record<number, string>>;
 /**
- * @deprecated use `algorandClient.asset.bulkOptOut()` instead
+ * @deprecated use `algorand.asset.bulkOptOut()` instead
  *
  * Opt out of multiple assets in Algorand blockchain.
  *
@@ -72,4 +72,3 @@ export declare function assetBulkOptIn(optIn: AssetBulkOptInOutParams, algod: Al
  * @example algokit.bulkOptOut({ account: account, assetIds: [12345, 67890] }, algod)
  */
 export declare function assetBulkOptOut(optOut: AssetBulkOptInOutParams, algod: Algodv2): Promise<Record<number, string>>;
-//# sourceMappingURL=asset.d.ts.map

package/config.d.ts

@@ -1,4 +1,3 @@
 import { UpdatableConfig } from './types/config';
 /** The AlgoKit config. To update it use the configure method. */
 export declare const Config: UpdatableConfig;
-//# sourceMappingURL=config.d.ts.map