@stacks/blockchain-api-client 7.12.0 → 7.13.0

package/package.json

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

package/src/generated/.openapi-generator/FILES

@@ -4,6 +4,7 @@ apis/BlocksApi.ts
 apis/BurnBlocksApi.ts
 apis/FaucetsApi.ts
 apis/FeesApi.ts
+apis/FungibleTokensApi.ts
 apis/InfoApi.ts
 apis/MempoolApi.ts
 apis/MicroblocksApi.ts
@@ -61,6 +62,8 @@ models/CoreNodeInfoResponse.ts
 models/CoreNodePoxResponse.ts
 models/FeeRate.ts
 models/FeeRateRequest.ts
+models/FtHolderEntry.ts
+models/FungibleTokenHolderList.ts
 models/GetRawTransactionResult.ts
 models/GetStxSupplyLegacyFormatResponse.ts
 models/GetStxSupplyResponse.ts

package/src/generated/apis/AccountsApi.ts

@@ -226,7 +226,7 @@ export interface AccountsApiInterface {
     getAccountStxBalance(requestParameters: GetAccountStxBalanceRequest, initOverrides?: RequestInit): Promise<object>;
 
     /**
-     * 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. 
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  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
      * @param {number} [limit] max number of account transactions to fetch
@@ -241,7 +241,7 @@ export interface AccountsApiInterface {
     getAccountTransactionsRaw(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionsListResponse>>;
 
     /**
-     * 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. 
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  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. 
      * Get account transactions
      */
     getAccountTransactions(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<AddressTransactionsListResponse>;
@@ -268,7 +268,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.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier. 
      * @summary Get account transaction information for specific transaction
      * @param {string} principal Stacks address or a contract identifier
      * @param {string} txId Transaction id
@@ -279,7 +279,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.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier. 
      * Get account transaction information for specific transaction
      */
     getSingleTransactionWithTransfers(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionWithTransfers>;
@@ -552,7 +552,7 @@ export class AccountsApi extends runtime.BaseAPI implements 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. 
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  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. 
      * Get account transactions
      */
     async getAccountTransactionsRaw(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionsListResponse>> {
@@ -595,7 +595,7 @@ export class AccountsApi extends runtime.BaseAPI implements 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. 
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  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. 
      * Get account transactions
      */
     async getAccountTransactions(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<AddressTransactionsListResponse> {
@@ -656,7 +656,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.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier. 
      * Get account transaction information for specific transaction
      */
     async getSingleTransactionWithTransfersRaw(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionWithTransfers>> {
@@ -683,7 +683,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.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier. 
      * Get account transaction information for specific transaction
      */
     async getSingleTransactionWithTransfers(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionWithTransfers> {

package/src/generated/apis/FungibleTokensApi.ts

@@ -0,0 +1,89 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/stacks-blockchain-api).  [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json) 
+ *
+ * The version of the OpenAPI document: STACKS_API_VERSION
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import {
+    FungibleTokenHolderList,
+    FungibleTokenHolderListFromJSON,
+    FungibleTokenHolderListToJSON,
+} from '../models';
+
+export interface GetFtHoldersRequest {
+    token: string;
+}
+
+/**
+ * FungibleTokensApi - interface
+ * 
+ * @export
+ * @interface FungibleTokensApiInterface
+ */
+export interface FungibleTokensApiInterface {
+    /**
+     * Retrieves the list of Fungible Token holders for a given token ID. Specify `stx` for the `token` parameter to get the list of STX holders. 
+     * @summary Fungible token holders
+     * @param {string} token fungible token identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FungibleTokensApiInterface
+     */
+    getFtHoldersRaw(requestParameters: GetFtHoldersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenHolderList>>;
+
+    /**
+     * Retrieves the list of Fungible Token holders for a given token ID. Specify `stx` for the `token` parameter to get the list of STX holders. 
+     * Fungible token holders
+     */
+    getFtHolders(requestParameters: GetFtHoldersRequest, initOverrides?: RequestInit): Promise<FungibleTokenHolderList>;
+
+}
+
+/**
+ * 
+ */
+export class FungibleTokensApi extends runtime.BaseAPI implements FungibleTokensApiInterface {
+
+    /**
+     * Retrieves the list of Fungible Token holders for a given token ID. Specify `stx` for the `token` parameter to get the list of STX holders. 
+     * Fungible token holders
+     */
+    async getFtHoldersRaw(requestParameters: GetFtHoldersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenHolderList>> {
+        if (requestParameters.token === null || requestParameters.token === undefined) {
+            throw new runtime.RequiredError('token','Required parameter requestParameters.token was null or undefined when calling getFtHolders.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v1/tokens/ft/{token}/holders`.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters.token))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FungibleTokenHolderListFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves the list of Fungible Token holders for a given token ID. Specify `stx` for the `token` parameter to get the list of STX holders. 
+     * Fungible token holders
+     */
+    async getFtHolders(requestParameters: GetFtHoldersRequest, initOverrides?: RequestInit): Promise<FungibleTokenHolderList> {
+        const response = await this.getFtHoldersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/generated/apis/index.ts

@@ -5,6 +5,7 @@ export * from './BlocksApi';
 export * from './BurnBlocksApi';
 export * from './FaucetsApi';
 export * from './FeesApi';
+export * from './FungibleTokensApi';
 export * from './InfoApi';
 export * from './MempoolApi';
 export * from './MicroblocksApi';

package/src/generated/models/FtHolderEntry.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/stacks-blockchain-api).  [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json) 
+ *
+ * The version of the OpenAPI document: STACKS_API_VERSION
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface FtHolderEntry
+ */
+export interface FtHolderEntry {
+    /**
+     * 
+     * @type {string}
+     * @memberof FtHolderEntry
+     */
+    address: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FtHolderEntry
+     */
+    balance: string;
+}
+
+export function FtHolderEntryFromJSON(json: any): FtHolderEntry {
+    return FtHolderEntryFromJSONTyped(json, false);
+}
+
+export function FtHolderEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): FtHolderEntry {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'address': json['address'],
+        'balance': json['balance'],
+    };
+}
+
+export function FtHolderEntryToJSON(value?: FtHolderEntry | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'address': value.address,
+        'balance': value.balance,
+    };
+}
+

package/src/generated/models/FungibleTokenHolderList.ts

@@ -0,0 +1,95 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/stacks-blockchain-api).  [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json) 
+ *
+ * The version of the OpenAPI document: STACKS_API_VERSION
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    FtHolderEntry,
+    FtHolderEntryFromJSON,
+    FtHolderEntryFromJSONTyped,
+    FtHolderEntryToJSON,
+} from './';
+
+/**
+ * List of Fungible Token holders
+ * @export
+ * @interface FungibleTokenHolderList
+ */
+export interface FungibleTokenHolderList {
+    /**
+     * The number of holders to return
+     * @type {number}
+     * @memberof FungibleTokenHolderList
+     */
+    limit: number;
+    /**
+     * The number to holders to skip (starting at `0`)
+     * @type {number}
+     * @memberof FungibleTokenHolderList
+     */
+    offset: number;
+    /**
+     * The number of holders available
+     * @type {number}
+     * @memberof FungibleTokenHolderList
+     */
+    total: number;
+    /**
+     * The total supply of the token (the sum of all balances)
+     * @type {string}
+     * @memberof FungibleTokenHolderList
+     */
+    total_supply: string;
+    /**
+     * 
+     * @type {Array<FtHolderEntry>}
+     * @memberof FungibleTokenHolderList
+     */
+    results: Array<FtHolderEntry>;
+}
+
+export function FungibleTokenHolderListFromJSON(json: any): FungibleTokenHolderList {
+    return FungibleTokenHolderListFromJSONTyped(json, false);
+}
+
+export function FungibleTokenHolderListFromJSONTyped(json: any, ignoreDiscriminator: boolean): FungibleTokenHolderList {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'limit': json['limit'],
+        'offset': json['offset'],
+        'total': json['total'],
+        'total_supply': json['total_supply'],
+        'results': ((json['results'] as Array<any>).map(FtHolderEntryFromJSON)),
+    };
+}
+
+export function FungibleTokenHolderListToJSON(value?: FungibleTokenHolderList | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'limit': value.limit,
+        'offset': value.offset,
+        'total': value.total,
+        'total_supply': value.total_supply,
+        'results': ((value.results as Array<any>).map(FtHolderEntryToJSON)),
+    };
+}
+

package/src/generated/models/index.ts

@@ -43,6 +43,8 @@ export * from './CoreNodeInfoResponse';
 export * from './CoreNodePoxResponse';
 export * from './FeeRate';
 export * from './FeeRateRequest';
+export * from './FtHolderEntry';
+export * from './FungibleTokenHolderList';
 export * from './GetRawTransactionResult';
 export * from './GetStxSupplyLegacyFormatResponse';
 export * from './GetStxSupplyResponse';