@algorandfoundation/algokit-utils 9.2.1 → 9.2.2

package/types/account.d.ts

@@ -1,209 +1,219 @@
-import { AlgoAmount } from "./amount.js";
-import algosdk, { Address } from "algosdk";
-
-//#region src/types/account.d.ts
+import algosdk, { Address } from 'algosdk';
+import { AlgoAmount } from './amount';
+import ApplicationLocalState = algosdk.modelsv2.ApplicationLocalState;
+import ApplicationStateSchema = algosdk.modelsv2.ApplicationStateSchema;
+import AssetHolding = algosdk.modelsv2.AssetHolding;
+import Application = algosdk.modelsv2.Application;
+import Asset = algosdk.modelsv2.Asset;
+import AccountParticipation = algosdk.modelsv2.AccountParticipation;
+import Account = algosdk.Account;
+import MultisigMetadata = algosdk.MultisigMetadata;
+import Transaction = algosdk.Transaction;
+import TransactionSigner = algosdk.TransactionSigner;
 /**
  * The account name identifier used for fund dispensing in test environments
  */
-declare const DISPENSER_ACCOUNT = "DISPENSER";
+export declare const DISPENSER_ACCOUNT = "DISPENSER";
 /** Account wrapper that supports partial or full multisig signing. */
-declare class MultisigAccount {
-  _params: algosdk.MultisigMetadata;
-  _signingAccounts: (algosdk.Account | SigningAccount)[];
-  _addr: Address;
-  _signer: TransactionSigner;
-  /** The parameters for the multisig account */
-  get params(): Readonly<algosdk.MultisigMetadata>;
-  /** The list of accounts that are present to sign */
-  get signingAccounts(): Readonly<(algosdk.Account | SigningAccount)[]>;
-  /** The address of the multisig account */
-  get addr(): Readonly<Address>;
-  /** The transaction signer for the multisig account */
-  get signer(): TransactionSigner;
-  constructor(multisigParams: MultisigMetadata, signingAccounts: (Account | SigningAccount)[]);
-  /**
-   * Sign the given transaction
-   * @param transaction Either a transaction object or a raw, partially signed transaction
-   * @returns The transaction signed by the present signers
-   * @example
-   * ```typescript
-   * const signedTxn = multisigAccount.sign(myTransaction)
-   * ```
-   */
-  sign(transaction: Transaction | Uint8Array): Uint8Array;
+export declare class MultisigAccount {
+    _params: algosdk.MultisigMetadata;
+    _signingAccounts: (algosdk.Account | SigningAccount)[];
+    _addr: Address;
+    _signer: TransactionSigner;
+    /** The parameters for the multisig account */
+    get params(): Readonly<algosdk.MultisigMetadata>;
+    /** The list of accounts that are present to sign */
+    get signingAccounts(): Readonly<(algosdk.Account | SigningAccount)[]>;
+    /** The address of the multisig account */
+    get addr(): Readonly<Address>;
+    /** The transaction signer for the multisig account */
+    get signer(): TransactionSigner;
+    constructor(multisigParams: MultisigMetadata, signingAccounts: (Account | SigningAccount)[]);
+    /**
+     * Sign the given transaction
+     * @param transaction Either a transaction object or a raw, partially signed transaction
+     * @returns The transaction signed by the present signers
+     * @example
+     * ```typescript
+     * const signedTxn = multisigAccount.sign(myTransaction)
+     * ```
+     */
+    sign(transaction: Transaction | Uint8Array): Uint8Array;
 }
 /** Account wrapper that supports a rekeyed account */
-declare class SigningAccount implements Account {
-  private _account;
-  private _signer;
-  private _sender;
-  /**
-   * Algorand address of the sender
-   */
-  get addr(): Readonly<Address>;
-  /**
-   * Secret key belonging to the signer
-   */
-  get sk(): Readonly<Uint8Array>;
-  /**
-   * Transaction signer for the underlying signing account
-   */
-  get signer(): TransactionSigner;
-  /**
-   * Algorand account of the sender address and signer private key
-   */
-  get sender(): Account;
-  constructor(account: Account, sender: string | Address | undefined);
+export declare class SigningAccount implements Account {
+    private _account;
+    private _signer;
+    private _sender;
+    /**
+     * Algorand address of the sender
+     */
+    get addr(): Readonly<Address>;
+    /**
+     * Secret key belonging to the signer
+     */
+    get sk(): Readonly<Uint8Array>;
+    /**
+     * Transaction signer for the underlying signing account
+     */
+    get signer(): TransactionSigner;
+    /**
+     * Algorand account of the sender address and signer private key
+     */
+    get sender(): Account;
+    constructor(account: Account, sender: string | Address | undefined);
 }
 /** A wrapper around `TransactionSigner` that also has the sender address. */
-interface TransactionSignerAccount {
-  addr: Readonly<Address>;
-  signer: TransactionSigner;
+export interface TransactionSignerAccount {
+    addr: Readonly<Address>;
+    signer: TransactionSigner;
 }
 /** Account information at a given round. */
-type AccountInformation = {
-  /**
-   * The account public key
-   */
-  address: Address; /** The balance of Algo currently held by the account. */
-  balance: AlgoAmount;
-  /**
-   * The amount of Algo in the account, without the pending rewards.
-   */
-  amountWithoutPendingRewards: AlgoAmount;
-  /**
-   * Algo balance required to be held by the account.
-   *
-   * The requirement grows based on asset and application usage.
-   */
-  minBalance: AlgoAmount;
-  /**
-   * Amount of Algo of pending rewards in this account.
-   */
-  pendingRewards: AlgoAmount;
-  /**
-   * Total rewards of Algo the account has received, including pending
-   * rewards.
-   */
-  rewards: AlgoAmount;
-  /**
-   * The round number for which this information is relevant.
-   */
-  validAsOfRound: bigint;
-  /**
-   * Delegation status of the account's Algo:
-   * * Offline - indicates that the associated account is delegated.
-   * * Online - indicates that the associated account used as part of the delegation pool.
-   * * NotParticipating - indicates that the associated account is neither a delegator nor a delegate.
-   */
-  status: string;
-  /**
-   * The count of all applications that have been opted in, equivalent to the count
-   * of application local data (AppLocalState objects) stored in this account.
-   */
-  totalAppsOptedIn: number;
-  /**
-   * The count of all assets that have been opted in, equivalent to the count of
-   * AssetHolding objects held by this account.
-   */
-  totalAssetsOptedIn: number;
-  /**
-   * The count of all apps (AppParams objects) created by this account.
-   */
-  totalCreatedApps: number;
-  /**
-   * The count of all assets (AssetParams objects) created by this account.
-   */
-  totalCreatedAssets: number;
-  /**
-   * Applications local data stored in this account.
-   */
-  appsLocalState?: ApplicationLocalState[];
-  /**
-   * The sum of all extra application program pages for this account.
-   */
-  appsTotalExtraPages?: number;
-  /**
-   * (tsch) stores the sum of all of the local schemas and global schemas in this
-   * account.
-   * Note: the raw account uses `StateSchema` for this type.
-   */
-  appsTotalSchema?: ApplicationStateSchema;
-  /**
-   * Assets held by this account.
-   */
-  assets?: AssetHolding[];
-  /**
-   * The address against which signing should be checked. If empty, the
-   * address of the current account is used. This field can be updated in any
-   * transaction by setting the `RekeyTo` field.
-   */
-  authAddr?: Address;
-  /**
-   * Parameters of applications created by this account including app global data.
-   */
-  createdApps?: Application[];
-  /**
-   * (apar) parameters of assets created by this account.
-   * Note: the raw account uses `map[int] -> Asset` for this type.
-   */
-  createdAssets?: Asset[];
-  /**
-   * AccountParticipation describes the parameters used by this account in consensus
-   * protocol.
-   */
-  participation?: AccountParticipation;
-  /**
-   * Used as part of the rewards computation. Only applicable to accounts
-   * which are participating.
-   */
-  rewardBase?: number;
-  /**
-   * Indicates what type of signature is used by this account, must be one of:
-   * * sig
-   * * msig
-   * * lsig
-   */
-  sigType?: string;
-  /**
-   * The total number of bytes used by this account's app's box keys and
-   * values.
-   */
-  totalBoxBytes?: number;
-  /**
-   * The number of existing boxes created by this account's app.
-   */
-  totalBoxes?: number;
-  /**
-   * The round in which this account last went online, or explicitly renewed their
-   * online status.
-   */
-  lastHeartbeatRound?: bigint;
-  /**
-   * The round in which this account last proposed the block.
-   */
-  lastProposedRound?: bigint;
+export type AccountInformation = {
+    /**
+     * The account public key
+     */
+    address: Address;
+    /** The balance of Algo currently held by the account. */
+    balance: AlgoAmount;
+    /**
+     * The amount of Algo in the account, without the pending rewards.
+     */
+    amountWithoutPendingRewards: AlgoAmount;
+    /**
+     * Algo balance required to be held by the account.
+     *
+     * The requirement grows based on asset and application usage.
+     */
+    minBalance: AlgoAmount;
+    /**
+     * Amount of Algo of pending rewards in this account.
+     */
+    pendingRewards: AlgoAmount;
+    /**
+     * Total rewards of Algo the account has received, including pending
+     * rewards.
+     */
+    rewards: AlgoAmount;
+    /**
+     * The round number for which this information is relevant.
+     */
+    validAsOfRound: bigint;
+    /**
+     * Delegation status of the account's Algo:
+     * * Offline - indicates that the associated account is delegated.
+     * * Online - indicates that the associated account used as part of the delegation pool.
+     * * NotParticipating - indicates that the associated account is neither a delegator nor a delegate.
+     */
+    status: string;
+    /**
+     * The count of all applications that have been opted in, equivalent to the count
+     * of application local data (AppLocalState objects) stored in this account.
+     */
+    totalAppsOptedIn: number;
+    /**
+     * The count of all assets that have been opted in, equivalent to the count of
+     * AssetHolding objects held by this account.
+     */
+    totalAssetsOptedIn: number;
+    /**
+     * The count of all apps (AppParams objects) created by this account.
+     */
+    totalCreatedApps: number;
+    /**
+     * The count of all assets (AssetParams objects) created by this account.
+     */
+    totalCreatedAssets: number;
+    /**
+     * Applications local data stored in this account.
+     */
+    appsLocalState?: ApplicationLocalState[];
+    /**
+     * The sum of all extra application program pages for this account.
+     */
+    appsTotalExtraPages?: number;
+    /**
+     * (tsch) stores the sum of all of the local schemas and global schemas in this
+     * account.
+     * Note: the raw account uses `StateSchema` for this type.
+     */
+    appsTotalSchema?: ApplicationStateSchema;
+    /**
+     * Assets held by this account.
+     */
+    assets?: AssetHolding[];
+    /**
+     * The address against which signing should be checked. If empty, the
+     * address of the current account is used. This field can be updated in any
+     * transaction by setting the `RekeyTo` field.
+     */
+    authAddr?: Address;
+    /**
+     * Parameters of applications created by this account including app global data.
+     */
+    createdApps?: Application[];
+    /**
+     * (apar) parameters of assets created by this account.
+     * Note: the raw account uses `map[int] -> Asset` for this type.
+     */
+    createdAssets?: Asset[];
+    /**
+     * AccountParticipation describes the parameters used by this account in consensus
+     * protocol.
+     */
+    participation?: AccountParticipation;
+    /**
+     * Used as part of the rewards computation. Only applicable to accounts
+     * which are participating.
+     */
+    rewardBase?: number;
+    /**
+     * Indicates what type of signature is used by this account, must be one of:
+     * * sig
+     * * msig
+     * * lsig
+     */
+    sigType?: string;
+    /**
+     * The total number of bytes used by this account's app's box keys and
+     * values.
+     */
+    totalBoxBytes?: number;
+    /**
+     * The number of existing boxes created by this account's app.
+     */
+    totalBoxes?: number;
+    /**
+     * The round in which this account last went online, or explicitly renewed their
+     * online status.
+     */
+    lastHeartbeatRound?: bigint;
+    /**
+     * The round in which this account last proposed the block.
+     */
+    lastProposedRound?: bigint;
 };
 /** Account asset holding information at a given round. */
-type AccountAssetInformation = {
-  /** The ID of the asset held. */assetId: bigint; /** The current balance of that asset holding. */
-  balance: bigint; /** Whether or not the asset is frozen for the account. */
-  frozen: boolean; /** The round as at which the holding was correct. */
-  round: bigint;
+export type AccountAssetInformation = {
+    /** The ID of the asset held. */
+    assetId: bigint;
+    /** The current balance of that asset holding. */
+    balance: bigint;
+    /** Whether or not the asset is frozen for the account. */
+    frozen: boolean;
+    /** The round as at which the holding was correct. */
+    round: bigint;
 };
 /**
  * @deprecated The methods that use this can be achieved using `AccountManager` instead.
  * Config for an account config */
-interface AccountConfig {
-  /** Mnemonic for an account */
-  accountMnemonic: string;
-  /** Address of a rekeyed account */
-  senderAddress?: string;
-  /** Account name used to retrieve config */
-  accountName: string;
-  /** @deprecated Renamed to senderAddress in 2.3.1 */
-  senderMnemonic?: string;
+export interface AccountConfig {
+    /** Mnemonic for an account */
+    accountMnemonic: string;
+    /** Address of a rekeyed account */
+    senderAddress?: string;
+    /** Account name used to retrieve config */
+    accountName: string;
+    /** @deprecated Renamed to senderAddress in 2.3.1 */
+    senderMnemonic?: string;
 }
-//#endregion
-export { AccountAssetInformation, AccountConfig, AccountInformation, DISPENSER_ACCOUNT, MultisigAccount, SigningAccount, TransactionSignerAccount };
-//# sourceMappingURL=account.d.ts.map

package/types/algo-http-client-with-retry.d.ts

@@ -1,17 +1,12 @@
-import { BaseHTTPClientResponse, Query, URLTokenBaseHTTPClient } from "algosdk/client";
-
-//#region src/types/algo-http-client-with-retry.d.ts
+import { BaseHTTPClientResponse, Query, URLTokenBaseHTTPClient } from 'algosdk/client';
 /** A HTTP Client that wraps the Algorand SDK HTTP Client with retries */
-declare class AlgoHttpClientWithRetry extends URLTokenBaseHTTPClient {
-  private static readonly MAX_TRIES;
-  private static readonly MAX_BACKOFF_MS;
-  private static readonly RETRY_STATUS_CODES;
-  private static readonly RETRY_ERROR_CODES;
-  private callWithRetry;
-  get(relativePath: string, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
-  post(relativePath: string, data: Uint8Array, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
-  delete(relativePath: string, data: Uint8Array, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
+export declare class AlgoHttpClientWithRetry extends URLTokenBaseHTTPClient {
+    private static readonly MAX_TRIES;
+    private static readonly MAX_BACKOFF_MS;
+    private static readonly RETRY_STATUS_CODES;
+    private static readonly RETRY_ERROR_CODES;
+    private callWithRetry;
+    get(relativePath: string, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
+    post(relativePath: string, data: Uint8Array, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
+    delete(relativePath: string, data: Uint8Array, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
 }
-//#endregion
-export { AlgoHttpClientWithRetry };
-//# sourceMappingURL=algo-http-client-with-retry.d.ts.map