@stacks/blockchain-api-client 4.1.0 → 5.0.0-beta.1

package/package.json

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

@@ -126,11 +126,11 @@ export interface AccountsApiInterface {
     /**
      * Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
      * @summary Get account assets
-     * @param {string} principal Stacks address or a Contract identifier (e.g. `SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info`)
+     * @param {string} principal Stacks address or a Contract identifier
      * @param {number} [limit] max number of account assets to fetch
      * @param {number} [offset] index of first account assets to fetch
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
-     * @param {string} [untilBlock] returned data representing the state at that point in time, rather than the current block.
+     * @param {string} [untilBlock] returned data representing the state at that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
@@ -146,7 +146,7 @@ export interface AccountsApiInterface {
     /**
      * Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of  STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
      * @summary Get account balances
-     * @param {string} principal Stacks address or a Contract identifier (e.g. `SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info`)
+     * @param {string} principal Stacks address or a Contract identifier
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
      * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
      * @param {*} [options] Override http request option.
@@ -164,12 +164,12 @@ export interface AccountsApiInterface {
     /**
      * Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract. 
      * @summary Get inbound STX transfers
-     * @param {string} principal Stacks address or a Contract identifier (e.g. `SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info`)
+     * @param {string} principal Stacks address or a Contract identifier
      * @param {number} [limit] number of items to return
      * @param {number} [offset] number of items to skip
      * @param {number} [height] Filter for transfers only at this given block height
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
-     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
+     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
@@ -185,7 +185,7 @@ export interface AccountsApiInterface {
     /**
      * Retrieves the account data for a given Account or a Contract Identifier  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0. 
      * @summary Get account info
-     * @param {string} principal Stacks address or a Contract identifier (e.g. `SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info`)
+     * @param {string} principal Stacks address or a Contract identifier
      * @param {number} [proof] Returns object without the proof field if set to 0
      * @param {string} [tip] The Stacks chain tip to query from
      * @param {*} [options] Override http request option.
@@ -203,11 +203,11 @@ export interface AccountsApiInterface {
     /**
      * **NOTE:** This endpoint is deprecated in favor of [Non-Fungible Token holdings](#operation/get_nft_holdings).  Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft. 
      * @summary Get nft events
-     * @param {string} principal Stacks address or a Contract identifier (e.g. `SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info`)
+     * @param {string} principal Stacks address or a Contract identifier
      * @param {number} [limit] number of items to return
      * @param {number} [offset] number of items to skip
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
-     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
+     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
@@ -223,9 +223,9 @@ export interface AccountsApiInterface {
     /**
      * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
      * @summary Get the latest nonce used by an account
-     * @param {string} principal Stacks address (e.g. `SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0`)
-     * @param {number} [blockHeight] Optionally get the nonce at a given block height
-     * @param {string} [blockHash] Optionally get the nonce at a given block hash
+     * @param {string} principal Stacks address
+     * @param {number} [blockHeight] Optionally get the nonce at a given block height.
+     * @param {string} [blockHash] Optionally get the nonce at a given block hash. Note - Use either of the query parameters but not both at a time.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
@@ -241,9 +241,9 @@ export interface AccountsApiInterface {
     /**
      * Retrieves STX token balance for a given Address or Contract Identifier.
      * @summary Get account STX balance
-     * @param {string} principal Stacks address or a Contract identifier (e.g. `SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info`)
-     * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
-     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
+     * @param {string} principal Stacks address or a Contract identifier.
+     * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks.
+     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
@@ -259,12 +259,12 @@ export interface AccountsApiInterface {
     /**
      * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 
      * @summary Get account transactions
-     * @param {string} principal Stacks address or a Contract identifier (e.g. `SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info`)
+     * @param {string} principal Stacks address or a Contract identifier
      * @param {number} [limit] max number of account transactions to fetch
      * @param {number} [offset] index of first account transaction to fetch
      * @param {number} [height] Filter for transactions only at this given block height
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
-     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
+     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
@@ -280,7 +280,7 @@ export interface AccountsApiInterface {
     /**
      * Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
      * @summary Get account transactions including STX transfers for each transaction.
-     * @param {string} principal Stacks address or a Contract identifier (e.g. `SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info`)
+     * @param {string} principal Stacks address or a Contract identifier
      * @param {number} [limit] max number of account transactions to fetch
      * @param {number} [offset] index of first account transaction to fetch
      * @param {number} [height] Filter for transactions only at this given block height

package/src/generated/apis/BlocksApi.ts

@@ -84,7 +84,7 @@ export interface BlocksApiInterface {
     getBlockByBurnBlockHeight(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<Block>;
 
     /**
-     * Retrieves block details of a specific block for a given chain height
+     * Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
      * @summary Get block by hash
      * @param {string} hash Hash of the block
      * @param {*} [options] Override http request option.
@@ -94,7 +94,7 @@ export interface BlocksApiInterface {
     getBlockByHashRaw(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
 
     /**
-     * Retrieves block details of a specific block for a given chain height
+     * Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
      * Get block by hash
      */
     getBlockByHash(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<Block>;
@@ -204,7 +204,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
     }
 
     /**
-     * Retrieves block details of a specific block for a given chain height
+     * Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
      * Get block by hash
      */
     async getBlockByHashRaw(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
@@ -227,7 +227,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
     }
 
     /**
-     * Retrieves block details of a specific block for a given chain height
+     * Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
      * Get block by hash
      */
     async getBlockByHash(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<Block> {

package/src/generated/apis/FeesApi.ts

@@ -45,7 +45,7 @@ export interface PostFeeTransactionRequest {
  */
 export interface FeesApiInterface {
     /**
-     * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for the given transaction](#operation/post_fee_transaction).  Retrieves estimated fee rate. 
+     * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction).  Retrieves estimated fee rate. 
      * @summary Fetch fee rate
      * @param {FeeRateRequest} feeRateRequest 
      * @param {*} [options] Override http request option.
@@ -55,7 +55,7 @@ export interface FeesApiInterface {
     fetchFeeRateRaw(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FeeRate>>;
 
     /**
-     * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for the given transaction](#operation/post_fee_transaction).  Retrieves estimated fee rate. 
+     * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction).  Retrieves estimated fee rate. 
      * Fetch fee rate
      */
     fetchFeeRate(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<FeeRate>;
@@ -77,7 +77,7 @@ export interface FeesApiInterface {
 
     /**
      * Get an estimated fee for the supplied transaction.  This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts. * `transaction_payload` is a hex-encoded serialization of   the TransactionPayload for the transaction. * `estimated_len` is an optional argument that provides the   endpoint with an estimation of the final length (in bytes)   of the transaction, including any post-conditions and   signatures If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a `reason` field which can be one of the following: * `DatabaseError` - this Stacks node has had an internal   database error while trying to estimate the costs of the   supplied transaction. * `NoEstimateAvailable` - this Stacks node has not seen this   kind of contract-call before, and it cannot provide an   estimate yet. * `CostEstimationDisabled` - this Stacks node does not perform   fee or cost estimation, and it cannot respond on this   endpoint. The 200 response contains the following data: * `estimated_cost` - the estimated multi-dimensional cost of   executing the Clarity VM on the provided transaction. * `estimated_cost_scalar` - a unitless integer that the Stacks   node uses to compare how much of the block limit is consumed   by different transactions. This value incorporates the   estimated length of the transaction and the estimated   execution cost of the transaction. The range of this integer   may vary between different Stacks nodes. In order to compute   an estimate of total fee amount for the transaction, this   value is multiplied by the same Stacks node\'s estimated fee   rate. * `cost_scalar_change_by_byte` - a float value that indicates how   much the `estimated_cost_scalar` value would increase for every   additional byte in the final transaction. * `estimations` - an array of estimated fee rates and total fees to   pay in microSTX for the transaction. This array provides a range of   estimates (default: 3) that may be used. Each element of the array   contains the following fields:     * `fee_rate` - the estimated value for the current fee       rates in the network     * `fee` - the estimated value for the total fee in       microSTX that the given transaction should pay. These       values are the result of computing:       `fee_rate` x `estimated_cost_scalar`.       If the estimated fees are less than the minimum relay       fee `(1 ustx x estimated_len)`, then that minimum relay       fee will be returned here instead. Note: If the final transaction\'s byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by:   `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`) 
-     * @summary Get approximate fees for the given transaction
+     * @summary Get approximate fees for a given transaction
      * @param {TransactionFeeEstimateRequest} [transactionFeeEstimateRequest] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -87,7 +87,7 @@ export interface FeesApiInterface {
 
     /**
      * Get an estimated fee for the supplied transaction.  This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts. * `transaction_payload` is a hex-encoded serialization of   the TransactionPayload for the transaction. * `estimated_len` is an optional argument that provides the   endpoint with an estimation of the final length (in bytes)   of the transaction, including any post-conditions and   signatures If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a `reason` field which can be one of the following: * `DatabaseError` - this Stacks node has had an internal   database error while trying to estimate the costs of the   supplied transaction. * `NoEstimateAvailable` - this Stacks node has not seen this   kind of contract-call before, and it cannot provide an   estimate yet. * `CostEstimationDisabled` - this Stacks node does not perform   fee or cost estimation, and it cannot respond on this   endpoint. The 200 response contains the following data: * `estimated_cost` - the estimated multi-dimensional cost of   executing the Clarity VM on the provided transaction. * `estimated_cost_scalar` - a unitless integer that the Stacks   node uses to compare how much of the block limit is consumed   by different transactions. This value incorporates the   estimated length of the transaction and the estimated   execution cost of the transaction. The range of this integer   may vary between different Stacks nodes. In order to compute   an estimate of total fee amount for the transaction, this   value is multiplied by the same Stacks node\'s estimated fee   rate. * `cost_scalar_change_by_byte` - a float value that indicates how   much the `estimated_cost_scalar` value would increase for every   additional byte in the final transaction. * `estimations` - an array of estimated fee rates and total fees to   pay in microSTX for the transaction. This array provides a range of   estimates (default: 3) that may be used. Each element of the array   contains the following fields:     * `fee_rate` - the estimated value for the current fee       rates in the network     * `fee` - the estimated value for the total fee in       microSTX that the given transaction should pay. These       values are the result of computing:       `fee_rate` x `estimated_cost_scalar`.       If the estimated fees are less than the minimum relay       fee `(1 ustx x estimated_len)`, then that minimum relay       fee will be returned here instead. Note: If the final transaction\'s byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by:   `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`) 
-     * Get approximate fees for the given transaction
+     * Get approximate fees for a given transaction
      */
     postFeeTransaction(requestParameters: PostFeeTransactionRequest, initOverrides?: RequestInit): Promise<TransactionFeeEstimateResponse>;
 
@@ -99,7 +99,7 @@ export interface FeesApiInterface {
 export class FeesApi extends runtime.BaseAPI implements FeesApiInterface {
 
     /**
-     * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for the given transaction](#operation/post_fee_transaction).  Retrieves estimated fee rate. 
+     * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction).  Retrieves estimated fee rate. 
      * Fetch fee rate
      */
     async fetchFeeRateRaw(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FeeRate>> {
@@ -125,7 +125,7 @@ export class FeesApi extends runtime.BaseAPI implements FeesApiInterface {
     }
 
     /**
-     * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for the given transaction](#operation/post_fee_transaction).  Retrieves estimated fee rate. 
+     * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction).  Retrieves estimated fee rate. 
      * Fetch fee rate
      */
     async fetchFeeRate(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<FeeRate> {
@@ -163,7 +163,7 @@ export class FeesApi extends runtime.BaseAPI implements FeesApiInterface {
 
     /**
      * Get an estimated fee for the supplied transaction.  This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts. * `transaction_payload` is a hex-encoded serialization of   the TransactionPayload for the transaction. * `estimated_len` is an optional argument that provides the   endpoint with an estimation of the final length (in bytes)   of the transaction, including any post-conditions and   signatures If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a `reason` field which can be one of the following: * `DatabaseError` - this Stacks node has had an internal   database error while trying to estimate the costs of the   supplied transaction. * `NoEstimateAvailable` - this Stacks node has not seen this   kind of contract-call before, and it cannot provide an   estimate yet. * `CostEstimationDisabled` - this Stacks node does not perform   fee or cost estimation, and it cannot respond on this   endpoint. The 200 response contains the following data: * `estimated_cost` - the estimated multi-dimensional cost of   executing the Clarity VM on the provided transaction. * `estimated_cost_scalar` - a unitless integer that the Stacks   node uses to compare how much of the block limit is consumed   by different transactions. This value incorporates the   estimated length of the transaction and the estimated   execution cost of the transaction. The range of this integer   may vary between different Stacks nodes. In order to compute   an estimate of total fee amount for the transaction, this   value is multiplied by the same Stacks node\'s estimated fee   rate. * `cost_scalar_change_by_byte` - a float value that indicates how   much the `estimated_cost_scalar` value would increase for every   additional byte in the final transaction. * `estimations` - an array of estimated fee rates and total fees to   pay in microSTX for the transaction. This array provides a range of   estimates (default: 3) that may be used. Each element of the array   contains the following fields:     * `fee_rate` - the estimated value for the current fee       rates in the network     * `fee` - the estimated value for the total fee in       microSTX that the given transaction should pay. These       values are the result of computing:       `fee_rate` x `estimated_cost_scalar`.       If the estimated fees are less than the minimum relay       fee `(1 ustx x estimated_len)`, then that minimum relay       fee will be returned here instead. Note: If the final transaction\'s byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by:   `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`) 
-     * Get approximate fees for the given transaction
+     * Get approximate fees for a given transaction
      */
     async postFeeTransactionRaw(requestParameters: PostFeeTransactionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionFeeEstimateResponse>> {
         const queryParameters: any = {};
@@ -185,7 +185,7 @@ export class FeesApi extends runtime.BaseAPI implements FeesApiInterface {
 
     /**
      * Get an estimated fee for the supplied transaction.  This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts. * `transaction_payload` is a hex-encoded serialization of   the TransactionPayload for the transaction. * `estimated_len` is an optional argument that provides the   endpoint with an estimation of the final length (in bytes)   of the transaction, including any post-conditions and   signatures If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a `reason` field which can be one of the following: * `DatabaseError` - this Stacks node has had an internal   database error while trying to estimate the costs of the   supplied transaction. * `NoEstimateAvailable` - this Stacks node has not seen this   kind of contract-call before, and it cannot provide an   estimate yet. * `CostEstimationDisabled` - this Stacks node does not perform   fee or cost estimation, and it cannot respond on this   endpoint. The 200 response contains the following data: * `estimated_cost` - the estimated multi-dimensional cost of   executing the Clarity VM on the provided transaction. * `estimated_cost_scalar` - a unitless integer that the Stacks   node uses to compare how much of the block limit is consumed   by different transactions. This value incorporates the   estimated length of the transaction and the estimated   execution cost of the transaction. The range of this integer   may vary between different Stacks nodes. In order to compute   an estimate of total fee amount for the transaction, this   value is multiplied by the same Stacks node\'s estimated fee   rate. * `cost_scalar_change_by_byte` - a float value that indicates how   much the `estimated_cost_scalar` value would increase for every   additional byte in the final transaction. * `estimations` - an array of estimated fee rates and total fees to   pay in microSTX for the transaction. This array provides a range of   estimates (default: 3) that may be used. Each element of the array   contains the following fields:     * `fee_rate` - the estimated value for the current fee       rates in the network     * `fee` - the estimated value for the total fee in       microSTX that the given transaction should pay. These       values are the result of computing:       `fee_rate` x `estimated_cost_scalar`.       If the estimated fees are less than the minimum relay       fee `(1 ustx x estimated_len)`, then that minimum relay       fee will be returned here instead. Note: If the final transaction\'s byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by:   `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`) 
-     * Get approximate fees for the given transaction
+     * Get approximate fees for a given transaction
      */
     async postFeeTransaction(requestParameters: PostFeeTransactionRequest, initOverrides?: RequestInit): Promise<TransactionFeeEstimateResponse> {
         const response = await this.postFeeTransactionRaw(requestParameters, initOverrides);

package/src/generated/apis/FungibleTokensApi.ts

@@ -58,7 +58,7 @@ export interface FungibleTokensApiInterface {
     /**
      * Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
      * @summary Fungible tokens metadata list
-     * @param {number} [limit] max number of tokens to fetch
+     * @param {number} [limit] max number of tokens to fetch.
      * @param {number} [offset] index of first tokens to fetch
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/src/generated/apis/InfoApi.ts

@@ -75,7 +75,7 @@ export interface InfoApiInterface {
     /**
      * Retrieves the target block time for a given network. The network can be mainnet or testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.
      * @summary Get a given network\'s target block time
-     * @param {'testnet' | 'mainnet'} network Which network to retrieve the target block time of
+     * @param {'testnet' | 'mainnet'} network the target block time for a given network (testnet, mainnet).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof InfoApiInterface
@@ -136,7 +136,7 @@ export interface InfoApiInterface {
     /**
      * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
      * @summary Get total and unlocked STX supply
-     * @param {number} [height] The block height at which to query supply details from, if not provided then the latest block height is used
+     * @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.
      * @throws {RequiredError}
      * @memberof InfoApiInterface
@@ -182,7 +182,7 @@ export interface InfoApiInterface {
     /**
      * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
      * @summary Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
-     * @param {number} [height] The block height at which to query supply details from, if not provided then the latest block height is used
+     * @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.
      * @throws {RequiredError}
      * @memberof InfoApiInterface

package/src/generated/apis/NamesApi.ts

@@ -44,7 +44,7 @@ export interface FetchZoneFileRequest {
 }
 
 export interface GetAllNamesRequest {
-    page: number;
+    page?: number;
 }
 
 export interface GetHistoricalZoneFileRequest {
@@ -67,7 +67,7 @@ export interface GetNamesOwnedByAddressRequest {
 
 export interface GetNamespaceNamesRequest {
     tld: string;
-    page: number;
+    page?: number;
 }
 
 export interface GetNamespacePriceRequest {
@@ -116,7 +116,7 @@ export interface NamesApiInterface {
     /**
      * Retrieves a list of all names known to the node.
      * @summary Get All Names
-     * @param {number} page names are returned in pages of size 100, so specify the page number.
+     * @param {number} [page] names are defaulted to page 1 with 100 results. You can query specific page results by using the \'page\' query parameter.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof NamesApiInterface
@@ -213,8 +213,8 @@ export interface NamesApiInterface {
     /**
      * Retrieves a list of names within a given namespace.
      * @summary Get Namespace Names
-     * @param {string} tld the namespace to fetch names from
-     * @param {number} page names are returned in pages of size 100, so specify the page number.
+     * @param {string} tld the namespace to fetch names from.
+     * @param {number} [page] namespace values are defaulted to page 1 with 100 results. You can query specific page results by using the \'page\' query parameter.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof NamesApiInterface
@@ -319,10 +319,6 @@ export class NamesApi extends runtime.BaseAPI implements NamesApiInterface {
      * Get All Names
      */
     async getAllNamesRaw(requestParameters: GetAllNamesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>> {
-        if (requestParameters.page === null || requestParameters.page === undefined) {
-            throw new runtime.RequiredError('page','Required parameter requestParameters.page was null or undefined when calling getAllNames.');
-        }
-
         const queryParameters: any = {};
 
         if (requestParameters.page !== undefined) {
@@ -523,10 +519,6 @@ export class NamesApi extends runtime.BaseAPI implements NamesApiInterface {
             throw new runtime.RequiredError('tld','Required parameter requestParameters.tld was null or undefined when calling getNamespaceNames.');
         }
 
-        if (requestParameters.page === null || requestParameters.page === undefined) {
-            throw new runtime.RequiredError('page','Required parameter requestParameters.page was null or undefined when calling getNamespaceNames.');
-        }
-
         const queryParameters: any = {};
 
         if (requestParameters.page !== undefined) {

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,7 +351,7 @@ 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>;
@@ -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> {

package/src/generated/models/Block.ts

@@ -37,6 +37,12 @@ export interface Block {
      * @memberof Block
      */
     hash: string;
+    /**
+     * The only hash that can uniquely identify an anchored block or an unconfirmed state trie
+     * @type {string}
+     * @memberof Block
+     */
+    index_block_hash: string;
     /**
      * Hash of the parent block
      * @type {string}
@@ -148,6 +154,7 @@ export function BlockFromJSONTyped(json: any, ignoreDiscriminator: boolean): Blo
         'canonical': json['canonical'],
         'height': json['height'],
         'hash': json['hash'],
+        'index_block_hash': json['index_block_hash'],
         'parent_block_hash': json['parent_block_hash'],
         'burn_block_time': json['burn_block_time'],
         'burn_block_time_iso': json['burn_block_time_iso'],
@@ -179,6 +186,7 @@ export function BlockToJSON(value?: Block | null): any {
         'canonical': value.canonical,
         'height': value.height,
         'hash': value.hash,
+        'index_block_hash': value.index_block_hash,
         'parent_block_hash': value.parent_block_hash,
         'burn_block_time': value.burn_block_time,
         'burn_block_time_iso': value.burn_block_time_iso,