@stacks/blockchain-api-client 7.4.0-nakamoto.3 → 7.4.0-nakamoto.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/blockchain-api-client",
-  "version": "7.4.0-nakamoto.3",
+  "version": "7.4.0-nakamoto.4",
   "access": "public",
   "description": "Client for the Stacks Blockchain API",
   "homepage": "https://github.com/hirosystems/stacks-blockchain-api/tree/master/client#readme",

package/src/generated/.openapi-generator/FILES

@@ -74,6 +74,8 @@ models/MempoolTransactionStatsResponseTxSimpleFeeAveragesTokenTransfer.ts
 models/MempoolTransactionStatsResponseTxTypeCounts.ts
 models/Microblock.ts
 models/MicroblockListResponse.ts
+models/NakamotoBlock.ts
+models/NakamotoBlockListResponse.ts
 models/NetworkBlockTimeResponse.ts
 models/NetworkBlockTimesResponse.ts
 models/NetworkIdentifier.ts

package/src/generated/apis/BlocksApi.ts

@@ -24,6 +24,9 @@ import {
     BurnBlockListResponse,
     BurnBlockListResponseFromJSON,
     BurnBlockListResponseToJSON,
+    NakamotoBlockListResponse,
+    NakamotoBlockListResponseFromJSON,
+    NakamotoBlockListResponseToJSON,
 } from '../models';
 
 export interface GetBlockByBurnBlockHashRequest {
@@ -47,6 +50,13 @@ export interface GetBlockListRequest {
     offset?: number;
 }
 
+export interface GetBlocksRequest {
+    limit?: number;
+    offset?: number;
+    burnBlockHash?: string;
+    burnBlockHeight?: number;
+}
+
 export interface GetBurnBlockListRequest {
     limit?: number;
     offset?: number;
@@ -62,7 +72,7 @@ export interface GetBurnBlockListRequest {
  */
 export interface BlocksApiInterface {
     /**
-     * Retrieves block details of a specific block for a given burnchain block hash
+     * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves block details of a specific block for a given burnchain block hash 
      * @summary Get block by burnchain block hash
      * @param {string} burnBlockHash Hash of the burnchain block
      * @param {*} [options] Override http request option.
@@ -72,13 +82,13 @@ export interface BlocksApiInterface {
     getBlockByBurnBlockHashRaw(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
 
     /**
-     * Retrieves block details of a specific block for a given burnchain block hash
+     * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves block details of a specific block for a given burnchain block hash 
      * Get block by burnchain block hash
      */
     getBlockByBurnBlockHash(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<Block>;
 
     /**
-     * Retrieves block details of a specific block for a given burn chain height
+     * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves block details of a specific block for a given burn chain height 
      * @summary Get block by burnchain height
      * @param {number} burnBlockHeight Height of the burn chain block
      * @param {*} [options] Override http request option.
@@ -88,7 +98,7 @@ export interface BlocksApiInterface {
     getBlockByBurnBlockHeightRaw(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
 
     /**
-     * Retrieves block details of a specific block for a given burn chain height
+     * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves block details of a specific block for a given burn chain height 
      * Get block by burnchain height
      */
     getBlockByBurnBlockHeight(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<Block>;
@@ -126,7 +136,7 @@ export interface BlocksApiInterface {
     getBlockByHeight(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<Block>;
 
     /**
-     * Retrieves a list of recently mined blocks  If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 
+     * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves a list of recently mined blocks  If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 
      * @summary Get recent blocks
      * @param {number} [limit] max number of blocks to fetch
      * @param {number} [offset] index of first block to fetch
@@ -137,11 +147,30 @@ export interface BlocksApiInterface {
     getBlockListRaw(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BlockListResponse>>;
 
     /**
-     * Retrieves a list of recently mined blocks  If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 
+     * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves a list of recently mined blocks  If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 
      * Get recent blocks
      */
     getBlockList(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<BlockListResponse>;
 
+    /**
+     * Retrieves a list of recently mined blocks 
+     * @summary Get blocks
+     * @param {number} [limit] max number of blocks to fetch
+     * @param {number} [offset] index of first burn block to fetch
+     * @param {string} [burnBlockHash] filter blocks by burn block hash
+     * @param {number} [burnBlockHeight] filter blocks by burn block height
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlocksApiInterface
+     */
+    getBlocksRaw(requestParameters: GetBlocksRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NakamotoBlockListResponse>>;
+
+    /**
+     * Retrieves a list of recently mined blocks 
+     * Get blocks
+     */
+    getBlocks(requestParameters: GetBlocksRequest, initOverrides?: RequestInit): Promise<NakamotoBlockListResponse>;
+
     /**
      * Retrieves a list of recent burn blocks 
      * @summary Get recent burn blocks
@@ -169,7 +198,7 @@ export interface BlocksApiInterface {
 export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
 
     /**
-     * Retrieves block details of a specific block for a given burnchain block hash
+     * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves block details of a specific block for a given burnchain block hash 
      * Get block by burnchain block hash
      */
     async getBlockByBurnBlockHashRaw(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
@@ -192,7 +221,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
     }
 
     /**
-     * Retrieves block details of a specific block for a given burnchain block hash
+     * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves block details of a specific block for a given burnchain block hash 
      * Get block by burnchain block hash
      */
     async getBlockByBurnBlockHash(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<Block> {
@@ -201,7 +230,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
     }
 
     /**
-     * Retrieves block details of a specific block for a given burn chain height
+     * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves block details of a specific block for a given burn chain height 
      * Get block by burnchain height
      */
     async getBlockByBurnBlockHeightRaw(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
@@ -224,7 +253,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
     }
 
     /**
-     * Retrieves block details of a specific block for a given burn chain height
+     * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves block details of a specific block for a given burn chain height 
      * Get block by burnchain height
      */
     async getBlockByBurnBlockHeight(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<Block> {
@@ -297,7 +326,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
     }
 
     /**
-     * Retrieves a list of recently mined blocks  If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 
+     * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves a list of recently mined blocks  If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 
      * Get recent blocks
      */
     async getBlockListRaw(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BlockListResponse>> {
@@ -324,7 +353,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
     }
 
     /**
-     * Retrieves a list of recently mined blocks  If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 
+     * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves a list of recently mined blocks  If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 
      * Get recent blocks
      */
     async getBlockList(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<BlockListResponse> {
@@ -332,6 +361,50 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
         return await response.value();
     }
 
+    /**
+     * Retrieves a list of recently mined blocks 
+     * Get blocks
+     */
+    async getBlocksRaw(requestParameters: GetBlocksRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NakamotoBlockListResponse>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.limit !== undefined) {
+            queryParameters['limit'] = requestParameters.limit;
+        }
+
+        if (requestParameters.offset !== undefined) {
+            queryParameters['offset'] = requestParameters.offset;
+        }
+
+        if (requestParameters.burnBlockHash !== undefined) {
+            queryParameters['burn_block_hash'] = requestParameters.burnBlockHash;
+        }
+
+        if (requestParameters.burnBlockHeight !== undefined) {
+            queryParameters['burn_block_height'] = requestParameters.burnBlockHeight;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v2/blocks`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => NakamotoBlockListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a list of recently mined blocks 
+     * Get blocks
+     */
+    async getBlocks(requestParameters: GetBlocksRequest, initOverrides?: RequestInit): Promise<NakamotoBlockListResponse> {
+        const response = await this.getBlocksRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves a list of recent burn blocks 
      * Get recent burn blocks

package/src/generated/models/NakamotoBlock.ts

@@ -0,0 +1,184 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>.  <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a> 
+ *
+ * The version of the OpenAPI document: STACKS_API_VERSION
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * A block
+ * @export
+ * @interface NakamotoBlock
+ */
+export interface NakamotoBlock {
+    /**
+     * Set to `true` if block corresponds to the canonical chain tip
+     * @type {boolean}
+     * @memberof NakamotoBlock
+     */
+    canonical: boolean;
+    /**
+     * Height of the block
+     * @type {number}
+     * @memberof NakamotoBlock
+     */
+    height: number;
+    /**
+     * Hash representing the block
+     * @type {string}
+     * @memberof NakamotoBlock
+     */
+    hash: string;
+    /**
+     * The only hash that can uniquely identify an anchored block or an unconfirmed state trie
+     * @type {string}
+     * @memberof NakamotoBlock
+     */
+    index_block_hash: string;
+    /**
+     * Hash of the parent block
+     * @type {string}
+     * @memberof NakamotoBlock
+     */
+    parent_block_hash: string;
+    /**
+     * Index block hash of the parent block
+     * @type {string}
+     * @memberof NakamotoBlock
+     */
+    parent_index_block_hash: string;
+    /**
+     * Unix timestamp (in seconds) indicating when this block was mined.
+     * @type {number}
+     * @memberof NakamotoBlock
+     */
+    burn_block_time: number;
+    /**
+     * An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined.
+     * @type {string}
+     * @memberof NakamotoBlock
+     */
+    burn_block_time_iso: string;
+    /**
+     * Hash of the anchor chain block
+     * @type {string}
+     * @memberof NakamotoBlock
+     */
+    burn_block_hash: string;
+    /**
+     * Height of the anchor chain block
+     * @type {number}
+     * @memberof NakamotoBlock
+     */
+    burn_block_height: number;
+    /**
+     * Anchor chain transaction ID
+     * @type {string}
+     * @memberof NakamotoBlock
+     */
+    miner_txid: string;
+    /**
+     * List of transactions included in the block
+     * @type {Array<string>}
+     * @memberof NakamotoBlock
+     */
+    txs: Array<string>;
+    /**
+     * Execution cost read count.
+     * @type {number}
+     * @memberof NakamotoBlock
+     */
+    execution_cost_read_count: number;
+    /**
+     * Execution cost read length.
+     * @type {number}
+     * @memberof NakamotoBlock
+     */
+    execution_cost_read_length: number;
+    /**
+     * Execution cost runtime.
+     * @type {number}
+     * @memberof NakamotoBlock
+     */
+    execution_cost_runtime: number;
+    /**
+     * Execution cost write count.
+     * @type {number}
+     * @memberof NakamotoBlock
+     */
+    execution_cost_write_count: number;
+    /**
+     * Execution cost write length.
+     * @type {number}
+     * @memberof NakamotoBlock
+     */
+    execution_cost_write_length: number;
+}
+
+export function NakamotoBlockFromJSON(json: any): NakamotoBlock {
+    return NakamotoBlockFromJSONTyped(json, false);
+}
+
+export function NakamotoBlockFromJSONTyped(json: any, ignoreDiscriminator: boolean): NakamotoBlock {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'canonical': json['canonical'],
+        'height': json['height'],
+        'hash': json['hash'],
+        'index_block_hash': json['index_block_hash'],
+        'parent_block_hash': json['parent_block_hash'],
+        'parent_index_block_hash': json['parent_index_block_hash'],
+        'burn_block_time': json['burn_block_time'],
+        'burn_block_time_iso': json['burn_block_time_iso'],
+        'burn_block_hash': json['burn_block_hash'],
+        'burn_block_height': json['burn_block_height'],
+        'miner_txid': json['miner_txid'],
+        'txs': json['txs'],
+        'execution_cost_read_count': json['execution_cost_read_count'],
+        'execution_cost_read_length': json['execution_cost_read_length'],
+        'execution_cost_runtime': json['execution_cost_runtime'],
+        'execution_cost_write_count': json['execution_cost_write_count'],
+        'execution_cost_write_length': json['execution_cost_write_length'],
+    };
+}
+
+export function NakamotoBlockToJSON(value?: NakamotoBlock | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'canonical': value.canonical,
+        'height': value.height,
+        'hash': value.hash,
+        'index_block_hash': value.index_block_hash,
+        'parent_block_hash': value.parent_block_hash,
+        'parent_index_block_hash': value.parent_index_block_hash,
+        'burn_block_time': value.burn_block_time,
+        'burn_block_time_iso': value.burn_block_time_iso,
+        'burn_block_hash': value.burn_block_hash,
+        'burn_block_height': value.burn_block_height,
+        'miner_txid': value.miner_txid,
+        'txs': value.txs,
+        'execution_cost_read_count': value.execution_cost_read_count,
+        'execution_cost_read_length': value.execution_cost_read_length,
+        'execution_cost_runtime': value.execution_cost_runtime,
+        'execution_cost_write_count': value.execution_cost_write_count,
+        'execution_cost_write_length': value.execution_cost_write_length,
+    };
+}
+

package/src/generated/models/NakamotoBlockListResponse.ts

@@ -0,0 +1,87 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>.  <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a> 
+ *
+ * The version of the OpenAPI document: STACKS_API_VERSION
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    NakamotoBlock,
+    NakamotoBlockFromJSON,
+    NakamotoBlockFromJSONTyped,
+    NakamotoBlockToJSON,
+} from './';
+
+/**
+ * GET request that returns blocks
+ * @export
+ * @interface NakamotoBlockListResponse
+ */
+export interface NakamotoBlockListResponse {
+    /**
+     * The number of blocks to return
+     * @type {number}
+     * @memberof NakamotoBlockListResponse
+     */
+    limit: number;
+    /**
+     * The number to blocks to skip (starting at `0`)
+     * @type {number}
+     * @memberof NakamotoBlockListResponse
+     */
+    offset: number;
+    /**
+     * The number of blocks available
+     * @type {number}
+     * @memberof NakamotoBlockListResponse
+     */
+    total: number;
+    /**
+     * 
+     * @type {Array<NakamotoBlock>}
+     * @memberof NakamotoBlockListResponse
+     */
+    results: Array<NakamotoBlock>;
+}
+
+export function NakamotoBlockListResponseFromJSON(json: any): NakamotoBlockListResponse {
+    return NakamotoBlockListResponseFromJSONTyped(json, false);
+}
+
+export function NakamotoBlockListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NakamotoBlockListResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'limit': json['limit'],
+        'offset': json['offset'],
+        'total': json['total'],
+        'results': ((json['results'] as Array<any>).map(NakamotoBlockFromJSON)),
+    };
+}
+
+export function NakamotoBlockListResponseToJSON(value?: NakamotoBlockListResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'limit': value.limit,
+        'offset': value.offset,
+        'total': value.total,
+        'results': ((value.results as Array<any>).map(NakamotoBlockToJSON)),
+    };
+}
+

package/src/generated/models/index.ts

@@ -58,6 +58,8 @@ export * from './MempoolTransactionStatsResponseTxSimpleFeeAveragesTokenTransfer
 export * from './MempoolTransactionStatsResponseTxTypeCounts';
 export * from './Microblock';
 export * from './MicroblockListResponse';
+export * from './NakamotoBlock';
+export * from './NakamotoBlockListResponse';
 export * from './NetworkBlockTimeResponse';
 export * from './NetworkBlockTimesResponse';
 export * from './NetworkIdentifier';