@algorandfoundation/algokit-utils 7.0.0-beta.1 → 7.0.0-beta.3

package/app.d.ts

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

package/app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAc7B,OAAO,EACL,cAAc,EACd,SAAS,EAET,WAAW,EACX,aAAa,EACb,wBAAwB,EACxB,WAAW,EACX,oBAAoB,EACpB,YAAY,EACZ,QAAQ,EACR,aAAa,EACb,OAAO,EACP,YAAY,EACZ,qBAAqB,EACrB,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,cAAc,EACd,eAAe,EAChB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,mBAAmB,EAAyB,MAAM,qBAAqB,CAAA;AAEhF,OAAO,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;AACpC,OAAO,eAAe,GAAG,OAAO,CAAC,eAAe,CAAA;AAEhD,OAAO,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;AAElC,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAEhC,OAAO,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;AAClC,OAAO,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAA;AAI5D;;;;;GAKG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,wBAAwB,GAAG,YAAY,CAAC,CAyHlF;AAED;;;;;GAKG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,wBAAwB,CAAC,CAiEnE;AAUD;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,kBAAkB,CAAC,EAAE,WAAW,GAAG,qBAAqB,iCAsB9F;AAED;;;;;GAKG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAyEpG;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,QAAQ,CAAC,0BAA0B,GAAG,SAAS,GAAG,SAAS,CA4B1H;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,OAAO,qBAQ7E;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,mBAAmB,EAAE,KAAK,EAAE,OAAO,qBAWnH;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAS/F;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAIxI;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAEvI;AAED;;;;;GAKG;AACH,wBAAsB,yBAAyB,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAIjH;AAED;;;;;GAKG;AACH,wBAAsB,0BAA0B,CAAC,OAAO,EAAE,sBAAsB,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAGrH;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAA;CAAE,EAAE,GAAG,QAAQ,CAwCjH;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,CAAC,EAAE,cAAc;;;;;;;cAY7D;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,mBAAmB;;;;;;;;;;;GAkCzF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,aAAa,GAAG,YAAY,GAAG,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAiB9G;AAMD;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,OAAO,yCAEtE;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CASzF;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,WAAY,eAAe,GAAG,SAAS,WAExE,CAAA"}
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAG7B,OAAO,EACL,cAAc,EACd,SAAS,EACT,WAAW,EACX,aAAa,EACb,wBAAwB,EACxB,WAAW,EACX,oBAAoB,EACpB,YAAY,EACZ,QAAQ,EACR,aAAa,EACb,OAAO,EACP,YAAY,EACZ,qBAAqB,EACrB,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,cAAc,EACd,eAAe,EAChB,MAAM,aAAa,CAAA;AAEpB,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAEzD,OAAO,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;AACpC,OAAO,eAAe,GAAG,OAAO,CAAC,eAAe,CAAA;AAChD,OAAO,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;AAElC,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAEhC,OAAO,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;AAClC,OAAO,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAA;AAG5D;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,wBAAwB,GAAG,YAAY,CAAC,CA0ClF;AAED;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,wBAAwB,CAAC,CAiCnE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,CAAC,kBAAkB,CAAC,EAAE,WAAW,GAAG,qBAAqB,iCAsB9F;AAED;;;;;;;;GAQG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAkCpG;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,QAAQ,CAAC,0BAA0B,GAAG,SAAS,GAAG,SAAS,CAO1H;AAED;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,OAAO,qBAE7E;AAED;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,mBAAmB,EAAE,KAAK,EAAE,OAAO,qBAEnH;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAE/F;AAED;;;;;;;GAOG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAExI;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAKvI;AAED;;;;;;GAMG;AACH,wBAAsB,yBAAyB,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAMjH;AAED;;;;;;GAMG;AACH,wBAAsB,0BAA0B,CAAC,OAAO,EAAE,sBAAsB,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAMrH;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAA;CAAE,EAAE,GAAG,QAAQ,CAEjH;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,CAAC,EAAE,cAAc;;;;;;;cAY7D;AAED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,mBAAmB;;;;;;;;;;;GAEzF;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,aAAa,GAAG,YAAY,GAAG,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAE9G;AAMD;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,OAAO,yCAEtE;AAED;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAEzF;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,WAAY,eAAe,GAAG,SAAS,WAExE,CAAA"}