algosdk 3.1.0 → 3.3.0

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/dist/types/client/v2/indexer/searchForBlockHeaders.d.ts

@@ -0,0 +1,176 @@
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
+import { Address } from '../../../encoding/address.js';
+import { BlockHeadersResponse } from './models/types.js';
+/**
+ * Returns information about indexed block headers.
+ *
+ * #### Example
+ * ```typescript
+ * const bhs = await indexerClient.searchForBlockHeaders().do();
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2block-headers)
+ * @category GET
+ */
+export default class SearchForBlockHeaders extends JSONRequest<BlockHeadersResponse> {
+    /**
+     * @returns `/v2/block-headers`
+     */
+    path(): string;
+    /**
+     * Accounts marked as absent in the block header's participation updates.
+     *
+     * #### Example
+     * ```typescript
+     * const address1 = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const address2 = "4H5UNRBJ2Q6JENAXQ6HNTGKLKINP4J4VTQBEPK5F3I6RDICMZBPGNH6KD4";
+     * const bhs = await indexerClient
+     *        .searchForBlockHeaders()
+     *        .absent([address1,address2])
+     *        .do();
+     * ```
+     *
+     * @param absent - a comma separated list of addresses
+     * @category query
+     */
+    absent(absent: (string | Address)[]): this;
+    /**
+     * Include results after the given time.
+     *
+     * #### Example
+     * ```typescript
+     * const afterTime = "2022-10-21T00:00:11.55Z";
+     * const bhs = await indexerClient
+     *        .searchForBlockHeaders()
+     *        .afterTime(afterTime)
+     *        .do();
+     * ```
+     *
+     * @param after - rfc3339 string or Date object
+     * @category query
+     */
+    afterTime(after: string | Date): this;
+    /**
+     * Include results before the given time.
+     *
+     * #### Example
+     * ```typescript
+     * const beforeTime = "2022-02-02T20:20:22.02Z";
+     * const bhs = await indexerClient
+     *        .searchForBlockHeaders()
+     *        .beforeTime(beforeTime)
+     *        .do();
+     * ```
+     *
+     * @param before - rfc3339 string or Date object
+     * @category query
+     */
+    beforeTime(before: string | Date): this;
+    /**
+     * Accounts marked as expired in the block header's participation updates.
+     *
+     * #### Example
+     * ```typescript
+     * const address1 = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const address2 = "4H5UNRBJ2Q6JENAXQ6HNTGKLKINP4J4VTQBEPK5F3I6RDICMZBPGNH6KD4";
+     * const bhs = await indexerClient
+     *        .searchForBlockHeaders()
+     *        .expired([address1,address2])
+     *        .do();
+     * ```
+     *
+     * @param expired - - a comma separated list of addresses
+     * @category query
+     */
+    expired(expired: (string | Address)[]): this;
+    /**
+     * Maximum number of results to return.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     * const bhs = await indexerClient
+     *        .searchForBlockHeaders()
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit
+     * @category query
+     */
+    limit(limit: number): this;
+    /**
+     * Include results at or before the specified max-round.
+     *
+     * #### Example
+     * ```typescript
+     * const maxRound = 18309917;
+     * const bhs = await indexerClient
+     *        .searchForBlockHeaders()
+     *        .maxRound(maxRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
+    maxRound(round: number | bigint): this;
+    /**
+     * Include results at or after the specified min-round.
+     *
+     * #### Example
+     * ```typescript
+     * const minRound = 18309917;
+     * const bhs = await indexerClient
+     *        .searchForBlockHeaders()
+     *        .minRound(minRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
+    minRound(round: number | bigint): this;
+    /**
+     * The next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     *
+     * const bh1 = await indexerClient
+     *        .searchForBlockHeaders()
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const bh2 = await indexerClient
+     *        .searchForBlockHeaders()
+     *        .limit(maxResults)
+     *        .nextToken(bh1["next-token"])
+     *        .do();
+     * ```
+     *
+     * @param nextToken - provided by the previous results
+     * @category query
+     */
+    nextToken(nextToken: string): this;
+    /**
+     * Accounts marked as proposer in the block header's participation updates.
+     *
+     * #### Example
+     * ```typescript
+     * const address1 = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const address2 = "4H5UNRBJ2Q6JENAXQ6HNTGKLKINP4J4VTQBEPK5F3I6RDICMZBPGNH6KD4";
+     * const bhs = await indexerClient
+     *        .searchForBlockHeaders()
+     *        .proposers([address1,address2])
+     *        .do();
+     * ```
+     *
+     * @param proposers - a comma separated list of addresses
+     * @category query
+     */
+    proposers(proposers: (string | Address)[]): this;
+    prepare(response: HTTPClientResponse): BlockHeadersResponse;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algosdk",
-  "version": "3.1.0",
+  "version": "3.3.0",
   "description": "The official JavaScript SDK for Algorand",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -78,7 +78,7 @@
     "geckodriver": "^4.3.0",
     "husky": "^4.3.8",
     "lint-staged": "^10.5.4",
-    "mocha": "^9.0.0",
+    "mocha": "^11.1.0",
     "mock-http-server": "^1.4.3",
     "prettier": "^3.2.1",
     "selenium-webdriver": "^4.10.0",

package/src/abi/abi_type.ts

@@ -13,7 +13,7 @@
     // | string
     // | (T1, ..., Tn)
 */
-import { encodeAddress, decodeAddress } from '../encoding/address.js';
+import { encodeAddress, decodeAddress, Address } from '../encoding/address.js';
 import { bigIntToBytes, bytesToBigInt } from '../encoding/bigint.js';
 import { concatArrays } from '../utils/utils.js';
 
@@ -37,7 +37,8 @@ export type ABIValue =
   | bigint
   | string
   | Uint8Array
-  | ABIValue[];
+  | ABIValue[]
+  | Address;
 
 export abstract class ABIType {
   // Converts a ABIType object to a string
@@ -255,18 +256,24 @@ export class ABIAddressType extends ABIType {
   }
 
   encode(value: ABIValue) {
-    if (typeof value !== 'string' && !(value instanceof Uint8Array)) {
-      throw new Error(`Cannot encode value as ${this.toString()}: ${value}`);
-    }
     if (typeof value === 'string') {
       const decodedAddress = decodeAddress(value);
       return decodedAddress.publicKey;
     }
-    // Return the address if it is already in bytes
-    if (value.byteLength !== 32) {
-      throw new Error(`byte string must be 32 bytes long for an address`);
+
+    if (value instanceof Address) {
+      return value.publicKey;
     }
-    return value;
+
+    if (value instanceof Uint8Array) {
+      if (value.byteLength !== 32) {
+        throw new Error(`byte string must be 32 bytes long for an address`);
+      }
+
+      return value;
+    }
+
+    throw new Error(`Cannot encode value as ${this.toString()}: ${value}`);
   }
 
   decode(byteString: Uint8Array): string {

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

@@ -19,6 +19,28 @@ export default class Block extends JSONRequest<BlockResponse> {
     return `/v2/blocks/${this.round}`;
   }
 
+  /**
+   * If true, only the block header (exclusive of payset or certificate) may be included in response.
+   *
+   * #### Example
+   * ```typescript
+   *
+   * const roundNumber = 41000000;
+   *
+   * const blockResponse = await algodClient
+   *        .block(roundNumber)
+   *        .headerOnly(true)
+   *        .do();
+   * ```
+   *
+   * @param headerOnly - the flag indicating whether exclusively return header in response
+   * @category query
+   */
+  headerOnly(headerOnly: boolean) {
+    this.query['header-only'] = headerOnly;
+    return this;
+  }
+
   // eslint-disable-next-line class-methods-use-this
   prepare(response: HTTPClientResponse): BlockResponse {
     return decodeMsgpack(response.body, BlockResponse);

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);