@stacks/blockchain-api-client 9.0.0-pox5.12 → 9.0.0-pox5.14

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.
@@ -33,7 +33,8 @@ export interface paths {
33
33
  };
34
34
  /**
35
35
  * Get recent transactions
36
- * @description Retrieves all recently mined transactions
36
+ * @deprecated
37
+ * @description Retrieves all recently mined transactions. **Deprecated:** use `GET /extended/v3/transactions` instead.
37
38
  */
38
39
  get: operations["get_transaction_list"];
39
40
  put?: never;
@@ -73,9 +74,12 @@ export interface paths {
73
74
  };
74
75
  /**
75
76
  * Get mempool transactions
77
+ * @deprecated
76
78
  * @description Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
77
79
  *
78
80
  * If you need to monitor new transactions, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
81
+ *
82
+ * **Deprecated:** use `GET /extended/v3/mempool/transactions` instead.
79
83
  */
80
84
  get: operations["get_mempool_transaction_list"];
81
85
  put?: never;
@@ -116,8 +120,11 @@ export interface paths {
116
120
  };
117
121
  /**
118
122
  * Transaction Events
123
+ * @deprecated
119
124
  * @description Retrieves the list of events filtered by principal (STX address or Smart Contract ID), transaction id or event types.
120
125
  * The list of event types is ('smart_contract_log', 'stx_lock', 'stx_asset', 'fungible_token_asset', 'non_fungible_token_asset').
126
+ *
127
+ * **Deprecated:** this endpoint has no direct v3 replacement.
121
128
  */
122
129
  get: operations["get_filtered_events"];
123
130
  put?: never;
@@ -137,7 +144,8 @@ export interface paths {
137
144
  };
138
145
  /**
139
146
  * Get transaction
140
- * @description Retrieves transaction details for a given transaction ID
147
+ * @deprecated
148
+ * @description Retrieves transaction details for a given transaction ID. **Deprecated:** use `GET /extended/v3/transactions/{tx_id}` instead.
141
149
  */
142
150
  get: operations["get_transaction_by_id"];
143
151
  put?: never;
@@ -157,7 +165,8 @@ export interface paths {
157
165
  };
158
166
  /**
159
167
  * Get raw transaction
160
- * @description Retrieves a hex encoded serialized transaction for a given ID
168
+ * @deprecated
169
+ * @description Retrieves a hex encoded serialized transaction for a given ID. **Deprecated:** use the Stacks node RPC endpoint `GET /v3/transaction/{tx_id}` to fetch a single raw transaction instead.
161
170
  */
162
171
  get: operations["get_raw_transaction_by_id"];
163
172
  put?: never;
