@algorandfoundation/algokit-utils 9.2.0 → 9.2.1-beta.2

package/app-client.mjs

@@ -1,94 +1,101 @@
-import { ApplicationClient } from './types/app-client.mjs';
-
+import { ApplicationClient } from "./types/app-client.mjs";
+//#region src/app-client.ts
 /**
- * @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
- *
- * @example Resolve by creator and name
- * const client = algokit.getAppClient(
- *     {
- *       resolveBy: 'creatorAndName',
- *       app: {appSpec},
- *       sender: {account},
- *       creatorAddress: {creator},
- *       findExistingUsing: indexerClient,
- *     },
- *     algodClient,
- *   )
- *
- * @example Resolve by id:
- * const client = algokit.getAppClient(
- *     {
- *       resolveBy: 'id',
- *       app: {appSpec},
- *       sender: {account},
- *       id: {id},
- *     },
- *    algodClient,
- * )
- *
- * @returns The application client
- */
+* @deprecated Use `AppClient` instead e.g. via `algorand.client.getAppClientById` or
+* `algorand.client.getAppClientByCreatorAndName`.
+* If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,
+* which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.
+*
+* Create a new ApplicationClient instance
+* @param appDetails The details of the app
+* @param algod An algod instance
+*
+* @example Resolve by creator and name
+* const client = algokit.getAppClient(
+*     {
+*       resolveBy: 'creatorAndName',
+*       app: {appSpec},
+*       sender: {account},
+*       creatorAddress: {creator},
+*       findExistingUsing: indexerClient,
+*     },
+*     algodClient,
+*   )
+*
+* @example Resolve by id:
+* const client = algokit.getAppClient(
+*     {
+*       resolveBy: 'id',
+*       app: {appSpec},
+*       sender: {account},
+*       id: {id},
+*     },
+*    algodClient,
+* )
+*
+* @returns The application client
+*/
 function getAppClient(appDetails, algod) {
-    return new ApplicationClient(appDetails, algod);
+	return new ApplicationClient(appDetails, algod);
 }
 /**
- * @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
- *
- * @example
- * const client = algokit.getAppClientById(
- *     {
- *       app: {appSpec},
- *       sender: {account},
- *       id: {id},
- *     },
- *     algodClient,
- *   )
- *
- * @returns The application client
- */
+* @deprecated Use `AppClient` instead e.g. via `algorand.client.getAppClientById`.
+* If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,
+* which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.
+*
+*
+* Create a new ApplicationClient instance by id
+* @param appDetails The details of the app
+* @param algod An algod instance
+*
+* @example
+* const client = algokit.getAppClientById(
+*     {
+*       app: {appSpec},
+*       sender: {account},
+*       id: {id},
+*     },
+*     algodClient,
+*   )
+*
+* @returns The application client
+*/
 function getAppClientById(appDetails, algod) {
-    return new ApplicationClient({ ...appDetails, resolveBy: 'id' }, algod);
+	return new ApplicationClient({
+		...appDetails,
+		resolveBy: "id"
+	}, algod);
 }
 /**
- * @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
- *
- * @example
- * const client = algokit.getAppClientByCreatorAndName(
- *     {
- *       app: appSpec,
- *       sender: account,
- *       creatorAddress: account,
- *       findExistingUsing: indexerClient,
- *     },
- *     algodClient,
- *   )
- *
- * @returns The application client
- */
+* @deprecated Use `AppClient` instead e.g. via `algorand.client.getAppClientByCreatorAndName`.
+* If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,
+* which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.
+*
+*
+* Create a new ApplicationClient instance by creator and name
+* @param appDetails The details of the app by creator and name
+* @param algod An algod instance
+*
+* @example
+* const client = algokit.getAppClientByCreatorAndName(
+*     {
+*       app: appSpec,
+*       sender: account,
+*       creatorAddress: account,
+*       findExistingUsing: indexerClient,
+*     },
+*     algodClient,
+*   )
+*
+* @returns The application client
+*/
 function getAppClientByCreatorAndName(appDetails, algod) {
-    return new ApplicationClient({ ...appDetails, resolveBy: 'creatorAndName' }, algod);
+	return new ApplicationClient({
+		...appDetails,
+		resolveBy: "creatorAndName"
+	}, algod);
 }
-
+//#endregion
 export { getAppClient, getAppClientByCreatorAndName, getAppClientById };
-//# sourceMappingURL=app-client.mjs.map
+
+//# sourceMappingURL=app-client.mjs.map

