@algorandfoundation/algokit-utils 10.0.0-alpha.3 → 10.0.0-alpha.32

package/app.d.ts

@@ -0,0 +1,257 @@
+import { Address } from "./packages/common/src/address.js";
+import { Expand } from "./packages/common/src/expand.js";
+import { ProgramSourceMap } from "./packages/common/src/sourcemap.js";
+import { ABIValue } from "./packages/abi/src/abi-value.js";
+import { ABIType } from "./packages/abi/src/abi-type.js";
+import { ABIMethod, ABIReturn } from "./packages/abi/src/abi-method.js";
+import { BoxReference, OnApplicationComplete } from "./packages/transact/src/transactions/app-call.js";
+import { Transaction } from "./packages/transact/src/transactions/transaction.js";
+import { SuggestedParams } from "./packages/algod_client/src/models/suggested-params.js";
+import { SendSingleTransactionResult, SendTransactionFrom, SendTransactionParams, SendTransactionResult, SendTransactionResults, TransactionNote, TransactionToSign } from "./transaction/types.js";
+import { TransactionWithSigner } from "./transaction/transaction.js";
+import { BoxIdentifier, BoxReference as BoxReference$1 } from "./app-manager.js";
+
+//#region src/app.d.ts
+type SourceMap = ProgramSourceMap;
+/** The name of the TEAL template variable for deploy-time immutability control */
+declare const UPDATABLE_TEMPLATE_NAME = "TMPL_UPDATABLE";
+/** The name of the TEAL template variable for deploy-time permanence control */
+declare const DELETABLE_TEMPLATE_NAME = "TMPL_DELETABLE";
+/** The app create/update [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) transaction note prefix */
+declare const APP_DEPLOY_NOTE_DAPP = "ALGOKIT_DEPLOYER";
+/** The maximum number of bytes in a single app code page */
+declare const APP_PAGE_MAX_SIZE = 2048;
+/** First 4 bytes of SHA-512/256 hash of "return" for retrieving ABI return values */
+declare const ABI_RETURN_PREFIX: Uint8Array;
+/** Information about an Algorand app */
+interface AppReference {
+  /** The id of the app */
+  appId: number | bigint;
+  /** The Algorand address of the account associated with the app */
+  appAddress: string;
+}
+/** Common app call arguments for ABI and non-ABI (raw) calls */
+interface CoreAppCallArgs {
+  /** The optional lease for the transaction */
+  lease?: string | Uint8Array;
+  /** Any box references to load */
+  boxes?: (BoxReference | BoxReference$1 | BoxIdentifier)[];
+  /** The address of any accounts to load in */
+  accounts?: (string | Address)[];
+  /** IDs of any apps to load into the foreignApps array */
+  apps?: number[];
+  /** IDs of any assets to load into the foreignAssets array */
+  assets?: number[];
+  /** Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction.
+   *
+   * **Note:** Use with extreme caution and review the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying) first.
+   */
+  rekeyTo?: SendTransactionFrom | string;
+}
+/**
+ * App call args with non-ABI (raw) values (minus some processing like encoding strings as binary)
+ */
+interface RawAppCallArgs extends CoreAppCallArgs {
+  /** Any application arguments to pass through */
+  appArgs?: (Uint8Array | string)[];
+  /** Property to aid intellisense */
+  method?: undefined;
+}
+/** An argument for an ABI method, either a primitive value, or a transaction with or without signer, or the unawaited async return value of an algokit method that returns a `SendTransactionResult` */
+type ABIAppCallArg = ABIValue | TransactionWithSigner | TransactionToSign | Transaction | Promise<SendTransactionResult> | SendTransactionResult | undefined;
+/**
+ * App call args for an ABI call
+ */
+type ABIAppCallArgs = CoreAppCallArgs & {
+  /** The ABI method to call */
+  method: ABIMethod;
+  /** The ABI method args to pass in */
+  methodArgs: ABIAppCallArg[];
+};
+/** Arguments to pass to an app call either:
+ *   * The raw app call values to pass through into the transaction (after processing); or
+ *   * An ABI method definition (method and args)
+ **/
+type AppCallArgs = RawAppCallArgs | ABIAppCallArgs;
+/** Parameters representing a call to an app. */
+interface AppCallParams extends SendTransactionParams {
+  /** The id of the app to call */
+  appId: number | bigint;
+  /** The type of call, everything except create (see `createApp`) and update (see `updateApp`) */
+  callType: Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplication>;
+  /** The account to make the call from */
+  from: SendTransactionFrom;
+  /** Optional transaction parameters */
+  transactionParams?: SuggestedParams;
+  /** The (optional) transaction note */
+  note?: TransactionNote;
+  /** The arguments passed in to the app call */
+  args?: AppCallArgs;
+}
+/** Parameters representing the storage schema of an app. */
+interface AppStorageSchema {
+  /** Restricts number of ints in per-user local state */
+  localInts: number;
+  /** Restricts number of byte slices in per-user local state */
+  localByteSlices: number;
+  /** Restricts number of ints in global state */
+  globalInts: number;
+  /** Restricts number of byte slices in global state */
+  globalByteSlices: number;
+  /** Any extra pages that are needed for the smart contract; if left blank then the right number of pages will be calculated based on the teal code size */
+  extraPages?: number;
+}
+/** Information about a compiled teal program */
+interface CompiledTeal {
+  /** Original TEAL code */
+  teal: string;
+  /** The compiled code */
+  compiled: string;
+  /** The hash returned by the compiler */
+  compiledHash: string;
+  /** The base64 encoded code as a byte array */
+  compiledBase64ToBytes: Uint8Array;
+  /** Source map from the compilation */
+  sourceMap: SourceMap;
+}
+interface AppCallTransactionResultOfType<T> extends SendTransactionResults, SendTransactionResult {
+  /** If an ABI method was called the processed return value */
+  return?: T;
+}
+/** Result from calling an app */
+type AppCallTransactionResult = AppCallTransactionResultOfType<ABIReturn>;
+/**
+ * The payload of the metadata to add to the transaction note when deploying an app, noting it will be prefixed with `APP_DEPLOY_NOTE_PREFIX`.
+ */
+interface AppDeployMetadata {
+  /** The unique name identifier of the app within the creator account */
+  name: string;
+  /** The version of app that is / will be deployed */
+  version: string;
+  /** Whether or not the app is deletable / permanent / unspecified */
+  deletable?: boolean;
+  /** Whether or not the app is updatable / immutable / unspecified */
+  updatable?: boolean;
+}
+/** The metadata that can be collected about a deployed app */
+interface AppMetadata extends AppReference, AppDeployMetadata {
+  /** The round the app was created */
+  createdRound: number;
+  /** The last round that the app was updated */
+  updatedRound: number;
+  /** The metadata when the app was created */
+  createdMetadata: AppDeployMetadata;
+  /** Whether or not the app is deleted */
+  deleted: boolean;
+}
+/** A lookup of name -> Algorand app for a creator */
+interface AppLookup {
+  creator: Readonly<string>;
+  apps: Readonly<{
+    [name: string]: AppMetadata;
+  }>;
+}
+/** Dictionary of deploy-time parameters to replace in a teal template.
+ *
+ * Note: Looks for `TMPL_{parameter}` for template replacements i.e. you can leave out the `TMPL_`.
+ *
+ */
+interface TealTemplateParams {
+  [key: string]: string | bigint | number | Uint8Array;
+}
+/** What action to perform when deploying an app and an update is detected in the TEAL code */
+declare enum OnUpdate {
+  /** Fail the deployment */
+  Fail = 0,
+  /** Update the app */
+  UpdateApp = 1,
+  /** Delete the app and create a new one in its place */
+  ReplaceApp = 2,
+  /** Create a new app */
+  AppendApp = 3,
+}
+/** What action to perform when deploying an app and a breaking schema change is detected */
+declare enum OnSchemaBreak {
+  /** Fail the deployment */
+  Fail = 0,
+  /** Delete the app and create a new one in its place */
+  ReplaceApp = 1,
+  /** Create a new app */
+  AppendApp = 2,
+}
+/** The result of compiling the approval and clear state TEAL programs for an app */
+interface AppCompilationResult {
+  /** The result of compiling the approval program */
+  compiledApproval: CompiledTeal;
+  /** The result of compiling the clear state program */
+  compiledClear: CompiledTeal;
+}
+type AppReturn<TReturn> = {
+  /** The ABI method call return value */
+  return?: TReturn;
+};
+/** Result from sending a single app transaction. */
+type SendAppTransactionResult = Expand<SendSingleTransactionResult & {
+  /** If an ABI method was called the processed return value */
+  return?: ABIReturn;
+}>;
+/** Result from sending a single app transaction. */
+type SendAppUpdateTransactionResult = Expand<SendAppTransactionResult & Partial<AppCompilationResult>>;
+/** Result from sending a single app transaction. */
+type SendAppCreateTransactionResult = Expand<SendAppUpdateTransactionResult & {
+  /** The id of the created app */
+  appId: bigint;
+  /** The Algorand address of the account associated with the app */
+  appAddress: Address;
+}>;
+/** Object holding app state values */
+interface AppState {
+  [key: string]: {
+    value: bigint;
+    keyRaw: Uint8Array;
+    keyBase64: string;
+  } | {
+    value: string;
+    valueRaw: Uint8Array;
+    valueBase64: string;
+    keyRaw: Uint8Array;
+    keyBase64: string;
+  };
+}
+/**
+ * The name of a box storage box */
+interface BoxName {
+  /** Name in UTF-8 */
+  name: string;
+  /** Name in binary bytes */
+  nameRaw: Uint8Array;
+  /** Name in Base64 */
+  nameBase64: string;
+}
+/**
+ * @deprecated Use `types/app-manager/BoxValueRequestParams` instead.
+ * Parameters to get and decode a box value as an ABI type.
+ */
+interface BoxValueRequestParams {
+  /** The ID of the app return box names for */
+  appId: number | bigint;
+  /** The name of the box to return either as a string, binary array or `BoxName` */
+  boxName: string | Uint8Array | BoxName;
+  /** The ABI type to decode the value using */
+  type: ABIType;
+}
+/**
+ * @deprecated Use `types/app-manager/BoxValuesRequestParams` instead.
+ * Parameters to get and decode a box value as an ABI type.
+ */
+interface BoxValuesRequestParams {
+  /** The ID of the app return box names for */
+  appId: number;
+  /** The names of the boxes to return either as a string, binary array or BoxName` */
+  boxNames: (string | Uint8Array | BoxName)[];
+  /** The ABI type to decode the value using */
+  type: ABIType;
+}
+//#endregion
+export { ABIAppCallArg, ABIAppCallArgs, ABI_RETURN_PREFIX, APP_DEPLOY_NOTE_DAPP, APP_PAGE_MAX_SIZE, AppCallArgs, AppCallParams, AppCallTransactionResult, AppCallTransactionResultOfType, AppCompilationResult, AppDeployMetadata, AppLookup, AppMetadata, AppReference, AppReturn, AppState, AppStorageSchema, BoxName, BoxValueRequestParams, BoxValuesRequestParams, CompiledTeal, CoreAppCallArgs, DELETABLE_TEMPLATE_NAME, OnSchemaBreak, OnUpdate, RawAppCallArgs, SendAppCreateTransactionResult, SendAppTransactionResult, SendAppUpdateTransactionResult, TealTemplateParams, UPDATABLE_TEMPLATE_NAME };
+//# sourceMappingURL=app.d.ts.map

