algosdk 3.5.1 → 3.6.0

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

@@ -238,6 +238,60 @@ export declare class Account implements Encodable {
     toEncodingData(): Map<string, unknown>;
     static fromEncodingData(data: unknown): Account;
 }
+/**
+ * AccountApplicationResource describes the account's application resource (local
+ * state and params if the account is the creator) for a specific application ID.
+ */
+export declare class AccountApplicationResource implements Encodable {
+    private static encodingSchemaValue;
+    static get encodingSchema(): Schema;
+    /**
+     * The application ID.
+     */
+    id: number;
+    /**
+     * (appl) the application local data stored in this account.
+     * The raw account uses `AppLocalState` for this type.
+     */
+    appLocalState?: ApplicationLocalState;
+    /**
+     * Round when the account opted into or created the application.
+     */
+    createdAtRound?: number;
+    /**
+     * Whether the application has been deleted.
+     */
+    deleted?: boolean;
+    /**
+     * (appp) parameters of the application created by this account including app
+     * global data.
+     * The raw account uses `AppParams` for this type.
+     * Only present if the account is the creator and `include=params` is specified.
+     */
+    params?: ApplicationParams;
+    /**
+     * Creates a new `AccountApplicationResource` object.
+     * @param id - The application ID.
+     * @param appLocalState - (appl) the application local data stored in this account.
+     * The raw account uses `AppLocalState` for this type.
+     * @param createdAtRound - Round when the account opted into or created the application.
+     * @param deleted - Whether the application has been deleted.
+     * @param params - (appp) parameters of the application created by this account including app
+     * global data.
+     * The raw account uses `AppParams` for this type.
+     * Only present if the account is the creator and `include=params` is specified.
+     */
+    constructor({ id, appLocalState, createdAtRound, deleted, params, }: {
+        id: number | bigint;
+        appLocalState?: ApplicationLocalState;
+        createdAtRound?: number | bigint;
+        deleted?: boolean;
+        params?: ApplicationParams;
+    });
+    getEncodingSchema(): Schema;
+    toEncodingData(): Map<string, unknown>;
+    static fromEncodingData(data: unknown): AccountApplicationResource;
+}
 /**
  * AccountApplicationResponse describes the account's application local state and
  * global state (AppLocalState and AppParams, if either exists) for a specific
@@ -280,6 +334,41 @@ export declare class AccountApplicationResponse implements Encodable {
     toEncodingData(): Map<string, unknown>;
     static fromEncodingData(data: unknown): AccountApplicationResponse;
 }
+/**
+ * AccountApplicationsInformationResponse contains a list of application resources
+ * for an account.
+ */
+export declare class AccountApplicationsInformationResponse implements Encodable {
+    private static encodingSchemaValue;
+    static get encodingSchema(): Schema;
+    /**
+     * The round for which this information is relevant.
+     */
+    round: number;
+    applicationResources?: AccountApplicationResource[];
+    /**
+     * Used for pagination, when making another request provide this token with the
+     * next parameter. The next token is the next application ID to use as the
+     * pagination cursor.
+     */
+    nextToken?: string;
+    /**
+     * Creates a new `AccountApplicationsInformationResponse` object.
+     * @param round - The round for which this information is relevant.
+     * @param applicationResources -
+     * @param nextToken - Used for pagination, when making another request provide this token with the
+     * next parameter. The next token is the next application ID to use as the
+     * pagination cursor.
+     */
+    constructor({ round, applicationResources, nextToken, }: {
+        round: number | bigint;
+        applicationResources?: AccountApplicationResource[];
+        nextToken?: string;
+    });
+    getEncodingSchema(): Schema;
+    toEncodingData(): Map<string, unknown>;
+    static fromEncodingData(data: unknown): AccountApplicationsInformationResponse;
+}
 /**
  * AccountAssetHolding describes the account's asset holding and asset parameters
  * (if either exist) for a specific asset ID.
@@ -508,7 +597,7 @@ export declare class Application implements Encodable {
     /**
      * (appparams) application parameters.
      */
