@stacks/blockchain-api-client 0.71.2 → 1.0.0

package/lib/generated/apis/{BurnchainApi.js → StackingRewardsApi.js}

@@ -2,8 +2,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Stacks 2.0 Blockchain API
- * This is the documentation for the Stacks 2.0 Blockchain API.  It is comprised of two parts; the Stacks Blockchain API and the Stacks Core API.  <a href=\"collection.json\" download=\"collection.json\">Download Postman collection</a>
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>.  <a href=\"/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
  *
  * The version of the OpenAPI document: STACKS_API_VERSION
  *
@@ -13,15 +13,15 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BurnchainApi = void 0;
+exports.StackingRewardsApi = void 0;
 const runtime = require("../runtime");
 const models_1 = require("../models");
 /**
  *
  */
-class BurnchainApi extends runtime.BaseAPI {
+class StackingRewardsApi extends runtime.BaseAPI {
     /**
-     * Get a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
+     * Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
      * Get recent burnchain reward recipients
      */
     async getBurnchainRewardListRaw(requestParameters, initOverrides) {
@@ -42,7 +42,7 @@ class BurnchainApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.BurnchainRewardListResponseFromJSON(jsonValue));
     }
     /**
-     * Get a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
+     * Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
      * Get recent burnchain reward recipients
      */
     async getBurnchainRewardList(requestParameters, initOverrides) {
@@ -50,7 +50,7 @@ class BurnchainApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Get a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
+     * Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
      * Get recent burnchain reward for the given recipient
      */
     async getBurnchainRewardListByAddressRaw(requestParameters, initOverrides) {
@@ -74,7 +74,7 @@ class BurnchainApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.BurnchainRewardListResponseFromJSON(jsonValue));
     }
     /**
-     * Get a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
+     * Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
      * Get recent burnchain reward for the given recipient
      */
     async getBurnchainRewardListByAddress(requestParameters, initOverrides) {
@@ -82,7 +82,7 @@ class BurnchainApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Array of the Bitcoin addresses that would validly receive PoX commitments.
+     * Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments.
      * Get recent reward slot holders
      */
     async getBurnchainRewardSlotHoldersRaw(requestParameters, initOverrides) {
@@ -103,7 +103,7 @@ class BurnchainApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.BurnchainRewardSlotHolderListResponseFromJSON(jsonValue));
     }
     /**
-     * Array of the Bitcoin addresses that would validly receive PoX commitments.
+     * Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments.
      * Get recent reward slot holders
      */
     async getBurnchainRewardSlotHolders(requestParameters, initOverrides) {
@@ -111,7 +111,7 @@ class BurnchainApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Array of the Bitcoin addresses that would validly receive PoX commitments.
+     * Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address.
      * Get recent reward slot holder entries for the given address
      */
     async getBurnchainRewardSlotHoldersByAddressRaw(requestParameters, initOverrides) {
@@ -135,7 +135,7 @@ class BurnchainApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.BurnchainRewardSlotHolderListResponseFromJSON(jsonValue));
     }
     /**
-     * Array of the Bitcoin addresses that would validly receive PoX commitments.
+     * Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address.
      * Get recent reward slot holder entries for the given address
      */
     async getBurnchainRewardSlotHoldersByAddress(requestParameters, initOverrides) {
@@ -143,7 +143,7 @@ class BurnchainApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Get the total burnchain (e.g. Bitcoin) rewards for the given recipient
+     * Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address`
      * Get total burnchain rewards for the given recipient
      */
     async getBurnchainRewardsTotalByAddressRaw(requestParameters, initOverrides) {
@@ -161,7 +161,7 @@ class BurnchainApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.BurnchainRewardsTotalFromJSON(jsonValue));
     }
     /**
-     * Get the total burnchain (e.g. Bitcoin) rewards for the given recipient
+     * Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address`
      * Get total burnchain rewards for the given recipient
      */
     async getBurnchainRewardsTotalByAddress(requestParameters, initOverrides) {
@@ -169,5 +169,5 @@ class BurnchainApi extends runtime.BaseAPI {
         return await response.value();
     }
 }
-exports.BurnchainApi = BurnchainApi;
-//# sourceMappingURL=BurnchainApi.js.map
+exports.StackingRewardsApi = StackingRewardsApi;
+//# sourceMappingURL=StackingRewardsApi.js.map

package/lib/generated/apis/StackingRewardsApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StackingRewardsApi.js","sourceRoot":"","sources":["../../../src/generated/apis/StackingRewardsApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAGH,sCAAsC;AACtC,sCAUmB;AA2HnB;;GAEG;AACH,MAAa,kBAAmB,SAAQ,OAAO,CAAC,OAAO;IAEnD;;;OAGG;IACH,KAAK,CAAC,yBAAyB,CAAC,iBAAgD,EAAE,aAA2B;QACzG,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,KAAK,KAAK,SAAS,EAAE;YACvC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC;SACtD;QAED,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,EAAE;YACxC,eAAe,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC;SACxD;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,gCAAgC;YACtC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,4CAAmC,CAAC,SAAS,CAAC,CAAC,CAAC;IAChH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,sBAAsB,CAAC,iBAAgD,EAAE,aAA2B;QACtG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACxF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,kCAAkC,CAAC,iBAAyD,EAAE,aAA2B;QAC3H,IAAI,iBAAiB,CAAC,OAAO,KAAK,IAAI,IAAI,iBAAiB,CAAC,OAAO,KAAK,SAAS,EAAE;YAC/E,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,SAAS,EAAC,kHAAkH,CAAC,CAAC;SACjK;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,KAAK,KAAK,SAAS,EAAE;YACvC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC;SACtD;QAED,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,EAAE;YACxC,eAAe,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC;SACxD;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,0CAA0C,CAAC,OAAO,CAAC,IAAI,SAAS,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;YACjI,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,4CAAmC,CAAC,SAAS,CAAC,CAAC,CAAC;IAChH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,+BAA+B,CAAC,iBAAyD,EAAE,aAA2B;QACxH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kCAAkC,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACjG,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gCAAgC,CAAC,iBAAuD,EAAE,aAA2B;QACvH,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,KAAK,KAAK,SAAS,EAAE;YACvC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC;SACtD;QAED,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,EAAE;YACxC,eAAe,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC;SACxD;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,sDAA6C,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1H,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,6BAA6B,CAAC,iBAAuD,EAAE,aAA2B;QACpH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gCAAgC,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC/F,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,yCAAyC,CAAC,iBAAgE,EAAE,aAA2B;QACzI,IAAI,iBAAiB,CAAC,OAAO,KAAK,IAAI,IAAI,iBAAiB,CAAC,OAAO,KAAK,SAAS,EAAE;YAC/E,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,SAAS,EAAC,yHAAyH,CAAC,CAAC;SACxK;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,KAAK,KAAK,SAAS,EAAE;YACvC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC;SACtD;QAED,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,EAAE;YACxC,eAAe,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC;SACxD;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,sDAAsD,CAAC,OAAO,CAAC,IAAI,SAAS,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;YAC7I,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,sDAA6C,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1H,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,sCAAsC,CAAC,iBAAgE,EAAE,aAA2B;QACtI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,yCAAyC,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACxG,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oCAAoC,CAAC,iBAA2D,EAAE,aAA2B;QAC/H,IAAI,iBAAiB,CAAC,OAAO,KAAK,IAAI,IAAI,iBAAiB,CAAC,OAAO,KAAK,SAAS,EAAE;YAC/E,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,SAAS,EAAC,oHAAoH,CAAC,CAAC;SACnK;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,gDAAgD,CAAC,OAAO,CAAC,IAAI,SAAS,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;YACvI,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,sCAA6B,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iCAAiC,CAAC,iBAA2D,EAAE,aAA2B;QAC5H,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oCAAoC,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACnG,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AA1LD,gDA0LC"}

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

@@ -1,6 +1,6 @@
 /**
- * Stacks 2.0 Blockchain API
- * This is the documentation for the Stacks 2.0 Blockchain API.  It is comprised of two parts; the Stacks Blockchain API and the Stacks Core API.  <a href=\"collection.json\" download=\"collection.json\">Download Postman collection</a>
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>.  <a href=\"/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
  *
  * The version of the OpenAPI document: STACKS_API_VERSION
  *
@@ -55,6 +55,12 @@ export interface GetTransactionsByBlockHeightRequest {
     offset?: number;
     unanchored?: boolean;
 }
+export interface GetTxListDetailsRequest {
+    txId: Array<string>;
+    eventOffset?: number;
+    eventLimit?: number;
+    unanchored?: boolean;
+}
 export interface PostCoreNodeTransactionsRequest {
     body?: Blob;
 }
@@ -66,7 +72,7 @@ export interface PostCoreNodeTransactionsRequest {
  */
 export interface TransactionsApiInterface {
     /**
-     * Get all transactions for address in mempool
+     * Retrieves all transactions for a given address that are currently in mempool
      * @summary Transactions for address
      * @param {string} address Transactions for the address
      * @param {number} [limit] max number of transactions to fetch
@@ -78,12 +84,12 @@ export interface TransactionsApiInterface {
      */
     getAddressMempoolTransactionsRaw(requestParameters: GetAddressMempoolTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MempoolTransactionListResponse>>;
     /**
-     * Get all transactions for address in mempool
+     * Retrieves all transactions for a given address that are currently in mempool
      * Transactions for address
      */
     getAddressMempoolTransactions(requestParameters: GetAddressMempoolTransactionsRequest, initOverrides?: RequestInit): Promise<MempoolTransactionListResponse>;
     /**
-     * Get all recently-broadcast mempool transactions
+     * Retrieves all recently-broadcast transactions that have been dropped from the mempool.  Transactions are dropped from the mempool if:  * they were stale and awaiting garbage collection or,  * were expensive,  or  * were replaced with a new fee
      * @summary Get dropped mempool transactions
      * @param {number} [limit] max number of mempool transactions to fetch
      * @param {number} [offset] index of first mempool transaction to fetch
@@ -93,12 +99,12 @@ export interface TransactionsApiInterface {
      */
     getDroppedMempoolTransactionListRaw(requestParameters: GetDroppedMempoolTransactionListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MempoolTransactionListResponse>>;
     /**
-     * Get all recently-broadcast mempool transactions
+     * Retrieves all recently-broadcast transactions that have been dropped from the mempool.  Transactions are dropped from the mempool if:  * they were stale and awaiting garbage collection or,  * were expensive,  or  * were replaced with a new fee
      * Get dropped mempool transactions
      */
     getDroppedMempoolTransactionList(requestParameters: GetDroppedMempoolTransactionListRequest, initOverrides?: RequestInit): Promise<MempoolTransactionListResponse>;
     /**
-     * Get all recently-broadcast mempool transactions
+     * Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
      * @summary Get mempool transactions
      * @param {string} [senderAddress] Filter to only return transactions with this sender address.
      * @param {string} [recipientAddress] Filter to only return transactions with this recipient address (only applicable for STX transfer tx types).
@@ -112,12 +118,12 @@ export interface TransactionsApiInterface {
      */
     getMempoolTransactionListRaw(requestParameters: GetMempoolTransactionListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MempoolTransactionListResponse>>;
     /**
-     * Get all recently-broadcast mempool transactions
+     * Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
      * Get mempool transactions
      */
     getMempoolTransactionList(requestParameters: GetMempoolTransactionListRequest, initOverrides?: RequestInit): Promise<MempoolTransactionListResponse>;
     /**
-     * Get raw transaction by ID
+     * Retrieves a hex encoded serialized transaction for a given ID
      * @summary Get Raw Transaction
      * @param {string} txId Hash of transaction
      * @param {*} [options] Override http request option.
@@ -126,12 +132,12 @@ export interface TransactionsApiInterface {
      */
     getRawTransactionByIdRaw(requestParameters: GetRawTransactionByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetRawTransactionResult>>;
     /**
-     * Get raw transaction by ID
+     * Retrieves a hex encoded serialized transaction for a given ID
      * Get Raw Transaction
      */
     getRawTransactionById(requestParameters: GetRawTransactionByIdRequest, initOverrides?: RequestInit): Promise<GetRawTransactionResult>;
     /**
-     * Get a specific transaction by ID  `import type { Transaction } from \'@stacks/stacks-blockchain-api-types\';`
+     * Retrieves transaction details for a given transaction ID  `import type { Transaction } from \'@stacks/stacks-blockchain-api-types\';`
      * @summary Get transaction
      * @param {string} txId Hash of transaction
      * @param {number} [eventOffset] The number of events to skip
@@ -143,12 +149,12 @@ export interface TransactionsApiInterface {
      */
     getTransactionByIdRaw(requestParameters: GetTransactionByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
     /**
-     * Get a specific transaction by ID  `import type { Transaction } from \'@stacks/stacks-blockchain-api-types\';`
+     * Retrieves transaction details for a given transaction ID  `import type { Transaction } from \'@stacks/stacks-blockchain-api-types\';`
      * Get transaction
      */
     getTransactionById(requestParameters: GetTransactionByIdRequest, initOverrides?: RequestInit): Promise<object>;
     /**
-     * Get all recently mined transactions  If using TypeScript, import typings for this response from our types package:  `import type { TransactionResults } from \'@stacks/stacks-blockchain-api-types\';`
+     * Retrieves all recently mined transactions  If using TypeScript, import typings for this response from our types package:  `import type { TransactionResults } from \'@stacks/stacks-blockchain-api-types\';`
      * @summary Get recent transactions
      * @param {number} [limit] max number of transactions to fetch
      * @param {number} [offset] index of first transaction to fetch
@@ -160,13 +166,13 @@ export interface TransactionsApiInterface {
      */
     getTransactionListRaw(requestParameters: GetTransactionListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionResults>>;
     /**
-     * Get all recently mined transactions  If using TypeScript, import typings for this response from our types package:  `import type { TransactionResults } from \'@stacks/stacks-blockchain-api-types\';`
+     * Retrieves all recently mined transactions  If using TypeScript, import typings for this response from our types package:  `import type { TransactionResults } from \'@stacks/stacks-blockchain-api-types\';`
      * Get recent transactions
      */
     getTransactionList(requestParameters: GetTransactionListRequest, initOverrides?: RequestInit): Promise<TransactionResults>;
     /**
-     * Get all transactions in block
-     * @summary Transactions in a block
+     * Retrieves a list of all transactions within a block for a given block hash.
+     * @summary Transactions by block hash
      * @param {string} blockHash Hash of block
      * @param {number} [limit] max number of transactions to fetch
      * @param {number} [offset] index of first transaction to fetch
@@ -176,13 +182,13 @@ export interface TransactionsApiInterface {
      */
     getTransactionsByBlockHashRaw(requestParameters: GetTransactionsByBlockHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionResults>>;
     /**
-     * Get all transactions in block
-     * Transactions in a block
+     * Retrieves a list of all transactions within a block for a given block hash.
+     * Transactions by block hash
      */
     getTransactionsByBlockHash(requestParameters: GetTransactionsByBlockHashRequest, initOverrides?: RequestInit): Promise<TransactionResults>;
     /**
-     * Get all transactions in block by height
-     * @summary Transactions in a block
+     * Retrieves all transactions within a block at a given height
+     * @summary Transactions by block height
      * @param {number} height Height of block
      * @param {number} [limit] max number of transactions to fetch
      * @param {number} [offset] index of first transaction to fetch
@@ -193,12 +199,33 @@ export interface TransactionsApiInterface {
      */
     getTransactionsByBlockHeightRaw(requestParameters: GetTransactionsByBlockHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionResults>>;
     /**
-     * Get all transactions in block by height
-     * Transactions in a block
+     * Retrieves all transactions within a block at a given height
+     * Transactions by block height
      */
     getTransactionsByBlockHeight(requestParameters: GetTransactionsByBlockHeightRequest, initOverrides?: RequestInit): Promise<TransactionResults>;
     /**
-     * Broadcast raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload.
+     * Retrieves a list of transactions for a given list of transaction IDs  If using TypeScript, import typings for this response from our types package:  `import type { Transaction } from \'@stacks/stacks-blockchain-api-types\';`
+     * @summary Get list of details for transactions
+     * @param {Array<string>} txId Array of transaction ids
+     * @param {number} [eventOffset] The number of events to skip
+     * @param {number} [eventLimit] The numbers of events to return
+     * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TransactionsApiInterface
+     */
+    getTxListDetailsRaw(requestParameters: GetTxListDetailsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<{
+        [key: string]: object;
+    }>>;
+    /**
+     * Retrieves a list of transactions for a given list of transaction IDs  If using TypeScript, import typings for this response from our types package:  `import type { Transaction } from \'@stacks/stacks-blockchain-api-types\';`
+     * Get list of details for transactions
+     */
+    getTxListDetails(requestParameters: GetTxListDetailsRequest, initOverrides?: RequestInit): Promise<{
+        [key: string]: object;
+    }>;
+    /**
+     * Broadcasts raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload.
      * @summary Broadcast raw transaction
      * @param {Blob} [body]
      * @param {*} [options] Override http request option.
@@ -207,7 +234,7 @@ export interface TransactionsApiInterface {
      */
     postCoreNodeTransactionsRaw(requestParameters: PostCoreNodeTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
     /**
-     * Broadcast raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload.
+     * Broadcasts raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload.
      * Broadcast raw transaction
      */
     postCoreNodeTransactions(requestParameters: PostCoreNodeTransactionsRequest, initOverrides?: RequestInit): Promise<string>;
@@ -217,92 +244,106 @@ export interface TransactionsApiInterface {
  */
 export declare class TransactionsApi extends runtime.BaseAPI implements TransactionsApiInterface {
     /**
-     * Get all transactions for address in mempool
+     * Retrieves all transactions for a given address that are currently in mempool
      * Transactions for address
      */
     getAddressMempoolTransactionsRaw(requestParameters: GetAddressMempoolTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MempoolTransactionListResponse>>;
     /**
-     * Get all transactions for address in mempool
+     * Retrieves all transactions for a given address that are currently in mempool
      * Transactions for address
      */
     getAddressMempoolTransactions(requestParameters: GetAddressMempoolTransactionsRequest, initOverrides?: RequestInit): Promise<MempoolTransactionListResponse>;
     /**
-     * Get all recently-broadcast mempool transactions
+     * Retrieves all recently-broadcast transactions that have been dropped from the mempool.  Transactions are dropped from the mempool if:  * they were stale and awaiting garbage collection or,  * were expensive,  or  * were replaced with a new fee
      * Get dropped mempool transactions
      */
     getDroppedMempoolTransactionListRaw(requestParameters: GetDroppedMempoolTransactionListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MempoolTransactionListResponse>>;
     /**
-     * Get all recently-broadcast mempool transactions
+     * Retrieves all recently-broadcast transactions that have been dropped from the mempool.  Transactions are dropped from the mempool if:  * they were stale and awaiting garbage collection or,  * were expensive,  or  * were replaced with a new fee
      * Get dropped mempool transactions
      */
     getDroppedMempoolTransactionList(requestParameters: GetDroppedMempoolTransactionListRequest, initOverrides?: RequestInit): Promise<MempoolTransactionListResponse>;
     /**
-     * Get all recently-broadcast mempool transactions
+     * Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
      * Get mempool transactions
      */
     getMempoolTransactionListRaw(requestParameters: GetMempoolTransactionListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MempoolTransactionListResponse>>;
     /**
-     * Get all recently-broadcast mempool transactions
+     * Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
      * Get mempool transactions
      */
     getMempoolTransactionList(requestParameters: GetMempoolTransactionListRequest, initOverrides?: RequestInit): Promise<MempoolTransactionListResponse>;
     /**
-     * Get raw transaction by ID
+     * Retrieves a hex encoded serialized transaction for a given ID
      * Get Raw Transaction
      */
     getRawTransactionByIdRaw(requestParameters: GetRawTransactionByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetRawTransactionResult>>;
     /**
-     * Get raw transaction by ID
+     * Retrieves a hex encoded serialized transaction for a given ID
      * Get Raw Transaction
      */
     getRawTransactionById(requestParameters: GetRawTransactionByIdRequest, initOverrides?: RequestInit): Promise<GetRawTransactionResult>;
     /**
-     * Get a specific transaction by ID  `import type { Transaction } from \'@stacks/stacks-blockchain-api-types\';`
+     * Retrieves transaction details for a given transaction ID  `import type { Transaction } from \'@stacks/stacks-blockchain-api-types\';`
      * Get transaction
      */
     getTransactionByIdRaw(requestParameters: GetTransactionByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
     /**
-     * Get a specific transaction by ID  `import type { Transaction } from \'@stacks/stacks-blockchain-api-types\';`
+     * Retrieves transaction details for a given transaction ID  `import type { Transaction } from \'@stacks/stacks-blockchain-api-types\';`
      * Get transaction
      */
     getTransactionById(requestParameters: GetTransactionByIdRequest, initOverrides?: RequestInit): Promise<object>;
     /**
-     * Get all recently mined transactions  If using TypeScript, import typings for this response from our types package:  `import type { TransactionResults } from \'@stacks/stacks-blockchain-api-types\';`
+     * Retrieves all recently mined transactions  If using TypeScript, import typings for this response from our types package:  `import type { TransactionResults } from \'@stacks/stacks-blockchain-api-types\';`
      * Get recent transactions
      */
     getTransactionListRaw(requestParameters: GetTransactionListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionResults>>;
     /**
-     * Get all recently mined transactions  If using TypeScript, import typings for this response from our types package:  `import type { TransactionResults } from \'@stacks/stacks-blockchain-api-types\';`
+     * Retrieves all recently mined transactions  If using TypeScript, import typings for this response from our types package:  `import type { TransactionResults } from \'@stacks/stacks-blockchain-api-types\';`
      * Get recent transactions
      */
     getTransactionList(requestParameters: GetTransactionListRequest, initOverrides?: RequestInit): Promise<TransactionResults>;
     /**
-     * Get all transactions in block
-     * Transactions in a block
+     * Retrieves a list of all transactions within a block for a given block hash.
+     * Transactions by block hash
      */
     getTransactionsByBlockHashRaw(requestParameters: GetTransactionsByBlockHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionResults>>;
     /**
-     * Get all transactions in block
-     * Transactions in a block
+     * Retrieves a list of all transactions within a block for a given block hash.
+     * Transactions by block hash
      */
     getTransactionsByBlockHash(requestParameters: GetTransactionsByBlockHashRequest, initOverrides?: RequestInit): Promise<TransactionResults>;
     /**
-     * Get all transactions in block by height
-     * Transactions in a block
+     * Retrieves all transactions within a block at a given height
+     * Transactions by block height
      */
     getTransactionsByBlockHeightRaw(requestParameters: GetTransactionsByBlockHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionResults>>;
     /**
-     * Get all transactions in block by height
-     * Transactions in a block
+     * Retrieves all transactions within a block at a given height
+     * Transactions by block height
      */
     getTransactionsByBlockHeight(requestParameters: GetTransactionsByBlockHeightRequest, initOverrides?: RequestInit): Promise<TransactionResults>;
     /**
-     * Broadcast raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload.
+     * Retrieves a list of transactions for a given list of transaction IDs  If using TypeScript, import typings for this response from our types package:  `import type { Transaction } from \'@stacks/stacks-blockchain-api-types\';`
+     * Get list of details for transactions
+     */
+    getTxListDetailsRaw(requestParameters: GetTxListDetailsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<{
+        [key: string]: object;
+    }>>;
+    /**
+     * Retrieves a list of transactions for a given list of transaction IDs  If using TypeScript, import typings for this response from our types package:  `import type { Transaction } from \'@stacks/stacks-blockchain-api-types\';`
+     * Get list of details for transactions
+     */
+    getTxListDetails(requestParameters: GetTxListDetailsRequest, initOverrides?: RequestInit): Promise<{
+        [key: string]: object;
+    }>;
+    /**
+     * Broadcasts raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload.
      * Broadcast raw transaction
      */
     postCoreNodeTransactionsRaw(requestParameters: PostCoreNodeTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
     /**
-     * Broadcast raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload.
+     * Broadcasts raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload.
      * Broadcast raw transaction
      */
     postCoreNodeTransactions(requestParameters: PostCoreNodeTransactionsRequest, initOverrides?: RequestInit): Promise<string>;