@stacks/blockchain-api-client 0.71.2 → 1.0.4

package/src/generated/apis/SmartContractsApi.ts

@@ -1,8 +1,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
  * 
@@ -18,6 +18,9 @@ import {
     ContractInterfaceResponse,
     ContractInterfaceResponseFromJSON,
     ContractInterfaceResponseToJSON,
+    ContractListResponse,
+    ContractListResponseFromJSON,
+    ContractListResponseToJSON,
     ContractSourceResponse,
     ContractSourceResponseFromJSON,
     ContractSourceResponseToJSON,
@@ -74,6 +77,12 @@ export interface GetContractSourceRequest {
     tip?: string;
 }
 
+export interface GetContractsByTraitRequest {
+    traitAbi: string;
+    limit?: number;
+    offset?: number;
+}
+
 /**
  * SmartContractsApi - interface
  * 
@@ -102,7 +111,7 @@ export interface SmartContractsApiInterface {
     callReadOnlyFunction(requestParameters: CallReadOnlyFunctionRequest, initOverrides?: RequestInit): Promise<ReadOnlyFunctionSuccessResponse>;
 
     /**
-     * Get contract info using the contract ID
+     * Retrieves details of a contract with a given `contract_id`
      * @summary Get contract info
      * @param {string} contractId Contract identifier formatted as &#x60;&lt;contract_address&gt;.&lt;contract_name&gt;&#x60;
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
@@ -113,13 +122,13 @@ export interface SmartContractsApiInterface {
     getContractByIdRaw(requestParameters: GetContractByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
 
     /**
-     * Get contract info using the contract ID
+     * Retrieves details of a contract with a given `contract_id`
      * Get contract info
      */
     getContractById(requestParameters: GetContractByIdRequest, initOverrides?: RequestInit): Promise<object>;
 
     /**
-     * Attempt to fetch data from a contract data map. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The map is identified with [Map Name].  The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.  In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object. 
+     * Attempt to fetch data from a contract data map. The contract is identified with Stacks Address `contract_address` and Contract Name `contract_address` in the URL path. The map is identified with [Map Name].  The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.  In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object. 
      * @summary Get specific data-map inside a contract
      * @param {string} contractAddress Stacks address
      * @param {string} contractName Contract name
@@ -134,13 +143,13 @@ export interface SmartContractsApiInterface {
     getContractDataMapEntryRaw(requestParameters: GetContractDataMapEntryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MapEntryResponse>>;
 
     /**
-     * Attempt to fetch data from a contract data map. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The map is identified with [Map Name].  The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.  In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object. 
+     * Attempt to fetch data from a contract data map. The contract is identified with Stacks Address `contract_address` and Contract Name `contract_address` in the URL path. The map is identified with [Map Name].  The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.  In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object. 
      * Get specific data-map inside a contract
      */
     getContractDataMapEntry(requestParameters: GetContractDataMapEntryRequest, initOverrides?: RequestInit): Promise<MapEntryResponse>;
 
     /**
-     * Get contract events using a contract ID
+     * Retrieves a list of events that have been triggered by a given `contract_id`
      * @summary Get contract events
      * @param {string} contractId Contract identifier formatted as &#x60;&lt;contract_address&gt;.&lt;contract_name&gt;&#x60;
      * @param {number} [limit] max number of contract events to fetch
@@ -153,13 +162,13 @@ export interface SmartContractsApiInterface {
     getContractEventsByIdRaw(requestParameters: GetContractEventsByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
 
     /**
-     * Get contract events using a contract ID
+     * Retrieves a list of events that have been triggered by a given `contract_id`
      * Get contract events
      */
     getContractEventsById(requestParameters: GetContractEventsByIdRequest, initOverrides?: RequestInit): Promise<object>;
 
     /**
-     * Get contract interface using a `contract_address` and `contract name`
+     * Retrieves a contract interface with a given `contract_address` and `contract name`
      * @summary Get contract interface
      * @param {string} contractAddress Stacks address
      * @param {string} contractName Contract name
@@ -171,13 +180,13 @@ export interface SmartContractsApiInterface {
     getContractInterfaceRaw(requestParameters: GetContractInterfaceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ContractInterfaceResponse>>;
 
     /**
-     * Get contract interface using a `contract_address` and `contract name`
+     * Retrieves a contract interface with a given `contract_address` and `contract name`
      * Get contract interface
      */
     getContractInterface(requestParameters: GetContractInterfaceRequest, initOverrides?: RequestInit): Promise<ContractInterfaceResponse>;
 
     /**
-     * Returns the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
+     * Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
      * @summary Get contract source
      * @param {string} contractAddress Stacks address
      * @param {string} contractName Contract name
@@ -190,11 +199,29 @@ export interface SmartContractsApiInterface {
     getContractSourceRaw(requestParameters: GetContractSourceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ContractSourceResponse>>;
 
     /**
-     * Returns the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
+     * Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
      * Get contract source
      */
     getContractSource(requestParameters: GetContractSourceRequest, initOverrides?: RequestInit): Promise<ContractSourceResponse>;
 
+    /**
+     * Retrieves a list of contracts based on the following traits listed in JSON format -  functions, variables, maps, fungible tokens and non-fungible tokens
+     * @summary Get contracts by trait
+     * @param {string} traitAbi JSON abi of the trait.
+     * @param {number} [limit] max number of contracts fetch
+     * @param {number} [offset] index of first contract event to fetch
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SmartContractsApiInterface
+     */
+    getContractsByTraitRaw(requestParameters: GetContractsByTraitRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ContractListResponse>>;
+
+    /**
+     * Retrieves a list of contracts based on the following traits listed in JSON format -  functions, variables, maps, fungible tokens and non-fungible tokens
+     * Get contracts by trait
+     */
+    getContractsByTrait(requestParameters: GetContractsByTraitRequest, initOverrides?: RequestInit): Promise<ContractListResponse>;
+
 }
 
 /**
@@ -254,7 +281,7 @@ export class SmartContractsApi extends runtime.BaseAPI implements SmartContracts
     }
 
     /**
-     * Get contract info using the contract ID
+     * Retrieves details of a contract with a given `contract_id`
      * Get contract info
      */
     async getContractByIdRaw(requestParameters: GetContractByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>> {
@@ -281,7 +308,7 @@ export class SmartContractsApi extends runtime.BaseAPI implements SmartContracts
     }
 
     /**
-     * Get contract info using the contract ID
+     * Retrieves details of a contract with a given `contract_id`
      * Get contract info
      */
     async getContractById(requestParameters: GetContractByIdRequest, initOverrides?: RequestInit): Promise<object> {
@@ -290,7 +317,7 @@ export class SmartContractsApi extends runtime.BaseAPI implements SmartContracts
     }
 
     /**
-     * Attempt to fetch data from a contract data map. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The map is identified with [Map Name].  The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.  In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object. 
+     * Attempt to fetch data from a contract data map. The contract is identified with Stacks Address `contract_address` and Contract Name `contract_address` in the URL path. The map is identified with [Map Name].  The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.  In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object. 
      * Get specific data-map inside a contract
      */
     async getContractDataMapEntryRaw(requestParameters: GetContractDataMapEntryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MapEntryResponse>> {
@@ -336,7 +363,7 @@ export class SmartContractsApi extends runtime.BaseAPI implements SmartContracts
     }
 
     /**
-     * Attempt to fetch data from a contract data map. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The map is identified with [Map Name].  The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.  In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object. 
+     * Attempt to fetch data from a contract data map. The contract is identified with Stacks Address `contract_address` and Contract Name `contract_address` in the URL path. The map is identified with [Map Name].  The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.  In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object. 
      * Get specific data-map inside a contract
      */
     async getContractDataMapEntry(requestParameters: GetContractDataMapEntryRequest, initOverrides?: RequestInit): Promise<MapEntryResponse> {
@@ -345,7 +372,7 @@ export class SmartContractsApi extends runtime.BaseAPI implements SmartContracts
     }
 
     /**
-     * Get contract events using a contract ID
+     * Retrieves a list of events that have been triggered by a given `contract_id`
      * Get contract events
      */
     async getContractEventsByIdRaw(requestParameters: GetContractEventsByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>> {
@@ -380,7 +407,7 @@ export class SmartContractsApi extends runtime.BaseAPI implements SmartContracts
     }
 
     /**
-     * Get contract events using a contract ID
+     * Retrieves a list of events that have been triggered by a given `contract_id`
      * Get contract events
      */
     async getContractEventsById(requestParameters: GetContractEventsByIdRequest, initOverrides?: RequestInit): Promise<object> {
@@ -389,7 +416,7 @@ export class SmartContractsApi extends runtime.BaseAPI implements SmartContracts
     }
 
     /**
-     * Get contract interface using a `contract_address` and `contract name`
+     * Retrieves a contract interface with a given `contract_address` and `contract name`
      * Get contract interface
      */
     async getContractInterfaceRaw(requestParameters: GetContractInterfaceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ContractInterfaceResponse>> {
@@ -420,7 +447,7 @@ export class SmartContractsApi extends runtime.BaseAPI implements SmartContracts
     }
 
     /**
-     * Get contract interface using a `contract_address` and `contract name`
+     * Retrieves a contract interface with a given `contract_address` and `contract name`
      * Get contract interface
      */
     async getContractInterface(requestParameters: GetContractInterfaceRequest, initOverrides?: RequestInit): Promise<ContractInterfaceResponse> {
@@ -429,7 +456,7 @@ export class SmartContractsApi extends runtime.BaseAPI implements SmartContracts
     }
 
     /**
-     * Returns the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
+     * Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
      * Get contract source
      */
     async getContractSourceRaw(requestParameters: GetContractSourceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ContractSourceResponse>> {
@@ -464,7 +491,7 @@ export class SmartContractsApi extends runtime.BaseAPI implements SmartContracts
     }
 
     /**
-     * Returns the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
+     * Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
      * Get contract source
      */
     async getContractSource(requestParameters: GetContractSourceRequest, initOverrides?: RequestInit): Promise<ContractSourceResponse> {
@@ -472,4 +499,48 @@ export class SmartContractsApi extends runtime.BaseAPI implements SmartContracts
         return await response.value();
     }
 
+    /**
+     * Retrieves a list of contracts based on the following traits listed in JSON format -  functions, variables, maps, fungible tokens and non-fungible tokens
+     * Get contracts by trait
+     */
+    async getContractsByTraitRaw(requestParameters: GetContractsByTraitRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ContractListResponse>> {
+        if (requestParameters.traitAbi === null || requestParameters.traitAbi === undefined) {
+            throw new runtime.RequiredError('traitAbi','Required parameter requestParameters.traitAbi was null or undefined when calling getContractsByTrait.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.traitAbi !== undefined) {
+            queryParameters['trait_abi'] = requestParameters.traitAbi;
+        }
+
+        if (requestParameters.limit !== undefined) {
+            queryParameters['limit'] = requestParameters.limit;
+        }
+
+        if (requestParameters.offset !== undefined) {
+            queryParameters['offset'] = requestParameters.offset;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v1/contract/by_trait`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ContractListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a list of contracts based on the following traits listed in JSON format -  functions, variables, maps, fungible tokens and non-fungible tokens
+     * Get contracts by trait
+     */
+    async getContractsByTrait(requestParameters: GetContractsByTraitRequest, initOverrides?: RequestInit): Promise<ContractListResponse> {
+        const response = await this.getContractsByTraitRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }

package/src/generated/apis/{BurnchainApi.ts → StackingRewardsApi.ts}

@@ -1,8 +1,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
  * 
@@ -53,94 +53,94 @@ export interface GetBurnchainRewardsTotalByAddressRequest {
 }
 
 /**
- * BurnchainApi - interface
+ * StackingRewardsApi - interface
  * 
  * @export
- * @interface BurnchainApiInterface
+ * @interface StackingRewardsApiInterface
  */
-export interface BurnchainApiInterface {
+export interface StackingRewardsApiInterface {
     /**
-     * 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
      * @summary Get recent burnchain reward recipients
      * @param {number} [limit] max number of rewards to fetch
      * @param {number} [offset] index of first rewards to fetch
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BurnchainApiInterface
+     * @memberof StackingRewardsApiInterface
      */
     getBurnchainRewardListRaw(requestParameters: GetBurnchainRewardListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardListResponse>>;
 
     /**
-     * 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
      */
     getBurnchainRewardList(requestParameters: GetBurnchainRewardListRequest, initOverrides?: RequestInit): Promise<BurnchainRewardListResponse>;
 
     /**
-     * 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
      * @summary Get recent burnchain reward for the given recipient
      * @param {string} address Reward recipient address. Should either be in the native burnchain\&#39;s format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format
      * @param {number} [limit] max number of rewards to fetch
      * @param {number} [offset] index of first rewards to fetch
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BurnchainApiInterface
+     * @memberof StackingRewardsApiInterface
      */
     getBurnchainRewardListByAddressRaw(requestParameters: GetBurnchainRewardListByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardListResponse>>;
 
     /**
-     * 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
      */
     getBurnchainRewardListByAddress(requestParameters: GetBurnchainRewardListByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardListResponse>;
 
     /**
-     * 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.
      * @summary Get recent reward slot holders
      * @param {number} [limit] max number of items to fetch
      * @param {number} [offset] index of the first items to fetch
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BurnchainApiInterface
+     * @memberof StackingRewardsApiInterface
      */
     getBurnchainRewardSlotHoldersRaw(requestParameters: GetBurnchainRewardSlotHoldersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardSlotHolderListResponse>>;
 
     /**
-     * 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
      */
     getBurnchainRewardSlotHolders(requestParameters: GetBurnchainRewardSlotHoldersRequest, initOverrides?: RequestInit): Promise<BurnchainRewardSlotHolderListResponse>;
 
     /**
-     * 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.
      * @summary Get recent reward slot holder entries for the given address
      * @param {string} address Reward slot holder recipient address. Should either be in the native burnchain\&#39;s format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format
      * @param {number} [limit] max number of items to fetch
      * @param {number} [offset] index of the first items to fetch
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BurnchainApiInterface
+     * @memberof StackingRewardsApiInterface
      */
     getBurnchainRewardSlotHoldersByAddressRaw(requestParameters: GetBurnchainRewardSlotHoldersByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardSlotHolderListResponse>>;
 
     /**
-     * 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
      */
     getBurnchainRewardSlotHoldersByAddress(requestParameters: GetBurnchainRewardSlotHoldersByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardSlotHolderListResponse>;
 
     /**
-     * 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`
      * @summary Get total burnchain rewards for the given recipient
      * @param {string} address Reward recipient address. Should either be in the native burnchain\&#39;s format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BurnchainApiInterface
+     * @memberof StackingRewardsApiInterface
      */
     getBurnchainRewardsTotalByAddressRaw(requestParameters: GetBurnchainRewardsTotalByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardsTotal>>;
 
     /**
-     * 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
      */
     getBurnchainRewardsTotalByAddress(requestParameters: GetBurnchainRewardsTotalByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardsTotal>;
@@ -150,10 +150,10 @@ export interface BurnchainApiInterface {
 /**
  * 
  */
-export class BurnchainApi extends runtime.BaseAPI implements BurnchainApiInterface {
+export class StackingRewardsApi extends runtime.BaseAPI implements StackingRewardsApiInterface {
 
     /**
-     * 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: GetBurnchainRewardListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardListResponse>> {
@@ -180,7 +180,7 @@ export class BurnchainApi extends runtime.BaseAPI implements BurnchainApiInterfa
     }
 
     /**
-     * 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: GetBurnchainRewardListRequest, initOverrides?: RequestInit): Promise<BurnchainRewardListResponse> {
@@ -189,7 +189,7 @@ export class BurnchainApi extends runtime.BaseAPI implements BurnchainApiInterfa
     }
 
     /**
-     * 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: GetBurnchainRewardListByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardListResponse>> {
@@ -220,7 +220,7 @@ export class BurnchainApi extends runtime.BaseAPI implements BurnchainApiInterfa
     }
 
     /**
-     * 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: GetBurnchainRewardListByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardListResponse> {
@@ -229,7 +229,7 @@ export class BurnchainApi extends runtime.BaseAPI implements BurnchainApiInterfa
     }
 
     /**
-     * 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: GetBurnchainRewardSlotHoldersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardSlotHolderListResponse>> {
@@ -256,7 +256,7 @@ export class BurnchainApi extends runtime.BaseAPI implements BurnchainApiInterfa
     }
 
     /**
-     * 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: GetBurnchainRewardSlotHoldersRequest, initOverrides?: RequestInit): Promise<BurnchainRewardSlotHolderListResponse> {
@@ -265,7 +265,7 @@ export class BurnchainApi extends runtime.BaseAPI implements BurnchainApiInterfa
     }
 
     /**
-     * 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: GetBurnchainRewardSlotHoldersByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardSlotHolderListResponse>> {
@@ -296,7 +296,7 @@ export class BurnchainApi extends runtime.BaseAPI implements BurnchainApiInterfa
     }
 
     /**
-     * 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: GetBurnchainRewardSlotHoldersByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardSlotHolderListResponse> {
@@ -305,7 +305,7 @@ export class BurnchainApi extends runtime.BaseAPI implements BurnchainApiInterfa
     }
 
     /**
-     * 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: GetBurnchainRewardsTotalByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardsTotal>> {
@@ -328,7 +328,7 @@ export class BurnchainApi extends runtime.BaseAPI implements BurnchainApiInterfa
     }
 
     /**
-     * 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: GetBurnchainRewardsTotalByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardsTotal> {