@stacks/blockchain-api-client 7.9.1 → 7.10.0-beta.2

package/package.json

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

@@ -9,6 +9,7 @@ apis/MempoolApi.ts
 apis/MicroblocksApi.ts
 apis/NamesApi.ts
 apis/NonFungibleTokensApi.ts
+apis/ProofOfTransferApi.ts
 apis/RosettaApi.ts
 apis/SearchApi.ts
 apis/SmartContractsApi.ts
@@ -89,6 +90,12 @@ models/OtherTransactionIdentifier.ts
 models/PoolDelegation.ts
 models/PoolDelegationsResponse.ts
 models/PostCoreNodeTransactionsError.ts
+models/PoxCycle.ts
+models/PoxCycleListResponse.ts
+models/PoxCycleSignerStackersListResponse.ts
+models/PoxCycleSignersListResponse.ts
+models/PoxSigner.ts
+models/PoxStacker.ts
 models/ReadOnlyFunctionArgs.ts
 models/ReadOnlyFunctionSuccessResponse.ts
 models/RosettaAccount.ts

package/src/generated/apis/ProofOfTransferApi.ts

@@ -0,0 +1,327 @@
+/* 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 * as runtime from '../runtime';
+import {
+    PoxCycle,
+    PoxCycleFromJSON,
+    PoxCycleToJSON,
+    PoxCycleListResponse,
+    PoxCycleListResponseFromJSON,
+    PoxCycleListResponseToJSON,
+    PoxCycleSignerStackersListResponse,
+    PoxCycleSignerStackersListResponseFromJSON,
+    PoxCycleSignerStackersListResponseToJSON,
+    PoxCycleSignersListResponse,
+    PoxCycleSignersListResponseFromJSON,
+    PoxCycleSignersListResponseToJSON,
+    PoxSigner,
+    PoxSignerFromJSON,
+    PoxSignerToJSON,
+} from '../models';
+
+export interface GetPoxCycleRequest {
+    cycleNumber: number;
+}
+
+export interface GetPoxCycleSignerRequest {
+    cycleNumber: number;
+    signerKey: string;
+}
+
+export interface GetPoxCycleSignerStackersRequest {
+    cycleNumber: number;
+    signerKey: string;
+}
+
+export interface GetPoxCycleSignersRequest {
+    cycleNumber: number;
+}
+
+export interface GetPoxCyclesRequest {
+    limit?: number;
+    offset?: number;
+}
+
+/**
+ * ProofOfTransferApi - interface
+ * 
+ * @export
+ * @interface ProofOfTransferApiInterface
+ */
+export interface ProofOfTransferApiInterface {
+    /**
+     * Retrieves details for a PoX cycle
+     * @summary Get PoX cycle
+     * @param {number} cycleNumber PoX cycle number
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProofOfTransferApiInterface
+     */
+    getPoxCycleRaw(requestParameters: GetPoxCycleRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PoxCycle>>;
+
+    /**
+     * Retrieves details for a PoX cycle
+     * Get PoX cycle
+     */
+    getPoxCycle(requestParameters: GetPoxCycleRequest, initOverrides?: RequestInit): Promise<PoxCycle>;
+
+    /**
+     * Retrieves details for a signer in a PoX cycle
+     * @summary Get signer in PoX cycle
+     * @param {number} cycleNumber PoX cycle number
+     * @param {string} signerKey Signer key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProofOfTransferApiInterface
+     */
+    getPoxCycleSignerRaw(requestParameters: GetPoxCycleSignerRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PoxSigner>>;
+
+    /**
+     * Retrieves details for a signer in a PoX cycle
+     * Get signer in PoX cycle
+     */
+    getPoxCycleSigner(requestParameters: GetPoxCycleSignerRequest, initOverrides?: RequestInit): Promise<PoxSigner>;
+
+    /**
+     * Retrieves a list of stackers for a signer in a PoX cycle
+     * @summary Get stackers for signer in PoX cycle
+     * @param {number} cycleNumber PoX cycle number
+     * @param {string} signerKey Signer key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProofOfTransferApiInterface
+     */
+    getPoxCycleSignerStackersRaw(requestParameters: GetPoxCycleSignerStackersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PoxCycleSignerStackersListResponse>>;
+
+    /**
+     * Retrieves a list of stackers for a signer in a PoX cycle
+     * Get stackers for signer in PoX cycle
+     */
+    getPoxCycleSignerStackers(requestParameters: GetPoxCycleSignerStackersRequest, initOverrides?: RequestInit): Promise<PoxCycleSignerStackersListResponse>;
+
+    /**
+     * Retrieves a list of signers in a PoX cycle
+     * @summary Get signers in PoX cycle
+     * @param {number} cycleNumber PoX cycle number
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProofOfTransferApiInterface
+     */
+    getPoxCycleSignersRaw(requestParameters: GetPoxCycleSignersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PoxCycleSignersListResponse>>;
+
+    /**
+     * Retrieves a list of signers in a PoX cycle
+     * Get signers in PoX cycle
+     */
+    getPoxCycleSigners(requestParameters: GetPoxCycleSignersRequest, initOverrides?: RequestInit): Promise<PoxCycleSignersListResponse>;
+
+    /**
+     * Retrieves a list of PoX cycles
+     * @summary Get PoX cycles
+     * @param {number} [limit] max number of cycles to fetch
+     * @param {number} [offset] index of first cycle to fetch
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProofOfTransferApiInterface
+     */
+    getPoxCyclesRaw(requestParameters: GetPoxCyclesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PoxCycleListResponse>>;
+
+    /**
+     * Retrieves a list of PoX cycles
+     * Get PoX cycles
+     */
+    getPoxCycles(requestParameters: GetPoxCyclesRequest, initOverrides?: RequestInit): Promise<PoxCycleListResponse>;
+
+}
+
+/**
+ * 
+ */
+export class ProofOfTransferApi extends runtime.BaseAPI implements ProofOfTransferApiInterface {
+
+    /**
+     * Retrieves details for a PoX cycle
+     * Get PoX cycle
+     */
+    async getPoxCycleRaw(requestParameters: GetPoxCycleRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PoxCycle>> {
+        if (requestParameters.cycleNumber === null || requestParameters.cycleNumber === undefined) {
+            throw new runtime.RequiredError('cycleNumber','Required parameter requestParameters.cycleNumber was null or undefined when calling getPoxCycle.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v2/pox/cycles/{cycle_number}`.replace(`{${"cycle_number"}}`, encodeURIComponent(String(requestParameters.cycleNumber))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PoxCycleFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves details for a PoX cycle
+     * Get PoX cycle
+     */
+    async getPoxCycle(requestParameters: GetPoxCycleRequest, initOverrides?: RequestInit): Promise<PoxCycle> {
+        const response = await this.getPoxCycleRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieves details for a signer in a PoX cycle
+     * Get signer in PoX cycle
+     */
+    async getPoxCycleSignerRaw(requestParameters: GetPoxCycleSignerRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PoxSigner>> {
+        if (requestParameters.cycleNumber === null || requestParameters.cycleNumber === undefined) {
+            throw new runtime.RequiredError('cycleNumber','Required parameter requestParameters.cycleNumber was null or undefined when calling getPoxCycleSigner.');
+        }
+
+        if (requestParameters.signerKey === null || requestParameters.signerKey === undefined) {
+            throw new runtime.RequiredError('signerKey','Required parameter requestParameters.signerKey was null or undefined when calling getPoxCycleSigner.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}`.replace(`{${"cycle_number"}}`, encodeURIComponent(String(requestParameters.cycleNumber))).replace(`{${"signer_key"}}`, encodeURIComponent(String(requestParameters.signerKey))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PoxSignerFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves details for a signer in a PoX cycle
+     * Get signer in PoX cycle
+     */
+    async getPoxCycleSigner(requestParameters: GetPoxCycleSignerRequest, initOverrides?: RequestInit): Promise<PoxSigner> {
+        const response = await this.getPoxCycleSignerRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieves a list of stackers for a signer in a PoX cycle
+     * Get stackers for signer in PoX cycle
+     */
+    async getPoxCycleSignerStackersRaw(requestParameters: GetPoxCycleSignerStackersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PoxCycleSignerStackersListResponse>> {
+        if (requestParameters.cycleNumber === null || requestParameters.cycleNumber === undefined) {
+            throw new runtime.RequiredError('cycleNumber','Required parameter requestParameters.cycleNumber was null or undefined when calling getPoxCycleSignerStackers.');
+        }
+
+        if (requestParameters.signerKey === null || requestParameters.signerKey === undefined) {
+            throw new runtime.RequiredError('signerKey','Required parameter requestParameters.signerKey was null or undefined when calling getPoxCycleSignerStackers.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers`.replace(`{${"cycle_number"}}`, encodeURIComponent(String(requestParameters.cycleNumber))).replace(`{${"signer_key"}}`, encodeURIComponent(String(requestParameters.signerKey))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PoxCycleSignerStackersListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a list of stackers for a signer in a PoX cycle
+     * Get stackers for signer in PoX cycle
+     */
+    async getPoxCycleSignerStackers(requestParameters: GetPoxCycleSignerStackersRequest, initOverrides?: RequestInit): Promise<PoxCycleSignerStackersListResponse> {
+        const response = await this.getPoxCycleSignerStackersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieves a list of signers in a PoX cycle
+     * Get signers in PoX cycle
+     */
+    async getPoxCycleSignersRaw(requestParameters: GetPoxCycleSignersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PoxCycleSignersListResponse>> {
+        if (requestParameters.cycleNumber === null || requestParameters.cycleNumber === undefined) {
+            throw new runtime.RequiredError('cycleNumber','Required parameter requestParameters.cycleNumber was null or undefined when calling getPoxCycleSigners.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v2/pox/cycles/{cycle_number}/signers`.replace(`{${"cycle_number"}}`, encodeURIComponent(String(requestParameters.cycleNumber))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PoxCycleSignersListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a list of signers in a PoX cycle
+     * Get signers in PoX cycle
+     */
+    async getPoxCycleSigners(requestParameters: GetPoxCycleSignersRequest, initOverrides?: RequestInit): Promise<PoxCycleSignersListResponse> {
+        const response = await this.getPoxCycleSignersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieves a list of PoX cycles
+     * Get PoX cycles
+     */
+    async getPoxCyclesRaw(requestParameters: GetPoxCyclesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PoxCycleListResponse>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.limit !== undefined) {
+            queryParameters['limit'] = requestParameters.limit;
+        }
+
+        if (requestParameters.offset !== undefined) {
+            queryParameters['offset'] = requestParameters.offset;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v2/pox/cycles`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PoxCycleListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a list of PoX cycles
+     * Get PoX cycles
+     */
+    async getPoxCycles(requestParameters: GetPoxCyclesRequest, initOverrides?: RequestInit): Promise<PoxCycleListResponse> {
+        const response = await this.getPoxCyclesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/generated/apis/index.ts

@@ -10,6 +10,7 @@ export * from './MempoolApi';
 export * from './MicroblocksApi';
 export * from './NamesApi';
 export * from './NonFungibleTokensApi';
+export * from './ProofOfTransferApi';
 export * from './RosettaApi';
 export * from './SearchApi';
 export * from './SmartContractsApi';

package/src/generated/models/Block.ts

@@ -37,6 +37,18 @@ export interface Block {
      * @memberof Block
      */
     hash: string;
+    /**
+     * Unix timestamp (in seconds) indicating when this block was mined.
+     * @type {number}
+     * @memberof Block
+     */
+    block_time: number;
+    /**
+     * An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined.
+     * @type {string}
+     * @memberof Block
+     */
+    block_time_iso: string;
     /**
      * The only hash that can uniquely identify an anchored block or an unconfirmed state trie
      * @type {string}
@@ -160,6 +172,8 @@ export function BlockFromJSONTyped(json: any, ignoreDiscriminator: boolean): Blo
         'canonical': json['canonical'],
         'height': json['height'],
         'hash': json['hash'],
+        'block_time': json['block_time'],
+        'block_time_iso': json['block_time_iso'],
         'index_block_hash': json['index_block_hash'],
         'parent_block_hash': json['parent_block_hash'],
         'burn_block_time': json['burn_block_time'],
@@ -193,6 +207,8 @@ export function BlockToJSON(value?: Block | null): any {
         'canonical': value.canonical,
         'height': value.height,
         'hash': value.hash,
+        'block_time': value.block_time,
+        'block_time_iso': value.block_time_iso,
         'index_block_hash': value.index_block_hash,
         'parent_block_hash': value.parent_block_hash,
         'burn_block_time': value.burn_block_time,

package/src/generated/models/NakamotoBlock.ts

@@ -37,6 +37,18 @@ export interface NakamotoBlock {
      * @memberof NakamotoBlock
      */
     hash: string;
+    /**
+     * Unix timestamp (in seconds) indicating when this block was mined.
+     * @type {number}
+     * @memberof NakamotoBlock
+     */
+    block_time: number;
+    /**
+     * An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined.
+     * @type {string}
+     * @memberof NakamotoBlock
+     */
+    block_time_iso: string;
     /**
      * The only hash that can uniquely identify an anchored block or an unconfirmed state trie
      * @type {string}
@@ -136,6 +148,8 @@ export function NakamotoBlockFromJSONTyped(json: any, ignoreDiscriminator: boole
         'canonical': json['canonical'],
         'height': json['height'],
         'hash': json['hash'],
+        'block_time': json['block_time'],
+        'block_time_iso': json['block_time_iso'],
         'index_block_hash': json['index_block_hash'],
         'parent_block_hash': json['parent_block_hash'],
         'parent_index_block_hash': json['parent_index_block_hash'],
@@ -165,6 +179,8 @@ export function NakamotoBlockToJSON(value?: NakamotoBlock | null): any {
         'canonical': value.canonical,
         'height': value.height,
         'hash': value.hash,
+        'block_time': value.block_time,
+        'block_time_iso': value.block_time_iso,
         'index_block_hash': value.index_block_hash,
         'parent_block_hash': value.parent_block_hash,
         'parent_index_block_hash': value.parent_index_block_hash,

package/src/generated/models/PoxCycle.ts

@@ -0,0 +1,96 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface PoxCycle
+ */
+export interface PoxCycle {
+    /**
+     * 
+     * @type {number}
+     * @memberof PoxCycle
+     */
+    block_height: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PoxCycle
+     */
+    index_block_hash: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PoxCycle
+     */
+    cycle_number: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PoxCycle
+     */
+    total_weight: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PoxCycle
+     */
+    total_stacked_amount: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PoxCycle
+     */
+    total_signers: number;
+}
+
+export function PoxCycleFromJSON(json: any): PoxCycle {
+    return PoxCycleFromJSONTyped(json, false);
+}
+
+export function PoxCycleFromJSONTyped(json: any, ignoreDiscriminator: boolean): PoxCycle {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'block_height': json['block_height'],
+        'index_block_hash': json['index_block_hash'],
+        'cycle_number': json['cycle_number'],
+        'total_weight': json['total_weight'],
+        'total_stacked_amount': json['total_stacked_amount'],
+        'total_signers': json['total_signers'],
+    };
+}
+
+export function PoxCycleToJSON(value?: PoxCycle | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'block_height': value.block_height,
+        'index_block_hash': value.index_block_hash,
+        'cycle_number': value.cycle_number,
+        'total_weight': value.total_weight,
+        'total_stacked_amount': value.total_stacked_amount,
+        'total_signers': value.total_signers,
+    };
+}
+

package/src/generated/models/PoxCycleListResponse.ts

@@ -0,0 +1,87 @@
+/* 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';
+import {
+    PoxCycle,
+    PoxCycleFromJSON,
+    PoxCycleFromJSONTyped,
+    PoxCycleToJSON,
+} from './';
+
+/**
+ * GET request that returns PoX cycles
+ * @export
+ * @interface PoxCycleListResponse
+ */
+export interface PoxCycleListResponse {
+    /**
+     * The number of cycles to return
+     * @type {number}
+     * @memberof PoxCycleListResponse
+     */
+    limit: number;
+    /**
+     * The number to cycles to skip (starting at `0`)
+     * @type {number}
+     * @memberof PoxCycleListResponse
+     */
+    offset: number;
+    /**
+     * The total number of cycles
+     * @type {number}
+     * @memberof PoxCycleListResponse
+     */
+    total: number;
+    /**
+     * 
+     * @type {Array<PoxCycle>}
+     * @memberof PoxCycleListResponse
+     */
+    results: Array<PoxCycle>;
+}
+
+export function PoxCycleListResponseFromJSON(json: any): PoxCycleListResponse {
+    return PoxCycleListResponseFromJSONTyped(json, false);
+}
+
+export function PoxCycleListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PoxCycleListResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'limit': json['limit'],
+        'offset': json['offset'],
+        'total': json['total'],
+        'results': ((json['results'] as Array<any>).map(PoxCycleFromJSON)),
+    };
+}
+
+export function PoxCycleListResponseToJSON(value?: PoxCycleListResponse | 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(PoxCycleToJSON)),
+    };
+}
+