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

package/package.json

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

@@ -299,7 +299,7 @@ export interface AccountsApiInterface {
     getAccountTransactionsWithTransfers(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionsWithTransfersListResponse>;
 
     /**
-     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
+     * Retrieves transaction details for a given Transcation 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 Transaction Id `tx_id`, for a given account or contract Identifier.
+     * Retrieves transaction details for a given Transcation 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 Transaction Id `tx_id`, for a given account or contract Identifier.
+     * Retrieves transaction details for a given Transcation 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 Transaction Id `tx_id`, for a given account or contract Identifier.
+     * Retrieves transaction details for a given Transcation 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/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. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
+     * Take unsigned transaction and signature, combine both and return signed transaction
      * @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. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
+     * Take unsigned transaction and signature, combine both and return signed transaction
      * 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 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 and unsigned transaction from operations and metadata
      * @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 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 and unsigned transaction from operations and metadata
      * 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. 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 pre-signed transaction to the node.
      * @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. 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 pre-signed transaction to the node.
      * Submit a Signed Transaction
      */
     rosettaConstructionSubmit(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionSubmitResponse>;
 
     /**
-     * Retrieves a list of transactions currently in the mempool for a given network.
+     * Retrieves a list of transcations 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 transactions currently in the mempool for a given network.
+     * Retrieves a list of transcations 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. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
+     * Take unsigned transaction and signature, combine both and return signed transaction
      * 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. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
+     * Take unsigned transaction and signature, combine both and return signed transaction
      * 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 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 and unsigned transaction from operations and metadata
      * 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 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 and unsigned transaction from operations and metadata
      * 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. 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 pre-signed transaction to the node.
      * 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. 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 pre-signed transaction to the node.
      * 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 transactions currently in the mempool for a given network.
+     * Retrieves a list of transcations 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 transactions currently in the mempool for a given network.
+     * Retrieves a list of transcations currently in the mempool for a given network.
      * Get All Mempool Transactions
      */
     async rosettaMempool(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<RosettaMempoolResponse> {

package/src/generated/models/ChainTip.ts

@@ -49,6 +49,12 @@ export interface ChainTip {
      * @memberof ChainTip
      */
     microblock_sequence?: number;
+    /**
+     * the current burn chain block height
+     * @type {number}
+     * @memberof ChainTip
+     */
+    burn_block_height: number;
 }
 
 export function ChainTipFromJSON(json: any): ChainTip {
@@ -66,6 +72,7 @@ export function ChainTipFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'index_block_hash': json['index_block_hash'],
         'microblock_hash': !exists(json, 'microblock_hash') ? undefined : json['microblock_hash'],
         'microblock_sequence': !exists(json, 'microblock_sequence') ? undefined : json['microblock_sequence'],
+        'burn_block_height': json['burn_block_height'],
     };
 }
 
@@ -83,6 +90,7 @@ export function ChainTipToJSON(value?: ChainTip | null): any {
         'index_block_hash': value.index_block_hash,
         'microblock_hash': value.microblock_hash,
         'microblock_sequence': value.microblock_sequence,
+        'burn_block_height': value.burn_block_height,
     };
 }
 

package/src/generated/models/InboundStxTransfer.ts

@@ -69,7 +69,8 @@ export interface InboundStxTransfer {
 */
 export enum InboundStxTransferTransferTypeEnum {
     bulk_send = 'bulk-send',
-    stx_transfer = 'stx-transfer'
+    stx_transfer = 'stx-transfer',
+    stx_transfer_memo = 'stx-transfer-memo'
 }
 
 export function InboundStxTransferFromJSON(json: any): InboundStxTransfer {

package/src/generated/models/ServerStatusResponse.ts

@@ -38,6 +38,12 @@ export interface ServerStatusResponse {
      * @memberof ServerStatusResponse
      */
     status: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ServerStatusResponse
+     */
+    pox_v1_unlock_height?: number | null;
     /**
      * 
      * @type {ChainTip}
@@ -58,6 +64,7 @@ export function ServerStatusResponseFromJSONTyped(json: any, ignoreDiscriminator
         
         'server_version': !exists(json, 'server_version') ? undefined : json['server_version'],
         'status': json['status'],
+        'pox_v1_unlock_height': !exists(json, 'pox_v1_unlock_height') ? undefined : json['pox_v1_unlock_height'],
         'chain_tip': !exists(json, 'chain_tip') ? undefined : ChainTipFromJSON(json['chain_tip']),
     };
 }
@@ -73,6 +80,7 @@ export function ServerStatusResponseToJSON(value?: ServerStatusResponse | null):
         
         'server_version': value.server_version,
         'status': value.status,
+        'pox_v1_unlock_height': value.pox_v1_unlock_height,
         'chain_tip': ChainTipToJSON(value.chain_tip),
     };
 }