algosdk 1.21.0 → 1.23.1

package/dist/types/src/client/v2/algod/getApplicationBoxes.d.ts

@@ -0,0 +1,43 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+import { BoxesResponse } from './models/types';
+/**
+ * Given an application ID, return all the box names associated with the app.
+ *
+ * #### Example
+ * ```typescript
+ * const index = 60553466;
+ * const boxesResponse = await algodClient.getApplicationBoxes(index).max(3).do();
+ * const boxNames = boxesResponse.boxes.map(box => box.name);
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplication-idboxes)
+ * @param index - The application ID to look up.
+ * @category GET
+ */
+export default class GetApplicationBoxes extends JSONRequest<BoxesResponse, Record<string, any>> {
+    private index;
+    constructor(c: HTTPClient, intDecoding: IntDecoding, index: number);
+    /**
+     * @returns `/v2/applications/${index}/boxes`
+     */
+    path(): string;
+    /**
+     * Limit results for pagination.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     * const boxesResult = await algodClient
+     *        .GetApplicationBoxes(1234)
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     * @category query
+     */
+    max(max: number): this;
+    prepare(body: Record<string, any>): BoxesResponse;
+}

package/dist/types/src/client/v2/algod/getBlockHash.d.ts

@@ -0,0 +1,8 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+export default class GetBlockHash extends JSONRequest {
+    round: number;
+    constructor(c: HTTPClient, intDecoding: IntDecoding, roundNumber: number);
+    path(): string;
+}

package/dist/types/src/client/v2/algod/models/types.d.ts

@@ -1,7 +1,7 @@
 /**
  * NOTICE: This file was generated. Editing this file manually is not recommended.
  */
-import BaseModel from './base';
+import BaseModel from '../../basemodel';
 import { EncodedSignedTransaction } from '../../../../types/transactions/encoded';
 import BlockHeader from '../../../../types/blockHeader';
 /**
@@ -121,6 +121,15 @@ export declare class Account extends BaseModel {
      * * lsig
      */
     sigType?: string;
+    /**
+     * (tbxb) The total number of bytes used by this account's app's box keys and
+     * values.
+     */
+    totalBoxBytes?: number | bigint;
+    /**
+     * (tbx) The number of existing boxes created by this account's app.
+     */
+    totalBoxes?: number | bigint;
     /**
      * Creates a new `Account` object.
      * @param address - the account public key
@@ -168,8 +177,11 @@ export declare class Account extends BaseModel {
      * * sig
      * * msig
      * * lsig
+     * @param totalBoxBytes - (tbxb) The total number of bytes used by this account's app's box keys and
+     * values.
+     * @param totalBoxes - (tbx) The number of existing boxes created by this account's app.
      */
-    constructor({ address, amount, amountWithoutPendingRewards, minBalance, pendingRewards, rewards, round, status, totalAppsOptedIn, totalAssetsOptedIn, totalCreatedApps, totalCreatedAssets, appsLocalState, appsTotalExtraPages, appsTotalSchema, assets, authAddr, createdApps, createdAssets, participation, rewardBase, sigType, }: {
+    constructor({ address, amount, amountWithoutPendingRewards, minBalance, pendingRewards, rewards, round, status, totalAppsOptedIn, totalAssetsOptedIn, totalCreatedApps, totalCreatedAssets, appsLocalState, appsTotalExtraPages, appsTotalSchema, assets, authAddr, createdApps, createdAssets, participation, rewardBase, sigType, totalBoxBytes, totalBoxes, }: {
         address: string;
         amount: number | bigint;
         amountWithoutPendingRewards: number | bigint;
@@ -192,7 +204,10 @@ export declare class Account extends BaseModel {
         participation?: AccountParticipation;
         rewardBase?: number | bigint;
         sigType?: string;
+        totalBoxBytes?: number | bigint;
+        totalBoxes?: number | bigint;
     });
+    static from_obj_for_encoding(data: Record<string, any>): Account;
 }
 /**
  * AccountApplicationResponse describes the account's application local state and
@@ -226,6 +241,7 @@ export declare class AccountApplicationResponse extends BaseModel {
      * The raw account uses `AppParams` for this type.
      */
     constructor(round: number | bigint, appLocalState?: ApplicationLocalState, createdApp?: ApplicationParams);
+    static from_obj_for_encoding(data: Record<string, any>): AccountApplicationResponse;
 }
 /**
  * AccountAssetResponse describes the account's asset holding and asset parameters
@@ -256,6 +272,7 @@ export declare class AccountAssetResponse extends BaseModel {
      * The raw account uses `AssetParams` for this type.
      */
     constructor(round: number | bigint, assetHolding?: AssetHolding, createdAsset?: AssetParams);
+    static from_obj_for_encoding(data: Record<string, any>): AccountAssetResponse;
 }
 /**
  * AccountParticipation describes the parameters used by this account in consensus
@@ -305,6 +322,7 @@ export declare class AccountParticipation extends BaseModel {
         voteParticipationKey: string | Uint8Array;
         stateProofKey?: string | Uint8Array;
     });
+    static from_obj_for_encoding(data: Record<string, any>): AccountParticipation;
 }
 /**
  * Application state delta.
@@ -321,6 +339,7 @@ export declare class AccountStateDelta extends BaseModel {
      * @param delta - Application state delta.
      */
     constructor(address: string, delta: EvalDeltaKeyValue[]);
