algosdk 3.2.0 → 3.3.0

package/dist/esm/client/v2/indexer/searchAccounts.js

@@ -257,6 +257,25 @@ export default class SearchAccounts extends JSONRequest {
         this.query.exclude = exclude;
         return this;
     }
+    /**
+     * If true, only online accounts will be returned in the response.
+     *
+     * #### Example
+     * ```typescript
+     * const onlineOnly = true;
+     * const accounts = await indexerClient
+     *        .searchAccounts
+     *        .onlineOnly(onlineOnly)
+     *        .do();
+     * ```
+     *
+     * @param onlineOnly - if true, only online accounts will be returned in the response
+     * @category query
+     */
+    onlineOnly(onlineOnly) {
+        this.query['online-only'] = onlineOnly;
+        return this;
+    }
     // eslint-disable-next-line class-methods-use-this
     prepare(response) {
         return decodeJSON(response.getJSONText(), AccountsResponse);

package/dist/esm/client/v2/indexer/searchAccounts.js.map

@@ -1 +1 @@
-{"version":3,"file":"searchAccounts.js","sourceRoot":"","sources":["../../../../../src/client/v2/indexer/searchAccounts.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAE3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,WAA6B;IACvE;;OAEG;IACH,kDAAkD;IAClD,IAAI;QACF,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,mBAAmB,CAAC,OAAwB;QAC1C,uGAAuG;QACvG,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,gBAAgB,CAAC,MAAuB;QACtC,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,EAAmB;QACzB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAsB;QAC1B,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,QAA0B;QACjC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,aAA8B;QAC1C,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kDAAkD;IAClD,OAAO,CAAC,QAA4B;QAClC,OAAO,UAAU,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,gBAAgB,CAAC,CAAC;IAC9D,CAAC;CACF"}
+{"version":3,"file":"searchAccounts.js","sourceRoot":"","sources":["../../../../../src/client/v2/indexer/searchAccounts.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAE3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,WAA6B;IACvE;;OAEG;IACH,kDAAkD;IAClD,IAAI;QACF,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,mBAAmB,CAAC,OAAwB;QAC1C,uGAAuG;QACvG,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,gBAAgB,CAAC,MAAuB;QACtC,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,EAAmB;QACzB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAsB;QAC1B,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,QAA0B;QACjC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,aAA8B;QAC1C,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,UAAmB;QAC5B,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kDAAkD;IAClD,OAAO,CAAC,QAA4B;QAClC,OAAO,UAAU,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,gBAAgB,CAAC,CAAC;IAC9D,CAAC;CACF"}

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

@@ -7,7 +7,7 @@ import { BoxesResponse } from './models/types.js';
  * #### Example
  * ```typescript
  * const index = 60553466;
- * const boxesResponse = await algodClient.getApplicationBoxes(index).max(3).do();
+ * const boxesResponse = await algodClient.getApplicationBoxes(index).prefix('int:1234').next('b64:A==').values(true).do();
  * const boxNames = boxesResponse.boxes.map(box => box.name);
  * ```
  *
@@ -38,5 +38,53 @@ export default class GetApplicationBoxes extends JSONRequest<BoxesResponse> {
      * @category query
      */
     max(max: number): this;
+    /**
+     * A box name prefix, in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.
+     *
+     * #### Example
+     * ```typescript
+     * const prefix = 'int:1234';
+     * const boxesResult = await algodClient
+     *        .GetApplicationBoxes(1234)
+     *        .prefix(prefix)
+     *        .do();
+     * ```
+     *
+     * @param prefix - the box name prefix in the form 'encoding:value'
+     * @category query
+     */
+    prefix(prefix: string): this;
+    /**
+     * A box name, in the goal app call arg form 'encoding:value'. When provided, the returned boxes begin (lexographically) with the supplied name. Callers may implement pagination by reinvoking the endpoint with the token from a previous call's next-token.
+     *
+     * #### Example
+     * ```typescript
+     * const next = 'int:1234';
+     * const boxesResult = await algodClient
+     *        .GetApplicationBoxes(1234)
+     *        .next(next)
+     *        .do();
+     * ```
+     *
+     * @param next - the next box name for pagination, in the goal app call arg form 'encoding:value'
+     * @category query
+     */
+    next(next: string): this;
+    /**
+     * If true, box values will be returned.
+     *
+     * #### Example
+     * ```typescript
+     * const values = true;
+     * const boxesResult = await algodClient
+     *        .GetApplicationBoxes(1234)
+     *        .values(values)
+     *        .do();
+     * ```
+     *
+     * @param values - if true, box values will be returned
+     * @category query
+     */
+    values(values: boolean): this;
     prepare(response: HTTPClientResponse): BoxesResponse;
 }

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

@@ -684,6 +684,10 @@ export declare class ApplicationParams implements Encodable {
      * (lsch) local schema
      */
     localStateSchema?: ApplicationStateSchema;
+    /**
+     * (v) the number of updates to the application programs
+     */
+    version?: number;
     /**
      * Creates a new `ApplicationParams` object.
      * @param approvalProgram - (approv) approval program.
@@ -694,8 +698,9 @@ export declare class ApplicationParams implements Encodable {
      * @param globalState - (gs) global state
      * @param globalStateSchema - (gsch) global schema
      * @param localStateSchema - (lsch) local schema
+     * @param version - (v) the number of updates to the application programs
      */
-    constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, }: {
+    constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, version, }: {
         approvalProgram: string | Uint8Array;
         clearStateProgram: string | Uint8Array;
         creator: Address | string;
@@ -703,6 +708,7 @@ export declare class ApplicationParams implements Encodable {
         globalState?: TealKeyValue[];
         globalStateSchema?: ApplicationStateSchema;
         localStateSchema?: ApplicationStateSchema;
+        version?: number | bigint;
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;
@@ -1168,53 +1174,32 @@ export declare class Box implements Encodable {
     private static encodingSchemaValue;
     static get encodingSchema(): Schema;
     /**
-     * (name) box name, base64 encoded
+     * The box name, base64 encoded
      */
     name: Uint8Array;
     /**
      * The round for which this information is relevant
      */
-    round: bigint;
+    round?: bigint;
     /**
-     * (value) box value, base64 encoded.
+     * The box value, base64 encoded.
      */
-    value: Uint8Array;
+    value?: Uint8Array;
     /**
      * Creates a new `Box` object.
-     * @param name - (name) box name, base64 encoded
+     * @param name - The box name, base64 encoded
      * @param round - The round for which this information is relevant
-     * @param value - (value) box value, base64 encoded.
+     * @param value - The box value, base64 encoded.
      */
     constructor({ name, round, value, }: {
         name: string | Uint8Array;
-        round: number | bigint;
-        value: string | Uint8Array;
+        round?: number | bigint;
+        value?: string | Uint8Array;
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;
     static fromEncodingData(data: unknown): Box;
 }
-/**
- * Box descriptor describes a Box.
- */
-export declare class BoxDescriptor implements Encodable {
-    private static encodingSchemaValue;
-    static get encodingSchema(): Schema;
-    /**
-     * Base64 encoded box name
-     */
-    name: Uint8Array;
-    /**
-     * Creates a new `BoxDescriptor` object.
-     * @param name - Base64 encoded box name
-     */
-    constructor({ name }: {
-        name: string | Uint8Array;
-    });
-    getEncodingSchema(): Schema;
-    toEncodingData(): Map<string, unknown>;
-    static fromEncodingData(data: unknown): BoxDescriptor;
-}
 /**
  * References a box of an application.
  */
@@ -1243,18 +1228,32 @@ 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[];
+    boxes: Box[];
+    /**
+     * The round for which this information is relevant.
+     */
+    round: number;
+    /**
+     * Used for pagination, when making another request provide this token with the
+     * next parameter.
+     */
+    nextToken?: string;
     /**
      * Creates a new `BoxesResponse` object.
      * @param boxes -
+     * @param round - The round for which this information is relevant.
+     * @param nextToken - Used for pagination, when making another request provide this token with the
+     * next parameter.
      */
-    constructor({ boxes }: {
-        boxes: BoxDescriptor[];
+    constructor({ boxes, round, nextToken, }: {
+        boxes: Box[];
+        round: number | bigint;
+        nextToken?: string;
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;
@@ -1639,6 +1638,66 @@ export declare class EvalDeltaKeyValue implements Encodable {
     toEncodingData(): Map<string, unknown>;
     static fromEncodingData(data: unknown): EvalDeltaKeyValue;
 }
+export declare class Genesis implements Encodable {
+    private static encodingSchemaValue;
+    static get encodingSchema(): Schema;
+    alloc: GenesisAllocation[];
+    fees: string;
+    id: string;
+    network: string;
+    proto: string;
+    rwd: string;
+    timestamp: number;
+    comment?: string;
+    devmode?: boolean;
+    /**
+     * Creates a new `Genesis` object.
+     * @param alloc -
+     * @param fees -
+     * @param id -
+     * @param network -
+     * @param proto -
+     * @param rwd -
+     * @param timestamp -
+     * @param comment -
+     * @param devmode -
+     */
+    constructor({ alloc, fees, id, network, proto, rwd, timestamp, comment, devmode, }: {
+        alloc: GenesisAllocation[];
+        fees: string;
+        id: string;
+        network: string;
+        proto: string;
+        rwd: string;
+        timestamp: number | bigint;
+        comment?: string;
+        devmode?: boolean;
+    });
+    getEncodingSchema(): Schema;
+    toEncodingData(): Map<string, unknown>;
+    static fromEncodingData(data: unknown): Genesis;
+}
+export declare class GenesisAllocation implements Encodable {
+    private static encodingSchemaValue;
+    static get encodingSchema(): Schema;
+    addr: string;
+    comment: string;
+    state: UntypedValue;
+    /**
+     * Creates a new `GenesisAllocation` object.
+     * @param addr -
+     * @param comment -
+     * @param state -
+     */
+    constructor({ addr, comment, state, }: {
+        addr: string;
+        comment: string;
+        state: UntypedValue;
+    });
+    getEncodingSchema(): Schema;
+    toEncodingData(): Map<string, unknown>;
+    static fromEncodingData(data: unknown): GenesisAllocation;
+}
 /**
  * Response containing the timestamp offset in seconds
  */
@@ -1681,34 +1740,6 @@ export declare class GetSyncRoundResponse implements Encodable {
     toEncodingData(): Map<string, unknown>;
     static fromEncodingData(data: unknown): GetSyncRoundResponse;
 }
-/**
- * A single Delta containing the key, the previous value and the current value for
- * a single round.
- */
-export declare class KvDelta implements Encodable {
-    private static encodingSchemaValue;
-    static get encodingSchema(): Schema;
-    /**
-     * The key, base64 encoded.
-     */
-    key?: Uint8Array;
-    /**
-     * The new value of the KV store entry, base64 encoded.
-     */
-    value?: Uint8Array;
-    /**
-     * Creates a new `KvDelta` object.
-     * @param key - The key, base64 encoded.
-     * @param value - The new value of the KV store entry, base64 encoded.
-     */
-    constructor({ key, value, }: {
-        key?: string | Uint8Array;
-        value?: string | Uint8Array;
-    });
-    getEncodingSchema(): Schema;
-    toEncodingData(): Map<string, unknown>;
-    static fromEncodingData(data: unknown): KvDelta;
-}
 /**
  * Contains a ledger delta for a single transaction group
  */

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

@@ -620,6 +620,10 @@ export declare class ApplicationParams implements Encodable {
      * local schema
      */
     localStateSchema?: ApplicationStateSchema;
+    /**
+     * the number of updates to the application programs
+     */
+    version?: number;
     /**
      * Creates a new `ApplicationParams` object.
      * @param approvalProgram - approval program.
@@ -630,8 +634,9 @@ export declare class ApplicationParams implements Encodable {
      * @param globalState - global state
      * @param globalStateSchema - global schema
      * @param localStateSchema - local schema
+     * @param version - the number of updates to the application programs
      */
-    constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, }: {
+    constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, version, }: {
         approvalProgram: string | Uint8Array;
         clearStateProgram: string | Uint8Array;
         creator?: Address | string;
@@ -639,6 +644,7 @@ export declare class ApplicationParams implements Encodable {
         globalState?: TealKeyValue[];
         globalStateSchema?: ApplicationStateSchema;
         localStateSchema?: ApplicationStateSchema;
+        version?: number | bigint;
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;

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

@@ -224,5 +224,21 @@ export default class SearchAccounts extends JSONRequest<AccountsResponse> {
      * @category query
      */
     exclude(exclude: string): this;
+    /**
+     * If true, only online accounts will be returned in the response.
+     *
+     * #### Example
+     * ```typescript
+     * const onlineOnly = true;
+     * const accounts = await indexerClient
+     *        .searchAccounts
+     *        .onlineOnly(onlineOnly)
+     *        .do();
+     * ```
+     *
+     * @param onlineOnly - if true, only online accounts will be returned in the response
+     * @category query
+     */
+    onlineOnly(onlineOnly: boolean): this;
     prepare(response: HTTPClientResponse): AccountsResponse;
 }

package/package.json

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

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

@@ -9,7 +9,7 @@ import { BoxesResponse } from './models/types.js';
  * #### Example
  * ```typescript
  * const index = 60553466;
- * const boxesResponse = await algodClient.getApplicationBoxes(index).max(3).do();
+ * const boxesResponse = await algodClient.getApplicationBoxes(index).prefix('int:1234').next('b64:A==').values(true).do();
  * const boxNames = boxesResponse.boxes.map(box => box.name);
  * ```
  *
@@ -53,6 +53,66 @@ export default class GetApplicationBoxes extends JSONRequest<BoxesResponse> {
     return this;
   }
 
+  /**
+   * A box name prefix, in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.
+   *
+   * #### Example
+   * ```typescript
+   * const prefix = 'int:1234';
+   * const boxesResult = await algodClient
+   *        .GetApplicationBoxes(1234)
+   *        .prefix(prefix)
+   *        .do();
+   * ```
+   *
+   * @param prefix - the box name prefix in the form 'encoding:value'
+   * @category query
+   */
+  prefix(prefix: string) {
+    this.query.prefix = prefix;
+    return this;
+  }
+
+  /**
+   * A box name, in the goal app call arg form 'encoding:value'. When provided, the returned boxes begin (lexographically) with the supplied name. Callers may implement pagination by reinvoking the endpoint with the token from a previous call's next-token.
+   *
+   * #### Example
+   * ```typescript
+   * const next = 'int:1234';
+   * const boxesResult = await algodClient
+   *        .GetApplicationBoxes(1234)
+   *        .next(next)
+   *        .do();
+   * ```
+   *
+   * @param next - the next box name for pagination, in the goal app call arg form 'encoding:value'
+   * @category query
+   */
+  next(next: string) {
+    this.query.next = next;
+    return this;
+  }
+
+  /**
+   * If true, box values will be returned.
+   *
+   * #### Example
+   * ```typescript
+   * const values = true;
+   * const boxesResult = await algodClient
+   *        .GetApplicationBoxes(1234)
+   *        .values(values)
+   *        .do();
+   * ```
+   *
+   * @param values - if true, box values will be returned
+   * @category query
+   */
+  values(values: boolean) {
+    this.query.values = values;
+    return this;
+  }
+
   // eslint-disable-next-line class-methods-use-this
   prepare(response: HTTPClientResponse): BoxesResponse {
     return decodeJSON(response.getJSONText(), BoxesResponse);