@stacks/blockchain-api-client 9.0.0-next.10 → 9.0.0-next.12
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.
- package/lib/generated/schema.d.ts +19 -44
- package/package.json +1 -1
- package/src/generated/schema.d.ts +19 -44
|
@@ -178,9 +178,7 @@ export interface paths {
|
|
|
178
178
|
/**
|
|
179
179
|
* Transactions by block hash
|
|
180
180
|
* @deprecated
|
|
181
|
-
* @description **
|
|
182
|
-
*
|
|
183
|
-
* Retrieves a list of all transactions within a block for a given block hash.
|
|
181
|
+
* @description Retrieves a list of all transactions within a block for a given block hash. **This endpoint is deprecated in favor of `get_transactions_by_block`.**
|
|
184
182
|
*/
|
|
185
183
|
get: operations["get_transactions_by_block_hash"];
|
|
186
184
|
put?: never;
|
|
@@ -201,9 +199,7 @@ export interface paths {
|
|
|
201
199
|
/**
|
|
202
200
|
* Transactions by block height
|
|
203
201
|
* @deprecated
|
|
204
|
-
* @description **
|
|
205
|
-
*
|
|
206
|
-
* Retrieves all transactions within a block at a given height
|
|
202
|
+
* @description Retrieves all transactions within a block at a given height. **This endpoint is deprecated in favor of `get_transactions_by_block`.**
|
|
207
203
|
*/
|
|
208
204
|
get: operations["get_transactions_by_block_height"];
|
|
209
205
|
put?: never;
|
|
@@ -244,7 +240,7 @@ export interface paths {
|
|
|
244
240
|
/**
|
|
245
241
|
* Get total STX supply in plain text format
|
|
246
242
|
* @deprecated
|
|
247
|
-
* @description Retrieves the total circulating STX token supply as plain text.
|
|
243
|
+
* @description Retrieves the total circulating STX token supply as plain text. **This endpoint is deprecated in favor of `get_stx_supply`.**
|
|
248
244
|
*/
|
|
249
245
|
get: operations["get_stx_supply_total_supply_plain"];
|
|
250
246
|
put?: never;
|
|
@@ -265,7 +261,7 @@ export interface paths {
|
|
|
265
261
|
/**
|
|
266
262
|
* Get circulating STX supply in plain text format
|
|
267
263
|
* @deprecated
|
|
268
|
-
* @description Retrieves the STX tokens currently in circulation that have been unlocked as plain text.
|
|
264
|
+
* @description Retrieves the STX tokens currently in circulation that have been unlocked as plain text. **This endpoint is deprecated in favor of `get_stx_supply`.**
|
|
269
265
|
*/
|
|
270
266
|
get: operations["get_stx_supply_circulating_plain"];
|
|
271
267
|
put?: never;
|
|
@@ -286,7 +282,7 @@ export interface paths {
|
|
|
286
282
|
/**
|
|
287
283
|
* Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
|
|
288
284
|
* @deprecated
|
|
289
|
-
* @description Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
|
|
285
|
+
* @description Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **This endpoint is deprecated in favor of `get_stx_supply`.**
|
|
290
286
|
*/
|
|
291
287
|
get: operations["get_total_stx_supply_legacy_format"];
|
|
292
288
|
put?: never;
|
|
@@ -579,11 +575,7 @@ export interface paths {
|
|
|
579
575
|
/**
|
|
580
576
|
* Get recent blocks
|
|
581
577
|
* @deprecated
|
|
582
|
-
* @description **
|
|
583
|
-
*
|
|
584
|
-
* Retrieves a list of recently mined blocks
|
|
585
|
-
*
|
|
586
|
-
* If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
|
|
578
|
+
* @description Retrieves a list of recently mined blocks. **This endpoint is deprecated in favor of `get_blocks`.**
|
|
587
579
|
*/
|
|
588
580
|
get: operations["get_block_list"];
|
|
589
581
|
put?: never;
|
|
@@ -604,9 +596,7 @@ export interface paths {
|
|
|
604
596
|
/**
|
|
605
597
|
* Get block by height
|
|
606
598
|
* @deprecated
|
|
607
|
-
* @description **
|
|
608
|
-
*
|
|
609
|
-
* Retrieves block details of a specific block at a given block height
|
|
599
|
+
* @description Retrieves block details of a specific block at a given block height. **This endpoint is deprecated in favor of `get_block`.**
|
|
610
600
|
*/
|
|
611
601
|
get: operations["get_block_by_height"];
|
|
612
602
|
put?: never;
|
|
@@ -627,9 +617,7 @@ export interface paths {
|
|
|
627
617
|
/**
|
|
628
618
|
* Get block by burnchain height
|
|
629
619
|
* @deprecated
|
|
630
|
-
* @description **
|
|
631
|
-
*
|
|
632
|
-
* Retrieves block details of a specific block for a given burn chain height
|
|
620
|
+
* @description Retrieves block details of a specific block for a given burn chain height. **This endpoint is deprecated in favor of `get_blocks_by_burn_block`.**
|
|
633
621
|
*/
|
|
634
622
|
get: operations["get_block_by_burn_block_height"];
|
|
635
623
|
put?: never;
|
|
@@ -650,9 +638,7 @@ export interface paths {
|
|
|
650
638
|
/**
|
|
651
639
|
* Get block by hash
|
|
652
640
|
* @deprecated
|
|
653
|
-
* @description **
|
|
654
|
-
*
|
|
655
|
-
* Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block ('get_block_list' API) to get your block details.
|
|
641
|
+
* @description Retrieves block details of a specific block for a given chain height. **This endpoint is deprecated in favor of `get_block`.**
|
|
656
642
|
*/
|
|
657
643
|
get: operations["get_block_by_hash"];
|
|
658
644
|
put?: never;
|
|
@@ -673,9 +659,7 @@ export interface paths {
|
|
|
673
659
|
/**
|
|
674
660
|
* Get block by burnchain block hash
|
|
675
661
|
* @deprecated
|
|
676
|
-
* @description **
|
|
677
|
-
*
|
|
678
|
-
* Retrieves block details of a specific block for a given burnchain block hash
|
|
662
|
+
* @description Retrieves block details of a specific block for a given burnchain block hash. **This endpoint is deprecated in favor of `get_blocks_by_burn_block`.**
|
|
679
663
|
*/
|
|
680
664
|
get: operations["get_block_by_burn_block_hash"];
|
|
681
665
|
put?: never;
|
|
@@ -796,9 +780,7 @@ export interface paths {
|
|
|
796
780
|
/**
|
|
797
781
|
* Get account STX balance
|
|
798
782
|
* @deprecated
|
|
799
|
-
* @description **
|
|
800
|
-
*
|
|
801
|
-
* Retrieves STX token balance for a given Address or Contract Identifier.
|
|
783
|
+
* @description Retrieves STX token balance for a given Address or Contract Identifier. **This endpoint is deprecated in favor of `get_principal_stx_balance`.**
|
|
802
784
|
*/
|
|
803
785
|
get: operations["get_account_stx_balance"];
|
|
804
786
|
put?: never;
|
|
@@ -819,9 +801,7 @@ export interface paths {
|
|
|
819
801
|
/**
|
|
820
802
|
* Get account balances
|
|
821
803
|
* @deprecated
|
|
822
|
-
* @description
|
|
823
|
-
*
|
|
824
|
-
* 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.
|
|
804
|
+
* @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. **This endpoint is deprecated in favor of `get_principal_ft_balances`.**
|
|
825
805
|
*/
|
|
826
806
|
get: operations["get_account_balance"];
|
|
827
807
|
put?: never;
|
|
@@ -842,11 +822,7 @@ export interface paths {
|
|
|
842
822
|
/**
|
|
843
823
|
* Get account transactions
|
|
844
824
|
* @deprecated
|
|
845
|
-
* @description **
|
|
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/transactions/how-transactions-work#types).
|
|
848
|
-
*
|
|
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.
|
|
825
|
+
* @description Retrieves a list of all Transactions for a given Address or Contract Identifier. **This endpoint is deprecated in favor of `get_address_transactions`.**
|
|
850
826
|
*/
|
|
851
827
|
get: operations["get_account_transactions"];
|
|
852
828
|
put?: never;
|
|
@@ -867,9 +843,7 @@ export interface paths {
|
|
|
867
843
|
/**
|
|
868
844
|
* Get account transaction information for specific transaction
|
|
869
845
|
* @deprecated
|
|
870
|
-
* @description **
|
|
871
|
-
*
|
|
872
|
-
* Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
|
|
846
|
+
* @description Retrieves transaction details for a given Transaction Id, for a given account or contract Identifier. **This endpoint is deprecated in favor of `get_address_transaction_events`.**
|
|
873
847
|
*/
|
|
874
848
|
get: operations["get_single_transaction_with_transfers"];
|
|
875
849
|
put?: never;
|
|
@@ -890,7 +864,7 @@ export interface paths {
|
|
|
890
864
|
/**
|
|
891
865
|
* Get account transactions including STX transfers for each transaction.
|
|
892
866
|
* @deprecated
|
|
893
|
-
* @description Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
|
|
867
|
+
* @description Retrieve all transactions for an account or contract identifier including STX transfers for each transaction. **This endpoint is deprecated in favor of `get_address_transactions`.**
|
|
894
868
|
*/
|
|
895
869
|
get: operations["get_account_transactions_with_transfers"];
|
|
896
870
|
put?: never;
|
|
@@ -910,7 +884,8 @@ export interface paths {
|
|
|
910
884
|
};
|
|
911
885
|
/**
|
|
912
886
|
* Get account assets
|
|
913
|
-
* @
|
|
887
|
+
* @deprecated
|
|
888
|
+
* @description Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints. **This endpoint is deprecated in favor of `get_address_transaction_events`.**
|
|
914
889
|
*/
|
|
915
890
|
get: operations["get_account_assets"];
|
|
916
891
|
put?: never;
|
|
@@ -930,8 +905,8 @@ export interface paths {
|
|
|
930
905
|
};
|
|
931
906
|
/**
|
|
932
907
|
* Get inbound STX transfers
|
|
933
|
-
* @
|
|
934
|
-
*
|
|
908
|
+
* @deprecated
|
|
909
|
+
* @description Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract. **This endpoint is deprecated in favor of `get_address_transactions`.**
|
|
935
910
|
*/
|
|
936
911
|
get: operations["get_account_inbound"];
|
|
937
912
|
put?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stacks/blockchain-api-client",
|
|
3
|
-
"version": "9.0.0-next.
|
|
3
|
+
"version": "9.0.0-next.12",
|
|
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",
|
|
@@ -178,9 +178,7 @@ export interface paths {
|
|
|
178
178
|
/**
|
|
179
179
|
* Transactions by block hash
|
|
180
180
|
* @deprecated
|
|
181
|
-
* @description **
|
|
182
|
-
*
|
|
183
|
-
* Retrieves a list of all transactions within a block for a given block hash.
|
|
181
|
+
* @description Retrieves a list of all transactions within a block for a given block hash. **This endpoint is deprecated in favor of `get_transactions_by_block`.**
|
|
184
182
|
*/
|
|
185
183
|
get: operations["get_transactions_by_block_hash"];
|
|
186
184
|
put?: never;
|
|
@@ -201,9 +199,7 @@ export interface paths {
|
|
|
201
199
|
/**
|
|
202
200
|
* Transactions by block height
|
|
203
201
|
* @deprecated
|
|
204
|
-
* @description **
|
|
205
|
-
*
|
|
206
|
-
* Retrieves all transactions within a block at a given height
|
|
202
|
+
* @description Retrieves all transactions within a block at a given height. **This endpoint is deprecated in favor of `get_transactions_by_block`.**
|
|
207
203
|
*/
|
|
208
204
|
get: operations["get_transactions_by_block_height"];
|
|
209
205
|
put?: never;
|
|
@@ -244,7 +240,7 @@ export interface paths {
|
|
|
244
240
|
/**
|
|
245
241
|
* Get total STX supply in plain text format
|
|
246
242
|
* @deprecated
|
|
247
|
-
* @description Retrieves the total circulating STX token supply as plain text.
|
|
243
|
+
* @description Retrieves the total circulating STX token supply as plain text. **This endpoint is deprecated in favor of `get_stx_supply`.**
|
|
248
244
|
*/
|
|
249
245
|
get: operations["get_stx_supply_total_supply_plain"];
|
|
250
246
|
put?: never;
|
|
@@ -265,7 +261,7 @@ export interface paths {
|
|
|
265
261
|
/**
|
|
266
262
|
* Get circulating STX supply in plain text format
|
|
267
263
|
* @deprecated
|
|
268
|
-
* @description Retrieves the STX tokens currently in circulation that have been unlocked as plain text.
|
|
264
|
+
* @description Retrieves the STX tokens currently in circulation that have been unlocked as plain text. **This endpoint is deprecated in favor of `get_stx_supply`.**
|
|
269
265
|
*/
|
|
270
266
|
get: operations["get_stx_supply_circulating_plain"];
|
|
271
267
|
put?: never;
|
|
@@ -286,7 +282,7 @@ export interface paths {
|
|
|
286
282
|
/**
|
|
287
283
|
* Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
|
|
288
284
|
* @deprecated
|
|
289
|
-
* @description Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
|
|
285
|
+
* @description Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **This endpoint is deprecated in favor of `get_stx_supply`.**
|
|
290
286
|
*/
|
|
291
287
|
get: operations["get_total_stx_supply_legacy_format"];
|
|
292
288
|
put?: never;
|
|
@@ -579,11 +575,7 @@ export interface paths {
|
|
|
579
575
|
/**
|
|
580
576
|
* Get recent blocks
|
|
581
577
|
* @deprecated
|
|
582
|
-
* @description **
|
|
583
|
-
*
|
|
584
|
-
* Retrieves a list of recently mined blocks
|
|
585
|
-
*
|
|
586
|
-
* If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
|
|
578
|
+
* @description Retrieves a list of recently mined blocks. **This endpoint is deprecated in favor of `get_blocks`.**
|
|
587
579
|
*/
|
|
588
580
|
get: operations["get_block_list"];
|
|
589
581
|
put?: never;
|
|
@@ -604,9 +596,7 @@ export interface paths {
|
|
|
604
596
|
/**
|
|
605
597
|
* Get block by height
|
|
606
598
|
* @deprecated
|
|
607
|
-
* @description **
|
|
608
|
-
*
|
|
609
|
-
* Retrieves block details of a specific block at a given block height
|
|
599
|
+
* @description Retrieves block details of a specific block at a given block height. **This endpoint is deprecated in favor of `get_block`.**
|
|
610
600
|
*/
|
|
611
601
|
get: operations["get_block_by_height"];
|
|
612
602
|
put?: never;
|
|
@@ -627,9 +617,7 @@ export interface paths {
|
|
|
627
617
|
/**
|
|
628
618
|
* Get block by burnchain height
|
|
629
619
|
* @deprecated
|
|
630
|
-
* @description **
|
|
631
|
-
*
|
|
632
|
-
* Retrieves block details of a specific block for a given burn chain height
|
|
620
|
+
* @description Retrieves block details of a specific block for a given burn chain height. **This endpoint is deprecated in favor of `get_blocks_by_burn_block`.**
|
|
633
621
|
*/
|
|
634
622
|
get: operations["get_block_by_burn_block_height"];
|
|
635
623
|
put?: never;
|
|
@@ -650,9 +638,7 @@ export interface paths {
|
|
|
650
638
|
/**
|
|
651
639
|
* Get block by hash
|
|
652
640
|
* @deprecated
|
|
653
|
-
* @description **
|
|
654
|
-
*
|
|
655
|
-
* Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block ('get_block_list' API) to get your block details.
|
|
641
|
+
* @description Retrieves block details of a specific block for a given chain height. **This endpoint is deprecated in favor of `get_block`.**
|
|
656
642
|
*/
|
|
657
643
|
get: operations["get_block_by_hash"];
|
|
658
644
|
put?: never;
|
|
@@ -673,9 +659,7 @@ export interface paths {
|
|
|
673
659
|
/**
|
|
674
660
|
* Get block by burnchain block hash
|
|
675
661
|
* @deprecated
|
|
676
|
-
* @description **
|
|
677
|
-
*
|
|
678
|
-
* Retrieves block details of a specific block for a given burnchain block hash
|
|
662
|
+
* @description Retrieves block details of a specific block for a given burnchain block hash. **This endpoint is deprecated in favor of `get_blocks_by_burn_block`.**
|
|
679
663
|
*/
|
|
680
664
|
get: operations["get_block_by_burn_block_hash"];
|
|
681
665
|
put?: never;
|
|
@@ -796,9 +780,7 @@ export interface paths {
|
|
|
796
780
|
/**
|
|
797
781
|
* Get account STX balance
|
|
798
782
|
* @deprecated
|
|
799
|
-
* @description **
|
|
800
|
-
*
|
|
801
|
-
* Retrieves STX token balance for a given Address or Contract Identifier.
|
|
783
|
+
* @description Retrieves STX token balance for a given Address or Contract Identifier. **This endpoint is deprecated in favor of `get_principal_stx_balance`.**
|
|
802
784
|
*/
|
|
803
785
|
get: operations["get_account_stx_balance"];
|
|
804
786
|
put?: never;
|
|
@@ -819,9 +801,7 @@ export interface paths {
|
|
|
819
801
|
/**
|
|
820
802
|
* Get account balances
|
|
821
803
|
* @deprecated
|
|
822
|
-
* @description
|
|
823
|
-
*
|
|
824
|
-
* 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.
|
|
804
|
+
* @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. **This endpoint is deprecated in favor of `get_principal_ft_balances`.**
|
|
825
805
|
*/
|
|
826
806
|
get: operations["get_account_balance"];
|
|
827
807
|
put?: never;
|
|
@@ -842,11 +822,7 @@ export interface paths {
|
|
|
842
822
|
/**
|
|
843
823
|
* Get account transactions
|
|
844
824
|
* @deprecated
|
|
845
|
-
* @description **
|
|
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/transactions/how-transactions-work#types).
|
|
848
|
-
*
|
|
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.
|
|
825
|
+
* @description Retrieves a list of all Transactions for a given Address or Contract Identifier. **This endpoint is deprecated in favor of `get_address_transactions`.**
|
|
850
826
|
*/
|
|
851
827
|
get: operations["get_account_transactions"];
|
|
852
828
|
put?: never;
|
|
@@ -867,9 +843,7 @@ export interface paths {
|
|
|
867
843
|
/**
|
|
868
844
|
* Get account transaction information for specific transaction
|
|
869
845
|
* @deprecated
|
|
870
|
-
* @description **
|
|
871
|
-
*
|
|
872
|
-
* Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
|
|
846
|
+
* @description Retrieves transaction details for a given Transaction Id, for a given account or contract Identifier. **This endpoint is deprecated in favor of `get_address_transaction_events`.**
|
|
873
847
|
*/
|
|
874
848
|
get: operations["get_single_transaction_with_transfers"];
|
|
875
849
|
put?: never;
|
|
@@ -890,7 +864,7 @@ export interface paths {
|
|
|
890
864
|
/**
|
|
891
865
|
* Get account transactions including STX transfers for each transaction.
|
|
892
866
|
* @deprecated
|
|
893
|
-
* @description Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
|
|
867
|
+
* @description Retrieve all transactions for an account or contract identifier including STX transfers for each transaction. **This endpoint is deprecated in favor of `get_address_transactions`.**
|
|
894
868
|
*/
|
|
895
869
|
get: operations["get_account_transactions_with_transfers"];
|
|
896
870
|
put?: never;
|
|
@@ -910,7 +884,8 @@ export interface paths {
|
|
|
910
884
|
};
|
|
911
885
|
/**
|
|
912
886
|
* Get account assets
|
|
913
|
-
* @
|
|
887
|
+
* @deprecated
|
|
888
|
+
* @description Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints. **This endpoint is deprecated in favor of `get_address_transaction_events`.**
|
|
914
889
|
*/
|
|
915
890
|
get: operations["get_account_assets"];
|
|
916
891
|
put?: never;
|
|
@@ -930,8 +905,8 @@ export interface paths {
|
|
|
930
905
|
};
|
|
931
906
|
/**
|
|
932
907
|
* Get inbound STX transfers
|
|
933
|
-
* @
|
|
934
|
-
*
|
|
908
|
+
* @deprecated
|
|
909
|
+
* @description Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract. **This endpoint is deprecated in favor of `get_address_transactions`.**
|
|
935
910
|
*/
|
|
936
911
|
get: operations["get_account_inbound"];
|
|
937
912
|
put?: never;
|