+    static from_obj_for_encoding(data: Record<string, any>): AccountStateDelta;
 }
 /**
  * Application index and its parameters
@@ -340,6 +359,7 @@ export declare class Application extends BaseModel {
      * @param params - (appparams) application parameters.
      */
     constructor(id: number | bigint, params: ApplicationParams);
+    static from_obj_for_encoding(data: Record<string, any>): Application;
 }
 /**
  * Stores local state associated with an application.
@@ -364,6 +384,7 @@ export declare class ApplicationLocalState extends BaseModel {
      * @param keyValue - (tkv) storage.
      */
     constructor(id: number | bigint, schema: ApplicationStateSchema, keyValue?: TealKeyValue[]);
+    static from_obj_for_encoding(data: Record<string, any>): ApplicationLocalState;
 }
 /**
  * Stores the global information associated with an application.
@@ -418,6 +439,7 @@ export declare class ApplicationParams extends BaseModel {
         globalStateSchema?: ApplicationStateSchema;
         localStateSchema?: ApplicationStateSchema;
     });
+    static from_obj_for_encoding(data: Record<string, any>): ApplicationParams;
 }
 /**
  * Specifies maximums on the number of each type that may be stored.
@@ -437,6 +459,7 @@ export declare class ApplicationStateSchema extends BaseModel {
      * @param numByteSlice - (nbs) num of byte slices.
      */
     constructor(numUint: number | bigint, numByteSlice: number | bigint);
+    static from_obj_for_encoding(data: Record<string, any>): ApplicationStateSchema;
 }
 /**
  * Specifies both the unique identifier and the parameters for an asset
@@ -462,6 +485,7 @@ export declare class Asset extends BaseModel {
      * data/transactions/asset.go : AssetParams
      */
     constructor(index: number | bigint, params: AssetParams);
+    static from_obj_for_encoding(data: Record<string, any>): Asset;
 }
 /**
  * Describes an asset held by an account.
@@ -488,6 +512,7 @@ export declare class AssetHolding extends BaseModel {
      * @param isFrozen - (f) whether or not the holding is frozen.
      */
     constructor(amount: number | bigint, assetId: number | bigint, isFrozen: boolean);
+    static from_obj_for_encoding(data: Record<string, any>): AssetHolding;
 }
 /**
  * AssetParams specifies the parameters for an asset.
@@ -613,6 +638,22 @@ export declare class AssetParams extends BaseModel {
         url?: string;
         urlB64?: string | Uint8Array;
     });
+    static from_obj_for_encoding(data: Record<string, any>): AssetParams;
+}
+/**
+ * Hash of a block header.
+ */
+export declare class BlockHashResponse extends BaseModel {
+    /**
+     * Block header hash.
+     */
+    blockhash: string;
+    /**
+     * Creates a new `BlockHashResponse` object.
+     * @param blockhash - Block header hash.
+     */
+    constructor(blockhash: string);
+    static from_obj_for_encoding(data: Record<string, any>): BlockHashResponse;
 }
 /**
  * Encoded block object.
@@ -634,6 +675,54 @@ export declare class BlockResponse extends BaseModel {
      * message pack.
      */
     constructor(block: BlockHeader, cert?: Record<string, any>);
