algosdk 2.10.0 → 2.11.0

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

@@ -0,0 +1,209 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const jsonrequest_1 = __importDefault(require("../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
+ */
+class SearchForBlockHeaders extends jsonrequest_1.default {
+    /**
+     * @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
+     * @category query
+     */
+    afterTime(after) {
+        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) {
+        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) {
+        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;
+    }
+}
+exports.default = SearchForBlockHeaders;
+//# sourceMappingURL=searchForBlockHeaders.js.map

package/dist/cjs/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,iEAAyC;AAEzC;;;;;;;;;;GAUG;AACH,MAAqB,qBAAsB,SAAQ,qBAAW;IAC5D;;OAEG;IACH,kDAAkD;IAClD,IAAI;QACF,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAgB;QACrB,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,KAAa;QACrB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,MAAc;QACvB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,OAAiB;QACvB,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,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,KAAa;QACpB,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,SAAmB;QAC3B,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtMD,wCAsMC"}

package/dist/esm/client/v2/algod/block.js

@@ -14,6 +14,27 @@ export default class Block extends JSONRequest {
     path() {
         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) {
+        this.query['header-only'] = headerOnly;
+        return this;
+    }
     // eslint-disable-next-line class-methods-use-this
     prepare(body) {
         if (body && body.byteLength > 0) {

package/dist/esm/client/v2/algod/block.js.map

@@ -1 +1 @@
-{"version":3,"file":"block.js","sourceRoot":"","sources":["../../../../../src/client/v2/algod/block.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,4BAA4B,CAAC;AACvD,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,WAAW;IAG5C,YAAY,CAAa,EAAE,WAAmB;QAC5C,KAAK,CAAC,CAAC,CAAC,CAAC;QACT,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC;YAChC,MAAM,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAClD,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACrC,CAAC;IAED,IAAI;QACF,OAAO,cAAc,IAAI,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;IAED,kDAAkD;IAClD,OAAO,CAAC,IAAgB;QACtB,IAAI,IAAI,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE;YAC/B,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAwB,CAAC;SACrD;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}
+{"version":3,"file":"block.js","sourceRoot":"","sources":["../../../../../src/client/v2/algod/block.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,4BAA4B,CAAC;AACvD,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,WAAW;IAG5C,YAAY,CAAa,EAAE,WAAmB;QAC5C,KAAK,CAAC,CAAC,CAAC,CAAC;QACT,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC;YAChC,MAAM,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAClD,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACrC,CAAC;IAED,IAAI;QACF,OAAO,cAAc,IAAI,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,UAAmB;QAC5B,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kDAAkD;IAClD,OAAO,CAAC,IAAgB;QACtB,IAAI,IAAI,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE;YAC/B,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAwB,CAAC;SACrD;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}

package/dist/esm/client/v2/algod/models/types.js

@@ -1136,30 +1136,6 @@ export class BlockHashResponse extends BaseModel {
         /* eslint-enable dot-notation */
     }
 }
-/**
- * Block header.
- */
-export class BlockHeaderResponse extends BaseModel {
-    /**
-     * Creates a new `BlockHeaderResponse` object.
-     * @param blockheader - Block header data.
-     */
-    constructor({ blockheader }) {
-        super();
-        this.blockheader = blockheader;
-        this.attribute_map = {
-            blockheader: 'blockHeader',
-        };
-    }
-    // eslint-disable-next-line camelcase
-    static from_obj_for_encoding(data) {
-        /* 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