@stacks/blockchain-api-client 7.11.0-beta.4 → 7.11.0-beta.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/blockchain-api-client",
-  "version": "7.11.0-beta.4",
+  "version": "7.11.0-beta.5",
   "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

@@ -37,6 +37,7 @@ models/AddressTransactionsV2ListResponseEvents.ts
 models/AddressTransactionsV2ListResponseEventsStx.ts
 models/AddressTransactionsWithTransfersListResponse.ts
 models/AddressUnlockSchedule.ts
+models/AverageBlockTimesResponse.ts
 models/Block.ts
 models/BlockListResponse.ts
 models/BnsError.ts

package/src/generated/apis/BlocksApi.ts

@@ -15,6 +15,9 @@
 
 import * as runtime from '../runtime';
 import {
+    AverageBlockTimesResponse,
+    AverageBlockTimesResponseFromJSON,
+    AverageBlockTimesResponseToJSON,
     Block,
     BlockFromJSON,
     BlockToJSON,
@@ -72,6 +75,21 @@ export interface GetBlocksByBurnBlockRequest {
  * @interface BlocksApiInterface
  */
 export interface BlocksApiInterface {
+    /**
+     * Retrieves average block times (in seconds) 
+     * @summary Get average block times
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlocksApiInterface
+     */
+    getAverageBlockTimesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<AverageBlockTimesResponse>>;
+
+    /**
+     * Retrieves average block times (in seconds) 
+     * Get average block times
+     */
+    getAverageBlockTimes(initOverrides?: RequestInit): Promise<AverageBlockTimesResponse>;
+
     /**
      * Retrieves a single block 
      * @summary Get block
@@ -211,6 +229,34 @@ export interface BlocksApiInterface {
  */
 export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
 
+    /**
+     * Retrieves average block times (in seconds) 
+     * Get average block times
+     */
+    async getAverageBlockTimesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<AverageBlockTimesResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v2/blocks/average-times`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AverageBlockTimesResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves average block times (in seconds) 
+     * Get average block times
+     */
+    async getAverageBlockTimes(initOverrides?: RequestInit): Promise<AverageBlockTimesResponse> {
+        const response = await this.getAverageBlockTimesRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves a single block 
      * Get block

package/src/generated/models/AverageBlockTimesResponse.ts

@@ -0,0 +1,80 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/stacks-blockchain-api).  [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json) 
+ *
+ * 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';
+/**
+ * Request to fetch average block times (in seconds)
+ * @export
+ * @interface AverageBlockTimesResponse
+ */
+export interface AverageBlockTimesResponse {
+    /**
+     * Average block times over the last hour (in seconds)
+     * @type {number}
+     * @memberof AverageBlockTimesResponse
+     */
+    last_1h: number;
+    /**
+     * Average block times over the last 24 hours (in seconds)
+     * @type {number}
+     * @memberof AverageBlockTimesResponse
+     */
+    last_24h: number;
+    /**
+     * Average block times over the last 7 days (in seconds)
+     * @type {number}
+     * @memberof AverageBlockTimesResponse
+     */
+    last_7d: number;
+    /**
+     * Average block times over the last 30 days (in seconds)
+     * @type {number}
+     * @memberof AverageBlockTimesResponse
+     */
+    last_30d: number;
+}
+
+export function AverageBlockTimesResponseFromJSON(json: any): AverageBlockTimesResponse {
+    return AverageBlockTimesResponseFromJSONTyped(json, false);
+}
+
+export function AverageBlockTimesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AverageBlockTimesResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'last_1h': json['last_1h'],
+        'last_24h': json['last_24h'],
+        'last_7d': json['last_7d'],
+        'last_30d': json['last_30d'],
+    };
+}
+
+export function AverageBlockTimesResponseToJSON(value?: AverageBlockTimesResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'last_1h': value.last_1h,
+        'last_24h': value.last_24h,
+        'last_7d': value.last_7d,
+        'last_30d': value.last_30d,
+    };
+}
+

package/src/generated/models/BurnBlock.ts

@@ -49,6 +49,18 @@ export interface BurnBlock {
      * @memberof BurnBlock
      */
     stacks_blocks: Array<string>;
+    /**
+     * Average time between blocks in seconds. Returns 0 if there is only one block in the burn block.
+     * @type {number}
+     * @memberof BurnBlock
+     */
+    avg_block_time: number;
+    /**
+     * Total number of transactions in the Stacks blocks associated with this burn block
+     * @type {number}
+     * @memberof BurnBlock
+     */
+    total_tx_count: number;
 }
 
 export function BurnBlockFromJSON(json: any): BurnBlock {
@@ -66,6 +78,8 @@ export function BurnBlockFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'burn_block_hash': json['burn_block_hash'],
         'burn_block_height': json['burn_block_height'],
         'stacks_blocks': json['stacks_blocks'],
+        'avg_block_time': json['avg_block_time'],
+        'total_tx_count': json['total_tx_count'],
     };
 }
 
@@ -83,6 +97,8 @@ export function BurnBlockToJSON(value?: BurnBlock | null): any {
         'burn_block_hash': value.burn_block_hash,
         'burn_block_height': value.burn_block_height,
         'stacks_blocks': value.stacks_blocks,
+        'avg_block_time': value.avg_block_time,
+        'total_tx_count': value.total_tx_count,
     };
 }
 

package/src/generated/models/index.ts

@@ -19,6 +19,7 @@ export * from './AddressTransactionsV2ListResponseEvents';
 export * from './AddressTransactionsV2ListResponseEventsStx';
 export * from './AddressTransactionsWithTransfersListResponse';
 export * from './AddressUnlockSchedule';
+export * from './AverageBlockTimesResponse';
 export * from './Block';
 export * from './BlockListResponse';
 export * from './BnsError';