+    static from_obj_for_encoding(data: Record<string, any>): BlockResponse;
+}
+/**
+ * Box name and its content.
+ */
+export declare class Box extends BaseModel {
+    /**
+     * (name) box name, base64 encoded
+     */
+    name: Uint8Array;
+    /**
+     * (value) box value, base64 encoded.
+     */
+    value: Uint8Array;
+    /**
+     * Creates a new `Box` object.
+     * @param name - (name) box name, base64 encoded
+     * @param value - (value) box value, base64 encoded.
+     */
+    constructor(name: string | Uint8Array, value: string | Uint8Array);
+    static from_obj_for_encoding(data: Record<string, any>): Box;
+}
+/**
+ * Box descriptor describes a Box.
+ */
+export declare class BoxDescriptor extends BaseModel {
+    /**
+     * Base64 encoded box name
+     */
+    name: Uint8Array;
+    /**
+     * Creates a new `BoxDescriptor` object.
+     * @param name - Base64 encoded box name
+     */
+    constructor(name: string | Uint8Array);
+    static from_obj_for_encoding(data: Record<string, any>): BoxDescriptor;
+}
+/**
+ * Box names of an application
+ */
+export declare class BoxesResponse extends BaseModel {
+    boxes: BoxDescriptor[];
+    /**
+     * Creates a new `BoxesResponse` object.
+     * @param boxes -
+     */
+    constructor(boxes: BoxDescriptor[]);
+    static from_obj_for_encoding(data: Record<string, any>): BoxesResponse;
 }
 export declare class BuildVersion extends BaseModel {
     branch: string;
@@ -659,6 +748,7 @@ export declare class BuildVersion extends BaseModel {
         major: number | bigint;
         minor: number | bigint;
     });
+    static from_obj_for_encoding(data: Record<string, any>): BuildVersion;
 }
 /**
  *
@@ -673,6 +763,7 @@ export declare class CatchpointAbortResponse extends BaseModel {
      * @param catchupMessage - Catchup abort response string
      */
     constructor(catchupMessage: string);
+    static from_obj_for_encoding(data: Record<string, any>): CatchpointAbortResponse;
 }
 /**
  *
@@ -687,6 +778,7 @@ export declare class CatchpointStartResponse extends BaseModel {
      * @param catchupMessage - Catchup start response string
      */
     constructor(catchupMessage: string);
+    static from_obj_for_encoding(data: Record<string, any>): CatchpointStartResponse;
 }
 /**
  * Teal compile Result
@@ -711,6 +803,7 @@ export declare class CompileResponse extends BaseModel {
      * @param sourcemap - JSON of the source map
      */
     constructor(hash: string, result: string, sourcemap?: Record<string, any>);
+    static from_obj_for_encoding(data: Record<string, any>): CompileResponse;
 }
 /**
  * Teal disassembly Result
@@ -725,6 +818,7 @@ export declare class DisassembleResponse extends BaseModel {
      * @param result - disassembled Teal code
      */
     constructor(result: string);
+    static from_obj_for_encoding(data: Record<string, any>): DisassembleResponse;
 }
 /**
  * Request data type for dryrun endpoint. Given the Transactions and simulated
@@ -772,6 +866,7 @@ export declare class DryrunRequest extends BaseModel {
         sources: DryrunSource[];
         txns: EncodedSignedTransaction[];
     });
+    static from_obj_for_encoding(data: Record<string, any>): DryrunRequest;
 }
 /**
  * DryrunResponse contains per-txn debug information from a dryrun.
@@ -790,6 +885,7 @@ export declare class DryrunResponse extends BaseModel {
      * @param txns -
      */
     constructor(error: string, protocolVersion: string, txns: DryrunTxnResult[]);
+    static from_obj_for_encoding(data: Record<string, any>): DryrunResponse;
 }
 /**
  * DryrunSource is TEAL source text that gets uploaded, compiled, and inserted into
@@ -815,6 +911,7 @@ export declare class DryrunSource extends BaseModel {
      * @param appIndex -
      */
     constructor(fieldName: string, source: string, txnIndex: number | bigint, appIndex: number | bigint);
+    static from_obj_for_encoding(data: Record<string, any>): DryrunSource;
 }
 /**
  * Stores the TEAL eval step data
@@ -849,6 +946,7 @@ export declare class DryrunState extends BaseModel {
         error?: string;
         scratch?: TealValue[];
     });
+    static from_obj_for_encoding(data: Record<string, any>): DryrunState;
 }
 /**
  * DryrunTxnResult contains any LogicSig or ApplicationCall program debug
@@ -916,6 +1014,7 @@ export declare class DryrunTxnResult extends BaseModel {
         logicSigTrace?: DryrunState[];
         logs?: Uint8Array[];
     });
+    static from_obj_for_encoding(data: Record<string, any>): DryrunTxnResult;
 }
 /**
  * An error response with optional data field.
@@ -929,6 +1028,7 @@ export declare class ErrorResponse extends BaseModel {
      * @param data -
      */
     constructor(message: string, data?: Record<string, any>);