@@ -178,7 +187,7 @@ export interface paths {
178
187
  /**
179
188
  * Transactions by block hash
180
189
  * @deprecated
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`.**
190
+ * @description Retrieves a list of all transactions within a block for a given block hash. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead.
182
191
  */
183
192
  get: operations["get_transactions_by_block_hash"];
184
193
  put?: never;
@@ -199,7 +208,7 @@ export interface paths {
199
208
  /**
200
209
  * Transactions by block height
201
210
  * @deprecated
202
- * @description Retrieves all transactions within a block at a given height. **This endpoint is deprecated in favor of `get_transactions_by_block`.**
211
+ * @description Retrieves all transactions within a block at a given height. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead.
203
212
  */
204
213
  get: operations["get_transactions_by_block_height"];
205
214
  put?: never;
@@ -342,10 +351,13 @@ export interface paths {
342
351
  };
343
352
  /**
344
353
  * Non-Fungible Token holdings
354
+ * @deprecated
345
355
  * @description Retrieves the list of Non-Fungible Tokens owned by the given principal (STX address or Smart Contract ID).
346
356
  * Results can be filtered by one or more asset identifiers and can include metadata about the transaction that made the principal own each token.
347
357
  *
348
358
  * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).
359
+ *
360
+ * **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/nft` instead.
349
361
  */
350
362
  get: operations["get_nft_holdings"];
351
363
  put?: never;
@@ -783,7 +795,7 @@ export interface paths {
783
795
  /**
784
796
  * Get account STX balance
785
797
  * @deprecated
786
- * @description Retrieves STX token balance for a given Address or Contract Identifier. **This endpoint is deprecated in favor of `get_principal_stx_balance`.**
798
+ * @description Retrieves STX token balance for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx` instead.
787
799
  */
788
800
  get: operations["get_account_stx_balance"];
789
801
  put?: never;
@@ -804,7 +816,7 @@ export interface paths {
804
816
  /**
805
817
  * Get account balances
806
818
  * @deprecated
807
- * @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`.**
819
+ * @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. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx`, `GET /extended/v3/principals/{principal}/balances/ft`, and `GET /extended/v3/principals/{principal}/balances/nft` instead.
808
820
  */
809
821
  get: operations["get_account_balance"];
810
822
  put?: never;
@@ -825,7 +837,7 @@ export interface paths {
825
837
  /**
826
838
  * Get account transactions
827
839
  * @deprecated
828
- * @description Retrieves a list of all Transactions for a given Address or Contract Identifier. **This endpoint is deprecated in favor of `get_address_transactions`.**
840
+ * @description Retrieves a list of all Transactions for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead.
829
841
  */
830
842
  get: operations["get_account_transactions"];
831
843
  put?: never;
@@ -846,7 +858,7 @@ export interface paths {
846
858
  /**
847
859
  * Get account transaction information for specific transaction
848
860
  * @deprecated
849
- * @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`.**
861
+ * @description Retrieves transaction details for a given Transaction Id, for a given account or contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes` instead.
850
862
  */
851
863
  get: operations["get_single_transaction_with_transfers"];
852
864
  put?: never;
@@ -867,7 +879,7 @@ export interface paths {
867
879
  /**
868
880
  * Get account transactions including STX transfers for each transaction.
869
881
  * @deprecated
870
- * @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`.**
882
+ * @description Retrieve all transactions for an account or contract identifier including STX transfers for each transaction. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead.
871
883
  */
872
884
  get: operations["get_account_transactions_with_transfers"];
873
885
  put?: never;
@@ -888,7 +900,7 @@ export interface paths {
888
900
  /**
889
901
  * Get account assets
890
902
  * @deprecated
891
- * @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`.**
903
+ * @description Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints. **Deprecated:** this endpoint has no direct v3 replacement; the closest equivalent is `GET /extended/v3/principals/{principal}/balance-changes`.
892
904
  */
893
905
  get: operations["get_account_assets"];
894
906
  put?: never;
@@ -909,7 +921,7 @@ export interface paths {
909
921
  /**
910
922
  * Get inbound STX transfers
911
923
  * @deprecated
912
- * @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`.**
924
+ * @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 at the `send-many-memo` bulk sending contract. **Deprecated:** this endpoint has no direct v3 replacement.
913
925
  */
914
926
  get: operations["get_account_inbound"];
915
927
  put?: never;
@@ -929,7 +941,8 @@ export interface paths {
929
941
  };
930
942
  /**
931
943
  * Transactions for address
932
- * @description Retrieves all transactions for a given address that are currently in mempool
944
+ * @deprecated
945
+ * @description Retrieves all transactions for a given address that are currently in mempool. **Deprecated:** use `GET /extended/v3/principals/{principal}/mempool/transactions` instead.
933
946
  */
934
947
  get: operations["get_address_mempool_transactions"];
935
948
  put?: never;
@@ -949,7 +962,8 @@ export interface paths {
949
962
  };
950
963
  /**
951
964
  * Get the latest nonce used by an account
952
- * @description Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
965
+ * @deprecated
966
+ * @description Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions. **Deprecated:** use `GET /extended/v3/principals/{principal}/nonces` instead.
953
967
  */
954
968
  get: operations["get_account_nonces"];
955
969
  put?: never;
@@ -1304,7 +1318,8 @@ export interface paths {
1304
1318
  };
1305
1319
  /**
1306
1320
  * Get transactions by block
1307
- * @description Retrieves transactions confirmed in a single block
1321
+ * @deprecated
1322
+ * @description Retrieves transactions confirmed in a single block. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead.
1308
1323
  */
1309
1324
  get: operations["get_transactions_by_block"];
1310
1325
  put?: never;
@@ -1604,9 +1619,12 @@ export interface paths {
1604
1619
  };
1605
1620
  /**
1606
1621
  * Get address transactions
1622
+ * @deprecated
1607
1623
  * @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.
1608
1624
  *
1609
1625
  * More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types).
1626
+ *
1627
+ * **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead.
1610
1628
  */
1611
1629
  get: operations["get_address_transactions"];
1612
1630
  put?: never;
@@ -1626,7 +1644,8 @@ export interface paths {
1626
1644
  };
1627
1645
  /**
1628
1646
  * Get events for an address transaction
1629
- * @description Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction.
1647
+ * @deprecated
1648
+ * @description Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes` instead.
1630
1649
  */
1631
1650
  get: operations["get_address_transaction_events"];
1632
1651
  put?: never;
@@ -1646,7 +1665,8 @@ export interface paths {
1646
1665
  };
1647
1666
  /**
1648
1667
  * Get principal STX balance
1649
- * @description Retrieves STX account balance information for a given Address or Contract Identifier.
1668
+ * @deprecated
1669
+ * @description Retrieves STX account balance information for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx` instead.
1650
1670
  */
1651
1671
  get: operations["get_principal_stx_balance"];
1652
1672
  put?: never;
@@ -1666,7 +1686,8 @@ export interface paths {
1666
1686
  };
1667
1687
  /**
1668
1688
  * Get principal FT balances
1669
- * @description Retrieves Fungible-token account balance information for a given Address or Contract Identifier.
1689
+ * @deprecated
1690
+ * @description Retrieves Fungible-token account balance information for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/ft` instead.
1670
1691
  */
1671
1692
  get: operations["get_principal_ft_balances"];
1672
1693
  put?: never;
@@ -1686,7 +1707,8 @@ export interface paths {
1686
1707
  };
1687
1708
  /**
1688
1709
  * Get principal FT balance
1689
- * @description Retrieves a specific fungible-token balance for a given principal.
1710
+ * @deprecated
1711
+ * @description Retrieves a specific fungible-token balance for a given principal. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/ft/{asset_identifier}` instead.
1690
1712
  */
1691
1713
  get: operations["get_principal_ft_balance"];
1692
1714
  put?: never;
@@ -1897,6 +1919,26 @@ export interface paths {
1897
1919
  patch?: never;
1898
1920
  trace?: never;
1899
1921
  };
1922
+ "/extended/v3/principals/{principal}/balances/ft/{asset_identifier}": {
1923
+ parameters: {
1924
+ query?: never;
1925
+ header?: never;
1926
+ path?: never;
1927
+ cookie?: never;
1928
+ };
1929
+ /**
1930
+ * Get principal FT balance
1931
+ * @description Get a principal's balance of a single fungible token. Returns a zero balance if the principal does not currently hold the token.
1932
+ */
1933
+ get: operations["get_principal_balance_ft"];
1934
+ put?: never;
1935
+ post?: never;
1936
+ delete?: never;
1937
+ options?: never;
1938
+ head?: never;
1939
+ patch?: never;
1940
+ trace?: never;
1941
+ };
1900
1942
  "/extended/v3/principals/{principal}/balances/nft": {
1901
1943
  parameters: {
1902
1944
  query?: never;
@@ -1917,6 +1959,46 @@ export interface paths {
1917
1959
  patch?: never;
1918
1960
  trace?: never;
1919
1961
  };
1962
+ "/extended/v3/principals/{principal}/nonces": {
1963
+ parameters: {
1964
+ query?: never;
1965
+ header?: never;
1966
+ path?: never;
1967
+ cookie?: never;
1968
+ };
1969
+ /**
1970
+ * Get principal nonces
1971
+ * @description Get a Stacks account's latest nonce state by inspecting its confirmed (anchored + microblock) transactions and the mempool, including the nonce to use for its next transaction. Only standard principals have nonces; contract principals are not valid.
1972
+ */
1973
+ get: operations["get_principal_nonces"];
1974
+ put?: never;
1975
+ post?: never;
1976
+ delete?: never;
1977
+ options?: never;
1978
+ head?: never;
1979
+ patch?: never;
1980
+ trace?: never;
1981
+ };
1982
+ "/extended/v3/principals/{principal}/mempool/transactions": {
1983
+ parameters: {
1984
+ query?: never;
1985
+ header?: never;
1986
+ path?: never;
1987
+ cookie?: never;
1988
+ };
1989
+ /**
1990
+ * Get principal mempool transactions
1991
+ * @description Returns a list of pending mempool transactions that involve a principal — as the sender, a token-transfer recipient, the deployed contract, or the called contract.
1992
+ */
1993
+ get: operations["get_principal_mempool_transactions"];
1994
+ put?: never;
1995
+ post?: never;
1996
+ delete?: never;
1997
+ options?: never;
1998
+ head?: never;
1999
+ patch?: never;
2000
+ trace?: never;
2001
+ };
1920
2002
  "/extended/v3/staking/bonds": {
1921
2003
  parameters: {
1922
2004
  query?: never;
@@ -38106,6 +38188,55 @@ export interface operations {
38106
38188
  };
38107
38189
  };
38108
38190
  };
38191
+ get_principal_balance_ft: {
38192
+ parameters: {
38193
+ query?: never;
38194
+ header?: never;
38195
+ path: {
38196
+ principal: string;
38197
+ /**
38198
+ * @description Asset Identifier
38199
+ * @example SP000000000000000000002Q6VF78.pox-3::stx-token
38200
+ */
38201
+ asset_identifier: string;
38202
+ };
38203
+ cookie?: never;
38204
+ };
38205
+ requestBody?: never;
38206
+ responses: {
38207
+ /** @description Default Response */
38208
+ 200: {
38209
+ headers: {
38210
+ [name: string]: unknown;
38211
+ };
38212
+ content: {
38213
+ "application/json": {
38214
+ /**
38215
+ * @description Fungible token asset identifier
38216
+ * @example SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token
38217
+ */
38218
+ asset_identifier: string;
38219
+ /** @description The principal's balance of this token, as a string-quoted integer in base units */
38220
+ balance: string;
38221
+ };
38222
+ };
38223
+ };
38224
+ /** @description Default Response */
38225
+ "4XX": {
38226
+ headers: {
38227
+ [name: string]: unknown;
38228
+ };
38229
+ content: {
38230
+ "application/json": {
38231
+ error: string;
38232
+ message?: string;
38233
+ } & {
38234
+ [key: string]: unknown;
38235
+ };
38236
+ };
38237
+ };
38238
+ };
38239
+ };
38109
38240
  get_principal_balances_nft: {
38110
38241
  parameters: {
38111
38242
  query?: {
@@ -38172,6 +38303,283 @@ export interface operations {
38172
38303
  };
38173
38304
  };
38174
38305
  };
38306
+ get_principal_nonces: {
38307
+ parameters: {
38308
+ query?: never;
38309
+ header?: never;
38310
+ path: {
38311
+ /**
38312
+ * @description Stacks Address
38313
+ * @example SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP
38314
+ */
38315
+ principal: string;
38316
+ };
38317
+ cookie?: never;
38318
+ };
38319
+ requestBody?: never;
38320
+ responses: {
38321
+ /** @description Default Response */
38322
+ 200: {
38323
+ headers: {
38324
+ [name: string]: unknown;
38325
+ };
38326
+ content: {
38327
+ "application/json": {
38328
+ /** @description The nonce to use for this principal's next transaction, derived from the latest confirmed and mempool nonces. May be inaccurate if the API is not fully synchronized. */
38329
+ next_nonce: number;
38330
+ last_confirmed_nonce: number | null;
38331
+ /** PrincipalMempoolNonces */
38332
+ mempool: {
38333
+ last_nonce: number | null;
38334
+ /** @description Intermediate nonces found in the mempool between the last confirmed nonce and the highest mempool nonce. */
38335
+ pending_nonces: number[];
38336
+ /** @description Expected intermediate nonces between the last confirmed nonce and the highest mempool nonce that are absent from the mempool — likely stalling transactions. */
38337
+ missing_nonces: number[];
38338
+ };
38339
+ };
38340
+ };
38341
+ };
38342
+ /** @description Default Response */
38343
+ "4XX": {
38344
+ headers: {
38345
+ [name: string]: unknown;
38346
+ };
38347
+ content: {
38348
+ "application/json": {
38349
+ error: string;
38350
+ message?: string;
38351
+ } & {
38352
+ [key: string]: unknown;
38353
+ };
38354
+ };
38355
+ };
38356
+ };
38357
+ };
38358
+ get_principal_mempool_transactions: {
38359
+ parameters: {
38360
+ query?: {
38361
+ /** @description Number of results per page */
38362
+ limit?: number;
38363
+ /** @description Cursor for paginating mempool transactions. Format: receipt_time:tx_id */
38364
+ cursor?: string;
38365
+ };
38366
+ header?: never;
38367
+ path: {
38368
+ principal: string;
38369
+ };
38370
+ cookie?: never;
38371
+ };
38372
+ requestBody?: never;
38373
+ responses: {
38374
+ /** @description Default Response */
38375
+ 200: {
38376
+ headers: {
38377
+ [name: string]: unknown;
38378
+ };
38379
+ content: {
38380
+ "application/json": {
38381
+ /** @example 1 */
38382
+ total: number;
38383
+ /**
38384
+ * @description Number of results per page
38385
+ * @default 20
38386
+ */
38387
+ limit: number;
38388
+ cursor: {
38389
+ next: string | null;
38390
+ previous: string | null;
38391
+ current: string | null;
38392
+ };
38393
+ results: ({
38394
+ /** @description Transaction ID */
38395
+ tx_id: string;
38396
+ sender: {
38397
+ /** @description Address of the transaction initiator */
38398
+ address: string;
38399
+ /** @description Nonce of the transaction initiator */
38400
+ nonce: number;
38401
+ };
38402
+ sponsor: {
38403
+ /** @description Address of the transaction initiator */
38404
+ address: string;
38405
+ /** @description Nonce of the transaction initiator */
38406
+ nonce: number;
38407
+ } | null;
38408
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
38409
+ fee_rate: string;
38410
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
38411
+ receipt_time: number;
38412
+ /** @description Height of the block this transaction was received by the node */
38413
+ receipt_block_height: number;
38414
+ /** @description Status of the mempool transaction */
38415
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
38416
+ /** @enum {string} */
38417
+ type: "token_transfer";
38418
+ token_transfer: {
38419
+ recipient: string;
38420
+ /** @description Transfer amount as Integer string (64-bit unsigned integer) */
38421
+ amount: string;
38422
+ memo: {
38423
+ hex: string;
38424
+ repr: string;
38425
+ } | null;
38426
+ };
38427
+ } | {
38428
+ /** @description Transaction ID */
38429
+ tx_id: string;
38430
+ sender: {
38431
+ /** @description Address of the transaction initiator */
38432
+ address: string;
38433
+ /** @description Nonce of the transaction initiator */
38434
+ nonce: number;
38435
+ };
38436
+ sponsor: {
38437
+ /** @description Address of the transaction initiator */
38438
+ address: string;
38439
+ /** @description Nonce of the transaction initiator */
38440
+ nonce: number;
38441
+ } | null;
38442
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
38443
+ fee_rate: string;
38444
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
38445
+ receipt_time: number;
38446
+ /** @description Height of the block this transaction was received by the node */
38447
+ receipt_block_height: number;
38448
+ /** @description Status of the mempool transaction */
38449
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
38450
+ /** @enum {string} */
38451
+ type: "smart_contract";
38452
+ smart_contract: {
38453
+ clarity_version: number | null;
38454
+ /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
38455
+ contract_id: string;
38456
+ };
38457
+ } | {
38458
+ /** @description Transaction ID */
38459
+ tx_id: string;
38460
+ sender: {
38461
+ /** @description Address of the transaction initiator */
38462
+ address: string;
38463
+ /** @description Nonce of the transaction initiator */
38464
+ nonce: number;
38465
+ };
38466
+ sponsor: {
38467
+ /** @description Address of the transaction initiator */
38468
+ address: string;
38469
+ /** @description Nonce of the transaction initiator */
38470
+ nonce: number;
38471
+ } | null;
38472
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
38473
+ fee_rate: string;
38474
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
38475
+ receipt_time: number;
38476
+ /** @description Height of the block this transaction was received by the node */
38477
+ receipt_block_height: number;
38478
+ /** @description Status of the mempool transaction */
38479
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
38480
+ /** @enum {string} */
38481
+ type: "contract_call";
38482
+ contract_call: {
38483
+ /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
38484
+ contract_id: string;
38485
+ /** @description Name of the Clarity function to be invoked */
38486
+ function_name: string;
38487
+ };
38488
+ } | {
38489
+ /** @description Transaction ID */
38490
+ tx_id: string;
38491
+ sender: {
38492
+ /** @description Address of the transaction initiator */
38493
+ address: string;
38494
+ /** @description Nonce of the transaction initiator */
38495
+ nonce: number;
38496
+ };
38497
+ sponsor: {
38498
+ /** @description Address of the transaction initiator */
38499
+ address: string;
38500
+ /** @description Nonce of the transaction initiator */
38501
+ nonce: number;
38502
+ } | null;
38503
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
38504
+ fee_rate: string;
38505
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
38506
+ receipt_time: number;
38507
+ /** @description Height of the block this transaction was received by the node */
38508
+ receipt_block_height: number;
38509
+ /** @description Status of the mempool transaction */
38510
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
38511
+ /** @enum {string} */
38512
+ type: "poison_microblock";
38513
+ } | {
38514
+ /** @description Transaction ID */
38515
+ tx_id: string;
38516
+ sender: {
38517
+ /** @description Address of the transaction initiator */
38518
+ address: string;
38519
+ /** @description Nonce of the transaction initiator */
38520
+ nonce: number;
38521
+ };
38522
+ sponsor: {
38523
+ /** @description Address of the transaction initiator */
38524
+ address: string;
38525
+ /** @description Nonce of the transaction initiator */
38526
+ nonce: number;
38527
+ } | null;
38528
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
38529
+ fee_rate: string;
38530
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
38531
+ receipt_time: number;
38532
+ /** @description Height of the block this transaction was received by the node */
38533
+ receipt_block_height: number;
38534
+ /** @description Status of the mempool transaction */
38535
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
38536
+ /** @enum {string} */
38537
+ type: "coinbase";
38538
+ } | {
38539
+ /** @description Transaction ID */
38540
+ tx_id: string;
38541
+ sender: {
38542
+ /** @description Address of the transaction initiator */
38543
+ address: string;
38544
+ /** @description Nonce of the transaction initiator */
38545
+ nonce: number;
38546
+ };
38547
+ sponsor: {
38548
+ /** @description Address of the transaction initiator */
38549
+ address: string;
38550
+ /** @description Nonce of the transaction initiator */
38551
+ nonce: number;
38552
+ } | null;
38553
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
38554
+ fee_rate: string;
38555
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
38556
+ receipt_time: number;
38557
+ /** @description Height of the block this transaction was received by the node */
38558
+ receipt_block_height: number;
38559
+ /** @description Status of the mempool transaction */
38560
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
38561
+ /** @enum {string} */
38562
+ type: "tenure_change";
38563
+ })[];
38564
+ };
38565
+ };
38566
+ };
38567
+ /** @description Default Response */
38568
+ "4XX": {
38569
+ headers: {
38570
+ [name: string]: unknown;
38571
+ };
38572
+ content: {
38573
+ "application/json": {
38574
+ error: string;
38575
+ message?: string;
38576
+ } & {
38577
+ [key: string]: unknown;
38578
+ };
38579
+ };
38580
+ };
38581
+ };
38582
+ };
38175
38583
  get_bonds: {
38176
38584
  parameters: {
38177
38585
  query?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stacks/blockchain-api-client",
3
- "version": "9.0.0-pox5.12",
3
+ "version": "9.0.0-pox5.14",
4
4
  "access": "public",
5
5
  "description": "Client for the Stacks Blockchain API",
6
6
  "homepage": "https://github.com/stx-labs/stacks-blockchain-api/tree/master/client#readme",
@@ -33,7 +33,8 @@ export interface paths {
33
33
  };
34
34
  /**
35
35
  * Get recent transactions
36
- * @description Retrieves all recently mined transactions
36
+ * @deprecated
37
+ * @description Retrieves all recently mined transactions. **Deprecated:** use `GET /extended/v3/transactions` instead.
37
38
  */
38
39
  get: operations["get_transaction_list"];
39
40
  put?: never;
@@ -73,9 +74,12 @@ export interface paths {
73
74
  };
74
75
  /**
75
76
  * Get mempool transactions
77
+ * @deprecated
76
78
  * @description Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
77
79
  *
78
80
  * If you need to monitor new transactions, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
81
+ *
82
+ * **Deprecated:** use `GET /extended/v3/mempool/transactions` instead.
79
83
  */
80
84
  get: operations["get_mempool_transaction_list"];
81
85
  put?: never;
@@ -116,8 +120,11 @@ export interface paths {
116
120
  };
117
121
  /**
118
122
  * Transaction Events
123
+ * @deprecated
119
124
  * @description Retrieves the list of events filtered by principal (STX address or Smart Contract ID), transaction id or event types.
120
125
  * The list of event types is ('smart_contract_log', 'stx_lock', 'stx_asset', 'fungible_token_asset', 'non_fungible_token_asset').
126
+ *
127
+ * **Deprecated:** this endpoint has no direct v3 replacement.
121
128
  */
122
129
  get: operations["get_filtered_events"];
123
130
  put?: never;
@@ -137,7 +144,8 @@ export interface paths {
137
144
  };
138
145
  /**
139
146
  * Get transaction
140
- * @description Retrieves transaction details for a given transaction ID
147
+ * @deprecated
148
+ * @description Retrieves transaction details for a given transaction ID. **Deprecated:** use `GET /extended/v3/transactions/{tx_id}` instead.
141
149
  */
142
150
  get: operations["get_transaction_by_id"];
143
151
  put?: never;
@@ -157,7 +165,8 @@ export interface paths {
157
165
  };
158
166
  /**
159
167
  * Get raw transaction
160
- * @description Retrieves a hex encoded serialized transaction for a given ID
168
+ * @deprecated
169
+ * @description Retrieves a hex encoded serialized transaction for a given ID. **Deprecated:** use the Stacks node RPC endpoint `GET /v3/transaction/{tx_id}` to fetch a single raw transaction instead.
161
170
  */
162
171
  get: operations["get_raw_transaction_by_id"];
163
172
  put?: never;
@@ -178,7 +187,7 @@ export interface paths {
178
187
  /**
179
188
  * Transactions by block hash
180
189
  * @deprecated
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`.**
190
+ * @description Retrieves a list of all transactions within a block for a given block hash. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead.
182
191
  */
183
192
  get: operations["get_transactions_by_block_hash"];
184
193
  put?: never;
@@ -199,7 +208,7 @@ export interface paths {
199
208
  /**
200
209
  * Transactions by block height
201
210
  * @deprecated
202
- * @description Retrieves all transactions within a block at a given height. **This endpoint is deprecated in favor of `get_transactions_by_block`.**
211
+ * @description Retrieves all transactions within a block at a given height. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead.
203
212
  */
204
213
  get: operations["get_transactions_by_block_height"];
205
214
  put?: never;
@@ -342,10 +351,13 @@ export interface paths {
342
351
  };
343
352
  /**
344
353
  * Non-Fungible Token holdings
354
+ * @deprecated
345
355
  * @description Retrieves the list of Non-Fungible Tokens owned by the given principal (STX address or Smart Contract ID).
346
356
  * Results can be filtered by one or more asset identifiers and can include metadata about the transaction that made the principal own each token.
347
357
  *
348
358
  * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).
359
+ *
360
+ * **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/nft` instead.
349
361
  */
350
362
  get: operations["get_nft_holdings"];
351
363
  put?: never;
@@ -783,7 +795,7 @@ export interface paths {
783
795
  /**
784
796
  * Get account STX balance
785
797
  * @deprecated
786
- * @description Retrieves STX token balance for a given Address or Contract Identifier. **This endpoint is deprecated in favor of `get_principal_stx_balance`.**
798
+ * @description Retrieves STX token balance for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx` instead.
787
799
  */
788
800
  get: operations["get_account_stx_balance"];
789
801
  put?: never;
@@ -804,7 +816,7 @@ export interface paths {
804
816
  /**
805
817
  * Get account balances
806
818
  * @deprecated
807
- * @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`.**
819
+ * @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. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx`, `GET /extended/v3/principals/{principal}/balances/ft`, and `GET /extended/v3/principals/{principal}/balances/nft` instead.
808
820
  */
809
821
  get: operations["get_account_balance"];
810
822
  put?: never;
@@ -825,7 +837,7 @@ export interface paths {
825
837
  /**
826
838
  * Get account transactions
827
839
  * @deprecated
828
- * @description Retrieves a list of all Transactions for a given Address or Contract Identifier. **This endpoint is deprecated in favor of `get_address_transactions`.**
840
+ * @description Retrieves a list of all Transactions for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead.
829
841
  */
830
842
  get: operations["get_account_transactions"];
831
843
  put?: never;
@@ -846,7 +858,7 @@ export interface paths {
846
858
  /**
847
859
  * Get account transaction information for specific transaction
848
860
  * @deprecated
849
- * @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`.**
861
+ * @description Retrieves transaction details for a given Transaction Id, for a given account or contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes` instead.
850
862
  */
851
863
  get: operations["get_single_transaction_with_transfers"];
852
864
  put?: never;
@@ -867,7 +879,7 @@ export interface paths {
867
879
  /**
868
880
  * Get account transactions including STX transfers for each transaction.
869
881
  * @deprecated
870
- * @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`.**
882
+ * @description Retrieve all transactions for an account or contract identifier including STX transfers for each transaction. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead.
871
883
  */
872
884
  get: operations["get_account_transactions_with_transfers"];
873
885
  put?: never;
@@ -888,7 +900,7 @@ export interface paths {
888
900
  /**
889
901
  * Get account assets
890
902
  * @deprecated
891
- * @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`.**
903
+ * @description Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints. **Deprecated:** this endpoint has no direct v3 replacement; the closest equivalent is `GET /extended/v3/principals/{principal}/balance-changes`.
892
904
  */
893
905
  get: operations["get_account_assets"];
894
906
  put?: never;
@@ -909,7 +921,7 @@ export interface paths {
909
921
  /**
910
922
  * Get inbound STX transfers
911
923
  * @deprecated
912
- * @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`.**
924
+ * @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 at the `send-many-memo` bulk sending contract. **Deprecated:** this endpoint has no direct v3 replacement.
913
925
  */
914
926
  get: operations["get_account_inbound"];
915
927
  put?: never;
@@ -929,7 +941,8 @@ export interface paths {
929
941
  };
930
942
  /**
931
943
  * Transactions for address
932
- * @description Retrieves all transactions for a given address that are currently in mempool
944
+ * @deprecated
945
+ * @description Retrieves all transactions for a given address that are currently in mempool. **Deprecated:** use `GET /extended/v3/principals/{principal}/mempool/transactions` instead.
933
946
  */
934
947
  get: operations["get_address_mempool_transactions"];
935
948
  put?: never;
@@ -949,7 +962,8 @@ export interface paths {
949
962
  };
950
963
  /**
951
964
  * Get the latest nonce used by an account
952
- * @description Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
965
+ * @deprecated
966
+ * @description Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions. **Deprecated:** use `GET /extended/v3/principals/{principal}/nonces` instead.
953
967
  */
954
968
  get: operations["get_account_nonces"];
955
969
  put?: never;
@@ -1304,7 +1318,8 @@ export interface paths {
1304
1318
  };
1305
1319
  /**
1306
1320
  * Get transactions by block
1307
- * @description Retrieves transactions confirmed in a single block
1321
+ * @deprecated
1322
+ * @description Retrieves transactions confirmed in a single block. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead.
1308
1323
  */
1309
1324
  get: operations["get_transactions_by_block"];
1310
1325
  put?: never;
@@ -1604,9 +1619,12 @@ export interface paths {
1604
1619
  };
1605
1620
  /**
1606
1621
  * Get address transactions
1622
+ * @deprecated
1607
1623
  * @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.
1608
1624
  *
1609
1625
  * More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types).
1626
+ *
1627
+ * **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead.
1610
1628
  */
1611
1629
  get: operations["get_address_transactions"];
1612
1630
  put?: never;
@@ -1626,7 +1644,8 @@ export interface paths {
1626
1644
  };
1627
1645
  /**
1628
1646
  * Get events for an address transaction
1629
- * @description Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction.
1647
+ * @deprecated
1648
+ * @description Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes` instead.
1630
1649
  */
1631
1650
  get: operations["get_address_transaction_events"];
1632
1651
  put?: never;
@@ -1646,7 +1665,8 @@ export interface paths {
1646
1665
  };
1647
1666
  /**
1648
1667
  * Get principal STX balance
1649
- * @description Retrieves STX account balance information for a given Address or Contract Identifier.
1668
+ * @deprecated
1669
+ * @description Retrieves STX account balance information for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx` instead.
1650
1670
  */
1651
1671
  get: operations["get_principal_stx_balance"];
1652
1672
  put?: never;
@@ -1666,7 +1686,8 @@ export interface paths {
1666
1686
  };
1667
1687
  /**
1668
1688
  * Get principal FT balances
1669
- * @description Retrieves Fungible-token account balance information for a given Address or Contract Identifier.
1689
+ * @deprecated
1690
+ * @description Retrieves Fungible-token account balance information for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/ft` instead.
1670
1691
  */
1671
1692
  get: operations["get_principal_ft_balances"];
1672
1693
  put?: never;
@@ -1686,7 +1707,8 @@ export interface paths {
1686
1707
  };
1687
1708
  /**
1688
1709
  * Get principal FT balance
1689
- * @description Retrieves a specific fungible-token balance for a given principal.
1710
+ * @deprecated
1711
+ * @description Retrieves a specific fungible-token balance for a given principal. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/ft/{asset_identifier}` instead.
1690
1712
  */
1691
1713
  get: operations["get_principal_ft_balance"];
1692
1714
  put?: never;
@@ -1897,6 +1919,26 @@ export interface paths {
1897
1919
  patch?: never;
1898
1920
  trace?: never;
1899
1921
  };
1922
+ "/extended/v3/principals/{principal}/balances/ft/{asset_identifier}": {
1923
+ parameters: {
1924
+ query?: never;
1925
+ header?: never;
1926
+ path?: never;
1927
+ cookie?: never;
1928
+ };
1929
+ /**
1930
+ * Get principal FT balance
1931
+ * @description Get a principal's balance of a single fungible token. Returns a zero balance if the principal does not currently hold the token.
1932
+ */
1933
+ get: operations["get_principal_balance_ft"];
1934
+ put?: never;
1935
+ post?: never;
1936
+ delete?: never;
1937
+ options?: never;
1938
+ head?: never;
1939
+ patch?: never;
1940
+ trace?: never;
1941
+ };
1900
1942
  "/extended/v3/principals/{principal}/balances/nft": {
1901
1943
  parameters: {
1902
1944
  query?: never;
@@ -1917,6 +1959,46 @@ export interface paths {
1917
1959
  patch?: never;
1918
1960
  trace?: never;
1919
1961
  };
1962
+ "/extended/v3/principals/{principal}/nonces": {
1963
+ parameters: {
1964
+ query?: never;
1965
+ header?: never;
1966
+ path?: never;
1967
+ cookie?: never;
1968
+ };
1969
+ /**
1970
+ * Get principal nonces
1971
+ * @description Get a Stacks account's latest nonce state by inspecting its confirmed (anchored + microblock) transactions and the mempool, including the nonce to use for its next transaction. Only standard principals have nonces; contract principals are not valid.
1972
+ */
1973
+ get: operations["get_principal_nonces"];
1974
+ put?: never;
1975
+ post?: never;
1976
+ delete?: never;
1977
+ options?: never;
1978
+ head?: never;
1979
+ patch?: never;
1980
+ trace?: never;
1981
+ };
1982
+ "/extended/v3/principals/{principal}/mempool/transactions": {
1983
+ parameters: {
1984
+ query?: never;
1985
+ header?: never;
1986
+ path?: never;
1987
+ cookie?: never;
1988
+ };
1989
+ /**
1990
+ * Get principal mempool transactions
1991
+ * @description Returns a list of pending mempool transactions that involve a principal — as the sender, a token-transfer recipient, the deployed contract, or the called contract.
1992
+ */
1993
+ get: operations["get_principal_mempool_transactions"];
1994
+ put?: never;
1995
+ post?: never;
1996
+ delete?: never;
1997
+ options?: never;
1998
+ head?: never;
1999
+ patch?: never;
2000
+ trace?: never;
2001
+ };
1920
2002
  "/extended/v3/staking/bonds": {
1921
2003
  parameters: {
1922
2004
  query?: never;
@@ -38106,6 +38188,55 @@ export interface operations {
38106
38188
  };
38107
38189
  };
38108
38190
  };
38191
+ get_principal_balance_ft: {
38192
+ parameters: {
38193
+ query?: never;
38194
+ header?: never;
38195
+ path: {
38196
+ principal: string;
38197
+ /**
38198
+ * @description Asset Identifier
38199
+ * @example SP000000000000000000002Q6VF78.pox-3::stx-token
38200
+ */
38201
+ asset_identifier: string;
38202
+ };
38203
+ cookie?: never;
38204
+ };
38205
+ requestBody?: never;
38206
+ responses: {
38207
+ /** @description Default Response */
38208
+ 200: {
38209
+ headers: {
38210
+ [name: string]: unknown;
38211
+ };
38212
+ content: {
38213
+ "application/json": {
38214
+ /**
38215
+ * @description Fungible token asset identifier
38216
+ * @example SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token
38217
+ */
38218
+ asset_identifier: string;
38219
+ /** @description The principal's balance of this token, as a string-quoted integer in base units */
38220
+ balance: string;
38221
+ };
38222
+ };
38223
+ };
38224
+ /** @description Default Response */
38225
+ "4XX": {
38226
+ headers: {
38227
+ [name: string]: unknown;
38228
+ };
38229
+ content: {
38230
+ "application/json": {
38231
+ error: string;
38232
+ message?: string;
38233
+ } & {
38234
+ [key: string]: unknown;
38235
+ };
38236
+ };
38237
+ };
38238
+ };
38239
+ };
38109
38240
  get_principal_balances_nft: {
38110
38241
  parameters: {
38111
38242
  query?: {
@@ -38172,6 +38303,283 @@ export interface operations {
38172
38303
  };
38173
38304
  };
38174
38305
  };
38306
+ get_principal_nonces: {
38307
+ parameters: {
38308
+ query?: never;
38309
+ header?: never;
38310
+ path: {
38311
+ /**
38312
+ * @description Stacks Address
38313
+ * @example SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP
38314
+ */
38315
+ principal: string;
38316
+ };
38317
+ cookie?: never;
38318
+ };
38319
+ requestBody?: never;
38320
+ responses: {
38321
+ /** @description Default Response */
38322
+ 200: {
38323
+ headers: {
38324
+ [name: string]: unknown;
38325
+ };
38326
+ content: {
38327
+ "application/json": {
38328
+ /** @description The nonce to use for this principal's next transaction, derived from the latest confirmed and mempool nonces. May be inaccurate if the API is not fully synchronized. */
38329
+ next_nonce: number;
38330
+ last_confirmed_nonce: number | null;
38331
+ /** PrincipalMempoolNonces */
38332
+ mempool: {
38333
+ last_nonce: number | null;
38334
+ /** @description Intermediate nonces found in the mempool between the last confirmed nonce and the highest mempool nonce. */
38335
+ pending_nonces: number[];
38336
+ /** @description Expected intermediate nonces between the last confirmed nonce and the highest mempool nonce that are absent from the mempool — likely stalling transactions. */
38337
+ missing_nonces: number[];
38338
+ };
38339
+ };
38340
+ };
38341
+ };
38342
+ /** @description Default Response */
38343
+ "4XX": {
38344
+ headers: {
38345
+ [name: string]: unknown;
38346
+ };
38347
+ content: {
38348
+ "application/json": {
38349
+ error: string;
38350
+ message?: string;
38351
+ } & {
38352
+ [key: string]: unknown;
38353
+ };
38354
+ };
38355
+ };
38356
+ };
38357
+ };
38358
+ get_principal_mempool_transactions: {
38359
+ parameters: {
38360
+ query?: {
38361
+ /** @description Number of results per page */
38362
+ limit?: number;
38363
+ /** @description Cursor for paginating mempool transactions. Format: receipt_time:tx_id */
38364
+ cursor?: string;
38365
+ };
38366
+ header?: never;
38367
+ path: {
38368
+ principal: string;
38369
+ };
38370
+ cookie?: never;
38371
+ };
38372
+ requestBody?: never;
38373
+ responses: {
38374
+ /** @description Default Response */
38375
+ 200: {
38376
+ headers: {
38377
+ [name: string]: unknown;
38378
+ };
38379
+ content: {
38380
+ "application/json": {
38381
+ /** @example 1 */
38382
+ total: number;
38383
+ /**
38384
+ * @description Number of results per page
38385
+ * @default 20
38386
+ */
38387
+ limit: number;
38388
+ cursor: {
38389
+ next: string | null;
38390
+ previous: string | null;
38391
+ current: string | null;
38392
+ };
38393
+ results: ({
38394
+ /** @description Transaction ID */
38395
+ tx_id: string;
38396
+ sender: {
38397
+ /** @description Address of the transaction initiator */
38398
+ address: string;
38399
+ /** @description Nonce of the transaction initiator */
38400
+ nonce: number;
38401
+ };
38402
+ sponsor: {
38403
+ /** @description Address of the transaction initiator */
38404
+ address: string;
38405
+ /** @description Nonce of the transaction initiator */
38406
+ nonce: number;
38407
+ } | null;
38408
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
38409
+ fee_rate: string;
38410
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
38411
+ receipt_time: number;
38412
+ /** @description Height of the block this transaction was received by the node */
38413
+ receipt_block_height: number;
38414
+ /** @description Status of the mempool transaction */
38415
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
38416
+ /** @enum {string} */
38417
+ type: "token_transfer";
38418
+ token_transfer: {
38419
+ recipient: string;
38420
+ /** @description Transfer amount as Integer string (64-bit unsigned integer) */
38421
+ amount: string;
38422
+ memo: {
38423
+ hex: string;
38424
+ repr: string;
38425
+ } | null;
38426
+ };
38427
+ } | {
38428
+ /** @description Transaction ID */
38429
+ tx_id: string;
38430
+ sender: {
38431
+ /** @description Address of the transaction initiator */
38432
+ address: string;
38433
+ /** @description Nonce of the transaction initiator */
38434
+ nonce: number;
38435
+ };
38436
+ sponsor: {
38437
+ /** @description Address of the transaction initiator */
38438
+ address: string;
38439
+ /** @description Nonce of the transaction initiator */
38440
+ nonce: number;
38441
+ } | null;
38442
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
38443
+ fee_rate: string;
38444
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
38445
+ receipt_time: number;
38446
+ /** @description Height of the block this transaction was received by the node */
38447
+ receipt_block_height: number;
38448
+ /** @description Status of the mempool transaction */
38449
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
38450
+ /** @enum {string} */
38451
+ type: "smart_contract";
38452
+ smart_contract: {
38453
+ clarity_version: number | null;
38454
+ /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
38455
+ contract_id: string;
38456
+ };
38457
+ } | {
38458
+ /** @description Transaction ID */
38459
+ tx_id: string;
38460
+ sender: {
38461
+ /** @description Address of the transaction initiator */
38462
+ address: string;
38463
+ /** @description Nonce of the transaction initiator */
38464
+ nonce: number;
38465
+ };
38466
+ sponsor: {
38467
+ /** @description Address of the transaction initiator */
38468
+ address: string;
38469
+ /** @description Nonce of the transaction initiator */
38470
+ nonce: number;
38471
+ } | null;
38472
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
38473
+ fee_rate: string;
38474
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
38475
+ receipt_time: number;
38476
+ /** @description Height of the block this transaction was received by the node */
38477
+ receipt_block_height: number;
38478
+ /** @description Status of the mempool transaction */
38479
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
38480
+ /** @enum {string} */
38481
+ type: "contract_call";
38482
+ contract_call: {
38483
+ /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
38484
+ contract_id: string;
38485
+ /** @description Name of the Clarity function to be invoked */
38486
+ function_name: string;
38487
+ };
38488
+ } | {
38489
+ /** @description Transaction ID */
38490
+ tx_id: string;
38491
+ sender: {
38492
+ /** @description Address of the transaction initiator */
38493
+ address: string;
38494
+ /** @description Nonce of the transaction initiator */
38495
+ nonce: number;
38496
+ };
38497
+ sponsor: {
38498
+ /** @description Address of the transaction initiator */
38499
+ address: string;
38500
+ /** @description Nonce of the transaction initiator */
38501
+ nonce: number;
38502
+ } | null;
38503
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
38504
+ fee_rate: string;
38505
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
38506
+ receipt_time: number;
38507
+ /** @description Height of the block this transaction was received by the node */
38508
+ receipt_block_height: number;
38509
+ /** @description Status of the mempool transaction */
38510
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
38511
+ /** @enum {string} */
38512
+ type: "poison_microblock";
38513
+ } | {
38514
+ /** @description Transaction ID */
38515
+ tx_id: string;
38516
+ sender: {
38517
+ /** @description Address of the transaction initiator */
38518
+ address: string;
38519
+ /** @description Nonce of the transaction initiator */
38520
+ nonce: number;
38521
+ };
38522
+ sponsor: {
38523
+ /** @description Address of the transaction initiator */
38524
+ address: string;
38525
+ /** @description Nonce of the transaction initiator */
38526
+ nonce: number;
38527
+ } | null;
38528
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
38529
+ fee_rate: string;
38530
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
38531
+ receipt_time: number;
38532
+ /** @description Height of the block this transaction was received by the node */
38533
+ receipt_block_height: number;
38534
+ /** @description Status of the mempool transaction */
38535
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
38536
+ /** @enum {string} */
38537
+ type: "coinbase";
38538
+ } | {
38539
+ /** @description Transaction ID */
38540
+ tx_id: string;
38541
+ sender: {
38542
+ /** @description Address of the transaction initiator */
38543
+ address: string;
38544
+ /** @description Nonce of the transaction initiator */
38545
+ nonce: number;
38546
+ };
38547
+ sponsor: {
38548
+ /** @description Address of the transaction initiator */
38549
+ address: string;
38550
+ /** @description Nonce of the transaction initiator */
38551
+ nonce: number;
38552
+ } | null;
38553
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
38554
+ fee_rate: string;
38555
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
38556
+ receipt_time: number;
38557
+ /** @description Height of the block this transaction was received by the node */
38558
+ receipt_block_height: number;
38559
+ /** @description Status of the mempool transaction */
38560
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
38561
+ /** @enum {string} */
38562
+ type: "tenure_change";
38563
+ })[];
38564
+ };
38565
+ };
38566
+ };
38567
+ /** @description Default Response */
38568
+ "4XX": {
38569
+ headers: {
38570
+ [name: string]: unknown;
38571
+ };
38572
+ content: {
38573
+ "application/json": {
38574
+ error: string;
38575
+ message?: string;
38576
+ } & {
38577
+ [key: string]: unknown;
38578
+ };
38579
+ };
38580
+ };
38581
+ };
38582
+ };
38175
38583
  get_bonds: {
38176
38584
  parameters: {
38177
38585
  query?: {