@algorandfoundation/algokit-utils 5.3.3-beta.1 → 5.4.0-beta.1

package/types/types/app-client.d.ts

@@ -1,416 +0,0 @@
-import algosdk from 'algosdk';
-import { AlgoAmount } from './amount';
-import { ABIAppCallArgs, ABIReturn, AppCallArgs, AppCallTransactionResult, AppCallType, AppCompilationResult, AppLookup, AppMetadata, AppReference, AppState, BoxName, OnSchemaBreak, OnUpdate, RawAppCallArgs, TealTemplateParams } from './app';
-import { AppSpec } from './app-spec';
-import { SendTransactionFrom, SendTransactionParams, TransactionNote } from './transaction';
-import ABIMethod = algosdk.ABIMethod;
-import ABIMethodParams = algosdk.ABIMethodParams;
-import ABIType = algosdk.ABIType;
-import ABIValue = algosdk.ABIValue;
-import Algodv2 = algosdk.Algodv2;
-import Indexer = algosdk.Indexer;
-import OnApplicationComplete = algosdk.OnApplicationComplete;
-import SuggestedParams = algosdk.SuggestedParams;
-/** Configuration to resolve app by creator and name `getCreatorAppsByName` */
-export type ResolveAppByCreatorAndNameBase = {
-    /** The address of the app creator account to resolve the app by */
-    creatorAddress: string;
-    /** The optional name override to resolve the app by within the creator account (default: uses the name in the ABI contract) */
-    name?: string;
-    /** The mechanism to find an existing app instance metadata for the given creator and name; either:
-     *  * An indexer instance to search the creator account apps; or
-     *  * The cached value of the existing apps for the given creator from `getCreatorAppsByName`
-     */
-    findExistingUsing: Indexer | AppLookup;
-};
-/** Configuration to resolve app by creator and name `getCreatorAppsByName` */
-export type ResolveAppByCreatorAndName = ResolveAppByCreatorAndNameBase & {
-    /** How the app ID is resolved, either by `'id'` or `'creatorAndName'`; must be `'creatorAndName'` if you want to use `deploy` */
-    resolveBy: 'creatorAndName';
-};
-/** Configuration to resolve app by ID */
-export interface ResolveAppByIdBase {
-    /** The id of an existing app to call using this client, or 0 if the app hasn't been created yet */
-    id: number | bigint;
-    /** The optional name to use to mark the app when deploying `ApplicationClient.deploy` (default: uses the name in the ABI contract) */
-    name?: string;
-}
-export interface ResolveAppById extends ResolveAppByIdBase {
-    /** How the app ID is resolved, either by `'id'` or `'creatorAndName'`; must be `'creatorAndName'` if you want to use `deploy` */
-    resolveBy: 'id';
-}
-/** The details of an AlgoKit Utils deployed app */
-export type AppDetailsBase = {
-    /** Default sender to use for transactions issued by this application client */
-    sender?: SendTransactionFrom;
-    /** Default suggested params object to use */
-    params?: SuggestedParams;
-    /** Optionally provide any deploy-time parameters to replace in the TEAL code; if specified here will get
-     * used in calls to `deploy`, `create` and `update` unless overridden in those calls
-     */
-    deployTimeParams?: TealTemplateParams;
-};
-/** The details of an AlgoKit Utils deployed app */
-export type AppDetails = AppDetailsBase & (ResolveAppById | ResolveAppByCreatorAndName);
-/** The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app */
-export type AppSpecAppDetailsBase = {
-    /** The ARC-0032 application spec as either:
-     *  * Parsed JSON `AppSpec`
-     *  * Raw JSON string
-     */
-    app: AppSpec | string;
-};
-/** The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app by id*/
-export type AppSpecAppDetailsById = AppSpecAppDetailsBase & AppDetailsBase & ResolveAppByIdBase;
-/** The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app by creator and name*/
-export type AppSpecAppDetailsByCreatorAndName = AppSpecAppDetailsBase & AppDetailsBase & ResolveAppByCreatorAndNameBase;
-/** The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app */
-export type AppSpecAppDetails = AppSpecAppDetailsBase & AppDetails;
-/** Core parameters to pass into ApplicationClient.deploy */
-export interface AppClientDeployCoreParams {
-    /** The version of the contract, uses "1.0" by default */
-    version?: string;
-    /** The optional sender to send the transaction from, will use the application client's default sender by default if specified */
-    sender?: SendTransactionFrom;
-    /** Parameters to control transaction sending */
-    sendParams?: Omit<SendTransactionParams, 'skipSending' | 'skipWaiting'>;
-    /** Whether or not to allow updates in the contract using the deploy-time updatability control if present in your contract.
-     * If this is not specified then it will automatically be determined based on the AppSpec definition
-     **/
-    allowUpdate?: boolean;
-    /** Whether or not to allow deletes in the contract using the deploy-time deletability control if present in your contract.
-     * If this is not specified then it will automatically be determined based on the AppSpec definition
-     **/
-    allowDelete?: boolean;
-    /** What action to perform if a schema break is detected */
-    onSchemaBreak?: 'replace' | 'fail' | 'append' | OnSchemaBreak;
-    /** What action to perform if a TEAL update is detected */
-    onUpdate?: 'update' | 'replace' | 'append' | 'fail' | OnUpdate;
-}
-/** Call interface parameters to pass into ApplicationClient.deploy */
-export interface AppClientDeployCallInterfaceParams {
-    /** Any deploy-time parameters to replace in the TEAL code */
-    deployTimeParams?: TealTemplateParams;
-    /** Any args to pass to any create transaction that is issued as part of deployment */
-    createArgs?: AppClientCallArgs;
-    /** Override the on-completion action for the create call; defaults to NoOp */
-    createOnCompleteAction?: Exclude<AppCallType, 'clear_state'> | Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC>;
-    /** Any args to pass to any update transaction that is issued as part of deployment */
-    updateArgs?: AppClientCallArgs;
-    /** Any args to pass to any delete transaction that is issued as part of deployment */
-    deleteArgs?: AppClientCallArgs;
-}
-/** Parameters to pass into ApplicationClient.deploy */
-export interface AppClientDeployParams extends AppClientDeployCoreParams, AppClientDeployCallInterfaceParams {
-}
-export interface AppClientCallRawArgs extends RawAppCallArgs {
-}
-export interface AppClientCallABIArgs extends Omit<ABIAppCallArgs, 'method'> {
-    /** If calling an ABI method then either the name of the method, or the ABI signature */
-    method: string;
-}
-/** The arguments to pass to an Application Client smart contract call */
-export type AppClientCallArgs = AppClientCallRawArgs | AppClientCallABIArgs;
-/** Common (core) parameters to construct a ApplicationClient contract call */
-export interface AppClientCallCoreParams {
-    /** The optional sender to send the transaction from, will use the application client's default sender by default if specified */
-    sender?: SendTransactionFrom;
-    /** The transaction note for the smart contract call */
-    note?: TransactionNote;
-    /** Parameters to control transaction sending */
-    sendParams?: SendTransactionParams;
-}
-/** Parameters to construct a ApplicationClient contract call */
-export type AppClientCallParams = AppClientCallArgs & AppClientCallCoreParams;
-/** Parameters to construct a ApplicationClient clear state contract call */
-export type AppClientClearStateParams = AppClientCallRawArgs & AppClientCallCoreParams;
-export interface AppClientCompilationParams {
-    /** Any deploy-time parameters to replace in the TEAL code */
-    deployTimeParams?: TealTemplateParams;
-    updatable?: boolean;
-    deletable?: boolean;
-}
-/** On-complete action parameter for creating a contract using ApplicationClient */
-export type AppClientCreateOnComplete = {
-    /** Override the on-completion action for the create call; defaults to NoOp */
-    onCompleteAction?: Exclude<AppCallType, 'clear_state'> | Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC>;
-};
-/** Parameters for creating a contract using ApplicationClient */
-export type AppClientCreateParams = AppClientCallParams & AppClientCompilationParams & AppClientCreateOnComplete;
-/** Parameters for updating a contract using ApplicationClient */
-export type AppClientUpdateParams = AppClientCallParams & AppClientCompilationParams;
-/** Parameters for funding an app account */
-export interface FundAppAccountParams {
-    amount: AlgoAmount;
-    /** The optional sender to send the transaction from, will use the application client's default sender by default if specified */
-    sender?: SendTransactionFrom;
-    /** The transaction note for the smart contract call */
-    note?: TransactionNote;
-    /** Parameters to control transaction sending */
-    sendParams?: SendTransactionParams;
-}
-/** Source maps for an Algorand app */
-export interface AppSourceMaps {
-    /** The source map of the approval program */
-    approvalSourceMap: SourceMapExport;
-    /** The source map of the clear program */
-    clearSourceMap: SourceMapExport;
-}
-export interface SourceMapExport {
-    version: number;
-    sources: string[];
-    names: string[];
-    mappings: string;
-}
-/** Application client - a class that wraps an ARC-0032 app spec and provides high productivity methods to deploy and call the app */
-export declare class ApplicationClient {
-    private algod;
-    private indexer?;
-    private appSpec;
-    private sender;
-    private params;
-    private existingDeployments;
-    private deployTimeParams?;
-    private _appId;
-    private _appAddress;
-    private _creator;
-    private _appName;
-    private _approvalSourceMap;
-    private _clearSourceMap;
-    /**
-     * Create a new ApplicationClient instance
-     * @param appDetails The details of the app
-     * @param algod An algod instance
-     */
-    constructor(appDetails: AppSpecAppDetails, algod: Algodv2);
-    /**
-     * Compiles the approval and clear programs and sets up the source map.
-     * @param compilation The deploy-time parameters for the compilation
-     * @returns The compiled approval and clear programs
-     */
-    compile(compilation?: AppClientCompilationParams): Promise<{
-        approvalCompiled: import("./app").CompiledTeal;
-        clearCompiled: import("./app").CompiledTeal;
-    }>;
-    /**
-     * Export the current source maps for the app.
-     * @returns The source maps
-     */
-    exportSourceMaps(): AppSourceMaps;
-    /**
-     * Import source maps for the app.
-     * @param sourceMaps The source maps to import
-     */
-    importSourceMaps(sourceMaps: AppSourceMaps): void;
-    /**
-     * 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
-     *
-     * **Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created.
-     *
-     * **Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created.
-     * @param deploy Deployment details
-     * @returns The metadata and transaction result(s) of the deployment, or just the metadata if it didn't need to issue transactions
-     */
-    deploy(deploy?: AppClientDeployParams): Promise<(Partial<AppCompilationResult> & AppMetadata & {
-        operationPerformed: "nothing";
-    }) | {
-        compiledApproval: import("./app").CompiledTeal;
-        compiledClear: import("./app").CompiledTeal;
-        confirmation: algosdk.modelsv2.PendingTransactionResponse;
-        confirmations: algosdk.modelsv2.PendingTransactionResponse[];
-        transaction: algosdk.Transaction;
-        transactions: algosdk.Transaction[];
-        createdRound: number;
-        updatedRound: number;
-        createdMetadata: import("./app").AppDeployMetadata;
-        deleted: boolean;
-        appId: number | bigint;
-        appAddress: string;
-        name: string;
-        version: string;
-        deletable?: boolean | undefined;
-        updatable?: boolean | undefined;
-        return?: ABIReturn | undefined;
-        operationPerformed: "update" | "create";
-    } | {
-        compiledApproval: import("./app").CompiledTeal;
-        compiledClear: import("./app").CompiledTeal;
-        confirmation: algosdk.modelsv2.PendingTransactionResponse;
-        confirmations: algosdk.modelsv2.PendingTransactionResponse[];
-        transaction: algosdk.Transaction;
-        transactions: algosdk.Transaction[];
-        createdRound: number;
-        updatedRound: number;
-        createdMetadata: import("./app").AppDeployMetadata;
-        deleted: boolean;
-        appId: number | bigint;
-        appAddress: string;
-        name: string;
-        version: string;
-        deletable?: boolean | undefined;
-        updatable?: boolean | undefined;
-        return?: ABIReturn | undefined;
-        deleteReturn?: ABIReturn | undefined;
-        deleteResult: import("./transaction").ConfirmedTransactionResult;
-        operationPerformed: "replace";
-    }>;
-    /**
-     * Creates a smart contract app, returns the details of the created app.
-     * @param create The parameters to create the app with
-     * @returns The details of the created app, or the transaction to create it if `skipSending` and the compilation result
-     */
-    create(create?: AppClientCreateParams): Promise<{
-        compiledApproval: import("./app").CompiledTeal;
-        compiledClear: import("./app").CompiledTeal;
-        return?: ABIReturn | undefined;
-        transactions: algosdk.Transaction[];
-        confirmations?: algosdk.modelsv2.PendingTransactionResponse[] | undefined;
-        transaction: algosdk.Transaction;
-        confirmation?: algosdk.modelsv2.PendingTransactionResponse | undefined;
-        appId: number | bigint;
-        appAddress: string;
-    }>;
-    /**
-     * Updates the smart contract app.
-     * @param update The parameters to update the app with
-     * @returns The transaction send result and the compilation result
-     */
-    update(update?: AppClientUpdateParams): Promise<{
-        compiledApproval: import("./app").CompiledTeal;
-        compiledClear: import("./app").CompiledTeal;
-        return?: ABIReturn | undefined;
-        transactions: algosdk.Transaction[];
-        confirmations?: algosdk.modelsv2.PendingTransactionResponse[] | undefined;
-        transaction: algosdk.Transaction;
-        confirmation?: algosdk.modelsv2.PendingTransactionResponse | undefined;
-    }>;
-    /**
-     * Issues a no_op (normal) call to the app.
-     * @param call The call details.
-     * @returns The result of the call
-     */
-    call(call?: AppClientCallParams): Promise<AppCallTransactionResult>;
-    /**
-     * Issues a opt_in call to the app.
-     * @param call The call details.
-     * @returns The result of the call
-     */
-    optIn(call?: AppClientCallParams): Promise<AppCallTransactionResult>;
-    /**
-     * Issues a close_out call to the app.
-     * @param call The call details.
-     * @returns The result of the call
-     */
-    closeOut(call?: AppClientCallParams): Promise<AppCallTransactionResult>;
-    /**
-     * Issues a clear_state call to the app.
-     * @param call The call details.
-     * @returns The result of the call
-     */
-    clearState(call?: AppClientClearStateParams): Promise<AppCallTransactionResult>;
-    /**
-     * Issues a delete_application call to the app.
-     * @param call The call details.
-     * @returns The result of the call
-     */
-    delete(call?: AppClientCallParams): Promise<AppCallTransactionResult>;
-    /**
-     * Issues a call to the app with the given call type.
-     * @param call The call details.
-     * @param callType The call type
-     * @returns The result of the call
-     */
-    callOfType(call: AppClientCallParams | undefined, callType: Exclude<AppCallType, 'update_application'> | Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplicationOC>): Promise<AppCallTransactionResult>;
-    /**
-     * Funds ALGOs into the app account for this app.
-     * @param fund The parameters for the funding or the funding amount
-     * @returns The result of the funding
-     */
-    fundAppAccount(fund: FundAppAccountParams | AlgoAmount): Promise<import("./transaction").SendTransactionResult>;
-    /**
-     * Returns global state for the current app.
-     * @returns The global state
-     */
-    getGlobalState(): Promise<AppState>;
-    /**
-     * Returns local state for the given account / account address.
-     * @returns The global state
-     */
-    getLocalState(account: string | SendTransactionFrom): Promise<AppState>;
-    /**
-     * Returns the names of all current boxes for the current app.
-     * @returns The names of the boxes
-     */
-    getBoxNames(): Promise<BoxName[]>;
-    /**
-     * Returns the value of the given box for the current app.
-     * @param name The name of the box to return either as a string, binary array or `BoxName`
-     * @returns The current box value as a byte array
-     */
-    getBoxValue(name: BoxName | string | Uint8Array): Promise<Uint8Array>;
-    /**
-     * Returns the value of the given box for the current app.
-     * @param name The name of the box to return either as a string, binary array or `BoxName`
-     * @param type
-     * @returns The current box value as a byte array
-     */
-    getBoxValueFromABIType(name: BoxName | string | Uint8Array, type: ABIType): Promise<ABIValue>;
-    /**
-     * Returns the values of all current boxes for the current app.
-     * Note: This will issue multiple HTTP requests (one per box) and it's not an atomic operation so values may be out of sync.
-     * @param filter Optional filter to filter which boxes' values are returned
-     * @returns The (name, value) pair of the boxes with values as raw byte arrays
-     */
-    getBoxValues(filter?: (name: BoxName) => boolean): Promise<{
-        name: BoxName;
-        value: Uint8Array;
-    }[]>;
-    /**
-     * Returns the values of all current boxes for the current app decoded using an ABI Type.
-     * Note: This will issue multiple HTTP requests (one per box) and it's not an atomic operation so values may be out of sync.
-     * @param type The ABI type to decode the values with
-     * @param filter Optional filter to filter which boxes' values are returned
-     * @returns The (name, value) pair of the boxes with values as the ABI Value
-     */
-    getBoxValuesFromABIType(type: ABIType, filter?: (name: BoxName) => boolean): Promise<{
-        name: BoxName;
-        value: ABIValue;
-    }[]>;
-    /**
-     * Returns the arguments for an app call for the given ABI method or raw method specification.
-     * @param args The call args specific to this application client
-     * @param sender The sender of this call. Will be used to fetch any default argument values if applicable
-     * @returns The call args ready to pass into an app call
-     */
-    getCallArgs(args: AppClientCallArgs | undefined, sender: SendTransactionFrom): Promise<AppCallArgs | undefined>;
-    /**
-     * Returns the ABI Method parameters for the given method name string for the app represented by this application client instance
-     * @param method Either the name of the method or the ABI method spec definition string
-     * @returns The ABI method params for the given method
-     */
-    getABIMethodParams(method: string): ABIMethodParams | undefined;
-    /**
-     * Returns the ABI Method for the given method name string for the app represented by this application client instance
-     * @param method Either the name of the method or the ABI method spec definition string
-     * @returns The ABI method for the given method
-     */
-    getABIMethod(method: string): ABIMethod | undefined;
-    /**
-     * Gets the reference information for the current application instance.
-     * `appId` will be 0 if it can't find an app.
-     * @returns The app reference, or if deployed using the `deploy` method, the app metadata too
-     */
-    getAppReference(): Promise<AppMetadata | AppReference>;
-    /**
-     * Takes an error that may include a logic error from a smart contract call and re-exposes the error to include source code information via the source map.
-     * This is automatically used within `ApplicationClient` but if you pass `skipSending: true` e.g. if doing a group transaction
-     *  then you can use this in a try/catch block to get better debugging information.
-     * @param e The error to parse
-     * @param isClear Whether or not the code was running the clear state program
-     * @returns The new error, or if there was no logic error or source map then the wrapped error with source details
-     */
-    exposeLogicError(e: Error, isClear?: boolean): Error;
-}
-//# sourceMappingURL=app-client.d.ts.map