package/app-client.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"app-client.mjs","sources":["../src/app-client.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { AppSpecAppDetails, AppSpecAppDetailsByCreatorAndName, AppSpecAppDetailsById, ApplicationClient } from './types/app-client'\nimport Algodv2 = algosdk.Algodv2\n\n/**\n * @deprecated Use `AppClient` instead e.g. via `algorand.client.getAppClientById` or\n * `algorand.client.getAppClientByCreatorAndName`.\n * If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,\n * which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.\n *\n * Create a new ApplicationClient instance\n * @param appDetails The details of the app\n * @param algod An algod instance\n *\n * @example Resolve by creator and name\n * const client = algokit.getAppClient(\n *     {\n *       resolveBy: 'creatorAndName',\n *       app: {appSpec},\n *       sender: {account},\n *       creatorAddress: {creator},\n *       findExistingUsing: indexerClient,\n *     },\n *     algodClient,\n *   )\n *\n * @example Resolve by id:\n * const client = algokit.getAppClient(\n *     {\n *       resolveBy: 'id',\n *       app: {appSpec},\n *       sender: {account},\n *       id: {id},\n *     },\n *    algodClient,\n * )\n *\n * @returns The application client\n */\nexport function getAppClient(appDetails: AppSpecAppDetails, algod: Algodv2) {\n  return new ApplicationClient(appDetails, algod)\n}\n\n/**\n * @deprecated Use `AppClient` instead e.g. via `algorand.client.getAppClientById`.\n * If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,\n * which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.\n *\n *\n * Create a new ApplicationClient instance by id\n * @param appDetails The details of the app\n * @param algod An algod instance\n *\n * @example\n * const client = algokit.getAppClientById(\n *     {\n *       app: {appSpec},\n *       sender: {account},\n *       id: {id},\n *     },\n *     algodClient,\n *   )\n *\n * @returns The application client\n */\nexport function getAppClientById(appDetails: AppSpecAppDetailsById, algod: Algodv2) {\n  return new ApplicationClient({ ...appDetails, resolveBy: 'id' }, algod)\n}\n\n/**\n * @deprecated Use `AppClient` instead e.g. via `algorand.client.getAppClientByCreatorAndName`.\n * If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,\n * which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.\n *\n *\n * Create a new ApplicationClient instance by creator and name\n * @param appDetails The details of the app by creator and name\n * @param algod An algod instance\n *\n * @example\n * const client = algokit.getAppClientByCreatorAndName(\n *     {\n *       app: appSpec,\n *       sender: account,\n *       creatorAddress: account,\n *       findExistingUsing: indexerClient,\n *     },\n *     algodClient,\n *   )\n *\n * @returns The application client\n */\nexport function getAppClientByCreatorAndName(appDetails: AppSpecAppDetailsByCreatorAndName, algod: Algodv2) {\n  return new ApplicationClient({ ...appDetails, resolveBy: 'creatorAndName' }, algod)\n}\n"],"names":[],"mappings":";;AAIA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCG;AACa,SAAA,YAAY,CAAC,UAA6B,EAAE,KAAc,EAAA;AACxE,IAAA,OAAO,IAAI,iBAAiB,CAAC,UAAU,EAAE,KAAK,CAAC;AACjD;AAEA;;;;;;;;;;;;;;;;;;;;;AAqBG;AACa,SAAA,gBAAgB,CAAC,UAAiC,EAAE,KAAc,EAAA;AAChF,IAAA,OAAO,IAAI,iBAAiB,CAAC,EAAE,GAAG,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,KAAK,CAAC;AACzE;AAEA;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACa,SAAA,4BAA4B,CAAC,UAA6C,EAAE,KAAc,EAAA;AACxG,IAAA,OAAO,IAAI,iBAAiB,CAAC,EAAE,GAAG,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAAE,EAAE,KAAK,CAAC;AACrF;;;;"}
+{"version":3,"file":"app-client.mjs","names":[],"sources":["../src/app-client.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { AppSpecAppDetails, AppSpecAppDetailsByCreatorAndName, AppSpecAppDetailsById, ApplicationClient } from './types/app-client'\nimport Algodv2 = algosdk.Algodv2\n\n/**\n * @deprecated Use `AppClient` instead e.g. via `algorand.client.getAppClientById` or\n * `algorand.client.getAppClientByCreatorAndName`.\n * If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,\n * which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.\n *\n * Create a new ApplicationClient instance\n * @param appDetails The details of the app\n * @param algod An algod instance\n *\n * @example Resolve by creator and name\n * const client = algokit.getAppClient(\n *     {\n *       resolveBy: 'creatorAndName',\n *       app: {appSpec},\n *       sender: {account},\n *       creatorAddress: {creator},\n *       findExistingUsing: indexerClient,\n *     },\n *     algodClient,\n *   )\n *\n * @example Resolve by id:\n * const client = algokit.getAppClient(\n *     {\n *       resolveBy: 'id',\n *       app: {appSpec},\n *       sender: {account},\n *       id: {id},\n *     },\n *    algodClient,\n * )\n *\n * @returns The application client\n */\nexport function getAppClient(appDetails: AppSpecAppDetails, algod: Algodv2) {\n  return new ApplicationClient(appDetails, algod)\n}\n\n/**\n * @deprecated Use `AppClient` instead e.g. via `algorand.client.getAppClientById`.\n * If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,\n * which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.\n *\n *\n * Create a new ApplicationClient instance by id\n * @param appDetails The details of the app\n * @param algod An algod instance\n *\n * @example\n * const client = algokit.getAppClientById(\n *     {\n *       app: {appSpec},\n *       sender: {account},\n *       id: {id},\n *     },\n *     algodClient,\n *   )\n *\n * @returns The application client\n */\nexport function getAppClientById(appDetails: AppSpecAppDetailsById, algod: Algodv2) {\n  return new ApplicationClient({ ...appDetails, resolveBy: 'id' }, algod)\n}\n\n/**\n * @deprecated Use `AppClient` instead e.g. via `algorand.client.getAppClientByCreatorAndName`.\n * If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,\n * which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.\n *\n *\n * Create a new ApplicationClient instance by creator and name\n * @param appDetails The details of the app by creator and name\n * @param algod An algod instance\n *\n * @example\n * const client = algokit.getAppClientByCreatorAndName(\n *     {\n *       app: appSpec,\n *       sender: account,\n *       creatorAddress: account,\n *       findExistingUsing: indexerClient,\n *     },\n *     algodClient,\n *   )\n *\n * @returns The application client\n */\nexport function getAppClientByCreatorAndName(appDetails: AppSpecAppDetailsByCreatorAndName, algod: Algodv2) {\n  return new ApplicationClient({ ...appDetails, resolveBy: 'creatorAndName' }, algod)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,SAAgB,aAAa,YAA+B,OAAgB;CAC1E,OAAO,IAAI,kBAAkB,YAAY,KAAK;AAChD;;;;;;;;;;;;;;;;;;;;;;;AAwBA,SAAgB,iBAAiB,YAAmC,OAAgB;CAClF,OAAO,IAAI,kBAAkB;EAAE,GAAG;EAAY,WAAW;CAAK,GAAG,KAAK;AACxE;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,SAAgB,6BAA6B,YAA+C,OAAgB;CAC1G,OAAO,IAAI,kBAAkB;EAAE,GAAG;EAAY,WAAW;CAAiB,GAAG,KAAK;AACpF"}

package/app-deploy.d.ts

@@ -1,15 +1,14 @@
-import algosdk from 'algosdk';
-import { ABIReturn, AppCompilationResult, AppDeployMetadata, AppDeploymentParams, AppLookup, AppMetadata, CompiledTeal, TealTemplateParams } from './types/app';
-import { Arc2TransactionNote, ConfirmedTransactionResult, ConfirmedTransactionResults, SendTransactionFrom } from './types/transaction';
-import Algodv2 = algosdk.Algodv2;
-import Indexer = algosdk.Indexer;
-import modelsv2 = algosdk.modelsv2;
+import { ABIReturn, AppCompilationResult, AppDeployMetadata, AppDeploymentParams, AppLookup, AppMetadata, CompiledTeal, TealTemplateParams } from "./types/app.js";
+import { Arc2TransactionNote, ConfirmedTransactionResult, ConfirmedTransactionResults, SendTransactionFrom } from "./types/transaction.js";
+import algosdk from "algosdk";
+
+//#region src/app-deploy.d.ts
 /**
  * @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
+ * To understand the architecture decisions behind this functionality please see https://github.com/algorandfoundation/algokit-cli/blob/main/docs/src/content/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md
  *
  * **Note:** When using the return from this function be sure to check `operationPerformed` to get access to various return properties like `transaction`, `confirmation` and `deleteResult`.
  *
@@ -21,16 +20,16 @@ import modelsv2 = algosdk.modelsv2;
  * @param indexer An indexer client, needed if `existingDeployments` not passed in
  * @returns The app reference of the new/existing app
  */
-export declare function deployApp(deployment: AppDeploymentParams, algod: Algodv2, indexer?: Indexer): Promise<Partial<AppCompilationResult> & ((ConfirmedTransactionResults & AppMetadata & {
-    return?: ABIReturn;
-    operationPerformed: 'create' | 'update';
+declare function deployApp(deployment: AppDeploymentParams, algod: Algodv2, indexer?: Indexer): Promise<Partial<AppCompilationResult> & ((ConfirmedTransactionResults & AppMetadata & {
+  return?: ABIReturn;
+  operationPerformed: 'create' | 'update';
 }) | (ConfirmedTransactionResults & AppMetadata & {
-    return?: ABIReturn;
-    deleteReturn?: ABIReturn;
-    deleteResult: ConfirmedTransactionResult;
-    operationPerformed: 'replace';
+  return?: ABIReturn;
+  deleteReturn?: ABIReturn;
+  deleteResult: ConfirmedTransactionResult;
+  operationPerformed: 'replace';
 }) | (AppMetadata & {
-    operationPerformed: 'nothing';
+  operationPerformed: 'nothing';
 }))>;
 /**
  * @deprecated Use `before.numByteSlice < after.numByteSlice || before.numUint < after.numUint` instead.
@@ -43,7 +42,7 @@ export declare function deployApp(deployment: AppDeploymentParams, algod: Algodv
  * @param after The new schema
  * @returns Whether or not there is a breaking change
  */
-export declare function isSchemaIsBroken(before: modelsv2.ApplicationStateSchema, after: modelsv2.ApplicationStateSchema): boolean;
+declare function isSchemaIsBroken(before: modelsv2.ApplicationStateSchema, after: modelsv2.ApplicationStateSchema): boolean;
 /**
  * @deprecated Use `algorand.appDeployer.getCreatorAppsByName` instead.
  *
@@ -55,7 +54,7 @@ export declare function isSchemaIsBroken(before: modelsv2.ApplicationStateSchema
  * @param indexer An indexer client
  * @returns A name-based lookup of the app information (id, address)
  */
-export declare function getCreatorAppsByName(creatorAccount: SendTransactionFrom | string, indexer: Indexer): Promise<AppLookup>;
+declare function getCreatorAppsByName(creatorAccount: SendTransactionFrom | string, indexer: Indexer): Promise<AppLookup>;
 /**
  * @deprecated Use `{ dAppName: APP_DEPLOY_NOTE_DAPP, data: metadata, format: 'j' }` instead.
  *
@@ -63,7 +62,7 @@ export declare function getCreatorAppsByName(creatorAccount: SendTransactionFrom
  * @param metadata The metadata of the deployment
  * @returns The transaction note as a utf-8 string
  */
-export declare function getAppDeploymentTransactionNote(metadata: AppDeployMetadata): Arc2TransactionNote;
+declare function getAppDeploymentTransactionNote(metadata: AppDeployMetadata): Arc2TransactionNote;
 /**
  * @deprecated Use `AppManager.replaceTealTemplateDeployTimeControlParams` instead
  *
@@ -79,9 +78,9 @@ export declare function getAppDeploymentTransactionNote(metadata: AppDeployMetad
  * @param params The deploy-time deployment control parameter value to replace
  * @returns The replaced TEAL code
  */
-export declare function replaceDeployTimeControlParams(tealCode: string, params: {
-    updatable?: boolean;
-    deletable?: boolean;
+declare function replaceDeployTimeControlParams(tealCode: string, params: {
+  updatable?: boolean;
+  deletable?: boolean;
 }): string;
 /**
  * @deprecated Use `AppManager.replaceTealTemplateParams` instead
@@ -94,7 +93,7 @@ export declare function replaceDeployTimeControlParams(tealCode: string, params:
  * @param templateParams Any parameters to replace in the .teal file before compiling
  * @returns The TEAL code with replacements
  */
-export declare function performTemplateSubstitution(tealCode: string, templateParams?: TealTemplateParams): string;
+declare function performTemplateSubstitution(tealCode: string, templateParams?: TealTemplateParams): string;
 /**
  * @deprecated Use `algorand.appManager.compileTealTemplate` instead.
  *
@@ -108,7 +107,7 @@ export declare function performTemplateSubstitution(tealCode: string, templatePa
  * @param deploymentMetadata The deployment metadata the app will be deployed with
  * @returns The information about the compiled code
  */
-export declare function performTemplateSubstitutionAndCompile(tealCode: string, algod: Algodv2, templateParams?: TealTemplateParams, deploymentMetadata?: AppDeployMetadata): Promise<CompiledTeal>;
+declare function performTemplateSubstitutionAndCompile(tealCode: string, algod: Algodv2, templateParams?: TealTemplateParams, deploymentMetadata?: AppDeployMetadata): Promise<CompiledTeal>;
 /**
  * @deprecated Use `AppManager.stripTealComments` instead.
  *
@@ -117,4 +116,7 @@ export declare function performTemplateSubstitutionAndCompile(tealCode: string,
  * @param tealCode The TEAL logic to compile
  * @returns The TEAL without comments
  */
-export declare function stripTealComments(tealCode: string): string;
+declare function stripTealComments(tealCode: string): string;
+//#endregion
+export { deployApp, getAppDeploymentTransactionNote, getCreatorAppsByName, isSchemaIsBroken, performTemplateSubstitution, performTemplateSubstitutionAndCompile, replaceDeployTimeControlParams, stripTealComments };
+//# sourceMappingURL=app-deploy.d.ts.map