@stacks/blockchain-api-client 7.0.0-stacks-2.1.1 → 7.0.0

package/package.json

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

package/src/generated/apis/AccountsApi.ts

@@ -299,7 +299,7 @@ export interface AccountsApiInterface {
     getAccountTransactionsWithTransfers(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionsWithTransfersListResponse>;
 
     /**
-     * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
+     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * @summary Get account transaction information for specific transaction
      * @param {string} principal Stacks address or a contract identifier
      * @param {string} txId Transaction id
@@ -310,7 +310,7 @@ export interface AccountsApiInterface {
     getSingleTransactionWithTransfersRaw(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionWithTransfers>>;
 
     /**
-     * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
+     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     getSingleTransactionWithTransfers(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionWithTransfers>;
@@ -735,7 +735,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
     }
 
     /**
-     * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
+     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     async getSingleTransactionWithTransfersRaw(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionWithTransfers>> {
@@ -762,7 +762,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
     }
 
     /**
-     * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
+     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     async getSingleTransactionWithTransfers(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionWithTransfers> {

package/src/generated/apis/InfoApi.ts

@@ -134,7 +134,7 @@ 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 {*} [options] Override http request option.
@@ -144,7 +144,7 @@ export interface 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>;
@@ -165,7 +165,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}
@@ -174,13 +174,13 @@ 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.
@@ -190,7 +190,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>;
@@ -347,7 +347,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * 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: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyResponse>> {
@@ -370,7 +370,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * 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: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<GetStxSupplyResponse> {
@@ -407,7 +407,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * 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?: RequestInit): Promise<runtime.ApiResponse<string>> {
@@ -426,7 +426,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * 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?: RequestInit): Promise<string> {
@@ -435,7 +435,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * 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: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyLegacyFormatResponse>> {
@@ -458,7 +458,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * 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: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<GetStxSupplyLegacyFormatResponse> {

package/src/generated/apis/NonFungibleTokensApi.ts

@@ -76,7 +76,7 @@ export interface GetNftMintsRequest {
 export interface NonFungibleTokensApiInterface {
     /**
      * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
-     * @summary Non fungible tokens metadata for contract id
+     * @summary Non fungible tokens metadata for contract ID
      * @param {string} contractId token\'s contract id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -86,7 +86,7 @@ export interface NonFungibleTokensApiInterface {
 
     /**
      * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
-     * Non fungible tokens metadata for contract id
+     * Non fungible tokens metadata for contract ID
      */
     getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata>;
 
@@ -178,7 +178,7 @@ export class NonFungibleTokensApi extends runtime.BaseAPI implements NonFungible
 
     /**
      * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
-     * Non fungible tokens metadata for contract id
+     * Non fungible tokens metadata for contract ID
      */
     async getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>> {
         if (requestParameters.contractId === null || requestParameters.contractId === undefined) {
@@ -201,7 +201,7 @@ export class NonFungibleTokensApi extends runtime.BaseAPI implements NonFungible
 
     /**
      * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
-     * Non fungible tokens metadata for contract id
+     * Non fungible tokens metadata for contract ID
      */
     async getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata> {
         const response = await this.getContractNftMetadataRaw(requestParameters, initOverrides);

package/src/generated/apis/RosettaApi.ts

@@ -229,7 +229,7 @@ export interface RosettaApiInterface {
     rosettaBlockTransaction(requestParameters: RosettaBlockTransactionOperationRequest, initOverrides?: RequestInit): Promise<RosettaBlockTransactionResponse>;
 
     /**
-     * Take unsigned transaction and signature, combine both and return signed transaction
+     * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * @summary Create Network Transaction from Signatures
      * @param {RosettaConstructionCombineRequest} rosettaConstructionCombineRequest 
      * @param {*} [options] Override http request option.
@@ -239,7 +239,7 @@ export interface RosettaApiInterface {
     rosettaConstructionCombineRaw(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionCombineResponse>>;
 
     /**
-     * Take unsigned transaction and signature, combine both and return signed transaction
+     * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Create Network Transaction from Signatures
      */
     rosettaConstructionCombine(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionCombineResponse>;
@@ -309,7 +309,7 @@ export interface RosettaApiInterface {
     rosettaConstructionParse(requestParameters: RosettaConstructionParseOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionParseResponse>;
 
     /**
-     * Generate and unsigned transaction from operations and metadata
+     * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * @summary Generate an Unsigned Transaction and Signing Payloads
      * @param {RosettaConstructionPayloadsRequest} rosettaConstructionPayloadsRequest 
      * @param {*} [options] Override http request option.
@@ -319,7 +319,7 @@ export interface RosettaApiInterface {
     rosettaConstructionPayloadsRaw(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionPayloadResponse>>;
 
     /**
-     * Generate and unsigned transaction from operations and metadata
+     * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Generate an Unsigned Transaction and Signing Payloads
      */
     rosettaConstructionPayloads(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPayloadResponse>;
@@ -341,7 +341,7 @@ export interface RosettaApiInterface {
     rosettaConstructionPreprocess(requestParameters: RosettaConstructionPreprocessOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPreprocessResponse>;
 
     /**
-     * Submit a pre-signed transaction to the node.
+     * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * @summary Submit a Signed Transaction
      * @param {RosettaConstructionSubmitRequest} rosettaConstructionSubmitRequest 
      * @param {*} [options] Override http request option.
@@ -351,13 +351,13 @@ export interface RosettaApiInterface {
     rosettaConstructionSubmitRaw(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionSubmitResponse>>;
 
     /**
-     * Submit a pre-signed transaction to the node.
+     * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Submit a Signed Transaction
      */
     rosettaConstructionSubmit(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionSubmitResponse>;
 
     /**
-     * Retrieves a list of transcations currently in the mempool for a given network.
+     * Retrieves a list of transactions currently in the mempool for a given network.
      * @summary Get All Mempool Transactions
      * @param {RosettaMempoolRequest} rosettaMempoolRequest 
      * @param {*} [options] Override http request option.
@@ -367,7 +367,7 @@ export interface RosettaApiInterface {
     rosettaMempoolRaw(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaMempoolResponse>>;
 
     /**
-     * Retrieves a list of transcations currently in the mempool for a given network.
+     * Retrieves a list of transactions currently in the mempool for a given network.
      * Get All Mempool Transactions
      */
     rosettaMempool(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<RosettaMempoolResponse>;
@@ -548,7 +548,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * Take unsigned transaction and signature, combine both and return signed transaction
+     * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Create Network Transaction from Signatures
      */
     async rosettaConstructionCombineRaw(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionCombineResponse>> {
@@ -574,7 +574,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * Take unsigned transaction and signature, combine both and return signed transaction
+     * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Create Network Transaction from Signatures
      */
     async rosettaConstructionCombine(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionCombineResponse> {
@@ -723,7 +723,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * Generate and unsigned transaction from operations and metadata
+     * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Generate an Unsigned Transaction and Signing Payloads
      */
     async rosettaConstructionPayloadsRaw(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionPayloadResponse>> {
@@ -749,7 +749,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * Generate and unsigned transaction from operations and metadata
+     * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Generate an Unsigned Transaction and Signing Payloads
      */
     async rosettaConstructionPayloads(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPayloadResponse> {
@@ -793,7 +793,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * Submit a pre-signed transaction to the node.
+     * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Submit a Signed Transaction
      */
     async rosettaConstructionSubmitRaw(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionSubmitResponse>> {
@@ -819,7 +819,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * Submit a pre-signed transaction to the node.
+     * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Submit a Signed Transaction
      */
     async rosettaConstructionSubmit(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionSubmitResponse> {
@@ -828,7 +828,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * Retrieves a list of transcations currently in the mempool for a given network.
+     * Retrieves a list of transactions currently in the mempool for a given network.
      * Get All Mempool Transactions
      */
     async rosettaMempoolRaw(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaMempoolResponse>> {
@@ -854,7 +854,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * Retrieves a list of transcations currently in the mempool for a given network.
+     * Retrieves a list of transactions currently in the mempool for a given network.
      * Get All Mempool Transactions
      */
     async rosettaMempool(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<RosettaMempoolResponse> {