algosdk 3.3.0 → 3.3.1

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).prefix('int:1234').next('b64:A==').values(true).do();
+ * const boxesResponse = await algodClient.getApplicationBoxes(index).max(3).do();
  * const boxNames = boxesResponse.boxes.map(box => box.name);
  * ```
  *
@@ -38,53 +38,5 @@ 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

@@ -1180,11 +1180,11 @@ export declare class Box implements Encodable {
     /**
      * The round for which this information is relevant
      */
-    round?: bigint;
+    round: bigint;
     /**
      * The box value, base64 encoded.
      */
-    value?: Uint8Array;
+    value: Uint8Array;
     /**
      * Creates a new `Box` object.
      * @param name - The box name, base64 encoded
@@ -1193,13 +1193,34 @@ export declare class Box implements Encodable {
      */
     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.
  */
@@ -1228,32 +1249,18 @@ export declare class BoxReference implements Encodable {
     static fromEncodingData(data: unknown): BoxReference;
 }
 /**
- * Boxes of an application
+ *  * Box names of an application
  */
 export declare class BoxesResponse implements Encodable {
     private static encodingSchemaValue;
     static get encodingSchema(): Schema;
-    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;
+    boxes: BoxDescriptor[];
     /**
      * 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, round, nextToken, }: {
-        boxes: Box[];
-        round: number | bigint;
-        nextToken?: string;
+    constructor({ boxes }: {
+        boxes: BoxDescriptor[];
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algosdk",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "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).prefix('int:1234').next('b64:A==').values(true).do();
+ * const boxesResponse = await algodClient.getApplicationBoxes(index).max(3).do();
  * const boxNames = boxesResponse.boxes.map(box => box.name);
  * ```
  *
@@ -53,66 +53,6 @@ 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);

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

@@ -3113,16 +3113,8 @@ export class Box implements Encodable {
       this.encodingSchemaValue = new NamedMapSchema([]);
       (this.encodingSchemaValue as NamedMapSchema).pushEntries(
         { key: 'name', valueSchema: new ByteArraySchema(), omitEmpty: true },
-        {
-          key: 'round',
-          valueSchema: new OptionalSchema(new Uint64Schema()),
-          omitEmpty: true,
-        },
-        {
-          key: 'value',
-          valueSchema: new OptionalSchema(new ByteArraySchema()),
-          omitEmpty: true,
-        }
+        { key: 'round', valueSchema: new Uint64Schema(), omitEmpty: true },
+        { key: 'value', valueSchema: new ByteArraySchema(), omitEmpty: true }
       );
     }
     return this.encodingSchemaValue;
