@stacks/blockchain-api-client 8.3.0 → 8.4.0

package/lib/generated/schema.d.ts

@@ -1166,13 +1166,13 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Add testnet BTC tokens to address
-         * @description Add 1 BTC token to the specified testnet BTC address.
+         * Add regtest BTC tokens to address
+         * @description Add 0.01 BTC token to the specified regtest BTC address.
          *
-         *             The endpoint returns the transaction ID, which you can use to view the transaction in a testnet Bitcoin block
+         *             The endpoint returns the transaction ID, which you can use to view the transaction in a regtest Bitcoin block
          *             explorer. 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 the mainnet.
+         *             **Note:** This is a Bitcoin regtest-only endpoint. This endpoint will not work on the Bitcoin mainnet.
          */
         post: operations["run_faucet_btc"];
         delete?: never;
@@ -27680,10 +27680,14 @@ export interface operations {
         parameters: {
             query?: {
                 /**
-                 * @description A valid testnet BTC address
+                 * @description A valid regtest BTC address
                  * @example 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts
                  */
                 address?: string;
+                /** @description Request a large amount of regtest BTC than the default */
+                large?: boolean;
+                /** @description Request an extra large amount of regtest BTC than the default */
+                xlarge?: boolean;
             };
             header?: never;
             path?: never;
@@ -27692,13 +27696,13 @@ export interface operations {
         requestBody?: {
             content: {
                 "application/json": {
-                    /** @description A valid testnet BTC address */
+                    /** @description A valid regtest BTC address */
                     address?: string;
                 } | null;
             };
         };
         responses: {
-            /** @description POST request that initiates a transfer of tokens to a specified testnet address */
+            /** @description POST request that initiates a transfer of tokens to a specified Bitcoin regtest address */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -27739,7 +27743,7 @@ export interface operations {
             header?: never;
             path: {
                 /**
-                 * @description A valid testnet BTC address
+                 * @description A valid regtest BTC address
                  * @example 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts
                  */
                 address: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/blockchain-api-client",
-  "version": "8.3.0",
+  "version": "8.4.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/schema.d.ts

@@ -1166,13 +1166,13 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Add testnet BTC tokens to address
-         * @description Add 1 BTC token to the specified testnet BTC address.
+         * Add regtest BTC tokens to address
+         * @description Add 0.01 BTC token to the specified regtest BTC address.
          *
-         *             The endpoint returns the transaction ID, which you can use to view the transaction in a testnet Bitcoin block
+         *             The endpoint returns the transaction ID, which you can use to view the transaction in a regtest Bitcoin block
          *             explorer. 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 the mainnet.
+         *             **Note:** This is a Bitcoin regtest-only endpoint. This endpoint will not work on the Bitcoin mainnet.
          */
         post: operations["run_faucet_btc"];
         delete?: never;
@@ -27680,10 +27680,14 @@ export interface operations {
         parameters: {
             query?: {
                 /**
-                 * @description A valid testnet BTC address
+                 * @description A valid regtest BTC address
                  * @example 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts
                  */
                 address?: string;
+                /** @description Request a large amount of regtest BTC than the default */
+                large?: boolean;
+                /** @description Request an extra large amount of regtest BTC than the default */
+                xlarge?: boolean;
             };
             header?: never;
             path?: never;
@@ -27692,13 +27696,13 @@ export interface operations {
         requestBody?: {
             content: {
                 "application/json": {
-                    /** @description A valid testnet BTC address */
+                    /** @description A valid regtest BTC address */
                     address?: string;
                 } | null;
             };
         };
         responses: {
-            /** @description POST request that initiates a transfer of tokens to a specified testnet address */
+            /** @description POST request that initiates a transfer of tokens to a specified Bitcoin regtest address */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -27739,7 +27743,7 @@ export interface operations {
             header?: never;
             path: {
                 /**
-                 * @description A valid testnet BTC address
+                 * @description A valid regtest BTC address
                  * @example 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts
                  */
                 address: string;