+    static from_obj_for_encoding(data: Record<string, any>): ErrorResponse;
 }
 /**
  * Represents a TEAL value delta.
@@ -953,6 +1053,7 @@ export declare class EvalDelta extends BaseModel {
      * @param uint - (ui) uint value.
      */
     constructor(action: number | bigint, bytes?: string, uint?: number | bigint);
+    static from_obj_for_encoding(data: Record<string, any>): EvalDelta;
 }
 /**
  * Key-value pairs for StateDelta.
@@ -969,6 +1070,7 @@ export declare class EvalDeltaKeyValue extends BaseModel {
      * @param value - Represents a TEAL value delta.
      */
     constructor(key: string, value: EvalDelta);
+    static from_obj_for_encoding(data: Record<string, any>): EvalDeltaKeyValue;
 }
 /**
  * Proof of membership and position of a light block header.
@@ -995,6 +1097,7 @@ export declare class LightBlockHeaderProof extends BaseModel {
      * from a leaf to the root.
      */
     constructor(index: number | bigint, proof: string | Uint8Array, treedepth: number | bigint);
+    static from_obj_for_encoding(data: Record<string, any>): LightBlockHeaderProof;
 }
 /**
  *
@@ -1107,6 +1210,7 @@ export declare class NodeStatusResponse extends BaseModel {
         catchpointVerifiedAccounts?: number | bigint;
         lastCatchpoint?: string;
     });
+    static from_obj_for_encoding(data: Record<string, any>): NodeStatusResponse;
 }
 /**
  * Details about a pending transaction. If the transaction was recently confirmed,
@@ -1212,6 +1316,7 @@ export declare class PendingTransactionResponse extends BaseModel {
         receiverRewards?: number | bigint;
         senderRewards?: number | bigint;
     });
+    static from_obj_for_encoding(data: Record<string, any>): PendingTransactionResponse;
 }
 /**
  * A potentially truncated list of transactions currently in the node's transaction
@@ -1233,6 +1338,7 @@ export declare class PendingTransactionsResponse extends BaseModel {
      * @param totalTransactions - Total number of transactions in the pool.
      */
     constructor(topTransactions: EncodedSignedTransaction[], totalTransactions: number | bigint);
+    static from_obj_for_encoding(data: Record<string, any>): PendingTransactionsResponse;
 }
 /**
  * Transaction ID of the submission.
@@ -1247,6 +1353,7 @@ export declare class PostTransactionsResponse extends BaseModel {
      * @param txid - encoding of the transaction hash.
      */
     constructor(txid: string);
+    static from_obj_for_encoding(data: Record<string, any>): PostTransactionsResponse;
 }
 /**
  * Represents a state proof and its corresponding message
@@ -1266,6 +1373,7 @@ export declare class StateProof extends BaseModel {
      * @param stateproof - The encoded StateProof for the message.
      */
     constructor(message: StateProofMessage, stateproof: string | Uint8Array);
+    static from_obj_for_encoding(data: Record<string, any>): StateProof;
 }
 /**
  * Represents the message that the state proofs are attesting to.
@@ -1310,6 +1418,7 @@ export declare class StateProofMessage extends BaseModel {
         lnprovenweight: number | bigint;
         voterscommitment: string | Uint8Array;
     });
+    static from_obj_for_encoding(data: Record<string, any>): StateProofMessage;
 }
 /**
  * Supply represents the current supply of MicroAlgos in the system.
@@ -1334,6 +1443,7 @@ export declare class SupplyResponse extends BaseModel {
      * @param totalMoney - TotalMoney
      */
     constructor(currentRound: number | bigint, onlineMoney: number | bigint, totalMoney: number | bigint);
+    static from_obj_for_encoding(data: Record<string, any>): SupplyResponse;
 }
 /**
  * Represents a key-value pair in an application store.
@@ -1350,6 +1460,7 @@ export declare class TealKeyValue extends BaseModel {
      * @param value - Represents a TEAL value.
      */
     constructor(key: string, value: TealValue);
+    static from_obj_for_encoding(data: Record<string, any>): TealKeyValue;
 }
 /**
  * Represents a TEAL value.
@@ -1374,6 +1485,7 @@ export declare class TealValue extends BaseModel {
      * @param uint - (ui) uint value.
      */
     constructor(type: number | bigint, bytes: string, uint: number | bigint);