package/app.js

@@ -0,0 +1,49 @@
+
+//#region src/app.ts
+/** The name of the TEAL template variable for deploy-time immutability control */
+const UPDATABLE_TEMPLATE_NAME = "TMPL_UPDATABLE";
+/** The name of the TEAL template variable for deploy-time permanence control */
+const DELETABLE_TEMPLATE_NAME = "TMPL_DELETABLE";
+/** The app create/update [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) transaction note prefix */
+const APP_DEPLOY_NOTE_DAPP = "ALGOKIT_DEPLOYER";
+/** The maximum number of bytes in a single app code page */
+const APP_PAGE_MAX_SIZE = 2048;
+/** First 4 bytes of SHA-512/256 hash of "return" for retrieving ABI return values */
+const ABI_RETURN_PREFIX = new Uint8Array([
+	21,
+	31,
+	124,
+	117
+]);
+/** What action to perform when deploying an app and an update is detected in the TEAL code */
+let OnUpdate = /* @__PURE__ */ function(OnUpdate$1) {
+	/** Fail the deployment */
+	OnUpdate$1[OnUpdate$1["Fail"] = 0] = "Fail";
+	/** Update the app */
+	OnUpdate$1[OnUpdate$1["UpdateApp"] = 1] = "UpdateApp";
+	/** Delete the app and create a new one in its place */
+	OnUpdate$1[OnUpdate$1["ReplaceApp"] = 2] = "ReplaceApp";
+	/** Create a new app */
+	OnUpdate$1[OnUpdate$1["AppendApp"] = 3] = "AppendApp";
+	return OnUpdate$1;
+}({});
+/** What action to perform when deploying an app and a breaking schema change is detected */
+let OnSchemaBreak = /* @__PURE__ */ function(OnSchemaBreak$1) {
+	/** Fail the deployment */
+	OnSchemaBreak$1[OnSchemaBreak$1["Fail"] = 0] = "Fail";
+	/** Delete the app and create a new one in its place */
+	OnSchemaBreak$1[OnSchemaBreak$1["ReplaceApp"] = 1] = "ReplaceApp";
+	/** Create a new app */
+	OnSchemaBreak$1[OnSchemaBreak$1["AppendApp"] = 2] = "AppendApp";
+	return OnSchemaBreak$1;
+}({});
+
+//#endregion
+exports.ABI_RETURN_PREFIX = ABI_RETURN_PREFIX;
+exports.APP_DEPLOY_NOTE_DAPP = APP_DEPLOY_NOTE_DAPP;
+exports.APP_PAGE_MAX_SIZE = APP_PAGE_MAX_SIZE;
+exports.DELETABLE_TEMPLATE_NAME = DELETABLE_TEMPLATE_NAME;
+exports.OnSchemaBreak = OnSchemaBreak;
+exports.OnUpdate = OnUpdate;
+exports.UPDATABLE_TEMPLATE_NAME = UPDATABLE_TEMPLATE_NAME;
+//# sourceMappingURL=app.js.map

