@stacks/blockchain-api-client 8.13.5 → 8.14.0

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.
Files changed (3) hide show
  1. package/lib/generated/schema.d.ts +7 -7
  2. package/package.json +1 -1
  3. package/src/generated/schema.d.ts +7 -7
package/lib/generated/schema.d.ts CHANGED
@@ -223,7 +223,7 @@ export interface paths {
223
223
  };
224
224
  /**
225
225
  * Get total and unlocked STX supply
226
- * @description Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
226
+ * @description Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/block-production/stacking).
227
227
  */
228
228
  get: operations["get_stx_supply"];
229
229
  put?: never;
@@ -349,7 +349,7 @@ export interface paths {
349
349
  * @description Retrieves the list of Non-Fungible Tokens owned by the given principal (STX address or Smart Contract ID).
350
350
  * Results can be filtered by one or more asset identifiers and can include metadata about the transaction that made the principal own each token.
351
351
  *
352
- * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
352
+ * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).
353
353
  */
354
354
  get: operations["get_nft_holdings"];
355
355
  put?: never;
@@ -371,7 +371,7 @@ export interface paths {
371
371
  * Non-Fungible Token history
372
372
  * @description Retrieves all events relevant to a Non-Fungible Token. Useful to determine the ownership history of a particular asset.
373
373
  *
374
- * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
374
+ * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).
375
375
  */
376
376
  get: operations["get_nft_history"];
377
377
  put?: never;
@@ -393,7 +393,7 @@ export interface paths {
393
393
  * Non-Fungible Token mints
394
394
  * @description Retrieves all mint events for a Non-Fungible Token asset class. Useful to determine which NFTs of a particular collection have been claimed.
395
395
  *
396
- * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
396
+ * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).
397
397
  */
398
398
  get: operations["get_nft_mints"];
399
399
  put?: never;
@@ -844,7 +844,7 @@ export interface paths {
844
844
  * @deprecated
845
845
  * @description **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).
846
846
  *
847
- * 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).
847
+ * 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/transactions/how-transactions-work#types).
848
848
  *
849
849
  * 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.
850
850
  */
@@ -1541,7 +1541,7 @@ export interface paths {
1541
1541
  * Get address transactions
1542
1542
  * @description Retrieves a paginated list of confirmed transactions sent or received by a STX address or Smart Contract ID, alongside the total amount of STX sent or received and the number of STX, FT and NFT transfers contained within each transaction.
1543
1543
  *
1544
- * More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
1544
+ * More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types).
1545
1545
  */
1546
1546
  get: operations["get_address_transactions"];
1547
1547
  put?: never;
@@ -31292,7 +31292,7 @@ export interface operations {
31292
31292
  header?: never;
31293
31293
  path: {
31294
31294
  principal: string;
31295
- /** @description fungible token identifier */
31295
+ /** @description fungible token identifier, e.g. `SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token` */
31296
31296
  token: string;
31297
31297
  };
31298
31298
  cookie?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stacks/blockchain-api-client",
3
- "version": "8.13.5",
3
+ "version": "8.14.0",
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",
package/src/generated/schema.d.ts CHANGED
@@ -223,7 +223,7 @@ export interface paths {
223
223
  };
224
224
  /**
225
225
  * Get total and unlocked STX supply
226
- * @description Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
226
+ * @description Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/block-production/stacking).
227
227
  */
228
228
  get: operations["get_stx_supply"];
229
229
  put?: never;
@@ -349,7 +349,7 @@ export interface paths {
349
349
  * @description Retrieves the list of Non-Fungible Tokens owned by the given principal (STX address or Smart Contract ID).
350
350
  * Results can be filtered by one or more asset identifiers and can include metadata about the transaction that made the principal own each token.
351
351
  *
352
- * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
352
+ * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).
353
353
  */
354
354
  get: operations["get_nft_holdings"];
355
355
  put?: never;
@@ -371,7 +371,7 @@ export interface paths {
371
371
  * Non-Fungible Token history
372
372
  * @description Retrieves all events relevant to a Non-Fungible Token. Useful to determine the ownership history of a particular asset.
373
373
  *
374
- * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
374
+ * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).
375
375
  */
376
376
  get: operations["get_nft_history"];
377
377
  put?: never;
@@ -393,7 +393,7 @@ export interface paths {
393
393
  * Non-Fungible Token mints
394
394
  * @description Retrieves all mint events for a Non-Fungible Token asset class. Useful to determine which NFTs of a particular collection have been claimed.
395
395
  *
396
- * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
396
+ * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).
397
397
  */
398
398
  get: operations["get_nft_mints"];
399
399
  put?: never;
@@ -844,7 +844,7 @@ export interface paths {
844
844
  * @deprecated
845
845
  * @description **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).
846
846
  *
847
- * 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).
847
+ * 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/transactions/how-transactions-work#types).
848
848
  *
849
849
  * 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.
850
850
  */
@@ -1541,7 +1541,7 @@ export interface paths {
1541
1541
  * Get address transactions
1542
1542
  * @description Retrieves a paginated list of confirmed transactions sent or received by a STX address or Smart Contract ID, alongside the total amount of STX sent or received and the number of STX, FT and NFT transfers contained within each transaction.
1543
1543
  *
1544
- * More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
1544
+ * More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types).
1545
1545
  */
1546
1546
  get: operations["get_address_transactions"];
1547
1547
  put?: never;
@@ -31292,7 +31292,7 @@ export interface operations {
31292
31292
  header?: never;
31293
31293
  path: {
31294
31294
  principal: string;
31295
- /** @description fungible token identifier */
31295
+ /** @description fungible token identifier, e.g. `SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token` */
31296
31296
  token: string;
31297
31297
  };
31298
31298
  cookie?: never;