@stacks/blockchain-api-client 7.0.0-stacks-2.1.2 → 7.1.0-beta.1

package/lib/generated/apis/InfoApi.d.ts

@@ -94,16 +94,16 @@ export interface InfoApiInterface {
      */
     getStatus(initOverrides?: RequestInit): Promise<ServerStatusResponse>;
     /**
-     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050.
      * @summary Get total and unlocked STX supply
-     * @param {number} [height] Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value.
+     * @param {number} [height] Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value. Note that the &#x60;block height&#x60; is referred to the stacks blockchain.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof InfoApiInterface
      */
     getStxSupplyRaw(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyResponse>>;
     /**
-     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply
      */
     getStxSupply(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<GetStxSupplyResponse>;
@@ -121,7 +121,7 @@ export interface InfoApiInterface {
      */
     getStxSupplyCirculatingPlain(initOverrides?: RequestInit): Promise<string>;
     /**
-     * Retrieves the total supply for STX tokens as plain text.
+     * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
      * @summary Get total STX supply in plain text format
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -129,12 +129,12 @@ export interface InfoApiInterface {
      */
     getStxSupplyTotalSupplyPlainRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
     /**
-     * Retrieves the total supply for STX tokens as plain text.
+     * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total STX supply in plain text format
      */
     getStxSupplyTotalSupplyPlain(initOverrides?: RequestInit): Promise<string>;
     /**
-     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
      * @summary Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      * @param {number} [height] Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value.
      * @param {*} [options] Override http request option.
@@ -143,7 +143,7 @@ export interface InfoApiInterface {
      */
     getTotalStxSupplyLegacyFormatRaw(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyLegacyFormatResponse>>;
     /**
-     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      */
     getTotalStxSupplyLegacyFormat(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<GetStxSupplyLegacyFormatResponse>;
@@ -203,12 +203,12 @@ export declare class InfoApi extends runtime.BaseAPI implements InfoApiInterface
      */
     getStatus(initOverrides?: RequestInit): Promise<ServerStatusResponse>;
     /**
-     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply
      */
     getStxSupplyRaw(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyResponse>>;
     /**
-     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply
      */
     getStxSupply(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<GetStxSupplyResponse>;
@@ -223,22 +223,22 @@ export declare class InfoApi extends runtime.BaseAPI implements InfoApiInterface
      */
     getStxSupplyCirculatingPlain(initOverrides?: RequestInit): Promise<string>;
     /**
-     * Retrieves the total supply for STX tokens as plain text.
+     * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total STX supply in plain text format
      */
     getStxSupplyTotalSupplyPlainRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
     /**
-     * Retrieves the total supply for STX tokens as plain text.
+     * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total STX supply in plain text format
      */
     getStxSupplyTotalSupplyPlain(initOverrides?: RequestInit): Promise<string>;
     /**
-     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      */
     getTotalStxSupplyLegacyFormatRaw(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyLegacyFormatResponse>>;
     /**
-     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      */
     getTotalStxSupplyLegacyFormat(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<GetStxSupplyLegacyFormatResponse>;

package/lib/generated/apis/InfoApi.js

@@ -139,7 +139,7 @@ class InfoApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply
      */
     async getStxSupplyRaw(requestParameters, initOverrides) {
@@ -157,7 +157,7 @@ class InfoApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.GetStxSupplyResponseFromJSON)(jsonValue));
     }
     /**
-     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply
      */
     async getStxSupply(requestParameters, initOverrides) {
@@ -188,7 +188,7 @@ class InfoApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Retrieves the total supply for STX tokens as plain text.
+     * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total STX supply in plain text format
      */
     async getStxSupplyTotalSupplyPlainRaw(initOverrides) {
@@ -203,7 +203,7 @@ class InfoApi extends runtime.BaseAPI {
         return new runtime.TextApiResponse(response);
     }
     /**
-     * Retrieves the total supply for STX tokens as plain text.
+     * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total STX supply in plain text format
      */
     async getStxSupplyTotalSupplyPlain(initOverrides) {
@@ -211,7 +211,7 @@ class InfoApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      */
     async getTotalStxSupplyLegacyFormatRaw(requestParameters, initOverrides) {
@@ -229,7 +229,7 @@ class InfoApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.GetStxSupplyLegacyFormatResponseFromJSON)(jsonValue));
     }
     /**
-     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      */
     async getTotalStxSupplyLegacyFormat(requestParameters, initOverrides) {

package/lib/index.umd.js

@@ -7881,7 +7881,7 @@
       }
     }
     /**
-     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply
      */
     ;
@@ -7912,7 +7912,7 @@
       }
     }
     /**
-     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply
      */
     ;
@@ -7970,7 +7970,7 @@
       }
     }
     /**
-     * Retrieves the total supply for STX tokens as plain text.
+     * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total STX supply in plain text format
      */
     ;
@@ -7994,7 +7994,7 @@
       }
     }
     /**
-     * Retrieves the total supply for STX tokens as plain text.
+     * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total STX supply in plain text format
      */
     ;
@@ -8011,7 +8011,7 @@
       }
     }
     /**
-     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      */
     ;
@@ -8042,7 +8042,7 @@
       }
     }
     /**
-     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
      * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      */
     ;