algosdk 3.1.0 → 3.2.0

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

@@ -15,6 +15,7 @@ import LookupApplications from './lookupApplications.js';
 import LookupApplicationLogs from './lookupApplicationLogs.js';
 import LookupApplicationBoxByIDandName from './lookupApplicationBoxByIDandName.js';
 import SearchAccounts from './searchAccounts.js';
+import SearchForBlockHeaders from './searchForBlockHeaders.js';
 import SearchForTransactions from './searchForTransactions.js';
 import SearchForAssets from './searchForAssets.js';
 import SearchForApplications from './searchForApplications.js';
@@ -295,6 +296,20 @@ export class IndexerClient extends ServiceClient {
     searchAccounts() {
         return new SearchAccounts(this.c);
     }
+    /**
+     * 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
+     */
+    searchForBlockHeaders() {
+        return new SearchForBlockHeaders(this.c);
+    }
     /**
      * Returns information about indexed transactions.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"indexer.js","sourceRoot":"","sources":["../../../../../src/client/v2/indexer/indexer.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,eAAe,MAAM,sBAAsB,CAAC;AACnD,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAC3D,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AACnE,OAAO,yBAAyB,MAAM,gCAAgC,CAAC;AACvE,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,iBAAiB,MAAM,wBAAwB,CAAC;AACvD,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAC3D,OAAO,0BAA0B,MAAM,iCAAiC,CAAC;AACzE,OAAO,2BAA2B,MAAM,kCAAkC,CAAC;AAC3E,OAAO,gCAAgC,MAAM,uCAAuC,CAAC;AACrF,OAAO,eAAe,MAAM,sBAAsB,CAAC;AACnD,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,+BAA+B,MAAM,sCAAsC,CAAC;AACnF,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,eAAe,MAAM,sBAAsB,CAAC;AACnD,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,yBAAyB,MAAM,gCAAgC,CAAC;AAQvE;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YACE,iBAIkB,EAClB,UAAU,GAAG,kBAAkB,EAC/B,OAAwB,IAAI,EAC5B,UAAkC,EAAE;QAEpC,KAAK,CAAC,qBAAqB,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,eAAe;QACb,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,KAAsB;QACxC,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,uBAAuB,CAAC,KAAsB;QAC5C,OAAO,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,yBAAyB,CAAC,OAAyB;QACjD,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,KAAsB;QAChC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,IAAY;QAChC,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,OAAyB;QACzC,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,OAAyB;QAC3C,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,0BAA0B,CAAC,OAAyB;QAClD,OAAO,IAAI,0BAA0B,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,2BAA2B,CAAC,OAAyB;QACnD,OAAO,IAAI,2BAA2B,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gCAAgC,CAAC,OAAyB;QACxD,OAAO,IAAI,gCAAgC,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,KAAsB;QACpC,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,KAAsB;QACvC,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,KAAsB;QAC1C,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc;QACZ,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB;QACnB,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe;QACb,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB;QACnB,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,yBAAyB,CAAC,KAAsB;QAC9C,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,+BAA+B,CAAC,KAAsB,EAAE,OAAmB;QACzE,OAAO,IAAI,+BAA+B,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF"}
+{"version":3,"file":"indexer.js","sourceRoot":"","sources":["../../../../../src/client/v2/indexer/indexer.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,eAAe,MAAM,sBAAsB,CAAC;AACnD,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAC3D,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AACnE,OAAO,yBAAyB,MAAM,gCAAgC,CAAC;AACvE,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,iBAAiB,MAAM,wBAAwB,CAAC;AACvD,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAC3D,OAAO,0BAA0B,MAAM,iCAAiC,CAAC;AACzE,OAAO,2BAA2B,MAAM,kCAAkC,CAAC;AAC3E,OAAO,gCAAgC,MAAM,uCAAuC,CAAC;AACrF,OAAO,eAAe,MAAM,sBAAsB,CAAC;AACnD,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,+BAA+B,MAAM,sCAAsC,CAAC;AACnF,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,eAAe,MAAM,sBAAsB,CAAC;AACnD,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,yBAAyB,MAAM,gCAAgC,CAAC;AAQvE;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YACE,iBAIkB,EAClB,UAAU,GAAG,kBAAkB,EAC/B,OAAwB,IAAI,EAC5B,UAAkC,EAAE;QAEpC,KAAK,CAAC,qBAAqB,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,eAAe;QACb,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,KAAsB;QACxC,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,uBAAuB,CAAC,KAAsB;QAC5C,OAAO,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,yBAAyB,CAAC,OAAyB;QACjD,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,KAAsB;QAChC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,IAAY;QAChC,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,OAAyB;QACzC,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,OAAyB;QAC3C,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,0BAA0B,CAAC,OAAyB;QAClD,OAAO,IAAI,0BAA0B,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,2BAA2B,CAAC,OAAyB;QACnD,OAAO,IAAI,2BAA2B,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gCAAgC,CAAC,OAAyB;QACxD,OAAO,IAAI,gCAAgC,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,KAAsB;QACpC,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,KAAsB;QACvC,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,KAAsB;QAC1C,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc;QACZ,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB;QACnB,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB;QACnB,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe;QACb,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB;QACnB,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,yBAAyB,CAAC,KAAsB;QAC9C,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,+BAA+B,CAAC,KAAsB,EAAE,OAAmB;QACzE,OAAO,IAAI,+BAA+B,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF"}

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

@@ -0,0 +1,211 @@
+import JSONRequest from '../jsonrequest.js';
+import { decodeJSON } from '../../../encoding/encoding.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 {
+    /**
+     * @returns `/v2/block-headers`
+     */
+    // eslint-disable-next-line class-methods-use-this
+    path() {
+        return '/v2/block-headers';
+    }
+    /**
+     * 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) {
+        this.query.absent = absent;
+        return 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) {
+        this.query['after-time'] =
+            after instanceof Date ? after.toISOString() : after;
+        return 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) {
+        this.query['before-time'] =
+            before instanceof Date ? before.toISOString() : before;
+        return 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) {
+        this.query.expired = expired;
+        return 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) {
+        this.query.limit = limit;
+        return 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) {
+        this.query['max-round'] = round;
+        return 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) {
+        this.query['min-round'] = round;
+        return 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) {
+        this.query.next = nextToken;
+        return 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) {
+        this.query.proposers = proposers;
+        return this;
+    }
+    // eslint-disable-next-line class-methods-use-this
+    prepare(response) {
+        return decodeJSON(response.getJSONText(), BlockHeadersResponse);
+    }
+}
+//# sourceMappingURL=searchForBlockHeaders.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"searchForBlockHeaders.js","sourceRoot":"","sources":["../../../../../src/client/v2/indexer/searchForBlockHeaders.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAE3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,WAAiC;IAClF;;OAEG;IACH,kDAAkD;IAClD,IAAI;QACF,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAA4B;QACjC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,KAAoB;QAC5B,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YACtB,KAAK,YAAY,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,MAAqB;QAC9B,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC;YACvB,MAAM,YAAY,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,OAA6B;QACnC,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,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,QAAQ,CAAC,KAAsB;QAC7B,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,KAAsB;QAC7B,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,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;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CAAC,SAA+B;QACvC,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kDAAkD;IAClD,OAAO,CAAC,QAA4B;QAClC,OAAO,UAAU,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,oBAAoB,CAAC,CAAC;IAClE,CAAC;CACF"}

package/dist/types/abi/abi_type.d.ts

@@ -1,9 +1,21 @@
+/**
+    //ABI-Types: uint<N>: An N-bit unsigned integer (8 <= N <= 512 and N % 8 = 0).
+    // | byte (alias for uint8)
+    // | ufixed <N> x <M> (8 <= N <= 512, N % 8 = 0, and 0 < M <= 160)
+    // | bool
+    // | address (alias for byte[32])
+    // | <type> [<N>]
+    // | <type> []
+    // | string
+    // | (T1, ..., Tn)
+*/
+import { Address } from '../encoding/address.js';
 export declare const MAX_LEN: number;
 export declare const ADDR_BYTE_SIZE = 32;
 export declare const SINGLE_BYTE_SIZE = 1;
 export declare const SINGLE_BOOL_SIZE = 1;
 export declare const LENGTH_ENCODE_BYTE_SIZE = 2;
-export type ABIValue = boolean | number | bigint | string | Uint8Array | ABIValue[];
+export type ABIValue = boolean | number | bigint | string | Uint8Array | ABIValue[] | Address;
 export declare abstract class ABIType {
     abstract toString(): string;
     abstract equals(other: ABIType): boolean;

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

@@ -8,5 +8,23 @@ export default class Block extends JSONRequest<BlockResponse> {
     private round;
     constructor(c: HTTPClient, roundNumber: number | bigint);
     path(): string;
+    /**
+     * 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;
     prepare(response: HTTPClientResponse): BlockResponse;
 }

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

@@ -1087,27 +1087,6 @@ export declare class BlockHashResponse implements Encodable {
     toEncodingData(): Map<string, unknown>;
     static fromEncodingData(data: unknown): BlockHashResponse;
 }
-/**
- * Block header.
- */
-export declare class BlockHeaderResponse implements Encodable {
-    private static encodingSchemaValue;
-    static get encodingSchema(): Schema;
-    /**
-     * Block header data.
-     */
-    blockheader: Block;
-    /**
-     * Creates a new `BlockHeaderResponse` object.
-     * @param blockheader - Block header data.
-     */
-    constructor({ blockheader }: {
-        blockheader: Block;
-    });
-    getEncodingSchema(): Schema;
-    toEncodingData(): Map<string, unknown>;
-    static fromEncodingData(data: unknown): BlockHeaderResponse;
-}
 /**
  * All logs emitted in the given round. Each app call, whether top-level or inner,
  * that contains logs results in a separate AppCallLogs object. Therefore there may

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

@@ -15,6 +15,7 @@ import LookupApplications from './lookupApplications.js';
 import LookupApplicationLogs from './lookupApplicationLogs.js';
 import LookupApplicationBoxByIDandName from './lookupApplicationBoxByIDandName.js';
 import SearchAccounts from './searchAccounts.js';
+import SearchForBlockHeaders from './searchForBlockHeaders.js';
 import SearchForTransactions from './searchForTransactions.js';
 import SearchForAssets from './searchForAssets.js';
 import SearchForApplications from './searchForApplications.js';
@@ -266,6 +267,18 @@ export declare class IndexerClient extends ServiceClient {
      * @category GET
      */
     searchAccounts(): SearchAccounts;
+    /**
+     * 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
+     */
+    searchForBlockHeaders(): SearchForBlockHeaders;
     /**
      * Returns information about indexed transactions.
      *

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