package/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","names":[],"sources":["../src/app.ts"],"sourcesContent":["import { ABIMethod, ABIReturn, ABIType, ABIValue } from '@algorandfoundation/algokit-abi'\nimport { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { Address, Expand, ProgramSourceMap } from '@algorandfoundation/algokit-common'\nimport { OnApplicationComplete, BoxReference as TransactBoxReference, Transaction } from '@algorandfoundation/algokit-transact'\nimport { BoxIdentifier, BoxReference } from './app-manager'\nimport { TransactionWithSigner } from './transaction'\nimport {\n  SendSingleTransactionResult,\n  SendTransactionFrom,\n  SendTransactionParams,\n  SendTransactionResult,\n  SendTransactionResults,\n  TransactionNote,\n  TransactionToSign,\n} from './transaction/types'\ntype SourceMap = ProgramSourceMap\n\n/** The name of the TEAL template variable for deploy-time immutability control */\nexport const UPDATABLE_TEMPLATE_NAME = 'TMPL_UPDATABLE'\n\n/** The name of the TEAL template variable for deploy-time permanence control */\nexport const DELETABLE_TEMPLATE_NAME = 'TMPL_DELETABLE'\n\n/** The app create/update [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) transaction note prefix */\nexport const APP_DEPLOY_NOTE_DAPP = 'ALGOKIT_DEPLOYER'\n\n/** The maximum number of bytes in a single app code page */\nexport const APP_PAGE_MAX_SIZE = 2048\n\n/** First 4 bytes of SHA-512/256 hash of \"return\" for retrieving ABI return values */\nexport const ABI_RETURN_PREFIX = new Uint8Array([21, 31, 124, 117])\n\n/** Information about an Algorand app */\nexport interface AppReference {\n  /** The id of the app */\n  appId: number | bigint\n  /** The Algorand address of the account associated with the app */\n  appAddress: string\n}\n\n/** Common app call arguments for ABI and non-ABI (raw) calls */\nexport interface CoreAppCallArgs {\n  /** The optional lease for the transaction */\n  lease?: string | Uint8Array\n  /** Any box references to load */\n  boxes?: (TransactBoxReference | BoxReference | BoxIdentifier)[]\n  /** The address of any accounts to load in */\n  accounts?: (string | Address)[]\n  /** IDs of any apps to load into the foreignApps array */\n  apps?: number[]\n  /** IDs of any assets to load into the foreignAssets array */\n  assets?: number[]\n  /** Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction.\n   *\n   * **Note:** Use with extreme caution and review the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying) first.\n   */\n  rekeyTo?: SendTransactionFrom | string\n}\n\n/**\n * App call args with non-ABI (raw) values (minus some processing like encoding strings as binary)\n */\nexport interface RawAppCallArgs extends CoreAppCallArgs {\n  /** Any application arguments to pass through */\n  appArgs?: (Uint8Array | string)[]\n  /** Property to aid intellisense */\n  method?: undefined\n}\n\n/** An argument for an ABI method, either a primitive value, or a transaction with or without signer, or the unawaited async return value of an algokit method that returns a `SendTransactionResult` */\nexport type ABIAppCallArg =\n  | ABIValue\n  | TransactionWithSigner\n  | TransactionToSign\n  | Transaction\n  | Promise<SendTransactionResult>\n  | SendTransactionResult\n  | undefined\n\n/**\n * App call args for an ABI call\n */\nexport type ABIAppCallArgs = CoreAppCallArgs & {\n  /** The ABI method to call */\n  method: ABIMethod\n  /** The ABI method args to pass in */\n  methodArgs: ABIAppCallArg[]\n}\n\n/** Arguments to pass to an app call either:\n *   * The raw app call values to pass through into the transaction (after processing); or\n *   * An ABI method definition (method and args)\n **/\nexport type AppCallArgs = RawAppCallArgs | ABIAppCallArgs\n\n/** Parameters representing a call to an app. */\nexport interface AppCallParams extends SendTransactionParams {\n  /** The id of the app to call */\n  appId: number | bigint\n  /** The type of call, everything except create (see `createApp`) and update (see `updateApp`) */\n  callType: Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplication>\n  /** The account to make the call from */\n  from: SendTransactionFrom\n  /** Optional transaction parameters */\n  transactionParams?: SuggestedParams\n  /** The (optional) transaction note */\n  note?: TransactionNote\n  /** The arguments passed in to the app call */\n  args?: AppCallArgs\n}\n\n/** Parameters representing the storage schema of an app. */\nexport interface AppStorageSchema {\n  /** Restricts number of ints in per-user local state */\n  localInts: number\n  /** Restricts number of byte slices in per-user local state */\n  localByteSlices: number\n  /** Restricts number of ints in global state */\n  globalInts: number\n  /** Restricts number of byte slices in global state */\n  globalByteSlices: number\n  /** Any extra pages that are needed for the smart contract; if left blank then the right number of pages will be calculated based on the teal code size */\n  extraPages?: number\n}\n\n/** Information about a compiled teal program */\nexport interface CompiledTeal {\n  /** Original TEAL code */\n  teal: string\n  /** The compiled code */\n  compiled: string\n  /** The hash returned by the compiler */\n  compiledHash: string\n  /** The base64 encoded code as a byte array */\n  compiledBase64ToBytes: Uint8Array\n  /** Source map from the compilation */\n  sourceMap: SourceMap\n}\n\nexport interface AppCallTransactionResultOfType<T> extends SendTransactionResults, SendTransactionResult {\n  /** If an ABI method was called the processed return value */\n  return?: T\n}\n\n/** Result from calling an app */\nexport type AppCallTransactionResult = AppCallTransactionResultOfType<ABIReturn>\n\n/**\n * The payload of the metadata to add to the transaction note when deploying an app, noting it will be prefixed with `APP_DEPLOY_NOTE_PREFIX`.\n */\nexport interface AppDeployMetadata {\n  /** The unique name identifier of the app within the creator account */\n  name: string\n  /** The version of app that is / will be deployed */\n  version: string\n  /** Whether or not the app is deletable / permanent / unspecified */\n  deletable?: boolean\n  /** Whether or not the app is updatable / immutable / unspecified */\n  updatable?: boolean\n}\n\n/** The metadata that can be collected about a deployed app */\nexport interface AppMetadata extends AppReference, AppDeployMetadata {\n  /** The round the app was created */\n  createdRound: number\n  /** The last round that the app was updated */\n  updatedRound: number\n  /** The metadata when the app was created */\n  createdMetadata: AppDeployMetadata\n  /** Whether or not the app is deleted */\n  deleted: boolean\n}\n\n/** A lookup of name -> Algorand app for a creator */\nexport interface AppLookup {\n  creator: Readonly<string>\n  apps: Readonly<{\n    [name: string]: AppMetadata\n  }>\n}\n\n/** Dictionary of deploy-time parameters to replace in a teal template.\n *\n * Note: Looks for `TMPL_{parameter}` for template replacements i.e. you can leave out the `TMPL_`.\n *\n */\nexport interface TealTemplateParams {\n  [key: string]: string | bigint | number | Uint8Array\n}\n\n/** What action to perform when deploying an app and an update is detected in the TEAL code */\nexport enum OnUpdate {\n  /** Fail the deployment */\n  Fail,\n  /** Update the app */\n  UpdateApp,\n  /** Delete the app and create a new one in its place */\n  ReplaceApp,\n  /** Create a new app */\n  AppendApp,\n}\n\n/** What action to perform when deploying an app and a breaking schema change is detected */\nexport enum OnSchemaBreak {\n  /** Fail the deployment */\n  Fail,\n  /** Delete the app and create a new one in its place */\n  ReplaceApp,\n  /** Create a new app */\n  AppendApp,\n}\n\n/** The result of compiling the approval and clear state TEAL programs for an app */\nexport interface AppCompilationResult {\n  /** The result of compiling the approval program */\n  compiledApproval: CompiledTeal\n  /** The result of compiling the clear state program */\n  compiledClear: CompiledTeal\n}\n\nexport type AppReturn<TReturn> = {\n  /** The ABI method call return value */\n  return?: TReturn\n}\n\n/** Result from sending a single app transaction. */\nexport type SendAppTransactionResult = Expand<\n  SendSingleTransactionResult & {\n    /** If an ABI method was called the processed return value */\n    return?: ABIReturn\n  }\n>\n\n/** Result from sending a single app transaction. */\nexport type SendAppUpdateTransactionResult = Expand<SendAppTransactionResult & Partial<AppCompilationResult>>\n\n/** Result from sending a single app transaction. */\nexport type SendAppCreateTransactionResult = Expand<\n  SendAppUpdateTransactionResult & {\n    /** The id of the created app */\n    appId: bigint\n    /** The Algorand address of the account associated with the app */\n    appAddress: Address\n  }\n>\n\n/** Object holding app state values */\nexport interface AppState {\n  [key: string]:\n    | {\n        value: bigint\n        keyRaw: Uint8Array\n        keyBase64: string\n      }\n    | {\n        value: string\n        valueRaw: Uint8Array\n        valueBase64: string\n        keyRaw: Uint8Array\n        keyBase64: string\n      }\n}\n\n/**\n * The name of a box storage box */\nexport interface BoxName {\n  /** Name in UTF-8 */\n  name: string\n  /** Name in binary bytes */\n  nameRaw: Uint8Array\n  /** Name in Base64 */\n  nameBase64: string\n}\n\n/**\n * @deprecated Use `types/app-manager/BoxValueRequestParams` instead.\n * Parameters to get and decode a box value as an ABI type.\n */\nexport interface BoxValueRequestParams {\n  /** The ID of the app return box names for */\n  appId: number | bigint\n  /** The name of the box to return either as a string, binary array or `BoxName` */\n  boxName: string | Uint8Array | BoxName\n  /** The ABI type to decode the value using */\n  type: ABIType\n}\n\n/**\n * @deprecated Use `types/app-manager/BoxValuesRequestParams` instead.\n * Parameters to get and decode a box value as an ABI type.\n */\nexport interface BoxValuesRequestParams {\n  /** The ID of the app return box names for */\n  appId: number\n  /** The names of the boxes to return either as a string, binary array or BoxName` */\n  boxNames: (string | Uint8Array | BoxName)[]\n  /** The ABI type to decode the value using */\n  type: ABIType\n}\n"],"mappings":";;;AAkBA,MAAa,0BAA0B;;AAGvC,MAAa,0BAA0B;;AAGvC,MAAa,uBAAuB;;AAGpC,MAAa,oBAAoB;;AAGjC,MAAa,oBAAoB,IAAI,WAAW;CAAC;CAAI;CAAI;CAAK;CAAI,CAAC;;AAiKnE,IAAY,gDAAL;;AAEL;;AAEA;;AAEA;;AAEA;;;;AAIF,IAAY,0DAAL;;AAEL;;AAEA;;AAEA"}

package/app.mjs

@@ -0,0 +1,42 @@
+//#region src/app.ts
+/** The name of the TEAL template variable for deploy-time immutability control */
+const UPDATABLE_TEMPLATE_NAME = "TMPL_UPDATABLE";
+/** The name of the TEAL template variable for deploy-time permanence control */
+const DELETABLE_TEMPLATE_NAME = "TMPL_DELETABLE";
+/** The app create/update [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) transaction note prefix */
+const APP_DEPLOY_NOTE_DAPP = "ALGOKIT_DEPLOYER";
+/** The maximum number of bytes in a single app code page */
+const APP_PAGE_MAX_SIZE = 2048;
+/** First 4 bytes of SHA-512/256 hash of "return" for retrieving ABI return values */
+const ABI_RETURN_PREFIX = new Uint8Array([
+	21,
+	31,
+	124,
+	117
+]);
+/** What action to perform when deploying an app and an update is detected in the TEAL code */
+let OnUpdate = /* @__PURE__ */ function(OnUpdate$1) {
+	/** Fail the deployment */
+	OnUpdate$1[OnUpdate$1["Fail"] = 0] = "Fail";
+	/** Update the app */
+	OnUpdate$1[OnUpdate$1["UpdateApp"] = 1] = "UpdateApp";
+	/** Delete the app and create a new one in its place */
+	OnUpdate$1[OnUpdate$1["ReplaceApp"] = 2] = "ReplaceApp";
+	/** Create a new app */
+	OnUpdate$1[OnUpdate$1["AppendApp"] = 3] = "AppendApp";
+	return OnUpdate$1;
+}({});
+/** What action to perform when deploying an app and a breaking schema change is detected */
+let OnSchemaBreak = /* @__PURE__ */ function(OnSchemaBreak$1) {
+	/** Fail the deployment */
+	OnSchemaBreak$1[OnSchemaBreak$1["Fail"] = 0] = "Fail";
+	/** Delete the app and create a new one in its place */
+	OnSchemaBreak$1[OnSchemaBreak$1["ReplaceApp"] = 1] = "ReplaceApp";
+	/** Create a new app */
+	OnSchemaBreak$1[OnSchemaBreak$1["AppendApp"] = 2] = "AppendApp";
+	return OnSchemaBreak$1;
+}({});
+
+//#endregion
+export { ABI_RETURN_PREFIX, APP_DEPLOY_NOTE_DAPP, APP_PAGE_MAX_SIZE, DELETABLE_TEMPLATE_NAME, OnSchemaBreak, OnUpdate, UPDATABLE_TEMPLATE_NAME };
+//# sourceMappingURL=app.mjs.map

package/app.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.mjs","names":[],"sources":["../src/app.ts"],"sourcesContent":["import { ABIMethod, ABIReturn, ABIType, ABIValue } from '@algorandfoundation/algokit-abi'\nimport { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { Address, Expand, ProgramSourceMap } from '@algorandfoundation/algokit-common'\nimport { OnApplicationComplete, BoxReference as TransactBoxReference, Transaction } from '@algorandfoundation/algokit-transact'\nimport { BoxIdentifier, BoxReference } from './app-manager'\nimport { TransactionWithSigner } from './transaction'\nimport {\n  SendSingleTransactionResult,\n  SendTransactionFrom,\n  SendTransactionParams,\n  SendTransactionResult,\n  SendTransactionResults,\n  TransactionNote,\n  TransactionToSign,\n} from './transaction/types'\ntype SourceMap = ProgramSourceMap\n\n/** The name of the TEAL template variable for deploy-time immutability control */\nexport const UPDATABLE_TEMPLATE_NAME = 'TMPL_UPDATABLE'\n\n/** The name of the TEAL template variable for deploy-time permanence control */\nexport const DELETABLE_TEMPLATE_NAME = 'TMPL_DELETABLE'\n\n/** The app create/update [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) transaction note prefix */\nexport const APP_DEPLOY_NOTE_DAPP = 'ALGOKIT_DEPLOYER'\n\n/** The maximum number of bytes in a single app code page */\nexport const APP_PAGE_MAX_SIZE = 2048\n\n/** First 4 bytes of SHA-512/256 hash of \"return\" for retrieving ABI return values */\nexport const ABI_RETURN_PREFIX = new Uint8Array([21, 31, 124, 117])\n\n/** Information about an Algorand app */\nexport interface AppReference {\n  /** The id of the app */\n  appId: number | bigint\n  /** The Algorand address of the account associated with the app */\n  appAddress: string\n}\n\n/** Common app call arguments for ABI and non-ABI (raw) calls */\nexport interface CoreAppCallArgs {\n  /** The optional lease for the transaction */\n  lease?: string | Uint8Array\n  /** Any box references to load */\n  boxes?: (TransactBoxReference | BoxReference | BoxIdentifier)[]\n  /** The address of any accounts to load in */\n  accounts?: (string | Address)[]\n  /** IDs of any apps to load into the foreignApps array */\n  apps?: number[]\n  /** IDs of any assets to load into the foreignAssets array */\n  assets?: number[]\n  /** Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction.\n   *\n   * **Note:** Use with extreme caution and review the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying) first.\n   */\n  rekeyTo?: SendTransactionFrom | string\n}\n\n/**\n * App call args with non-ABI (raw) values (minus some processing like encoding strings as binary)\n */\nexport interface RawAppCallArgs extends CoreAppCallArgs {\n  /** Any application arguments to pass through */\n  appArgs?: (Uint8Array | string)[]\n  /** Property to aid intellisense */\n  method?: undefined\n}\n\n/** An argument for an ABI method, either a primitive value, or a transaction with or without signer, or the unawaited async return value of an algokit method that returns a `SendTransactionResult` */\nexport type ABIAppCallArg =\n  | ABIValue\n  | TransactionWithSigner\n  | TransactionToSign\n  | Transaction\n  | Promise<SendTransactionResult>\n  | SendTransactionResult\n  | undefined\n\n/**\n * App call args for an ABI call\n */\nexport type ABIAppCallArgs = CoreAppCallArgs & {\n  /** The ABI method to call */\n  method: ABIMethod\n  /** The ABI method args to pass in */\n  methodArgs: ABIAppCallArg[]\n}\n\n/** Arguments to pass to an app call either:\n *   * The raw app call values to pass through into the transaction (after processing); or\n *   * An ABI method definition (method and args)\n **/\nexport type AppCallArgs = RawAppCallArgs | ABIAppCallArgs\n\n/** Parameters representing a call to an app. */\nexport interface AppCallParams extends SendTransactionParams {\n  /** The id of the app to call */\n  appId: number | bigint\n  /** The type of call, everything except create (see `createApp`) and update (see `updateApp`) */\n  callType: Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplication>\n  /** The account to make the call from */\n  from: SendTransactionFrom\n  /** Optional transaction parameters */\n  transactionParams?: SuggestedParams\n  /** The (optional) transaction note */\n  note?: TransactionNote\n  /** The arguments passed in to the app call */\n  args?: AppCallArgs\n}\n\n/** Parameters representing the storage schema of an app. */\nexport interface AppStorageSchema {\n  /** Restricts number of ints in per-user local state */\n  localInts: number\n  /** Restricts number of byte slices in per-user local state */\n  localByteSlices: number\n  /** Restricts number of ints in global state */\n  globalInts: number\n  /** Restricts number of byte slices in global state */\n  globalByteSlices: number\n  /** Any extra pages that are needed for the smart contract; if left blank then the right number of pages will be calculated based on the teal code size */\n  extraPages?: number\n}\n\n/** Information about a compiled teal program */\nexport interface CompiledTeal {\n  /** Original TEAL code */\n  teal: string\n  /** The compiled code */\n  compiled: string\n  /** The hash returned by the compiler */\n  compiledHash: string\n  /** The base64 encoded code as a byte array */\n  compiledBase64ToBytes: Uint8Array\n  /** Source map from the compilation */\n  sourceMap: SourceMap\n}\n\nexport interface AppCallTransactionResultOfType<T> extends SendTransactionResults, SendTransactionResult {\n  /** If an ABI method was called the processed return value */\n  return?: T\n}\n\n/** Result from calling an app */\nexport type AppCallTransactionResult = AppCallTransactionResultOfType<ABIReturn>\n\n/**\n * The payload of the metadata to add to the transaction note when deploying an app, noting it will be prefixed with `APP_DEPLOY_NOTE_PREFIX`.\n */\nexport interface AppDeployMetadata {\n  /** The unique name identifier of the app within the creator account */\n  name: string\n  /** The version of app that is / will be deployed */\n  version: string\n  /** Whether or not the app is deletable / permanent / unspecified */\n  deletable?: boolean\n  /** Whether or not the app is updatable / immutable / unspecified */\n  updatable?: boolean\n}\n\n/** The metadata that can be collected about a deployed app */\nexport interface AppMetadata extends AppReference, AppDeployMetadata {\n  /** The round the app was created */\n  createdRound: number\n  /** The last round that the app was updated */\n  updatedRound: number\n  /** The metadata when the app was created */\n  createdMetadata: AppDeployMetadata\n  /** Whether or not the app is deleted */\n  deleted: boolean\n}\n\n/** A lookup of name -> Algorand app for a creator */\nexport interface AppLookup {\n  creator: Readonly<string>\n  apps: Readonly<{\n    [name: string]: AppMetadata\n  }>\n}\n\n/** Dictionary of deploy-time parameters to replace in a teal template.\n *\n * Note: Looks for `TMPL_{parameter}` for template replacements i.e. you can leave out the `TMPL_`.\n *\n */\nexport interface TealTemplateParams {\n  [key: string]: string | bigint | number | Uint8Array\n}\n\n/** What action to perform when deploying an app and an update is detected in the TEAL code */\nexport enum OnUpdate {\n  /** Fail the deployment */\n  Fail,\n  /** Update the app */\n  UpdateApp,\n  /** Delete the app and create a new one in its place */\n  ReplaceApp,\n  /** Create a new app */\n  AppendApp,\n}\n\n/** What action to perform when deploying an app and a breaking schema change is detected */\nexport enum OnSchemaBreak {\n  /** Fail the deployment */\n  Fail,\n  /** Delete the app and create a new one in its place */\n  ReplaceApp,\n  /** Create a new app */\n  AppendApp,\n}\n\n/** The result of compiling the approval and clear state TEAL programs for an app */\nexport interface AppCompilationResult {\n  /** The result of compiling the approval program */\n  compiledApproval: CompiledTeal\n  /** The result of compiling the clear state program */\n  compiledClear: CompiledTeal\n}\n\nexport type AppReturn<TReturn> = {\n  /** The ABI method call return value */\n  return?: TReturn\n}\n\n/** Result from sending a single app transaction. */\nexport type SendAppTransactionResult = Expand<\n  SendSingleTransactionResult & {\n    /** If an ABI method was called the processed return value */\n    return?: ABIReturn\n  }\n>\n\n/** Result from sending a single app transaction. */\nexport type SendAppUpdateTransactionResult = Expand<SendAppTransactionResult & Partial<AppCompilationResult>>\n\n/** Result from sending a single app transaction. */\nexport type SendAppCreateTransactionResult = Expand<\n  SendAppUpdateTransactionResult & {\n    /** The id of the created app */\n    appId: bigint\n    /** The Algorand address of the account associated with the app */\n    appAddress: Address\n  }\n>\n\n/** Object holding app state values */\nexport interface AppState {\n  [key: string]:\n    | {\n        value: bigint\n        keyRaw: Uint8Array\n        keyBase64: string\n      }\n    | {\n        value: string\n        valueRaw: Uint8Array\n        valueBase64: string\n        keyRaw: Uint8Array\n        keyBase64: string\n      }\n}\n\n/**\n * The name of a box storage box */\nexport interface BoxName {\n  /** Name in UTF-8 */\n  name: string\n  /** Name in binary bytes */\n  nameRaw: Uint8Array\n  /** Name in Base64 */\n  nameBase64: string\n}\n\n/**\n * @deprecated Use `types/app-manager/BoxValueRequestParams` instead.\n * Parameters to get and decode a box value as an ABI type.\n */\nexport interface BoxValueRequestParams {\n  /** The ID of the app return box names for */\n  appId: number | bigint\n  /** The name of the box to return either as a string, binary array or `BoxName` */\n  boxName: string | Uint8Array | BoxName\n  /** The ABI type to decode the value using */\n  type: ABIType\n}\n\n/**\n * @deprecated Use `types/app-manager/BoxValuesRequestParams` instead.\n * Parameters to get and decode a box value as an ABI type.\n */\nexport interface BoxValuesRequestParams {\n  /** The ID of the app return box names for */\n  appId: number\n  /** The names of the boxes to return either as a string, binary array or BoxName` */\n  boxNames: (string | Uint8Array | BoxName)[]\n  /** The ABI type to decode the value using */\n  type: ABIType\n}\n"],"mappings":";;AAkBA,MAAa,0BAA0B;;AAGvC,MAAa,0BAA0B;;AAGvC,MAAa,uBAAuB;;AAGpC,MAAa,oBAAoB;;AAGjC,MAAa,oBAAoB,IAAI,WAAW;CAAC;CAAI;CAAI;CAAK;CAAI,CAAC;;AAiKnE,IAAY,gDAAL;;AAEL;;AAEA;;AAEA;;AAEA;;;;AAIF,IAAY,0DAAL;;AAEL;;AAEA;;AAEA"}

package/asset-manager.d.ts

@@ -0,0 +1,212 @@
+import { Address } from "./packages/common/src/address.js";
+import { AlgodClient } from "./packages/algod_client/src/client.js";
+import { AccountAssetInformation } from "./account.js";
+import { SendParams } from "./transaction/types.js";
+import { CommonTransactionParams } from "./transactions/common.js";
+import { TransactionComposer, TransactionComposerConfig } from "./composer.js";
+
+//#region src/asset-manager.d.ts
+/** Individual result from performing a bulk opt-in or bulk opt-out for an account against a series of assets. */
+interface BulkAssetOptInOutResult {
+  /** The ID of the asset opted into / out of */
+  assetId: bigint;
+  /** The transaction ID of the resulting opt in / out */
+  transactionId: string;
+}
+/** Information about an asset. */
+interface AssetInformation {
+  /** The ID of the asset. */
+  assetId: bigint;
+  /** The address of the account that created the asset.
+   *
+   * This is the address where the parameters for this asset can be found,
+   * and also the address where unwanted asset units can be sent when
+   * closing out an asset position and opting-out of the asset.
+   */
+  creator: string;
+  /** The total amount of the smallest divisible (decimal) units that were created of the asset.
+   *
+   * For example, if `decimals` is, say, 2, then for every 100 `total` there is 1 whole unit.
+   */
+  total: bigint;
+  /** The amount of decimal places the asset was created with.
+   *
+   * * If 0, the asset is not divisible;
+   * * If 1, the base unit of the asset is in tenths;
+   * * If 2, the base unit of the asset is in hundredths;
+   * * If 3, the base unit of the asset is in thousandths;
+   * * and so on up to 19 decimal places.
+   */
+  decimals: number;
+  /** Whether the asset was frozen by default for all accounts.
+   *
+   * If `true` then for anyone apart from the creator to hold the
+   * asset it needs to be unfrozen per account using an asset freeze
+   * transaction from the `freeze` account.
+   */
+  defaultFrozen?: boolean;
+  /** The address of the optional account that can manage the configuration of the asset and destroy it.
+   *
+   * If not set the asset is permanently immutable.
+   */
+  manager?: string;
+  /**
+   * The address of the optional account that holds the reserve (uncirculated supply) units of the asset.
+   *
+   * This address has no specific authority in the protocol itself and is informational only.
+   *
+   * Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md)
+   * rely on this field to hold meaningful data.
+   *
+   * It can be used in the case where you want to signal to holders of your asset that the uncirculated units
+   * of the asset reside in an account that is different from the default creator account.
+   *
+   * If not set the field is permanently empty.
+   */
+  reserve?: string;
+  /**
+   * The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account.
+   *
+   * If empty, freezing is not permitted.
+   *
+   * If not set the field is permanently empty.
+   */
+  freeze?: string;
+  /**
+   * The address of the optional account that can clawback holdings of this asset from any account.
+   *
+   * The clawback account has the ability to **unconditionally take assets from any account**.
+   *
+   * If empty, clawback is not permitted.
+   *
+   * If not set the field is permanently empty.
+   */
+  clawback?: string;
+  /** The optional name of the unit of this asset (e.g. ticker name).
+   *
+   * Max size is 8 bytes.
+   */
+  unitName?: string;
+  /** The optional name of the unit of this asset (e.g. ticker name).
+   *
+   * Max size is 8 bytes.
+   */
+  unitNameAsBytes?: Uint8Array;
+  /** The optional name of the asset.
+   *
+   * Max size is 32 bytes.
+   */
+  assetName?: string;
+  /** The optional name of the asset.
+   *
+   * Max size is 32 bytes.
+   */
+  assetNameAsBytes?: Uint8Array;
+  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).
+   *
+   * Max size is 96 bytes.
+   */
+  url?: string;
+  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).
+   *
+   * Max size is 96 bytes.
+   */
+  urlAsBytes?: Uint8Array;
+  /** 32-byte hash of some metadata that is relevant to the asset and/or asset holders.
+   *
+   * The format of this metadata is up to the application.
+   */
+  metadataHash?: Uint8Array;
+}
+/** Allows management of asset information. */
+declare class AssetManager {
+  private _algod;
+  private _newGroup;
+  /**
+   * Create a new asset manager.
+   * @param algod An algod client
+   * @param newGroup A function that creates a new `TransactionComposer` transaction group
+   * @example Create a new asset manager
+   * ```typescript
+   * const assetManager = new AssetManager(algod, () => new TransactionComposer({algod, () => signer, () => suggestedParams}))
+   * ```
+   */
+  constructor(algod: AlgodClient, newGroup: (config?: TransactionComposerConfig) => TransactionComposer);
+  /**
+   * Returns the current asset information for the asset with the given ID.
+   *
+   * @example
+   * ```typescript
+   * const assetInfo = await assetManager.getById(12353n);
+   * ```
+   *
+   * @param assetId The ID of the asset
+   * @returns The asset information
+   */
+  getById(assetId: bigint): Promise<AssetInformation>;
+  /**
+   * Returns the given sender account's asset holding for a given asset.
+   *
+   * @example
+   * ```typescript
+   * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+   * const assetId = 123345n;
+   * const accountInfo = await assetManager.getAccountInformation(address, assetId);
+   * ```
+   *
+   * [Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountassetinformation)
+   * @param sender The address of the sender/account to look up
+   * @param assetId The ID of the asset to return a holding for
+   * @returns The account asset holding information
+   */
+  getAccountInformation(sender: string | Address, assetId: bigint): Promise<AccountAssetInformation>;
+  /**
+   * Opt an account in to a list of Algorand Standard Assets.
+   *
+   * Transactions will be sent in batches of 16 as transaction groups.
+   *
+   * @param account The account to opt-in
+   * @param assetIds The list of asset IDs to opt-in to
+   * @param options Any parameters to control the transaction or execution of the transaction
+   * @example Example using AlgorandClient
+   * ```typescript
+   * // Basic example
+   * assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n])
+   * // With configuration
+   * assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })
+   * ```
+   * @returns An array of records matching asset ID to transaction ID of the opt in
+   */
+  bulkOptIn(account: string | Address, assetIds: bigint[], options?: Omit<CommonTransactionParams, 'sender'> & SendParams): Promise<BulkAssetOptInOutResult[]>;
+  /**
+   * Opt an account out of a list of Algorand Standard Assets.
+   *
+   * Transactions will be sent in batches of 16 as transaction groups.
+   *
+   * @param account The account to opt-in
+   * @param assetIds The list of asset IDs to opt-out of
+   * @param options Any parameters to control the transaction or execution of the transaction
+   * @example Example using AlgorandClient
+   * ```typescript
+   * // Basic example
+   * assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n])
+   * // With configuration
+   * assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })
+   * ```
+   * @returns An array of records matching asset ID to transaction ID of the opt in
+   */
+  bulkOptOut(account: string | Address, assetIds: bigint[], options?: Omit<CommonTransactionParams, 'sender'> & SendParams & {
+    /** Whether or not to check if the account has a zero balance for each asset first or not.
+     *
+     * Defaults to `true`.
+     *
+     * If this is set to `true` and the account has an asset balance it will throw an error.
+     *
+     * If this is set to `false` and the account has an asset balance it will lose those assets to the asset creator.
+     */
+    ensureZeroBalance?: boolean;
+  }): Promise<BulkAssetOptInOutResult[]>;
+}
+//#endregion
+export { AssetInformation, AssetManager, BulkAssetOptInOutResult };
+//# sourceMappingURL=asset-manager.d.ts.map