package/types/types/app-client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"app-client.d.ts","sourceRoot":"","sources":["../../../src/types/app-client.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAmB7B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AACrC,OAAO,EAEL,cAAc,EACd,SAAS,EACT,WAAW,EACX,wBAAwB,EACxB,WAAW,EACX,oBAAoB,EACpB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,OAAO,EAEP,aAAa,EACb,QAAQ,EACR,cAAc,EACd,kBAAkB,EAEnB,MAAM,OAAO,CAAA;AACd,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAGpC,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAC3F,OAAO,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;AACpC,OAAO,eAAe,GAAG,OAAO,CAAC,eAAe,CAAA;AAChD,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;AAClC,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAGhC,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAA;AAE5D,OAAO,eAAe,GAAG,OAAO,CAAC,eAAe,CAAA;AAEhD,8EAA8E;AAC9E,MAAM,MAAM,8BAA8B,GAAG;IAC3C,mEAAmE;IACnE,cAAc,EAAE,MAAM,CAAA;IACtB,+HAA+H;IAC/H,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,iBAAiB,EAAE,OAAO,GAAG,SAAS,CAAA;CACvC,CAAA;AAED,8EAA8E;AAC9E,MAAM,MAAM,0BAA0B,GAAG,8BAA8B,GAAG;IACxE,iIAAiI;IACjI,SAAS,EAAE,gBAAgB,CAAA;CAC5B,CAAA;AAED,yCAAyC;AACzC,MAAM,WAAW,kBAAkB;IACjC,mGAAmG;IACnG,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,sIAAsI;IACtI,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACxD,iIAAiI;IACjI,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,mDAAmD;AACnD,MAAM,MAAM,cAAc,GAAG;IAC3B,+EAA+E;IAC/E,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,6CAA6C;IAC7C,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,kBAAkB,CAAA;CACtC,CAAA;AAED,mDAAmD;AACnD,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,CAAC,cAAc,GAAG,0BAA0B,CAAC,CAAA;AAEvF,gFAAgF;AAChF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;OAGG;IACH,GAAG,EAAE,OAAO,GAAG,MAAM,CAAA;CACtB,CAAA;AAED,qFAAqF;AACrF,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,GAAG,cAAc,GAAG,kBAAkB,CAAA;AAE/F,mGAAmG;AACnG,MAAM,MAAM,iCAAiC,GAAG,qBAAqB,GAAG,cAAc,GAAG,8BAA8B,CAAA;AAEvH,gFAAgF;AAChF,MAAM,MAAM,iBAAiB,GAAG,qBAAqB,GAAG,UAAU,CAAA;AAElE,4DAA4D;AAC5D,MAAM,WAAW,yBAAyB;IACxC,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iIAAiI;IACjI,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,gDAAgD;IAChD,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,EAAE,aAAa,GAAG,aAAa,CAAC,CAAA;IACvE;;QAEI;IACJ,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;QAEI;IACJ,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,2DAA2D;IAC3D,aAAa,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,aAAa,CAAA;IAC7D,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;CAC/D;AAED,sEAAsE;AACtE,MAAM,WAAW,kCAAkC;IACjD,6DAA6D;IAC7D,gBAAgB,CAAC,EAAE,kBAAkB,CAAA;IACrC,sFAAsF;IACtF,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,8EAA8E;IAC9E,sBAAsB,CAAC,EAAE,OAAO,CAAC,WAAW,EAAE,aAAa,CAAC,GAAG,OAAO,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAA;IACjI,sFAAsF;IACtF,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,sFAAsF;IACtF,UAAU,CAAC,EAAE,iBAAiB,CAAA;CAC/B;AAED,uDAAuD;AACvD,MAAM,WAAW,qBAAsB,SAAQ,yBAAyB,EAAE,kCAAkC;CAAG;AAG/G,MAAM,WAAW,oBAAqB,SAAQ,cAAc;CAAG;AAE/D,MAAM,WAAW,oBAAqB,SAAQ,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC;IAC1E,wFAAwF;IACxF,MAAM,EAAE,MAAM,CAAA;CACf;AAED,yEAAyE;AACzE,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,GAAG,oBAAoB,CAAA;AAE3E,8EAA8E;AAC9E,MAAM,WAAW,uBAAuB;IACtC,iIAAiI;IACjI,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,uDAAuD;IACvD,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,gDAAgD;IAChD,UAAU,CAAC,EAAE,qBAAqB,CAAA;CACnC;AAED,gEAAgE;AAChE,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,GAAG,uBAAuB,CAAA;AAE7E,4EAA4E;AAC5E,MAAM,MAAM,yBAAyB,GAAG,oBAAoB,GAAG,uBAAuB,CAAA;AAEtF,MAAM,WAAW,0BAA0B;IACzC,6DAA6D;IAC7D,gBAAgB,CAAC,EAAE,kBAAkB,CAAA;IAErC,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,mFAAmF;AACnF,MAAM,MAAM,yBAAyB,GAAG;IACtC,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,OAAO,CAAC,WAAW,EAAE,aAAa,CAAC,GAAG,OAAO,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAA;CAC5H,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,qBAAqB,GAAG,mBAAmB,GAAG,0BAA0B,GAAG,yBAAyB,CAAA;AAEhH,iEAAiE;AACjE,MAAM,MAAM,qBAAqB,GAAG,mBAAmB,GAAG,0BAA0B,CAAA;AAEpF,4CAA4C;AAC5C,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,UAAU,CAAA;IAClB,iIAAiI;IACjI,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,uDAAuD;IACvD,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,gDAAgD;IAChD,UAAU,CAAC,EAAE,qBAAqB,CAAA;CACnC;AAED,sCAAsC;AACtC,MAAM,WAAW,aAAa;IAC5B,6CAA6C;IAC7C,iBAAiB,EAAE,eAAe,CAAA;IAClC,0CAA0C;IAC1C,cAAc,EAAE,eAAe,CAAA;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB;AA8BD,qIAAqI;AACrI,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,OAAO,CAAC,CAAiB;IACjC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,MAAM,CAAiC;IAC/C,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,mBAAmB,CAAuB;IAClD,OAAO,CAAC,gBAAgB,CAAC,CAAoB;IAE7C,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAoB;IACpC,OAAO,CAAC,QAAQ,CAAQ;IAExB,OAAO,CAAC,kBAAkB,CAAuB;IACjD,OAAO,CAAC,eAAe,CAAuB;IAO9C;;;;OAIG;gBACS,UAAU,EAAE,iBAAiB,EAAE,KAAK,EAAE,OAAO;IAgCzD;;;;OAIG;IACG,OAAO,CAAC,WAAW,CAAC,EAAE,0BAA0B;;;;IAgCtD;;;OAGG;IACH,gBAAgB,IAAI,aAAa;IAajC;;;OAGG;IACH,gBAAgB,CAAC,UAAU,EAAE,aAAa;IAK1C;;;;;;;;;;OAUG;IACG,MAAM,CAAC,MAAM,CAAC,EAAE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAuG3C;;;;OAIG;IACG,MAAM,CAAC,MAAM,CAAC,EAAE,qBAAqB;;;;;;;;;;;IA+C3C;;;;OAIG;IACG,MAAM,CAAC,MAAM,CAAC,EAAE,qBAAqB;;;;;;;;;IAkC3C;;;;OAIG;IACG,IAAI,CAAC,IAAI,CAAC,EAAE,mBAAmB;IA+BrC;;;;OAIG;IACG,KAAK,CAAC,IAAI,CAAC,EAAE,mBAAmB;IAItC;;;;OAIG;IACG,QAAQ,CAAC,IAAI,CAAC,EAAE,mBAAmB;IAIzC;;;;OAIG;IACG,UAAU,CAAC,IAAI,CAAC,EAAE,yBAAyB;IAIjD;;;;OAIG;IACG,MAAM,CAAC,IAAI,CAAC,EAAE,mBAAmB;IAIvC;;;;;OAKG;IACG,UAAU,CACd,IAAI,iCAA0B,EAC9B,QAAQ,EAAE,OAAO,CAAC,WAAW,EAAE,oBAAoB,CAAC,GAAG,OAAO,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,mBAAmB,CAAC;IAiClI;;;;OAIG;IACG,cAAc,CAAC,IAAI,EAAE,oBAAoB,GAAG,UAAU;IAsB5D;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC,QAAQ,CAAC;IAUzC;;;OAGG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAU7E;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAUvC;;;;OAIG;IACG,WAAW,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAU3E;;;;;OAKG;IACG,sBAAsB,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,UAAU,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC;IAUnG;;;;;OAKG;IACG,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,UAAU,CAAA;KAAE,EAAE,CAAC;IAexG;;;;;;OAMG;IACG,uBAAuB,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,QAAQ,CAAA;KAAE,EAAE,CAAC;IAgBhI;;;;;OAKG;IACG,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,SAAS,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IA+DrH;;;;OAIG;IACH,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAiB/D;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAKnD;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,WAAW,GAAG,YAAY,CAAC;IAuB5D;;;;;;;OAOG;IACH,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;CAgBrD"}

