import algosdk from 'algosdk';
import { Expand } from './expand';
import { SendSingleTransactionResult, SendTransactionFrom, SendTransactionParams, SendTransactionResult, SendTransactionResults, TransactionNote, TransactionToSign } from './transaction';
import ABIArgument = algosdk.ABIArgument;
import ABIMethod = algosdk.ABIMethod;
import ABIMethodParams = algosdk.ABIMethodParams;
import ABIType = algosdk.ABIType;
import ABIValue = algosdk.ABIValue;
import Address = algosdk.Address;
import OnApplicationComplete = algosdk.OnApplicationComplete;
import SourceMap = algosdk.ProgramSourceMap;
import SuggestedParams = algosdk.SuggestedParams;
import Transaction = algosdk.Transaction;
/** The name of the TEAL template variable for deploy-time immutability control */
export declare const UPDATABLE_TEMPLATE_NAME = "TMPL_UPDATABLE";
/** The name of the TEAL template variable for deploy-time permanence control */
export 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 */
export declare const APP_DEPLOY_NOTE_DAPP = "ALGOKIT_DEPLOYER";
/** The maximum number of bytes in a single app code page */
export declare const APP_PAGE_MAX_SIZE = 2048;
/** First 4 bytes of SHA-512/256 hash of "return" for retrieving ABI return values */
export declare const ABI_RETURN_PREFIX: Uint8Array;
/** Information about an Algorand app */
export interface AppReference {
    /** The id of the app */
    appId: number | bigint;
    /** The Algorand address of the account associated with the app */
    appAddress: string;
}
/**
 * @deprecated Use `types/app-manager/BoxReference` instead.
 *
 * A grouping of the app ID and name of the box in an Uint8Array
 */
export interface BoxReference {
    /**
     * A unique application id
     */
    appId: number | bigint;
    /**
     * Name of box to reference
     */
    name: BoxIdentifier;
}
/**
 * @deprecated Use `types/app-manager/BoxIdentifier` instead.
 *
 * Something that identifies a box name - either a:
 *  * `Uint8Array`
 *  * `string` (that will be encoded to a Uint8Array)
 *  * `SendTransactionFrom` (encoded into the public key address of the corresponding account)
 */