-    params: ApplicationParams;
+    params?: ApplicationParams;
     /**
      * Creates a new `Application` object.
      * @param id - (appidx) application index.
@@ -516,7 +605,7 @@ export declare class Application implements Encodable {
      */
     constructor({ id, params, }: {
         id: number | bigint;
-        params: ApplicationParams;
+        params?: ApplicationParams;
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;
@@ -684,6 +773,10 @@ export declare class ApplicationParams implements Encodable {
      * (lsch) local schema
      */
     localStateSchema?: ApplicationStateSchema;
+    /**
+     * (ss) the account responsible for extra pages and global state MBR
+     */
+    sizeSponsor?: Address;
     /**
      * (v) the number of updates to the application programs
      */
@@ -698,9 +791,10 @@ export declare class ApplicationParams implements Encodable {
      * @param globalState - (gs) global state
      * @param globalStateSchema - (gsch) global schema
      * @param localStateSchema - (lsch) local schema
+     * @param sizeSponsor - (ss) the account responsible for extra pages and global state MBR
      * @param version - (v) the number of updates to the application programs
      */
-    constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, version, }: {
+    constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, sizeSponsor, version, }: {
         approvalProgram: string | Uint8Array;
         clearStateProgram: string | Uint8Array;
         creator: Address | string;
@@ -708,6 +802,7 @@ export declare class ApplicationParams implements Encodable {
         globalState?: TealKeyValue[];
         globalStateSchema?: ApplicationStateSchema;
         localStateSchema?: ApplicationStateSchema;
+        sizeSponsor?: Address | string;
         version?: number | bigint;
     });
     getEncodingSchema(): Schema;
@@ -806,7 +901,7 @@ export declare class Asset implements Encodable {
      * Definition:
      * data/transactions/asset.go : AssetParams
      */
-    params: AssetParams;
+    params?: AssetParams;
     /**
      * Creates a new `Asset` object.
      * @param index - unique asset identifier
@@ -817,7 +912,7 @@ export declare class Asset implements Encodable {
      */
     constructor({ index, params, }: {
         index: number | bigint;
-        params: AssetParams;
+        params?: AssetParams;
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;
@@ -1210,12 +1305,20 @@ export declare class BoxDescriptor implements Encodable {
      * Base64 encoded box name
      */
     name: Uint8Array;
+    /**
+     * Base64 encoded box value. Present only when the `values` query parameter is set
+     * to true.
+     */
+    value?: Uint8Array;
     /**
      * Creates a new `BoxDescriptor` object.
      * @param name - Base64 encoded box name
+     * @param value - Base64 encoded box value. Present only when the `values` query parameter is set
+     * to true.
      */
-    constructor({ name }: {
+    constructor({ name, value, }: {
         name: string | Uint8Array;
+        value?: string | Uint8Array;
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;
@@ -1249,18 +1352,34 @@ export declare class BoxReference implements Encodable {
     static fromEncodingData(data: unknown): BoxReference;
 }
 /**
- * Box names of an application
+ * Boxes of an application
  */
 export declare class BoxesResponse implements Encodable {
     private static encodingSchemaValue;
     static get encodingSchema(): Schema;
     boxes: BoxDescriptor[];
+    /**
+     * Used for pagination, when making another request provide this token with the
+     * next parameter. The next token is the box name to use as the pagination cursor,
+     * encoded in the goal app call arg form.
+     */
+    nextToken?: string;
+    /**
+     * The round for which this information is relevant.
+     */
+    round?: number;
     /**
      * Creates a new `BoxesResponse` object.
      * @param boxes -
+     * @param nextToken - Used for pagination, when making another request provide this token with the
+     * next parameter. The next token is the box name to use as the pagination cursor,
+     * encoded in the goal app call arg form.
+     * @param round - The round for which this information is relevant.
      */
-    constructor({ boxes }: {
+    constructor({ boxes, nextToken, round, }: {
         boxes: BoxDescriptor[];
+        nextToken?: string;
+        round?: number | bigint;
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;
@@ -2897,9 +3016,16 @@ export declare class SupplyResponse implements Encodable {
      */
     currentRound: bigint;
     /**
-     * OnlineMoney
+     * Total stake held by accounts with status Online at current_round, including
+     * those whose participation keys have expired but have not yet been marked
+     * offline.
      */
     onlineMoney: bigint;
+    /**
+     * Online stake used by agreement to vote for current_round, excluding accounts
+     * whose participation keys have expired.
+     */
+    onlineStake: bigint;
     /**
      * TotalMoney
      */
@@ -2907,12 +3033,17 @@ export declare class SupplyResponse implements Encodable {
     /**
      * Creates a new `SupplyResponse` object.
      * @param currentRound - Round
-     * @param onlineMoney - OnlineMoney
+     * @param onlineMoney - Total stake held by accounts with status Online at current_round, including
+     * those whose participation keys have expired but have not yet been marked
+     * offline.
+     * @param onlineStake - Online stake used by agreement to vote for current_round, excluding accounts
+     * whose participation keys have expired.
      * @param totalMoney - TotalMoney
      */
-    constructor({ currentRound, onlineMoney, totalMoney, }: {
+    constructor({ currentRound, onlineMoney, onlineStake, totalMoney, }: {
         currentRound: number | bigint;
         onlineMoney: number | bigint;
+        onlineStake: number | bigint;
         totalMoney: number | bigint;
     });
     getEncodingSchema(): Schema;
@@ -3027,8 +3158,8 @@ export declare class TransactionParametersResponse implements Encodable {
      */
     lastRound: bigint;
     /**
-     * The minimum transaction fee (not per byte) required for the
-     * txn to validate for the current network protocol.
+     * The minimum transaction fee (not per byte) required for the txn to validate for
+     * the current network protocol.
      */
     minFee: bigint;
     /**
@@ -3042,8 +3173,8 @@ export declare class TransactionParametersResponse implements Encodable {
      * @param genesisHash - GenesisHash is the hash of the genesis block.
      * @param genesisId - GenesisID is an ID listed in the genesis block.
      * @param lastRound - LastRound indicates the last round seen
-     * @param minFee - The minimum transaction fee (not per byte) required for the
-     * txn to validate for the current network protocol.
+     * @param minFee - The minimum transaction fee (not per byte) required for the txn to validate for
+     * the current network protocol.
      */
     constructor({ consensusVersion, fee, genesisHash, genesisId, lastRound, minFee, }: {
         consensusVersion: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algosdk",
-  "version": "3.5.1",
+  "version": "3.6.0",
   "description": "The official JavaScript SDK for Algorand",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/appAccess.ts

@@ -20,8 +20,14 @@ export function resourceReferencesToEncodingData(
   function ensure(target: ResourceReference): number {
     for (let idx = 0; idx < accessList.length; idx++) {
       const a = accessList[idx];
+      const aAddress = a.get('d') as Address | undefined;
+      const addressesEqual =
+        (!target.address && !aAddress) ||
+        (target.address &&
+          aAddress &&
+          (target.address as Address).equals(aAddress));
       if (
-        a.get('d') === target.address &&
+        addressesEqual &&
         a.get('s') === target.assetIndex &&
         a.get('p') === target.appIndex
       ) {
@@ -139,11 +145,12 @@ export function convertIndicesToResourceReferences(
       if (!hAssetIndex) {
         throw new Error(`Holding missing asset index: ${holding}`);
       }
+
       const hAddress =
         hAddressIndex === 0
           ? Address.zeroAddress()
-          : (references[hAddressIndex - 1].address as Address);
-      const asset = references[hAssetIndex - 1].assetIndex as bigint;
+          : (accessList[hAddressIndex - 1].get('d') as Address);
+      const asset = accessList[hAssetIndex - 1].get('s') as bigint;
       references.push({ holding: { address: hAddress, assetIndex: asset } });
       continue;
     }
@@ -154,11 +161,11 @@ export function convertIndicesToResourceReferences(
       const lAddress =
         lAddressIndex === 0
           ? Address.zeroAddress()
-          : (references[lAddressIndex - 1].address as Address);
+          : (accessList[lAddressIndex - 1].get('d') as Address);
       const app =
         lAppIndex === 0
           ? BigInt(0)
-          : (references[lAppIndex - 1].appIndex as bigint);
+          : (accessList[lAppIndex - 1].get('p') as bigint);
       references.push({ locals: { address: lAddress, appIndex: app } });
       continue;
     }
@@ -172,9 +179,13 @@ export function convertIndicesToResourceReferences(
       const app =
         bAppIndex === 0
           ? BigInt(0)
-          : (references[bAppIndex - 1].appIndex as number | bigint);
+          : (accessList[bAppIndex - 1].get('p') as number | bigint);
       references.push({ box: { appIndex: app, name } });
+      continue;
     }
+
+    // Empty resource reference - treat as an empty box reference
+    references.push({ box: { appIndex: BigInt(0), name: new Uint8Array(0) } });
   }
   return references;
 }

package/src/client/v2/algod/accountApplicationsInformation.ts

@@ -0,0 +1,46 @@
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { AccountApplicationsInformationResponse } from './models/types.js';
+import { Address } from '../../../encoding/address.js';
+
+export default class AccountApplicationsInformation extends JSONRequest<AccountApplicationsInformationResponse> {
+  private account: string;
+
+  constructor(c: HTTPClient, account: string | Address) {
+    super(c);
+    this.account = account.toString();
+  }
+
+  path() {
+    return `/v2/accounts/${this.account}/applications`;
+  }
+
+  /**
+   * @param include - use `params` to include full application parameters.
+   */
+  include(include: string[]) {
+    this.query.include = include.join(',');
+    return this;
+  }
+
+  limit(limit: number) {
+    this.query.limit = limit;
+    return this;
+  }
+
+  next(next: string) {
+    this.query.next = next;
+    return this;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(
+    response: HTTPClientResponse
+  ): AccountApplicationsInformationResponse {
+    return decodeJSON(
+      response.getJSONText(),
+      AccountApplicationsInformationResponse
+    );
+  }
+}

package/src/client/v2/algod/accountAssetsInformation.ts

@@ -0,0 +1,33 @@
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { AccountAssetsInformationResponse } from './models/types.js';
+import { Address } from '../../../encoding/address.js';
+
+export default class AccountAssetsInformation extends JSONRequest<AccountAssetsInformationResponse> {
+  private account: string;
+
+  constructor(c: HTTPClient, account: string | Address) {
+    super(c);
+    this.account = account.toString();
+  }
+
+  path() {
+    return `/v2/accounts/${this.account}/assets`;
+  }
+
+  limit(limit: number) {
+    this.query.limit = limit;
+    return this;
+  }
+
+  next(next: string) {
+    this.query.next = next;
+    return this;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): AccountAssetsInformationResponse {
+    return decodeJSON(response.getJSONText(), AccountAssetsInformationResponse);
+  }
+}

package/src/client/v2/algod/algod.ts

@@ -2,6 +2,8 @@ import ServiceClient from '../serviceClient.js';
 import * as modelsv2 from './models/types.js';
 import AccountInformation from './accountInformation.js';
 import AccountAssetInformation from './accountAssetInformation.js';
+import AccountAssetsInformation from './accountAssetsInformation.js';
+import AccountApplicationsInformation from './accountApplicationsInformation.js';
 import AccountApplicationInformation from './accountApplicationInformation.js';
 import Block from './block.js';
 import Compile from './compile.js';
@@ -177,6 +179,26 @@ export class AlgodClient extends ServiceClient {
     return new AccountAssetInformation(this.c, account, index);
   }
 
+  /**
+   * Returns the given account's asset holdings, paginated.
+   *
+   * @param account - The address of the account to look up.
+   * @category GET
+   */
+  accountAssetsInformation(account: string | Address) {
+    return new AccountAssetsInformation(this.c, account);
+  }
+
+  /**
+   * Returns the given account's application holdings, paginated.
+   *
+   * @param account - The address of the account to look up.
+   * @category GET
+   */
+  accountApplicationsInformation(account: string | Address) {
+    return new AccountApplicationsInformation(this.c, account);
+  }
+
   /**
    * Returns the given account's application information for a specific application.
    *
@@ -512,7 +534,7 @@ export class AlgodClient extends ServiceClient {
   }
 
   /**
-   * Given an application ID, return all the box names associated with the app.
+   * Given an application ID, return all the boxes associated with the app.
    *
    * #### Example
    * ```typescript
@@ -520,6 +542,8 @@ export class AlgodClient extends ServiceClient {
    * const boxesResponse = await algodClient.getApplicationBoxes(index).max(3).do();
    * const boxNames = boxesResponse.boxes.map(box => box.name);
    * ```
+   * With the `.include("values")` parameter, returns values in addition to names. Pagination is supported with `limit`. If using pagination,
+   * it is recommended to use the `.round()` parameter to ensure each page is for the same round.
    *
    * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2applicationsapplication-idboxes)
    * @param index - The application ID to look up.

package/src/client/v2/algod/getApplicationBoxes.ts

@@ -1,10 +1,14 @@
 import JSONRequest from '../jsonrequest.js';
 import { HTTPClient, HTTPClientResponse } from '../../client.js';
 import { decodeJSON } from '../../../encoding/encoding.js';
+import { bytesToBase64 } from '../../../encoding/binarydata.js';
+import { ensureSafeInteger } from '../../../utils/utils.js';
 import { BoxesResponse } from './models/types.js';
 
+export type BoxInclude = 'values';
+
 /**
- * Given an application ID, return all the box names associated with the app.
+ * Given an application ID, return all the boxes associated with the app.
  *
  * #### Example
  * ```typescript
@@ -13,6 +17,9 @@ import { BoxesResponse } from './models/types.js';
  * const boxNames = boxesResponse.boxes.map(box => box.name);
  * ```
  *
+ * With the `.include("values")` parameter, returns values in addition to names. Pagination is supported with `limit`. If using pagination,
+ * it is recommended to use the `.round()` parameter to ensure each page is for the same round.
+ *
  * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2applicationsapplication-idboxes)
  * @param index - The application ID to look up.
  * @category GET
@@ -34,18 +41,20 @@ export default class GetApplicationBoxes extends JSONRequest<BoxesResponse> {
   }
 
   /**
-   * Limit results for pagination.
+   * @deprecated - Use `limit` instead for proper pagination with a limit.
+   *
+   * Set the max amount of boxes to return. Returns HTTP 400 if max is exceeded.
    *
    * #### Example
    * ```typescript
    * const maxResults = 20;
    * const boxesResult = await algodClient
-   *        .GetApplicationBoxes(1234)
-   *        .limit(maxResults)
+   *        .getApplicationBoxes(1234)
+   *        .max(maxResults)
    *        .do();
    * ```
    *
-   * @param limit - maximum number of results to return.
+   * @param max - maximum number of results to return.
    * @category query
    */
   max(max: number) {
@@ -53,6 +62,115 @@ export default class GetApplicationBoxes extends JSONRequest<BoxesResponse> {
     return this;
   }
 
+  /**
+   * Pagination token returned by the previous call.
+   *
+   * This is the value returned by a previous call to this endpoint in the
+   * `next-token` response field. Provide this token to get the next page of
+   * results. The token is the box name to use as the pagination cursor,
+   * encoded in the goal app call arg form.
+   *
+   * #### Example
+   * ```typescript
+   * const boxesResponse = await algodClient
+   *        .getApplicationBoxes(1234)
+   *        .limit(20)
+   *        .next("b64:AAECAw==")
+   *        .do();
+   * ```
+   *
+   * @param nextToken - The next token to use for pagination.
+   * @category query
+   */
+  next(nextToken: string | undefined) {
+    this.query.next = nextToken;
+    return this;
+  }
+
+  /**
+   * Filter box names by a prefix.
+   *
+   * #### Example
+   * ```typescript
+   * const boxesResponse = await algodClient
+   *        .getApplicationBoxes(1234)
+   *        .prefix(myAddr.publicKey)
+   *        .do();
+   * ```
+   *
+   * @param prefix - The prefix to filter box names by
+   * @category query
+   */
+  prefix(prefix: Uint8Array) {
+    this.query.prefix = `b64:${bytesToBase64(prefix)}`;
+    return this;
+  }
+
+  /**
+   * Include additional items in the response.
+   *
+   * Use `values` to include box values.
+   *
+   * #### Example
+   * ```typescript
+   * const boxesResponse = await algodClient
+   *        .getApplicationBoxes(1234)
+   *        .prefix(myAddr.publicKey)
+   *        .include("values")
+   *        .do();
+   * ```
+   *
+   * @param include - The additional items to include in the response.
+   * @category query
+   */
+  include(...include: BoxInclude[]) {
+    this.query.include = include.join(',');
+    return this;
+  }
+
+  /**
+   * Limits results per page when using pagination.
+   *
+   * #### Example
+   * ```typescript
+   * const maxResults = 20;
+   * const boxesResult = await algodClient
+   *        .getApplicationBoxes(1234)
+   *        .limit(maxResults)
+   *        .do();
+   * const { nextToken } = boxesResult
+   * ```
+   *
+   * @param limit - maximum number of results to return per page.
+   * @category query
+   */
+  limit(limit: number) {
+    this.query.limit = limit;
+    return this;
+  }
+
+  /**
+   * Return results for the specified round.
+   *
+   * If not provided, results will be from the latest round. This parameter
+   * can be used to pin all pages of a paginated query to a consistent round.
+   *
+   * #### Example
+   * ```typescript
+   * const boxesResponse = await algodClient
+   *        .getApplicationBoxes(1234)
+   *        .round(12345678)
+   *        .do();
+   * ```
+   *
+   * @param roundNumber - The round to query.
+   * @category query
+   */
+  round(roundNumber: number | bigint) {
+    this.query.round = ensureSafeInteger(roundNumber);
+    return this;
+  }
+
   // eslint-disable-next-line class-methods-use-this
   prepare(response: HTTPClientResponse): BoxesResponse {
     return decodeJSON(response.getJSONText(), BoxesResponse);