@algorandfoundation/algokit-utils 6.2.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

@@ -1,5 +1,5 @@
 import algosdk from 'algosdk';
-import { AccountAssetInformation, AccountInformation, MultisigAccount, SigningAccount, TransactionSignerAccount } from '../types/account';
+import { AccountAssetInformation, MultisigAccount, SigningAccount, TransactionSignerAccount } from '../types/account';
 import { AlgoAmount } from '../types/amount';
 import { SendTransactionFrom } from '../types/transaction';
 import Account = algosdk.Account;
@@ -7,8 +7,9 @@ import Algodv2 = algosdk.Algodv2;
 import Kmd = algosdk.Kmd;
 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
@@ -17,7 +18,7 @@ import TransactionSigner = algosdk.TransactionSigner;
  */
 export declare function multisigAccount(multisigParams: MultisigMetadata, signingAccounts: (Account | SigningAccount)[]): MultisigAccount;
 /**
- * @deprecated Use `algorandClient.account.rekeyed(account, sender)` 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
@@ -26,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
@@ -35,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.
  *
@@ -44,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.
  *
@@ -65,12 +66,12 @@ export declare function randomAccount(): Account;
  * 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) ALGOs from the default LocalNet dispenser.
+ * 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.
  *
  * @param account 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 Algos will be funded from the dispenser 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
  * @param algod An algod client
  * @param 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 The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account)
@@ -95,8 +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;
+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>, '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.
  *
@@ -113,7 +123,7 @@ export declare function getAccountAddressAsString(addressEncodedInB64: string):
  */
 export declare function getAccountInformation(sender: string | SendTransactionFrom, algod: Algodv2): Promise<AccountInformation>;
 /**
- * @deprecated Use `algorandClient.account.getAssetInformation(sender, assetId)` or `new AccountManager(clientManager).getAssetInformation(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.
  *
@@ -131,4 +141,4 @@ export declare function getAccountInformation(sender: string | SendTransactionFr
  * @returns The account asset holding information
  */
 export declare function getAccountAssetInformation(sender: string | SendTransactionFrom, assetId: number | bigint, algod: Algodv2): Promise<AccountAssetInformation>;
-//# sourceMappingURL=account.d.ts.map
+export {};

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.
  *
@@ -25,11 +25,11 @@ import Kmd = algosdk.Kmd;
  * 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) ALGOs from the default LocalNet dispenser.
+ * 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.
  *
  * @param account 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 Algos will be funded from the dispenser 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
  * @param algod An algod client
  * @param 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 The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account)
@@ -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.
@@ -50,11 +50,11 @@ export declare function getAccount(account: {
  * const account = await getAccount({config: getAccountConfigFromEnvironment('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) ALGOs from the default LocalNet dispenser.
+ * 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.
  *
  * @param account 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 Algos will be funded from the dispenser 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
  * @param algod An algod client
  * @param 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 The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account)
@@ -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

@@ -1,20 +1,52 @@
 import { AlgoAmount } from './types/amount';
 declare global {
     interface Number {
+        /**
+         * Returns an `AlgoAmount` using this number of microAlgo.
+         */
         microAlgos(this: number): AlgoAmount;
+        /**
+         * Returns an `AlgoAmount` using this number of Algo.
+         */
         algos(this: number): AlgoAmount;
+        /**
+         * Returns an `AlgoAmount` using this number of microAlgo.
+         */
+        microAlgo(this: number): AlgoAmount;
+        /**
+         * Returns an `AlgoAmount` using this number of Algo.
+         */
+        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 Algos using AlgoAmount
- * @param algos The amount in Algos
+/** Returns an amount of Algo using AlgoAmount
+ * @param algos The amount of Algo
+ */
+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 | bigint) => AlgoAmount;
+/** Returns an amount of µAlgo using AlgoAmount
+ * @param microAlgos The amount of µAlgo
  */
-export declare const algos: (algos: number) => AlgoAmount;
-/** Returns an amount of µAlgos using AlgoAmount
- * @param microAlgos The amount in µAlgos
+export declare const microAlgos: (microAlgos: number | bigint) => AlgoAmount;
+/** Returns an amount of µAlgo using AlgoAmount
+ * @param microAlgos The amount of µAlgo
  */
-export declare const microAlgos: (microAlgos: number) => AlgoAmount;
-/** Returns an amount of µAlgos to cover standard fees for the given number of transactions using AlgoAmount
- * @param numberOfTransactions The of standard transaction fees to return the amount of ALGOs
+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