@stacks/blockchain-api-client 8.0.3 → 8.1.0-beta.2

package/lib/types.d.ts

@@ -0,0 +1,119 @@
+import type { operations, paths } from './generated/schema';
+
+type Extract200Response<T> = T extends { 200: infer R } ? R : never;
+type ExtractOperationResponse<T extends keyof operations> = Extract200Response<operations[T]['responses']> extends { content: { 'application/json': infer U } } ? U : never;
+type PathResponse<T extends keyof paths> = paths[T]['get'] extends { responses: infer R } ? Extract200Response<R> extends { content: { 'application/json': infer U } } ? U : never : never;
+
+export type OperationResponse = {
+  [K in keyof operations]: ExtractOperationResponse<K>;
+} & {
+  [P in keyof paths]: PathResponse<P>;
+};
+
+export type Transaction = OperationResponse['get_transaction_list']['results'][number];
+export type MempoolTransaction = OperationResponse['get_mempool_transaction_list']['results'][number];
+export type Block = OperationResponse['get_block_by_height'];
+export type Microblock = OperationResponse['get_microblock_by_hash'];
+export type NakamotoBlock = OperationResponse['get_block'];
+export type BurnBlock = OperationResponse['get_burn_blocks']['results'][number];
+export type SmartContract = OperationResponse['get_contract_by_id'];
+export type AddressTransactionWithTransfers = OperationResponse['get_account_transactions_with_transfers']['results'][number];
+export type AddressStxBalanceResponse = OperationResponse['get_account_stx_balance'];
+
+export type RpcAddressTxNotificationParams = AddressTransactionWithTransfers & {
+  address: string;
+  tx_id: string;
+  tx_status: Transaction['tx_status'];
+  tx_type: Transaction['tx_type'];
+};
+export type RpcAddressBalanceNotificationParams = AddressStxBalanceResponse & {
+  address: string;
+};
+export type NftEvent = {
+  sender?: string;
+  recipient?: string;
+  asset_identifier: string;
+  asset_event_type: string;
+  value: {
+    hex: string;
+    repr: string;
+  };
+  tx_id: string;
+  tx_index: number;
+  block_height: number;
+  event_index: number;
+};
+export type RpcTxUpdateSubscriptionParams = {
+  event: "tx_update";
+  tx_id: string;
+};
+export type RpcBlockSubscriptionParams = {
+  event: "block";
+};
+export type RpcMicroblockSubscriptionParams = {
+  event: "microblock";
+};
+export type RpcMempoolSubscriptionParams = {
+  event: "mempool";
+};
+export type RpcAddressTxSubscriptionParams = {
+  event: "address_tx_update";
+  address: string;
+};
+export type RpcAddressBalanceSubscriptionParams = {
+  event: "address_balance_update";
+  address: string;
+};
+export type RpcNftEventSubscriptionParams = {
+  event: "nft_event";
+};
+export type RpcNftAssetEventSubscriptionParams = {
+  event: "nft_asset_event";
+  asset_identifier: string;
+  value: string;
+};
+export type RpcNftCollectionEventSubscriptionParams = {
+  event: "nft_collection_event";
+  asset_identifier: string;
+};
+export type RpcSubscriptionType =
+  | "tx_update"
+  | "address_tx_update"
+  | "address_balance_update"
+  | "block"
+  | "microblock"
+  | "mempool"
+  | "nft_event"
+  | "nft_asset_event"
+  | "nft_collection_event";
+export type AddressTransactionTopic = `address-transaction:${string}`;
+export type AddressStxBalanceTopic = `address-stx-balance:${string}`;
+export type TransactionTopic = `transaction:${string}`;
+export type NftAssetEventTopic = `nft-asset-event:${string}+${string}`;
+export type NftCollectionEventTopic = `nft-collection-event:${string}`;
+export type Topic =
+  | 'block'
+  | 'microblock'
+  | 'mempool'
+  | 'nft-event'
+  | AddressTransactionTopic
+  | AddressStxBalanceTopic
+  | TransactionTopic
+  | NftAssetEventTopic
+  | NftCollectionEventTopic;
+export interface ClientToServerMessages {
+  subscribe: (topic: Topic | Topic[], callback: (error: string | null) => void) => void;
+  unsubscribe: (...topic: Topic[]) => void;
+}
+
+export interface ServerToClientMessages {
+  block: (block: Block) => void;
+  microblock: (microblock: Microblock) => void;
+  mempool: (transaction: MempoolTransaction) => void;
+  'nft-event': (event: NftEvent) => void;
+  [key: TransactionTopic]: (transaction: Transaction | MempoolTransaction) => void;
+  [key: NftAssetEventTopic]: (assetIdentifier: string, value: string, event: NftEvent) => void;
+  [key: NftCollectionEventTopic]: (assetIdentifier: string, event: NftEvent) => void;
+  [key: AddressTransactionTopic]: (address: string, stxBalance: AddressTransactionWithTransfers) => void;
+  [key: AddressStxBalanceTopic]: (address: string, stxBalance: AddressStxBalanceResponse) => void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/blockchain-api-client",
-  "version": "8.0.3",
+  "version": "8.1.0-beta.2",
   "access": "public",
   "description": "Client for the Stacks Blockchain API",
   "homepage": "https://github.com/hirosystems/stacks-blockchain-api/tree/master/client#readme",
@@ -18,7 +18,7 @@
   "unpkg": "lib/index.umd.js",
   "scripts": {
     "prepublishOnly": "npm run build",
-    "build": "rimraf ./lib && npm run build:client --prefix .. && npm run build:node && npm run build:browser",
+    "build": "rimraf ./lib && npm run build:client --prefix .. && npm run build:node && npm run build:browser && cpx './src/**/*.d.ts' ./lib",
     "build:node": "tsc",
     "build:browser": "microbundle -i src/index.ts -o lib/index.umd.js --no-pkg-main -f umd --external none --globals none --no-compress --tsconfig tsconfig.browser.json --name StacksBlockchainApiClient",
     "build:browser:watch": "npm run build:browser -- watch",
@@ -38,6 +38,7 @@
   },
   "devDependencies": {
     "concurrently": "7.6.0",
+    "cpx": "1.5.0",
     "http-server": "14.0.0",
     "microbundle": "0.15.1",
     "rimraf": "6.0.1",

package/src/generated/schema.d.ts

@@ -840,7 +840,7 @@ export interface paths {
         };
         /**
          * Get account balances
-         * @description Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of  STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
+         * @description Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
          */
         get: operations["get_account_balance"];
         put?: never;
@@ -17832,6 +17832,8 @@ export interface operations {
                 content: {
                     "application/json": {
                         balance: string;
+                        /** @description Total STX balance considering pending mempool transactions */
+                        estimated_balance?: string;
                         total_sent: string;
                         total_received: string;
                         total_fees_sent: string;
@@ -17896,6 +17898,8 @@ export interface operations {
                         /** StxBalance */
                         stx: {
                             balance: string;
+                            /** @description Total STX balance considering pending mempool transactions */
+                            estimated_balance?: string;
                             total_sent: string;
                             total_received: string;
                             total_fees_sent: string;
@@ -22924,6 +22928,8 @@ export interface operations {
                              */
                             metadata?: {
                                 balance: string;
+                                /** @description Total STX balance considering pending mempool transactions */
+                                estimated_balance?: string;
                                 total_sent: string;
                                 total_received: string;
                                 total_fees_sent: string;