algosdk 3.3.0 → 3.4.0

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'),
     });
   }
 }
@@ -8433,7 +8439,7 @@ export class TransactionParametersResponse implements Encodable {
 /**
  * Proof of transaction in a block.
  */
-export class TransactionProofResponse implements Encodable {
+export class TransactionProof implements Encodable {
   private static encodingSchemaValue: Schema | undefined;
 
   static get encodingSchema(): Schema {
@@ -8487,7 +8493,7 @@ export class TransactionProofResponse implements Encodable {
   public hashtype?: string;
 
   /**
-   * Creates a new `TransactionProofResponse` object.
+   * Creates a new `TransactionProof` object.
    * @param idx - Index of the transaction in the block's payset.
    * @param proof - Proof of transaction membership.
    * @param stibhash - Hash of SignedTxnInBlock for verifying proof.
@@ -8520,7 +8526,7 @@ export class TransactionProofResponse implements Encodable {
 
   // eslint-disable-next-line class-methods-use-this
   getEncodingSchema(): Schema {
-    return TransactionProofResponse.encodingSchema;
+    return TransactionProof.encodingSchema;
   }
 
   toEncodingData(): Map<string, unknown> {
@@ -8533,11 +8539,11 @@ export class TransactionProofResponse implements Encodable {
     ]);
   }
 
-  static fromEncodingData(data: unknown): TransactionProofResponse {
+  static fromEncodingData(data: unknown): TransactionProof {
     if (!(data instanceof Map)) {
-      throw new Error(`Invalid decoded TransactionProofResponse: ${data}`);
+      throw new Error(`Invalid decoded TransactionProof: ${data}`);
     }
-    return new TransactionProofResponse({
+    return new TransactionProof({
       idx: data.get('idx'),
       proof: data.get('proof'),
       stibhash: data.get('stibhash'),

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

@@ -4016,6 +4016,74 @@ export class BoxDescriptor implements Encodable {
   }
 }
 
+/**
+ * BoxReference names a box by its name and the application ID it belongs to.
+ */
+export class BoxReference implements Encodable {
+  private static encodingSchemaValue: Schema | undefined;
+
+  static get encodingSchema(): Schema {
+    if (!this.encodingSchemaValue) {
+      this.encodingSchemaValue = new NamedMapSchema([]);
+      (this.encodingSchemaValue as NamedMapSchema).pushEntries(
+        { key: 'app', valueSchema: new Uint64Schema(), omitEmpty: true },
+        { key: 'name', valueSchema: new ByteArraySchema(), omitEmpty: true }
+      );
+    }
+    return this.encodingSchemaValue;
+  }
+
+  /**
+   * Application ID to which the box belongs, or zero if referring to the called
+   * application.
+   */
+  public app: number;
+
+  /**
+   * Base64 encoded box name
+   */
+  public name: Uint8Array;
+
+  /**
+   * Creates a new `BoxReference` object.
+   * @param app - Application ID to which the box belongs, or zero if referring to the called
+   * application.
+   * @param name - Base64 encoded box name
+   */
+  constructor({
+    app,
+    name,
+  }: {
+    app: number | bigint;
+    name: string | Uint8Array;
+  }) {
+    this.app = ensureSafeInteger(app);
+    this.name = typeof name === 'string' ? base64ToBytes(name) : name;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  getEncodingSchema(): Schema {
+    return BoxReference.encodingSchema;
+  }
+
+  toEncodingData(): Map<string, unknown> {
+    return new Map<string, unknown>([
+      ['app', this.app],
+      ['name', this.name],
+    ]);
+  }
+
+  static fromEncodingData(data: unknown): BoxReference {
+    if (!(data instanceof Map)) {
+      throw new Error(`Invalid decoded BoxReference: ${data}`);
+    }
+    return new BoxReference({
+      app: data.get('app'),
+      name: data.get('name'),
+    });
+  }
+}
+
 /**
  * Box names of an application
  */
@@ -6909,6 +6977,13 @@ export class TransactionApplication implements Encodable {
           valueSchema: new OptionalSchema(new ByteArraySchema()),
           omitEmpty: true,
         },
+        {
+          key: 'box-references',
+          valueSchema: new OptionalSchema(
+            new ArraySchema(BoxReference.encodingSchema)
+          ),
+          omitEmpty: true,
+        },
         {
           key: 'clear-state-program',
           valueSchema: new OptionalSchema(new ByteArraySchema()),
@@ -6943,6 +7018,11 @@ export class TransactionApplication implements Encodable {
           key: 'on-completion',
           valueSchema: new OptionalSchema(new StringSchema()),
           omitEmpty: true,
+        },
+        {
+          key: 'reject-version',
+          valueSchema: new OptionalSchema(new Uint64Schema()),
+          omitEmpty: true,
         }
       );
     }
@@ -6974,6 +7054,12 @@ export class TransactionApplication implements Encodable {
    */
   public approvalProgram?: Uint8Array;
 
+  /**
+   * (apbx) the boxes that can be accessed by this transaction (and others in the
+   * same group).
+   */
+  public boxReferences?: BoxReference[];
+
   /**
    * (apsu) Logic executed for application transactions with on-completion set to
    * "clear". It can read and write global state for the application, as well as
@@ -7029,6 +7115,12 @@ export class TransactionApplication implements Encodable {
    */
   public onCompletion?: string;
 
+  /**
+   * (aprv) the lowest application version for which this transaction should
+   * immediately fail. 0 indicates that no version check should be performed.
+   */
+  public rejectVersion?: number;
+
   /**
    * Creates a new `TransactionApplication` object.
    * @param applicationId - (apid) ID of the application being configured or empty if creating.
@@ -7040,6 +7132,8 @@ export class TransactionApplication implements Encodable {
    * on-completion is set to "clear". It can read and write global state for the
    * application, as well as account-specific local state. Approval programs may
    * reject the transaction.
+   * @param boxReferences - (apbx) the boxes that can be accessed by this transaction (and others in the
+   * same group).
    * @param clearStateProgram - (apsu) Logic executed for application transactions with on-completion set to
    * "clear". It can read and write global state for the application, as well as
    * account-specific local state. Clear state programs cannot reject the
@@ -7067,12 +7161,15 @@ export class TransactionApplication implements Encodable {
    * * update
    * * update
    * * delete
+   * @param rejectVersion - (aprv) the lowest application version for which this transaction should
+   * immediately fail. 0 indicates that no version check should be performed.
    */
   constructor({
     applicationId,
     accounts,
     applicationArgs,
     approvalProgram,
+    boxReferences,
     clearStateProgram,
     extraProgramPages,
     foreignApps,
@@ -7080,11 +7177,13 @@ export class TransactionApplication implements Encodable {
     globalStateSchema,
     localStateSchema,
     onCompletion,
+    rejectVersion,
   }: {
     applicationId: number | bigint;
     accounts?: (Address | string)[];
     applicationArgs?: Uint8Array[];
     approvalProgram?: string | Uint8Array;
+    boxReferences?: BoxReference[];
     clearStateProgram?: string | Uint8Array;
     extraProgramPages?: number | bigint;
     foreignApps?: (number | bigint)[];
@@ -7092,6 +7191,7 @@ export class TransactionApplication implements Encodable {
     globalStateSchema?: StateSchema;
     localStateSchema?: StateSchema;
     onCompletion?: string;
+    rejectVersion?: number | bigint;
   }) {
     this.applicationId = ensureBigInt(applicationId);
     this.accounts =
@@ -7105,6 +7205,7 @@ export class TransactionApplication implements Encodable {
       typeof approvalProgram === 'string'
         ? base64ToBytes(approvalProgram)
         : approvalProgram;
+    this.boxReferences = boxReferences;
     this.clearStateProgram =
       typeof clearStateProgram === 'string'
         ? base64ToBytes(clearStateProgram)
@@ -7124,6 +7225,10 @@ export class TransactionApplication implements Encodable {
     this.globalStateSchema = globalStateSchema;
     this.localStateSchema = localStateSchema;
     this.onCompletion = onCompletion;
+    this.rejectVersion =
+      typeof rejectVersion === 'undefined'
+        ? undefined
+        : ensureSafeInteger(rejectVersion);
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -7142,6 +7247,12 @@ export class TransactionApplication implements Encodable {
       ],
       ['application-args', this.applicationArgs],
       ['approval-program', this.approvalProgram],
+      [
+        'box-references',
+        typeof this.boxReferences !== 'undefined'
+          ? this.boxReferences.map((v) => v.toEncodingData())
+          : undefined,
+      ],
       ['clear-state-program', this.clearStateProgram],
       ['extra-program-pages', this.extraProgramPages],
       ['foreign-apps', this.foreignApps],
@@ -7159,6 +7270,7 @@ export class TransactionApplication implements Encodable {
           : undefined,
       ],
       ['on-completion', this.onCompletion],
+      ['reject-version', this.rejectVersion],
     ]);
   }
 
@@ -7171,6 +7283,12 @@ export class TransactionApplication implements Encodable {
       accounts: data.get('accounts'),
       applicationArgs: data.get('application-args'),
       approvalProgram: data.get('approval-program'),
+      boxReferences:
+        typeof data.get('box-references') !== 'undefined'
+          ? data
+              .get('box-references')
+              .map((v: unknown) => BoxReference.fromEncodingData(v))
+          : undefined,
       clearStateProgram: data.get('clear-state-program'),
       extraProgramPages: data.get('extra-program-pages'),
       foreignApps: data.get('foreign-apps'),
@@ -7184,6 +7302,7 @@ export class TransactionApplication implements Encodable {
           ? StateSchema.fromEncodingData(data.get('local-state-schema'))
           : undefined,
       onCompletion: data.get('on-completion'),
+      rejectVersion: data.get('reject-version'),
     });
   }
 }

package/src/client/v2/indexer/searchForTransactions.ts

@@ -106,6 +106,26 @@ export default class SearchForTransactions extends JSONRequest<TransactionsRespo
     return this;
   }
 
+  /**
+   * Lookup transactions by group ID.
+   *
+   * #### Example
+   * ```typescript
+   * const groupIdBase64Encoded = "A62qVigWtWo0laUzcE1iZY8+KXWzK1vSkgwN/eKgvjc=";
+   * const txns = await indexerClient
+   *        .searchForTransactions()
+   *        .groupid(groupIdBase64Encoded)
+   *        .do();
+   * ```
+   *
+   * @param groupid - base64 string or uint8array
+   * @category query
+   */
+  groupid(groupid: Uint8Array | string) {
+    this.query['group-id'] = base64StringFunnel(groupid);
+    return this;
+  }
+
   /**
    * Include results for the specified round.
    *

package/src/encoding/schema/bytearray.ts

@@ -48,6 +48,9 @@ export class ByteArraySchema extends Schema {
   }
 
   public fromPreparedJSON(encoded: JSONEncodingData): Uint8Array {
+    if (encoded === null || encoded === undefined) {
+      return this.defaultValue();
+    }
     if (typeof encoded === 'string') {
       return base64ToBytes(encoded);
     }