@stacks/blockchain-api-client 9.0.0-pox5.7 → 9.0.0-pox5.8

package/lib/generated/schema.d.ts

@@ -1188,6 +1188,33 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/extended/v1/faucets/sbtc": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Get sBTC testnet tokens
+         * @description Add sBTC tokens to the specified testnet address. The endpoint performs a SIP-010 `transfer`
+         *             contract call on the configured testnet sBTC token contract. Testnet STX addresses begin with `ST`.
+         *
+         *             The endpoint returns the transaction ID, which you can use to view the transaction in the
+         *             [Stacks Explorer](https://explorer.hiro.so/?chain=testnet). The tokens are delivered once the transaction has
+         *             been included in a block.
+         *
+         *             **Note:** This is a testnet only endpoint. This endpoint will not work on mainnet.
+         */
+        post: operations["run_faucet_sbtc"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/extended/v2/blocks/": {
         parameters: {
             query?: never;
@@ -1761,7 +1788,67 @@ export interface paths {
          * Get principal staking balances
          * @description Get a principal's staking balances: its bond positions (staked amounts and accrued rewards) across all bonds it is enrolled in
          */
-        get: operations["get_principal_staking_balances"];
+        get: operations["get_principal_balances_staking"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/principals/{principal}/balances/stx": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get principal STX balance
+         * @description Get a principal's STX balance: its total and spendable (available) balance, any locked STX, and the projected balance from pending mempool transactions.
+         */
+        get: operations["get_principal_balances_stx"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/principals/{principal}/balances/ft": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get principal FT balances
+         * @description Get a principal's fungible-token balances, sorted by balance descending.
+         */
+        get: operations["get_principal_balances_ft"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/principals/{principal}/balances/nft": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get principal NFT balances
+         * @description Get the non-fungible token instances currently owned by a principal, ordered by asset identifier and value.
+         */
+        get: operations["get_principal_balances_nft"];
         put?: never;
         post?: never;
         delete?: never;
@@ -27703,6 +27790,59 @@ export interface operations {
             };
         };
     };
+    run_faucet_sbtc: {
+        parameters: {
+            query?: {
+                /**
+                 * @description A valid testnet STX address
+                 * @example ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ
+                 */
+                address?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description POST request that initiates a transfer of tokens to a specified testnet address */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description Indicates if the faucet call was successful
+                         * @enum {boolean}
+                         */
+                        success: true;
+                        /** @description The transaction ID for the faucet call */
+                        txId: string;
+                        /** @description Raw transaction in hex string representation */
+                        txRaw: string;
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description Indicates if the faucet call was successful
+                         * @enum {boolean}
+                         */
+                        success: false;
+                        /** @description Error message */
+                        error: string;
+                    };
+                };
+            };
+        };
+    };
     get_blocks: {
         parameters: {
             query?: {
@@ -32798,7 +32938,7 @@ export interface operations {
             };
         };
     };
-    get_principal_staking_balances: {
+    get_principal_balances_staking: {
         parameters: {
             query?: never;
             header?: never;
@@ -32868,6 +33008,201 @@ export interface operations {
             };
         };
     };
+    get_principal_balances_stx: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Total micro-STX balance (available plus locked) */
+                        balance: string;
+                        /** @description Spendable micro-STX balance (balance minus locked) */
+                        available: string;
+                        locked: {
+                            /** @description The amount of locked micro-STX */
+                            amount: string;
+                            /** @description The PoX contract version that created the lock (e.g. 4, 5) */
+                            pox_version: number;
+                            /**
+                             * Transaction ID
+                             * @description Transaction ID
+                             */
+                            lock_tx_id: string;
+                            /** @description The Stacks block height at which the lock was created */
+                            stacks_lock_height: number;
+                            /** @description The burnchain block height at which the lock was created */
+                            burn_lock_height: number;
+                            /** @description The burnchain block height at which the locked STX unlocks */
+                            burn_unlock_height: number;
+                        } | null;
+                        mempool: {
+                            /** @description Estimated spendable micro-STX balance once pending mempool txs confirm */
+                            estimated_balance: string;
+                            /** @description Pending inbound micro-STX from the mempool */
+                            inbound: string;
+                            /** @description Pending outbound micro-STX from the mempool (transfers plus fees) */
+                            outbound: string;
+                        } | null;
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    get_principal_balances_ft: {
+        parameters: {
+            query?: {
+                /** @description Number of results per page */
+                limit?: number;
+                /** @description Cursor for paginating FT balances (sorted by balance, descending). Format: balance:asset_identifier */
+                cursor?: string;
+            };
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example 1 */
+                        total: number;
+                        /**
+                         * @description Number of results per page
+                         * @default 100
+                         */
+                        limit: number;
+                        cursor: {
+                            next: string | null;
+                            previous: string | null;
+                            current: string | null;
+                        };
+                        results: {
+                            /**
+                             * @description Fungible token asset identifier
+                             * @example SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token
+                             */
+                            asset_identifier: string;
+                            /** @description The principal's balance of this token, as a string-quoted integer in base units */
+                            balance: string;
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    get_principal_balances_nft: {
+        parameters: {
+            query?: {
+                /** @description Number of results per page */
+                limit?: number;
+                /** @description Cursor for paginating NFT balances (sorted by asset identifier then value). Format: value:asset_identifier */
+                cursor?: string;
+            };
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example 1 */
+                        total: number;
+                        /**
+                         * @description Number of results per page
+                         * @default 100
+                         */
+                        limit: number;
+                        cursor: {
+                            next: string | null;
+                            previous: string | null;
+                            current: string | null;
+                        };
+                        results: {
+                            /**
+                             * @description Non-fungible token asset identifier
+                             * @example SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild
+                             */
+                            asset_identifier: string;
+                            /** @description The NFT instance identifier, as a Clarity value */
+                            value: {
+                                hex: string;
+                                repr: string;
+                            };
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
     get_bonds: {
         parameters: {
             query?: {

package/package.json

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

package/src/generated/schema.d.ts

@@ -1188,6 +1188,33 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/extended/v1/faucets/sbtc": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Get sBTC testnet tokens
+         * @description Add sBTC tokens to the specified testnet address. The endpoint performs a SIP-010 `transfer`
+         *             contract call on the configured testnet sBTC token contract. Testnet STX addresses begin with `ST`.
+         *
+         *             The endpoint returns the transaction ID, which you can use to view the transaction in the
+         *             [Stacks Explorer](https://explorer.hiro.so/?chain=testnet). The tokens are delivered once the transaction has
+         *             been included in a block.
+         *
+         *             **Note:** This is a testnet only endpoint. This endpoint will not work on mainnet.
+         */
+        post: operations["run_faucet_sbtc"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/extended/v2/blocks/": {
         parameters: {
             query?: never;
@@ -1761,7 +1788,67 @@ export interface paths {
          * Get principal staking balances
          * @description Get a principal's staking balances: its bond positions (staked amounts and accrued rewards) across all bonds it is enrolled in
          */
-        get: operations["get_principal_staking_balances"];
+        get: operations["get_principal_balances_staking"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/principals/{principal}/balances/stx": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get principal STX balance
+         * @description Get a principal's STX balance: its total and spendable (available) balance, any locked STX, and the projected balance from pending mempool transactions.
+         */
+        get: operations["get_principal_balances_stx"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/principals/{principal}/balances/ft": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get principal FT balances
+         * @description Get a principal's fungible-token balances, sorted by balance descending.
+         */
+        get: operations["get_principal_balances_ft"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/extended/v3/principals/{principal}/balances/nft": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get principal NFT balances
+         * @description Get the non-fungible token instances currently owned by a principal, ordered by asset identifier and value.
+         */
+        get: operations["get_principal_balances_nft"];
         put?: never;
         post?: never;
         delete?: never;
@@ -27703,6 +27790,59 @@ export interface operations {
             };
         };
     };
+    run_faucet_sbtc: {
+        parameters: {
+            query?: {
+                /**
+                 * @description A valid testnet STX address
+                 * @example ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ
+                 */
+                address?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description POST request that initiates a transfer of tokens to a specified testnet address */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description Indicates if the faucet call was successful
+                         * @enum {boolean}
+                         */
+                        success: true;
+                        /** @description The transaction ID for the faucet call */
+                        txId: string;
+                        /** @description Raw transaction in hex string representation */
+                        txRaw: string;
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description Indicates if the faucet call was successful
+                         * @enum {boolean}
+                         */
+                        success: false;
+                        /** @description Error message */
+                        error: string;
+                    };
+                };
+            };
+        };
+    };
     get_blocks: {
         parameters: {
             query?: {
@@ -32798,7 +32938,7 @@ export interface operations {
             };
         };
     };
-    get_principal_staking_balances: {
+    get_principal_balances_staking: {
         parameters: {
             query?: never;
             header?: never;
@@ -32868,6 +33008,201 @@ export interface operations {
             };
         };
     };
+    get_principal_balances_stx: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Total micro-STX balance (available plus locked) */
+                        balance: string;
+                        /** @description Spendable micro-STX balance (balance minus locked) */
+                        available: string;
+                        locked: {
+                            /** @description The amount of locked micro-STX */
+                            amount: string;
+                            /** @description The PoX contract version that created the lock (e.g. 4, 5) */
+                            pox_version: number;
+                            /**
+                             * Transaction ID
+                             * @description Transaction ID
+                             */
+                            lock_tx_id: string;
+                            /** @description The Stacks block height at which the lock was created */
+                            stacks_lock_height: number;
+                            /** @description The burnchain block height at which the lock was created */
+                            burn_lock_height: number;
+                            /** @description The burnchain block height at which the locked STX unlocks */
+                            burn_unlock_height: number;
+                        } | null;
+                        mempool: {
+                            /** @description Estimated spendable micro-STX balance once pending mempool txs confirm */
+                            estimated_balance: string;
+                            /** @description Pending inbound micro-STX from the mempool */
+                            inbound: string;
+                            /** @description Pending outbound micro-STX from the mempool (transfers plus fees) */
+                            outbound: string;
+                        } | null;
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    get_principal_balances_ft: {
+        parameters: {
+            query?: {
+                /** @description Number of results per page */
+                limit?: number;
+                /** @description Cursor for paginating FT balances (sorted by balance, descending). Format: balance:asset_identifier */
+                cursor?: string;
+            };
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example 1 */
+                        total: number;
+                        /**
+                         * @description Number of results per page
+                         * @default 100
+                         */
+                        limit: number;
+                        cursor: {
+                            next: string | null;
+                            previous: string | null;
+                            current: string | null;
+                        };
+                        results: {
+                            /**
+                             * @description Fungible token asset identifier
+                             * @example SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token
+                             */
+                            asset_identifier: string;
+                            /** @description The principal's balance of this token, as a string-quoted integer in base units */
+                            balance: string;
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    get_principal_balances_nft: {
+        parameters: {
+            query?: {
+                /** @description Number of results per page */
+                limit?: number;
+                /** @description Cursor for paginating NFT balances (sorted by asset identifier then value). Format: value:asset_identifier */
+                cursor?: string;
+            };
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example 1 */
+                        total: number;
+                        /**
+                         * @description Number of results per page
+                         * @default 100
+                         */
+                        limit: number;
+                        cursor: {
+                            next: string | null;
+                            previous: string | null;
+                            current: string | null;
+                        };
+                        results: {
+                            /**
+                             * @description Non-fungible token asset identifier
+                             * @example SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild
+                             */
+                            asset_identifier: string;
+                            /** @description The NFT instance identifier, as a Clarity value */
+                            value: {
+                                hex: string;
+                                repr: string;
+                            };
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
     get_bonds: {
         parameters: {
             query?: {