+    static from_obj_for_encoding(data: Record<string, any>): TealValue;
 }
 /**
  * TransactionParams contains the parameters that help a client construct a new
@@ -1431,6 +1543,7 @@ export declare class TransactionParametersResponse extends BaseModel {
         lastRound: number | bigint;
         minFee: number | bigint;
     });
+    static from_obj_for_encoding(data: Record<string, any>): TransactionParametersResponse;
 }
 /**
  * Proof of transaction in a block.
@@ -1477,6 +1590,7 @@ export declare class TransactionProofResponse extends BaseModel {
         treedepth: number | bigint;
         hashtype?: string;
     });
+    static from_obj_for_encoding(data: Record<string, any>): TransactionProofResponse;
 }
 /**
  * algod version information.
@@ -1494,4 +1608,5 @@ export declare class Version extends BaseModel {
      * @param versions -
      */
     constructor(build: BuildVersion, genesisHashB64: string | Uint8Array, genesisId: string, versions: string[]);
+    static from_obj_for_encoding(data: Record<string, any>): Version;
 }

package/dist/types/src/client/v2/indexer/indexer.d.ts

@@ -13,10 +13,12 @@ import LookupAccountCreatedApplications from './lookupAccountCreatedApplications
 import LookupAssetByID from './lookupAssetByID';
 import LookupApplications from './lookupApplications';
 import LookupApplicationLogs from './lookupApplicationLogs';
+import LookupApplicationBoxByIDandName from './lookupApplicationBoxByIDandName';
 import SearchAccounts from './searchAccounts';
 import SearchForTransactions from './searchForTransactions';
 import SearchForAssets from './searchForAssets';
 import SearchForApplications from './searchForApplications';
+import SearchForApplicationBoxes from './searchForApplicationBoxes';
 import { BaseHTTPClient } from '../../baseHTTPClient';
 import { CustomTokenHeader, IndexerTokenHeader } from '../../urlTokenBaseHTTPClient';
 /**
@@ -299,4 +301,48 @@ export default class IndexerClient extends ServiceClient {
      * @category GET
      */
     searchForApplications(): SearchForApplications;
+    /**
+     * Returns information about indexed application boxes.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     * const appID = 1234;
+     *
+     * const responsePage1 = await indexerClient
+     *        .searchForApplicationBoxes(appID)
+     *        .limit(maxResults)
+     *        .do();
+     * const boxNamesPage1 = responsePage1.boxes.map(box => box.name);
+     *
+     * const responsePage2 = await indexerClient
+     *        .searchForApplicationBoxes(appID)
+     *        .limit(maxResults)
+     *        .nextToken(responsePage1.nextToken)
+     *        .do();
+     * const boxNamesPage2 = responsePage2.boxes.map(box => box.name);
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-idboxes)
+     * @param appID - The ID of the application with boxes.
+     * @category GET
+     */
+    searchForApplicationBoxes(appID: number): SearchForApplicationBoxes;
+    /**
+     * Returns information about the application box given its name.
+     *
+     * #### Example
+     * ```typescript
+     * const boxName = Buffer.from("foo");
+     * const boxResponse = await indexerClient
+     *        .LookupApplicationBoxByIDandName(1234, boxName)
+     *        .do();
+     * const boxValue = boxResponse.value;
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-idbox)
+     * @param appID - The ID of the application with boxes.
+     * @category GET
+     */
+    lookupApplicationBoxByIDandName(appID: number, boxName: Uint8Array): LookupApplicationBoxByIDandName;
 }

package/dist/types/src/client/v2/indexer/lookupApplicationBoxByIDandName.d.ts

@@ -0,0 +1,29 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+import { Box } from './models/types';
+export default class LookupApplicationBoxByIDandName extends JSONRequest<Box, Record<string, any>> {
+    private index;
+    /**
+     * Returns information about indexed application boxes.
+     *
+     * #### Example
+     * ```typescript
+     * const boxName = Buffer.from("foo");
+     * const boxResponse = await indexerClient
+     *        .LookupApplicationBoxByIDandName(1234, boxName)
+     *        .do();
+     * const boxValue = boxResponse.value;
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-idbox)
+     * @oaram index - application index.
+     * @category GET
+     */
+    constructor(c: HTTPClient, intDecoding: IntDecoding, index: number, boxName: Uint8Array);
+    /**
+     * @returns `/v2/applications/${index}/box`
+     */
+    path(): string;
+    prepare(body: Record<string, any>): Box;
+}

package/dist/types/src/client/v2/indexer/lookupBlock.d.ts

@@ -21,4 +21,9 @@ export default class LookupBlock extends JSONRequest {
      * @returns `/v2/blocks/${round}`
      */
     path(): string;
+    /**
+     * Header only flag. When this is set to true, returned block does not contain the
+     * transactions.
+     */
+    headerOnly(headerOnly: boolean): this;
 }