-
Notifications
You must be signed in to change notification settings - Fork 210
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'release/v2.11.0' into v2.x-master
- Loading branch information
Showing
12 changed files
with
374 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ version: 2.1 | |
| orbs: | ||
| node: circleci/[email protected] | ||
| slack: circleci/[email protected] | ||
| browser-tools: circleci/browser-tools@1.4.8 | ||
| browser-tools: circleci/browser-tools@1.5.1 | ||
| gh-pages: sugarshin/[email protected] | ||
|
|
||
| parameters: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; | ||
| } | ||
| } |
Oops, something went wrong.