@@ -3136,12 +3128,12 @@ export class Box implements Encodable {
   /**
    * The round for which this information is relevant
    */
-  public round?: bigint;
+  public round: bigint;
 
   /**
    * The box value, base64 encoded.
    */
-  public value?: Uint8Array;
+  public value: Uint8Array;
 
   /**
    * Creates a new `Box` object.
@@ -3155,11 +3147,11 @@ export class Box implements Encodable {
     value,
   }: {
     name: string | Uint8Array;
-    round?: number | bigint;
-    value?: string | Uint8Array;
+    round: number | bigint;
+    value: string | Uint8Array;
   }) {
     this.name = typeof name === 'string' ? base64ToBytes(name) : name;
-    this.round = typeof round === 'undefined' ? undefined : ensureBigInt(round);
+    this.round = ensureBigInt(round);
     this.value = typeof value === 'string' ? base64ToBytes(value) : value;
   }
 
@@ -3188,6 +3180,56 @@ export class Box implements Encodable {
   }
 }
 
+/**
+ * Box descriptor describes a Box.
+ */
+export class BoxDescriptor implements Encodable {
+  private static encodingSchemaValue: Schema | undefined;
+
+  static get encodingSchema(): Schema {
+    if (!this.encodingSchemaValue) {
+      this.encodingSchemaValue = new NamedMapSchema([]);
+      (this.encodingSchemaValue as NamedMapSchema).pushEntries({
+        key: 'name',
+        valueSchema: new ByteArraySchema(),
+        omitEmpty: true,
+      });
+    }
+    return this.encodingSchemaValue;
+  }
+
+  /**
+   * Base64 encoded box name
+   */
+  public name: Uint8Array;
+
+  /**
+   * Creates a new `BoxDescriptor` object.
+   * @param name - Base64 encoded box name
+   */
+  constructor({ name }: { name: string | Uint8Array }) {
+    this.name = typeof name === 'string' ? base64ToBytes(name) : name;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  getEncodingSchema(): Schema {
+    return BoxDescriptor.encodingSchema;
+  }
+
+  toEncodingData(): Map<string, unknown> {
+    return new Map<string, unknown>([['name', this.name]]);
+  }
+
+  static fromEncodingData(data: unknown): BoxDescriptor {
+    if (!(data instanceof Map)) {
+      throw new Error(`Invalid decoded BoxDescriptor: ${data}`);
+    }
+    return new BoxDescriptor({
+      name: data.get('name'),
+    });
+  }
+}
+
 /**
  * References a box of an application.
  */
@@ -3255,7 +3297,7 @@ export class BoxReference implements Encodable {
 }
 
 /**
- * Boxes of an application
+ *  * Box names of an application
  */
 export class BoxesResponse implements Encodable {
   private static encodingSchemaValue: Schema | undefined;
@@ -3263,55 +3305,23 @@ export class BoxesResponse implements Encodable {
   static get encodingSchema(): Schema {
     if (!this.encodingSchemaValue) {
       this.encodingSchemaValue = new NamedMapSchema([]);
-      (this.encodingSchemaValue as NamedMapSchema).pushEntries(
-        {
-          key: 'boxes',
-          valueSchema: new ArraySchema(Box.encodingSchema),
-          omitEmpty: true,
-        },
-        { key: 'round', valueSchema: new Uint64Schema(), omitEmpty: true },
-        {
-          key: 'next-token',
-          valueSchema: new OptionalSchema(new StringSchema()),
-          omitEmpty: true,
-        }
-      );
+      (this.encodingSchemaValue as NamedMapSchema).pushEntries({
+        key: 'boxes',
+        valueSchema: new ArraySchema(BoxDescriptor.encodingSchema),
+        omitEmpty: true,
+      });
     }
     return this.encodingSchemaValue;
   }
 
-  public boxes: Box[];
-
-  /**
-   * The round for which this information is relevant.
-   */
-  public round: number;
-
-  /**
-   * Used for pagination, when making another request provide this token with the
-   * next parameter.
-   */
-  public nextToken?: string;
+  public boxes: BoxDescriptor[];
 
   /**
    * 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,
-    round,
-    nextToken,
-  }: {
-    boxes: Box[];
-    round: number | bigint;
-    nextToken?: string;
-  }) {
+  constructor({ boxes }: { boxes: BoxDescriptor[] }) {
     this.boxes = boxes;
-    this.round = ensureSafeInteger(round);
-    this.nextToken = nextToken;
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -3322,8 +3332,6 @@ export class BoxesResponse implements Encodable {
   toEncodingData(): Map<string, unknown> {
     return new Map<string, unknown>([
       ['boxes', this.boxes.map((v) => v.toEncodingData())],
-      ['round', this.round],
-      ['next-token', this.nextToken],
     ]);
   }
 
@@ -3333,10 +3341,8 @@ export class BoxesResponse implements Encodable {
     }
     return new BoxesResponse({
       boxes: (data.get('boxes') ?? []).map((v: unknown) =>
-        Box.fromEncodingData(v)
+        BoxDescriptor.fromEncodingData(v)
       ),
-      round: data.get('round'),
-      nextToken: data.get('next-token'),
     });
   }
 }