package/types/types/app-spec.d.ts

@@ -1,156 +0,0 @@
-import algosdk from 'algosdk';
-import ABIContractParams = algosdk.ABIContractParams;
-import ABIMethodParams = algosdk.ABIMethodParams;
-/** An ARC-0032 Application Specification see https://github.com/algorandfoundation/ARCs/pull/150 */
-export interface AppSpec {
-    /** Method call hints */
-    hints: HintSpec;
-    /** The TEAL source */
-    source: AppSources;
-    /** The ABI-0004 contract definition see https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0004.md */
-    contract: ABIContractParams;
-    /** The values that make up the local and global state */
-    schema: SchemaSpec;
-    /** The rolled-up schema allocation values for local and global state */
-    state: StateSchemaSpec;
-    /** The config of all BARE calls (i.e. non ABI calls with no args) */
-    bare_call_config: CallConfig;
-}
-/** A lookup of encoded method call spec to hint */
-export type HintSpec = Record<string, Hint>;
-/** The TEAL source of a contract */
-export interface AppSources {
-    /** The TEAL source of the approval program */
-    approval: string;
-    /** The TEAL source of the clear program */
-    clear: string;
-}
-/** The various call configs:
- *  * `NEVER`: Will not be called
- *  * `CALL`: Can be called during a non-create call i.e. app id != 0
- *  * `CREATE`: Can be called during a create call i.e. app id = 0
- *  * `ALL`: Can be during a create OR non-create call
- **/
-export type CallConfigValue = 'NEVER' | 'CALL' | 'CREATE' | 'ALL';
-/** Call configuration for a method */
-export interface CallConfig {
-    /** NoOp call config */
-    no_op?: CallConfigValue;
-    /** Opt-in call config */
-    opt_in?: CallConfigValue;
-    /** Close out call config */
-    close_out?: CallConfigValue;
-    /** Update call config */
-    update_application?: CallConfigValue;
-    /** Delete call config */
-    delete_application?: CallConfigValue;
-}
-/** Hint information for a given method call to allow client generation */
-export interface Hint {
-    /** Any user-defined struct/tuple types used in the method call, keyed by parameter name or `output` for return type */
-    structs?: Record<string, Struct>;
-    read_only?: boolean;
-    default_arguments?: Record<string, DefaultArgument>;
-    call_config: CallConfig;
-}
-/** The name of a field */
-export type FieldName = string;
-/** The string name of an ABI type */
-export type ABIType = string;
-/** The elements of the struct/tuple: `FieldName`, `ABIType` */
-export type StructElement = [FieldName, ABIType];
-/** A user-defined struct/tuple type */
-export interface Struct {
-    /** The name of the type */
-    name: string;
-    /** The elements (in order) that make up the struct/tuple */
-    elements: StructElement[];
-}
-/**
- * Defines a strategy for obtaining a default value for a given ABI arg.
- */
-export type DefaultArgument = {
-    /**
-     * The default value should be fetched by invoking an ABI method
-     */
-    source: 'abi-method';
-    data: ABIMethodParams;
-} | {
-    /**
-     * The default value should be fetched from global state
-     */
-    source: 'global-state';
-    /**
-     * The key of the state variable
-     */
-    data: string;
-} | {
-    /**
-     * The default value should be fetched from the local state of the sender user
-     */
-    source: 'local-state';
-    /**
-     * The key of the state variable
-     */
-    data: string;
-} | {
-    /**
-     * The default value is a constant.
-     */
-    source: 'constant';
-    /**
-     * The static default value to use.
-     */
-    data: string | number;
-};
-/** AVM data type */
-export type AVMType = 'uint64' | 'bytes';
-/** Declared schema value specification */
-export interface DeclaredSchemaValueSpec {
-    /** The type of value */
-    type: AVMType;
-    /** The name of the key */
-    key: string;
-    /** A description of the variable */
-    descr?: string;
-    /** Whether or not the value is set statically (at create time only) or dynamically */
-    static?: boolean;
-}
-/** Reserved schema value specification */
-export interface ReservedSchemaValueSpec {
-    /** The type of value */
-    type: AVMType;
-    /** The description of the reserved storage space */
-    descr: string;
-    /** The maximum number of slots to reserve */
-    max_keys: number;
-}
-/** The schema for global and local storage */
-export interface SchemaSpec {
-    /** The local storage schema */
-    local: Schema;
-    /** The global storage schema */
-    global: Schema;
-}
-/** The storage schema definition */
-export interface Schema {
-    /** Declared storage schema */
-    declared: Record<string, DeclaredSchemaValueSpec>;
-    /** Reserved storage schema */
-    reserved: Record<string, ReservedSchemaValueSpec>;
-}
-/** The rolled-up schema allocation specification for local and global state */
-export interface StateSchemaSpec {
-    /** Global storage spec */
-    global: StateSchema;
-    /** Local storage spec */
-    local: StateSchema;
-}
-/** Schema spec summary for global or local storage */
-export type StateSchema = {
-    /** Number of uint slots */
-    num_uints: number;
-    /** Number of byte slots */
-    num_byte_slices: number;
-};
-//# sourceMappingURL=app-spec.d.ts.map

