@stacks/blockchain-api-client 8.3.0 → 8.5.0-redis-stream.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1166,13 +1166,13 @@ export interface paths {
1166
1166
  get?: never;
1167
1167
  put?: never;
1168
1168
  /**
1169
- * Add testnet BTC tokens to address
1170
- * @description Add 1 BTC token to the specified testnet BTC address.
1169
+ * Add regtest BTC tokens to address
1170
+ * @description Add 0.01 BTC token to the specified regtest BTC address.
1171
1171
  *
1172
- * The endpoint returns the transaction ID, which you can use to view the transaction in a testnet Bitcoin block
1172
+ * The endpoint returns the transaction ID, which you can use to view the transaction in a regtest Bitcoin block
1173
1173
  * explorer. The tokens are delivered once the transaction has been included in a block.
1174
1174
  *
1175
- * **Note:** This is a testnet only endpoint. This endpoint will not work on the mainnet.
1175
+ * **Note:** This is a Bitcoin regtest-only endpoint. This endpoint will not work on the Bitcoin mainnet.
1176
1176
  */
1177
1177
  post: operations["run_faucet_btc"];
1178
1178
  delete?: never;
@@ -11689,11 +11689,6 @@ export interface operations {
11689
11689
  limit?: number;
11690
11690
  /** @description index of first tokens to fetch */
11691
11691
  offset?: number;
11692
- /**
11693
- * @description Include data from unanchored (i.e. unconfirmed) microblocks
11694
- * @example true
11695
- */
11696
- unanchored?: boolean;
11697
11692
  /** @description whether or not to include the complete transaction metadata instead of just `tx_id`. Enabling this option can affect performance and response times. */
11698
11693
  tx_metadata: boolean;
11699
11694
  };
@@ -27680,10 +27675,14 @@ export interface operations {
27680
27675
  parameters: {
27681
27676
  query?: {
27682
27677
  /**
27683
- * @description A valid testnet BTC address
27678
+ * @description A valid regtest BTC address
27684
27679
  * @example 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts
27685
27680
  */
27686
27681
  address?: string;
27682
+ /** @description Request a large amount of regtest BTC than the default */
27683
+ large?: boolean;
27684
+ /** @description Request an extra large amount of regtest BTC than the default */
27685
+ xlarge?: boolean;
27687
27686
  };
27688
27687
  header?: never;
27689
27688
  path?: never;
@@ -27692,13 +27691,13 @@ export interface operations {
27692
27691
  requestBody?: {
27693
27692
  content: {
27694
27693
  "application/json": {
27695
- /** @description A valid testnet BTC address */
27694
+ /** @description A valid regtest BTC address */
27696
27695
  address?: string;
27697
27696
  } | null;
27698
27697
  };
27699
27698
  };
27700
27699
  responses: {
27701
- /** @description POST request that initiates a transfer of tokens to a specified testnet address */
27700
+ /** @description POST request that initiates a transfer of tokens to a specified Bitcoin regtest address */
27702
27701
  200: {
27703
27702
  headers: {
27704
27703
  [name: string]: unknown;
@@ -27739,7 +27738,7 @@ export interface operations {
27739
27738
  header?: never;
27740
27739
  path: {
27741
27740
  /**
27742
- * @description A valid testnet BTC address
27741
+ * @description A valid regtest BTC address
27743
27742
  * @example 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts
27744
27743
  */
27745
27744
  address: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stacks/blockchain-api-client",
3
- "version": "8.3.0",
3
+ "version": "8.5.0-redis-stream.1",
4
4
  "access": "public",
5
5
  "description": "Client for the Stacks Blockchain API",
6
6
  "homepage": "https://github.com/hirosystems/stacks-blockchain-api/tree/master/client#readme",
@@ -1166,13 +1166,13 @@ export interface paths {
1166
1166
  get?: never;
1167
1167
  put?: never;
1168
1168
  /**
1169
- * Add testnet BTC tokens to address
1170
- * @description Add 1 BTC token to the specified testnet BTC address.
1169
+ * Add regtest BTC tokens to address
1170
+ * @description Add 0.01 BTC token to the specified regtest BTC address.
1171
1171
  *
1172
- * The endpoint returns the transaction ID, which you can use to view the transaction in a testnet Bitcoin block
1172
+ * The endpoint returns the transaction ID, which you can use to view the transaction in a regtest Bitcoin block
1173
1173
  * explorer. The tokens are delivered once the transaction has been included in a block.
1174
1174
  *
1175
- * **Note:** This is a testnet only endpoint. This endpoint will not work on the mainnet.
1175
+ * **Note:** This is a Bitcoin regtest-only endpoint. This endpoint will not work on the Bitcoin mainnet.
1176
1176
  */
1177
1177
  post: operations["run_faucet_btc"];
1178
1178
  delete?: never;
@@ -11689,11 +11689,6 @@ export interface operations {
11689
11689
  limit?: number;
11690
11690
  /** @description index of first tokens to fetch */
11691
11691
  offset?: number;
11692
- /**
11693
- * @description Include data from unanchored (i.e. unconfirmed) microblocks
11694
- * @example true
11695
- */
11696
- unanchored?: boolean;
11697
11692
  /** @description whether or not to include the complete transaction metadata instead of just `tx_id`. Enabling this option can affect performance and response times. */
11698
11693
  tx_metadata: boolean;
11699
11694
  };
@@ -27680,10 +27675,14 @@ export interface operations {
27680
27675
  parameters: {
27681
27676
  query?: {
27682
27677
  /**
27683
- * @description A valid testnet BTC address
27678
+ * @description A valid regtest BTC address
27684
27679
  * @example 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts
27685
27680
  */
27686
27681
  address?: string;
27682
+ /** @description Request a large amount of regtest BTC than the default */
27683
+ large?: boolean;
27684
+ /** @description Request an extra large amount of regtest BTC than the default */
27685
+ xlarge?: boolean;
27687
27686
  };
27688
27687
  header?: never;
27689
27688
  path?: never;
@@ -27692,13 +27691,13 @@ export interface operations {
27692
27691
  requestBody?: {
27693
27692
  content: {
27694
27693
  "application/json": {
27695
- /** @description A valid testnet BTC address */
27694
+ /** @description A valid regtest BTC address */
27696
27695
  address?: string;
27697
27696
  } | null;
27698
27697
  };
27699
27698
  };
27700
27699
  responses: {
27701
- /** @description POST request that initiates a transfer of tokens to a specified testnet address */
27700
+ /** @description POST request that initiates a transfer of tokens to a specified Bitcoin regtest address */
27702
27701
  200: {
27703
27702
  headers: {
27704
27703
  [name: string]: unknown;
@@ -27739,7 +27738,7 @@ export interface operations {
27739
27738
  header?: never;
27740
27739
  path: {
27741
27740
  /**
27742
- * @description A valid testnet BTC address
27741
+ * @description A valid regtest BTC address
27743
27742
  * @example 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts
27744
27743
  */
27745
27744
  address: string;