@algorandfoundation/algokit-utils 1.0.0-beta.4 → 1.0.0-beta.40

package/app.d.ts

@@ -0,0 +1,153 @@
+import algosdk, { ABIMethod, ABIMethodParams, ABIValue, Algodv2 } from 'algosdk';
+import { ApplicationResponse, EvalDelta, PendingTransactionResponse, TealValue } from './types/algod';
+import { ABIAppCallArgs, ABIReturn, AppCallArgs, AppCallParams, AppCallTransactionResult, AppCompilationResult, AppReference, AppState, BoxIdentifier, BoxName, BoxReference, BoxValueRequestParams, BoxValuesRequestParams, CompiledTeal, CreateAppParams, RawAppCallArgs, UpdateAppParams } from './types/app';
+import { SendTransactionFrom } from './types/transaction';
+/**
+ * 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
+ * @returns The details of the created app, or the transaction to create it if `skipSending`
+ */
+export declare function createApp(create: CreateAppParams, algod: Algodv2): Promise<Partial<AppCompilationResult> & AppCallTransactionResult & AppReference>;
+/**
+ * Updates a smart contract app.
+ * @param update The parameters to update the app with
+ * @param algod An algod client
+ * @returns The transaction
+ */
+export declare function updateApp(update: UpdateAppParams, algod: Algodv2): Promise<Partial<AppCompilationResult> & AppCallTransactionResult>;
+/**
+ * Issues a call to a given app.
+ * @param call The call details.
+ * @param algod An algod client
+ * @returns The result of the call
+ */
+export declare function callApp(call: AppCallParams, algod: Algodv2): Promise<AppCallTransactionResult>;
+/**
+ * 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
+ * @returns The return value for the method call
+ */
+export declare function getABIReturn(args?: AppCallArgs, confirmation?: PendingTransactionResponse): ABIReturn | undefined;
+/**
+ * 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
+ * @returns The current global state
+ */
+export declare function getAppGlobalState(appId: number, algod: Algodv2): Promise<AppState>;
+/**
+ * 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
+ * @param algod An algod client instance
+ * @returns The current local state for the given (app, account) combination
+ */
+export declare function getAppLocalState(appId: number, account: string | SendTransactionFrom, algod: Algodv2): Promise<AppState>;
+/**
+ * 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
+ * @returns The current box names
+ */
+export declare function getAppBoxNames(appId: number, algod: Algodv2): Promise<BoxName[]>;
+/**
+ * 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`
+ * @param algod An algod client instance
+ * @returns The current box value as a byte array
+ */
+export declare function getAppBoxValue(appId: number, boxName: string | Uint8Array | BoxName, algod: Algodv2): Promise<Uint8Array>;
+/**
+ * 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`
+ * @param algod An algod client instance
+ * @returns The current box values as a byte array in the same order as the passed in box names
+ */
+export declare function getAppBoxValues(appId: number, boxNames: (string | Uint8Array | BoxName)[], algod: Algodv2): Promise<Uint8Array[]>;
+/**
+ * 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
+ * @returns The current box value as an ABI value
+ */
+export declare function getAppBoxValueFromABIType(request: BoxValueRequestParams, algod: Algodv2): Promise<ABIValue>;
+/**
+ * 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
+ * @returns The current box values as an ABI value in the same order as the passed in box names
+ */
+export declare function getAppBoxValuesFromABIType(request: BoxValuesRequestParams, algod: Algodv2): Promise<ABIValue[]>;
+/**
+ * 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`
+ * @returns An object keyeed by the UTF-8 representation of the key with various parsings of the values
+ */
+export declare function decodeAppState(state: {
+    key: string;
+    value: TealValue | EvalDelta;
+}[]): AppState;
+/**
+ * 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`
+ */
+export declare function getAppArgsForTransaction(args?: RawAppCallArgs): {
+    accounts: string[] | undefined;
+    appArgs: Uint8Array[] | undefined;
+    boxes: algosdk.BoxReference[] | undefined;
+    foreignApps: number[] | undefined;
+    foreignAssets: number[] | undefined;
+    lease: Uint8Array | undefined;
+} | undefined;
+/**
+ * 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
+ * @returns The parameters ready to pass into `addMethodCall` within AtomicTransactionComposer
+ */
+export declare function getAppArgsForABICall(args: ABIAppCallArgs, from: SendTransactionFrom): Promise<{
+    method: algosdk.ABIMethod;
+    sender: string;
+    signer: algosdk.TransactionSigner;
+    boxes: algosdk.BoxReference[] | undefined;
+    lease: Uint8Array | undefined;
+    methodArgs: (string | number | bigint | boolean | Uint8Array | algosdk.ABIValue[] | algosdk.TransactionWithSigner)[];
+    rekeyTo: undefined;
+}>;
+/**
+ * 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;
+/**
+ * Gets the current data for the given app from algod.
+ *
+ * @param appId The id of the app
+ * @param algod An algod client
+ * @returns The data about the app
+ */
+export declare function getAppById(appId: number, algod: Algodv2): Promise<ApplicationResponse>;
+/** @deprecated Use `algokit.getAppById` instead. */
+export declare const getAppByIndex: typeof getAppById;
+/**
+ * Compiles the given TEAL using algod and returns the result, including source map.
+ *
+ * @param algod An algod client
+ * @param tealCode The TEAL code
+ * @returns The information about the compiled file
+ */
+export declare function compileTeal(tealCode: string, algod: Algodv2): Promise<CompiledTeal>;
+/**
+ * Returns the encoded ABI spec for a given ABI Method
+ * @param method The method to return a signature for
+ * @returns The encoded ABI method spec e.g. `method_name(uint64,string)string`
+ */
+export declare const getABIMethodSignature: (method: ABIMethodParams | ABIMethod) => string;
+//# sourceMappingURL=app.d.ts.map

package/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EACd,SAAS,EACT,eAAe,EAEf,QAAQ,EACR,OAAO,EAKR,MAAM,SAAS,CAAA;AAahB,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,0BAA0B,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AACrG,OAAO,EACL,cAAc,EACd,SAAS,EACT,WAAW,EACX,aAAa,EACb,wBAAwB,EACxB,oBAAoB,EACpB,YAAY,EACZ,QAAQ,EAER,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;;;;;GAKG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,wBAAwB,GAAG,YAAY,CAAC,CA+GlF;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;;;;;GAKG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAgFpG;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,0BAA0B,GAAG,SAAS,GAAG,SAAS,CA4BjH;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,qBAQpE;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,mBAAmB,EAAE,KAAK,EAAE,OAAO,qBAS1G;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAStF;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAI/H;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,SAAS,GAAG,SAAS,CAAA;CAAE,EAAE,GAAG,QAAQ,CAwC/F;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,CAAC,EAAE,cAAc;;;;;;;cAY7D;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,mBAAmB;;;;;;;;GA6BzF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,aAAa,GAAG,YAAY,GAAG,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAiB9G;AAED;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,gCAE7D;AAED,oDAAoD;AACpD,eAAO,MAAM,aAAa,mBAAa,CAAA;AAEvC;;;;;;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"}