package/types/types/app-spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"app-spec.d.ts","sourceRoot":"","sources":["../../../src/types/app-spec.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAA;AACpD,OAAO,eAAe,GAAG,OAAO,CAAC,eAAe,CAAA;AAEhD,oGAAoG;AACpG,MAAM,WAAW,OAAO;IACtB,wBAAwB;IACxB,KAAK,EAAE,QAAQ,CAAA;IACf,sBAAsB;IACtB,MAAM,EAAE,UAAU,CAAA;IAClB,iHAAiH;IACjH,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,yDAAyD;IACzD,MAAM,EAAE,UAAU,CAAA;IAClB,wEAAwE;IACxE,KAAK,EAAE,eAAe,CAAA;IACtB,qEAAqE;IACrE,gBAAgB,EAAE,UAAU,CAAA;CAC7B;AAED,mDAAmD;AACnD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;AAE3C,oCAAoC;AACpC,MAAM,WAAW,UAAU;IACzB,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAA;IAChB,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;;IAKI;AACJ,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAA;AAEjE,sCAAsC;AACtC,MAAM,WAAW,UAAU;IACzB,uBAAuB;IACvB,KAAK,CAAC,EAAE,eAAe,CAAA;IACvB,yBAAyB;IACzB,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB,4BAA4B;IAC5B,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,yBAAyB;IACzB,kBAAkB,CAAC,EAAE,eAAe,CAAA;IACpC,yBAAyB;IACzB,kBAAkB,CAAC,EAAE,eAAe,CAAA;CACrC;AAED,0EAA0E;AAC1E,MAAM,WAAW,IAAI;IACnB,uHAAuH;IACvH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACnD,WAAW,EAAE,UAAU,CAAA;CACxB;AAED,0BAA0B;AAC1B,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAE9B,qCAAqC;AACrC,MAAM,MAAM,OAAO,GAAG,MAAM,CAAA;AAE5B,+DAA+D;AAC/D,MAAM,MAAM,aAAa,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;AAEhD,uCAAuC;AACvC,MAAM,WAAW,MAAM;IACrB,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,4DAA4D;IAC5D,QAAQ,EAAE,aAAa,EAAE,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB;IACE;;OAEG;IACH,MAAM,EAAE,YAAY,CAAA;IACpB,IAAI,EAAE,eAAe,CAAA;CACtB,GACD;IACE;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE;;OAEG;IACH,MAAM,EAAE,aAAa,CAAA;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAEL,oBAAoB;AACpB,MAAM,MAAM,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;AAExC,0CAA0C;AAC1C,MAAM,WAAW,uBAAuB;IACtC,wBAAwB;IACxB,IAAI,EAAE,OAAO,CAAA;IACb,0BAA0B;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sFAAsF;IACtF,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,0CAA0C;AAC1C,MAAM,WAAW,uBAAuB;IACtC,wBAAwB;IACxB,IAAI,EAAE,OAAO,CAAA;IACb,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAA;IACb,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,8CAA8C;AAC9C,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAA;CACf;AAED,oCAAoC;AACpC,MAAM,WAAW,MAAM;IACrB,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;IACjD,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;CAClD;AAED,+EAA+E;AAC/E,MAAM,WAAW,eAAe;IAC9B,0BAA0B;IAC1B,MAAM,EAAE,WAAW,CAAA;IACnB,yBAAyB;IACzB,KAAK,EAAE,WAAW,CAAA;CACnB;AAED,sDAAsD;AACtD,MAAM,MAAM,WAAW,GAAG;IACxB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,2BAA2B;IAC3B,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA"}