algosdk 2.10.0 → 2.11.0

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

@@ -7,5 +7,23 @@ export default class Block extends JSONRequest {
     private round;
     constructor(c: HTTPClient, roundNumber: number);
     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(body: Uint8Array): Record<string, any>;
 }

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

@@ -992,23 +992,6 @@ export declare class BlockHashResponse extends BaseModel {
     });
     static from_obj_for_encoding(data: Record<string, any>): BlockHashResponse;
 }
-/**
- * Block header.
- */
-export declare class BlockHeaderResponse extends BaseModel {
-    /**
-     * Block header data.
-     */
-    blockheader?: BlockHeader;
-    /**
-     * Creates a new `BlockHeaderResponse` object.
-     * @param blockheader - Block header data.
-     */
-    constructor({ blockheader }: {
-        blockheader?: BlockHeader;
-    });
-    static from_obj_for_encoding(data: Record<string, any>): 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';
 import LookupApplicationLogs from './lookupApplicationLogs';
 import LookupApplicationBoxByIDandName from './lookupApplicationBoxByIDandName';
 import SearchAccounts from './searchAccounts';
+import SearchForBlockHeaders from './searchForBlockHeaders';
 import SearchForTransactions from './searchForTransactions';
 import SearchForAssets from './searchForAssets';
 import SearchForApplications from './searchForApplications';
@@ -277,6 +278,18 @@ export default class IndexerClient extends ServiceClient {
      * @category GET
      */
     searchForTransactions(): SearchForTransactions;
+    /**
+     * Returns information about indexed block headers.
+     *
+     * #### Example
+     * ```typescript
+     * const txns = 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 assets.
      *

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

@@ -0,0 +1,172 @@
+import JSONRequest from '../jsonrequest';
+/**
+ * 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`
+     */
+    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[]): 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
+     * @category query
+     */
+    afterTime(after: string): 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
+     * @category query
+     */
+    beforeTime(before: string): 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[]): 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): 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): 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[]): this;
+}

package/package.json

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

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

@@ -20,6 +20,28 @@ export default class Block extends JSONRequest {
     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(body: Uint8Array) {
     if (body && body.byteLength > 0) {

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

@@ -2098,38 +2098,6 @@ export class BlockHashResponse extends BaseModel {
   }
 }
 
-/**
- * Block header.
- */
-export class BlockHeaderResponse extends BaseModel {
-  /**
-   * Block header data.
-   */
-  public blockheader?: BlockHeader;
-
-  /**
-   * Creates a new `BlockHeaderResponse` object.
-   * @param blockheader - Block header data.
-   */
-  constructor({ blockheader }: { blockheader?: BlockHeader }) {
-    super();
-    this.blockheader = blockheader;
-
-    this.attribute_map = {
-      blockheader: 'blockHeader',
-    };
-  }
-
-  // eslint-disable-next-line camelcase
-  static from_obj_for_encoding(data: Record<string, any>): BlockHeaderResponse {
-    /* eslint-disable dot-notation */
-    return new BlockHeaderResponse({
-      blockheader: data['blockHeader'],
-    });
-    /* eslint-enable dot-notation */
-  }
-}
-
 /**
  * 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/src/client/v2/indexer/indexer.ts

@@ -15,6 +15,7 @@ import LookupApplications from './lookupApplications';
 import LookupApplicationLogs from './lookupApplicationLogs';
 import LookupApplicationBoxByIDandName from './lookupApplicationBoxByIDandName';
 import SearchAccounts from './searchAccounts';
+import SearchForBlockHeaders from './searchForBlockHeaders';
 import SearchForTransactions from './searchForTransactions';
 import SearchForAssets from './searchForAssets';
 import SearchForApplications from './searchForApplications';
@@ -345,6 +346,21 @@ export default class IndexerClient extends ServiceClient {
     return new SearchForTransactions(this.c, this.intDecoding);
   }
 
+  /**
+   * Returns information about indexed block headers.
+   *
+   * #### Example
+   * ```typescript
+   * const txns = 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, this.intDecoding);
+  }
+
   /**
    * Returns information about indexed assets.
    *

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

@@ -0,0 +1,212 @@
+import JSONRequest from '../jsonrequest';
+
+/**
+ * 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: string[]) {
+    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
+   * @category query
+   */
+  afterTime(after: string) {
+    this.query['after-time'] = 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
+   * @category query
+   */
+  beforeTime(before: string) {
+    this.query['before-time'] = 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: string[]) {
+    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: number) {
+    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: number) {
+    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: number) {
+    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: string) {
+    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: string[]) {
+    this.query.proposers = proposers;
+    return this;
+  }
+}