export type BoxIdentifier = string | Uint8Array | SendTransactionFrom;
/** Common app call arguments for ABI and non-ABI (raw) calls */
export interface CoreAppCallArgs {
    /** The optional lease for the transaction */
    lease?: string | Uint8Array;
    /** Any box references to load */
    boxes?: (algosdk.BoxReference | BoxReference | 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)
 */
export 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` */
export type ABIAppCallArg = ABIArgument | TransactionToSign | Transaction | Promise<SendTransactionResult> | SendTransactionResult | undefined;
/**
 * App call args for an ABI call
 */
export type ABIAppCallArgs = CoreAppCallArgs & {
    /** The ABI method to call */
    method: ABIMethodParams | 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)
 **/
export type AppCallArgs = RawAppCallArgs | ABIAppCallArgs;
/**
 * @deprecated Use `TransactionComposer` to construct create app transactions instead.
 *
 * Base interface for common data passed to an app create or update.
 */
interface CreateOrUpdateAppParams extends SendTransactionParams {
    /** The account (with private key loaded) that will send the transaction */
    from: SendTransactionFrom;
    /** The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */
    approvalProgram: Uint8Array | string;
    /** The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */
    clearStateProgram: Uint8Array | string;
    /** Optional transaction parameters */
    transactionParams?: SuggestedParams;
    /** The (optional) transaction note */
    note?: TransactionNote;
    /** The arguments passed in to the app call */
    args?: AppCallArgs;
}
/**
 * @deprecated Use `TransactionComposer` to construct create app transactions instead.
 *
 * Parameters that are passed in when creating an app. */
export interface CreateAppParams extends CreateOrUpdateAppParams {
    /** The storage schema to request for the created app */
    schema: AppStorageSchema;
    /** Override the on-completion action for the create call; defaults to NoOp */
    onCompleteAction?: Exclude<AppCallType, 'clear_state'> | Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC>;
}
/**
 * @deprecated Use `TransactionComposer` to construct update app transactions instead.
 *
 * Parameters that are passed in when updating an app. */
export interface UpdateAppParams extends CreateOrUpdateAppParams {
    /** The id of the app to update */
    appId: number | bigint;
}
/**
 * @deprecated Use `algosdk.OnApplicationComplete` directly instead.
 *
 * The type of call / [on-completion action](https://dev.algorand.co/concepts/smart-contracts/overview#smart-contract-lifecycle) for a smart contract call.
 *
 * Equivalent of `algosdk.OnApplicationComplete`, but as a more convenient string enum.
 *
 * * `no_op`: Normal smart contract call, no special on-complete action
 * * `opt_in`: Opt-in to smart contract local storage
 * * `close_out`: Close-out local storage storage
 * * `clear_state`: Clear local storage state
 * * `update_application`: Update the smart contract
 * * `delete_application`: Delete the smart contract
 */
export type AppCallType = 'no_op' | 'opt_in' | 'close_out' | 'clear_state' | 'update_application' | 'delete_application';
/** Parameters representing a call to an app. */
export 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<AppCallType, 'update_application'> | Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplicationOC>;
    /** 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. */
export 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 */
export 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;
}
export interface AppCallTransactionResultOfType<T> extends SendTransactionResults, SendTransactionResult {
    /** If an ABI method was called the processed return value */
    return?: T;
}
/** Result from calling an app */
export type AppCallTransactionResult = AppCallTransactionResultOfType<ABIReturn>;
/** The return value of an ABI method call */
export type ABIReturn = {
    rawReturnValue: Uint8Array;
    returnValue: ABIValue;
    method: ABIMethod;
    decodeError: undefined;
} | {
    rawReturnValue?: undefined;
    returnValue?: undefined;
    method?: undefined;
    decodeError: Error;
};
/**
 * 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`.
 */
export 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 */
export 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 */
export 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_`.
 *
 */
export 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 */
export 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 */
export 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 parameters to deploy an app */
export interface AppDeploymentParams extends Omit<CreateAppParams, 'onCompleteAction' | 'args' | 'note' | 'skipSending' | 'skipWaiting' | 'atc'> {
    /** The deployment metadata */
    metadata: AppDeployMetadata;
    /** Any deploy-time parameters to replace in the TEAL code */
    deployTimeParams?: TealTemplateParams;
    /** 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' | 'fail' | 'append' | OnUpdate;
    /** Optional cached value of the existing apps for the given creator */
    existingDeployments?: AppLookup;
    /** Any args to pass to any create transaction that is issued as part of deployment */
    createArgs?: AppCallArgs;
    /** 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?: AppCallArgs;
    /** Any args to pass to any delete transaction that is issued as part of deployment */
    deleteArgs?: AppCallArgs;
}
/** The result of compiling the approval and clear state TEAL programs for an app */
export interface AppCompilationResult {
    /** The result of compiling the approval program */
    compiledApproval: CompiledTeal;
    /** The result of compiling the clear state program */
    compiledClear: CompiledTeal;
}
export type AppReturn<TReturn> = {
    /** The ABI method call return value */
    return?: TReturn;
};
/** Result from sending a single app transaction. */
export type SendAppTransactionResult = Expand<SendSingleTransactionResult & {
    /** If an ABI method was called the processed return value */
    return?: ABIReturn;
}>;
/** Result from sending a single app transaction. */
export type SendAppUpdateTransactionResult = Expand<SendAppTransactionResult & Partial<AppCompilationResult>>;
/** Result from sending a single app transaction. */
export 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 */
export 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 */
export 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.
 */
export 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.
 */
export 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;
}
export {};