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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/blockchain-api-client",
-  "version": "7.4.0-nakamoto.1",
+  "version": "7.4.0-nakamoto.3",
   "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

@@ -40,6 +40,8 @@ models/BnsGetNameInfoResponse.ts
 models/BnsGetNamePriceResponse.ts
 models/BnsGetNamespacePriceResponse.ts
 models/BnsNamesOwnByAddressResponse.ts
+models/BurnBlock.ts
+models/BurnBlockListResponse.ts
 models/BurnchainReward.ts
 models/BurnchainRewardListResponse.ts
 models/BurnchainRewardSlotHolder.ts

package/src/generated/apis/BlocksApi.ts

@@ -21,6 +21,9 @@ import {
     BlockListResponse,
     BlockListResponseFromJSON,
     BlockListResponseToJSON,
+    BurnBlockListResponse,
+    BurnBlockListResponseFromJSON,
+    BurnBlockListResponseToJSON,
 } from '../models';
 
 export interface GetBlockByBurnBlockHashRequest {
@@ -44,6 +47,13 @@ export interface GetBlockListRequest {
     offset?: number;
 }
 
+export interface GetBurnBlockListRequest {
+    limit?: number;
+    offset?: number;
+    height?: number;
+    hash?: string;
+}
+
 /**
  * BlocksApi - interface
  * 
@@ -132,6 +142,25 @@ export interface BlocksApiInterface {
      */
     getBlockList(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<BlockListResponse>;
 
+    /**
+     * Retrieves a list of recent burn blocks 
+     * @summary Get recent burn blocks
+     * @param {number} [limit] max number of burn blocks to fetch
+     * @param {number} [offset] index of first burn block to fetch
+     * @param {number} [height] filter by burn block height
+     * @param {string} [hash] filter by burn block hash or the constant \&#39;latest\&#39; to filter for the most recent burn block
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlocksApiInterface
+     */
+    getBurnBlockListRaw(requestParameters: GetBurnBlockListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnBlockListResponse>>;
+
+    /**
+     * Retrieves a list of recent burn blocks 
+     * Get recent burn blocks
+     */
+    getBurnBlockList(requestParameters: GetBurnBlockListRequest, initOverrides?: RequestInit): Promise<BurnBlockListResponse>;
+
 }
 
 /**
@@ -303,4 +332,48 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
         return await response.value();
     }
 
+    /**
+     * Retrieves a list of recent burn blocks 
+     * Get recent burn blocks
+     */
+    async getBurnBlockListRaw(requestParameters: GetBurnBlockListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnBlockListResponse>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.limit !== undefined) {
+            queryParameters['limit'] = requestParameters.limit;
+        }
+
+        if (requestParameters.offset !== undefined) {
+            queryParameters['offset'] = requestParameters.offset;
+        }
+
+        if (requestParameters.height !== undefined) {
+            queryParameters['height'] = requestParameters.height;
+        }
+
+        if (requestParameters.hash !== undefined) {
+            queryParameters['hash'] = requestParameters.hash;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v1/burn_block`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => BurnBlockListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a list of recent burn blocks 
+     * Get recent burn blocks
+     */
+    async getBurnBlockList(requestParameters: GetBurnBlockListRequest, initOverrides?: RequestInit): Promise<BurnBlockListResponse> {
+        const response = await this.getBurnBlockListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }

package/src/generated/apis/TransactionsApi.ts

@@ -245,7 +245,7 @@ export interface TransactionsApiInterface {
      * @summary Get recent transactions
      * @param {number} [limit] max number of transactions to fetch
      * @param {number} [offset] index of first transaction to fetch
-     * @param {Array<'coinbase' | 'token_transfer' | 'smart_contract' | 'contract_call' | 'poison_microblock'>} [type] Filter by transaction type
+     * @param {Array<'coinbase' | 'token_transfer' | 'smart_contract' | 'contract_call' | 'poison_microblock' | 'tenure_change'>} [type] Filter by transaction type
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -851,5 +851,6 @@ export enum GetTransactionListTypeEnum {
     token_transfer = 'token_transfer',
     smart_contract = 'smart_contract',
     contract_call = 'contract_call',
-    poison_microblock = 'poison_microblock'
+    poison_microblock = 'poison_microblock',
+    tenure_change = 'tenure_change'
 }

package/src/generated/models/BurnBlock.ts

@@ -0,0 +1,88 @@
+/* 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 burn block
+ * @export
+ * @interface BurnBlock
+ */
+export interface BurnBlock {
+    /**
+     * Unix timestamp (in seconds) indicating when this block was mined.
+     * @type {number}
+     * @memberof BurnBlock
+     */
+    burn_block_time: number;
+    /**
+     * An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined.
+     * @type {string}
+     * @memberof BurnBlock
+     */
+    burn_block_time_iso: string;
+    /**
+     * Hash of the anchor chain block
+     * @type {string}
+     * @memberof BurnBlock
+     */
+    burn_block_hash: string;
+    /**
+     * Height of the anchor chain block
+     * @type {number}
+     * @memberof BurnBlock
+     */
+    burn_block_height: number;
+    /**
+     * Hashes of the Stacks blocks included in the burn block
+     * @type {Array<string>}
+     * @memberof BurnBlock
+     */
+    stacks_blocks: Array<string>;
+}
+
+export function BurnBlockFromJSON(json: any): BurnBlock {
+    return BurnBlockFromJSONTyped(json, false);
+}
+
+export function BurnBlockFromJSONTyped(json: any, ignoreDiscriminator: boolean): BurnBlock {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        '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'],
+        'stacks_blocks': json['stacks_blocks'],
+    };
+}
+
+export function BurnBlockToJSON(value?: BurnBlock | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        '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,
+        'stacks_blocks': value.stacks_blocks,
+    };
+}
+

package/src/generated/models/BurnBlockListResponse.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 {
+    BurnBlock,
+    BurnBlockFromJSON,
+    BurnBlockFromJSONTyped,
+    BurnBlockToJSON,
+} from './';
+
+/**
+ * GET request that returns burn blocks
+ * @export
+ * @interface BurnBlockListResponse
+ */
+export interface BurnBlockListResponse {
+    /**
+     * The number of burn blocks to return
+     * @type {number}
+     * @memberof BurnBlockListResponse
+     */
+    limit: number;
+    /**
+     * The number to burn blocks to skip (starting at `0`)
+     * @type {number}
+     * @memberof BurnBlockListResponse
+     */
+    offset: number;
+    /**
+     * The number of burn blocks available (regardless of filter parameters)
+     * @type {number}
+     * @memberof BurnBlockListResponse
+     */
+    total: number;
+    /**
+     * 
+     * @type {Array<BurnBlock>}
+     * @memberof BurnBlockListResponse
+     */
+    results: Array<BurnBlock>;
+}
+
+export function BurnBlockListResponseFromJSON(json: any): BurnBlockListResponse {
+    return BurnBlockListResponseFromJSONTyped(json, false);
+}
+
+export function BurnBlockListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): BurnBlockListResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'limit': json['limit'],
+        'offset': json['offset'],
+        'total': json['total'],
+        'results': ((json['results'] as Array<any>).map(BurnBlockFromJSON)),
+    };
+}
+
+export function BurnBlockListResponseToJSON(value?: BurnBlockListResponse | 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(BurnBlockToJSON)),
+    };
+}
+

package/src/generated/models/ServerStatusResponse.ts

@@ -50,6 +50,12 @@ export interface ServerStatusResponse {
      * @memberof ServerStatusResponse
      */
     pox_v2_unlock_height?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof ServerStatusResponse
+     */
+    pox_v3_unlock_height?: number | null;
     /**
      * 
      * @type {ChainTip}
@@ -72,6 +78,7 @@ export function ServerStatusResponseFromJSONTyped(json: any, ignoreDiscriminator
         'status': json['status'],
         'pox_v1_unlock_height': !exists(json, 'pox_v1_unlock_height') ? undefined : json['pox_v1_unlock_height'],
         'pox_v2_unlock_height': !exists(json, 'pox_v2_unlock_height') ? undefined : json['pox_v2_unlock_height'],
+        'pox_v3_unlock_height': !exists(json, 'pox_v3_unlock_height') ? undefined : json['pox_v3_unlock_height'],
         'chain_tip': !exists(json, 'chain_tip') ? undefined : ChainTipFromJSON(json['chain_tip']),
     };
 }
@@ -89,6 +96,7 @@ export function ServerStatusResponseToJSON(value?: ServerStatusResponse | null):
         'status': value.status,
         'pox_v1_unlock_height': value.pox_v1_unlock_height,
         'pox_v2_unlock_height': value.pox_v2_unlock_height,
+        'pox_v3_unlock_height': value.pox_v3_unlock_height,
         'chain_tip': ChainTipToJSON(value.chain_tip),
     };
 }

package/src/generated/models/index.ts

@@ -24,6 +24,8 @@ export * from './BnsGetNameInfoResponse';
 export * from './BnsGetNamePriceResponse';
 export * from './BnsGetNamespacePriceResponse';
 export * from './BnsNamesOwnByAddressResponse';
+export * from './BurnBlock';
+export * from './BurnBlockListResponse';
 export * from './BurnchainReward';
 export * from './BurnchainRewardListResponse';
 export * from './BurnchainRewardSlotHolder';