@stacks/blockchain-api-client 9.0.0-pox5.13 → 9.0.0-pox5.15
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 +337 -1
- package/package.json +1 -1
- package/src/generated/schema.d.ts +337 -1
|
@@ -120,8 +120,11 @@ export interface paths {
|
|
|
120
120
|
};
|
|
121
121
|
/**
|
|
122
122
|
* Transaction Events
|
|
123
|
+
* @deprecated
|
|
123
124
|
* @description Retrieves the list of events filtered by principal (STX address or Smart Contract ID), transaction id or event types.
|
|
124
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.
|
|
125
128
|
*/
|
|
126
129
|
get: operations["get_filtered_events"];
|
|
127
130
|
put?: never;
|
|
@@ -348,10 +351,13 @@ export interface paths {
|
|
|
348
351
|
};
|
|
349
352
|
/**
|
|
350
353
|
* Non-Fungible Token holdings
|
|
354
|
+
* @deprecated
|
|
351
355
|
* @description Retrieves the list of Non-Fungible Tokens owned by the given principal (STX address or Smart Contract ID).
|
|
352
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.
|
|
353
357
|
*
|
|
354
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.
|
|
355
361
|
*/
|
|
356
362
|
get: operations["get_nft_holdings"];
|
|
357
363
|
put?: never;
|
|
@@ -935,7 +941,8 @@ export interface paths {
|
|
|
935
941
|
};
|
|
936
942
|
/**
|
|
937
943
|
* Transactions for address
|
|
938
|
-
* @
|
|
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.
|
|
939
946
|
*/
|
|
940
947
|
get: operations["get_address_mempool_transactions"];
|
|
941
948
|
put?: never;
|
|
@@ -1972,6 +1979,26 @@ export interface paths {
|
|
|
1972
1979
|
patch?: never;
|
|
1973
1980
|
trace?: never;
|
|
1974
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
|
+
};
|
|
1975
2002
|
"/extended/v3/staking/bonds": {
|
|
1976
2003
|
parameters: {
|
|
1977
2004
|
query?: never;
|
|
@@ -2132,6 +2159,26 @@ export interface paths {
|
|
|
2132
2159
|
patch?: never;
|
|
2133
2160
|
trace?: never;
|
|
2134
2161
|
};
|
|
2162
|
+
"/extended/v3/staking/signers/{principal}/stakers": {
|
|
2163
|
+
parameters: {
|
|
2164
|
+
query?: never;
|
|
2165
|
+
header?: never;
|
|
2166
|
+
path?: never;
|
|
2167
|
+
cookie?: never;
|
|
2168
|
+
};
|
|
2169
|
+
/**
|
|
2170
|
+
* Get staking signer stakers
|
|
2171
|
+
* @description List the stakers that belong to a pox-5 signer, across both direct STX staking and BTC/sBTC bond staking. Each entry indicates which staking type(s) the staker participates in under this signer.
|
|
2172
|
+
*/
|
|
2173
|
+
get: operations["get_staking_signer_stakers"];
|
|
2174
|
+
put?: never;
|
|
2175
|
+
post?: never;
|
|
2176
|
+
delete?: never;
|
|
2177
|
+
options?: never;
|
|
2178
|
+
head?: never;
|
|
2179
|
+
patch?: never;
|
|
2180
|
+
trace?: never;
|
|
2181
|
+
};
|
|
2135
2182
|
"/extended/v3/transactions": {
|
|
2136
2183
|
parameters: {
|
|
2137
2184
|
query?: never;
|
|
@@ -38328,6 +38375,231 @@ export interface operations {
|
|
|
38328
38375
|
};
|
|
38329
38376
|
};
|
|
38330
38377
|
};
|
|
38378
|
+
get_principal_mempool_transactions: {
|
|
38379
|
+
parameters: {
|
|
38380
|
+
query?: {
|
|
38381
|
+
/** @description Number of results per page */
|
|
38382
|
+
limit?: number;
|
|
38383
|
+
/** @description Cursor for paginating mempool transactions. Format: receipt_time:tx_id */
|
|
38384
|
+
cursor?: string;
|
|
38385
|
+
};
|
|
38386
|
+
header?: never;
|
|
38387
|
+
path: {
|
|
38388
|
+
principal: string;
|
|
38389
|
+
};
|
|
38390
|
+
cookie?: never;
|
|
38391
|
+
};
|
|
38392
|
+
requestBody?: never;
|
|
38393
|
+
responses: {
|
|
38394
|
+
/** @description Default Response */
|
|
38395
|
+
200: {
|
|
38396
|
+
headers: {
|
|
38397
|
+
[name: string]: unknown;
|
|
38398
|
+
};
|
|
38399
|
+
content: {
|
|
38400
|
+
"application/json": {
|
|
38401
|
+
/** @example 1 */
|
|
38402
|
+
total: number;
|
|
38403
|
+
/**
|
|
38404
|
+
* @description Number of results per page
|
|
38405
|
+
* @default 20
|
|
38406
|
+
*/
|
|
38407
|
+
limit: number;
|
|
38408
|
+
cursor: {
|
|
38409
|
+
next: string | null;
|
|
38410
|
+
previous: string | null;
|
|
38411
|
+
current: string | null;
|
|
38412
|
+
};
|
|
38413
|
+
results: ({
|
|
38414
|
+
/** @description Transaction ID */
|
|
38415
|
+
tx_id: string;
|
|
38416
|
+
sender: {
|
|
38417
|
+
/** @description Address of the transaction initiator */
|
|
38418
|
+
address: string;
|
|
38419
|
+
/** @description Nonce of the transaction initiator */
|
|
38420
|
+
nonce: number;
|
|
38421
|
+
};
|
|
38422
|
+
sponsor: {
|
|
38423
|
+
/** @description Address of the transaction initiator */
|
|
38424
|
+
address: string;
|
|
38425
|
+
/** @description Nonce of the transaction initiator */
|
|
38426
|
+
nonce: number;
|
|
38427
|
+
} | null;
|
|
38428
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
38429
|
+
fee_rate: string;
|
|
38430
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
38431
|
+
receipt_time: number;
|
|
38432
|
+
/** @description Height of the block this transaction was received by the node */
|
|
38433
|
+
receipt_block_height: number;
|
|
38434
|
+
/** @description Status of the mempool transaction */
|
|
38435
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
38436
|
+
/** @enum {string} */
|
|
38437
|
+
type: "token_transfer";
|
|
38438
|
+
token_transfer: {
|
|
38439
|
+
recipient: string;
|
|
38440
|
+
/** @description Transfer amount as Integer string (64-bit unsigned integer) */
|
|
38441
|
+
amount: string;
|
|
38442
|
+
memo: {
|
|
38443
|
+
hex: string;
|
|
38444
|
+
repr: string;
|
|
38445
|
+
} | null;
|
|
38446
|
+
};
|
|
38447
|
+
} | {
|
|
38448
|
+
/** @description Transaction ID */
|
|
38449
|
+
tx_id: string;
|
|
38450
|
+
sender: {
|
|
38451
|
+
/** @description Address of the transaction initiator */
|
|
38452
|
+
address: string;
|
|
38453
|
+
/** @description Nonce of the transaction initiator */
|
|
38454
|
+
nonce: number;
|
|
38455
|
+
};
|
|
38456
|
+
sponsor: {
|
|
38457
|
+
/** @description Address of the transaction initiator */
|
|
38458
|
+
address: string;
|
|
38459
|
+
/** @description Nonce of the transaction initiator */
|
|
38460
|
+
nonce: number;
|
|
38461
|
+
} | null;
|
|
38462
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
38463
|
+
fee_rate: string;
|
|
38464
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
38465
|
+
receipt_time: number;
|
|
38466
|
+
/** @description Height of the block this transaction was received by the node */
|
|
38467
|
+
receipt_block_height: number;
|
|
38468
|
+
/** @description Status of the mempool transaction */
|
|
38469
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
38470
|
+
/** @enum {string} */
|
|
38471
|
+
type: "smart_contract";
|
|
38472
|
+
smart_contract: {
|
|
38473
|
+
clarity_version: number | null;
|
|
38474
|
+
/** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
|
|
38475
|
+
contract_id: string;
|
|
38476
|
+
};
|
|
38477
|
+
} | {
|
|
38478
|
+
/** @description Transaction ID */
|
|
38479
|
+
tx_id: string;
|
|
38480
|
+
sender: {
|
|
38481
|
+
/** @description Address of the transaction initiator */
|
|
38482
|
+
address: string;
|
|
38483
|
+
/** @description Nonce of the transaction initiator */
|
|
38484
|
+
nonce: number;
|
|
38485
|
+
};
|
|
38486
|
+
sponsor: {
|
|
38487
|
+
/** @description Address of the transaction initiator */
|
|
38488
|
+
address: string;
|
|
38489
|
+
/** @description Nonce of the transaction initiator */
|
|
38490
|
+
nonce: number;
|
|
38491
|
+
} | null;
|
|
38492
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
38493
|
+
fee_rate: string;
|
|
38494
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
38495
|
+
receipt_time: number;
|
|
38496
|
+
/** @description Height of the block this transaction was received by the node */
|
|
38497
|
+
receipt_block_height: number;
|
|
38498
|
+
/** @description Status of the mempool transaction */
|
|
38499
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
38500
|
+
/** @enum {string} */
|
|
38501
|
+
type: "contract_call";
|
|
38502
|
+
contract_call: {
|
|
38503
|
+
/** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
|
|
38504
|
+
contract_id: string;
|
|
38505
|
+
/** @description Name of the Clarity function to be invoked */
|
|
38506
|
+
function_name: string;
|
|
38507
|
+
};
|
|
38508
|
+
} | {
|
|
38509
|
+
/** @description Transaction ID */
|
|
38510
|
+
tx_id: string;
|
|
38511
|
+
sender: {
|
|
38512
|
+
/** @description Address of the transaction initiator */
|
|
38513
|
+
address: string;
|
|
38514
|
+
/** @description Nonce of the transaction initiator */
|
|
38515
|
+
nonce: number;
|
|
38516
|
+
};
|
|
38517
|
+
sponsor: {
|
|
38518
|
+
/** @description Address of the transaction initiator */
|
|
38519
|
+
address: string;
|
|
38520
|
+
/** @description Nonce of the transaction initiator */
|
|
38521
|
+
nonce: number;
|
|
38522
|
+
} | null;
|
|
38523
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
38524
|
+
fee_rate: string;
|
|
38525
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
38526
|
+
receipt_time: number;
|
|
38527
|
+
/** @description Height of the block this transaction was received by the node */
|
|
38528
|
+
receipt_block_height: number;
|
|
38529
|
+
/** @description Status of the mempool transaction */
|
|
38530
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
38531
|
+
/** @enum {string} */
|
|
38532
|
+
type: "poison_microblock";
|
|
38533
|
+
} | {
|
|
38534
|
+
/** @description Transaction ID */
|
|
38535
|
+
tx_id: string;
|
|
38536
|
+
sender: {
|
|
38537
|
+
/** @description Address of the transaction initiator */
|
|
38538
|
+
address: string;
|
|
38539
|
+
/** @description Nonce of the transaction initiator */
|
|
38540
|
+
nonce: number;
|
|
38541
|
+
};
|
|
38542
|
+
sponsor: {
|
|
38543
|
+
/** @description Address of the transaction initiator */
|
|
38544
|
+
address: string;
|
|
38545
|
+
/** @description Nonce of the transaction initiator */
|
|
38546
|
+
nonce: number;
|
|
38547
|
+
} | null;
|
|
38548
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
38549
|
+
fee_rate: string;
|
|
38550
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
38551
|
+
receipt_time: number;
|
|
38552
|
+
/** @description Height of the block this transaction was received by the node */
|
|
38553
|
+
receipt_block_height: number;
|
|
38554
|
+
/** @description Status of the mempool transaction */
|
|
38555
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
38556
|
+
/** @enum {string} */
|
|
38557
|
+
type: "coinbase";
|
|
38558
|
+
} | {
|
|
38559
|
+
/** @description Transaction ID */
|
|
38560
|
+
tx_id: string;
|
|
38561
|
+
sender: {
|
|
38562
|
+
/** @description Address of the transaction initiator */
|
|
38563
|
+
address: string;
|
|
38564
|
+
/** @description Nonce of the transaction initiator */
|
|
38565
|
+
nonce: number;
|
|
38566
|
+
};
|
|
38567
|
+
sponsor: {
|
|
38568
|
+
/** @description Address of the transaction initiator */
|
|
38569
|
+
address: string;
|
|
38570
|
+
/** @description Nonce of the transaction initiator */
|
|
38571
|
+
nonce: number;
|
|
38572
|
+
} | null;
|
|
38573
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
38574
|
+
fee_rate: string;
|
|
38575
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
38576
|
+
receipt_time: number;
|
|
38577
|
+
/** @description Height of the block this transaction was received by the node */
|
|
38578
|
+
receipt_block_height: number;
|
|
38579
|
+
/** @description Status of the mempool transaction */
|
|
38580
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
38581
|
+
/** @enum {string} */
|
|
38582
|
+
type: "tenure_change";
|
|
38583
|
+
})[];
|
|
38584
|
+
};
|
|
38585
|
+
};
|
|
38586
|
+
};
|
|
38587
|
+
/** @description Default Response */
|
|
38588
|
+
"4XX": {
|
|
38589
|
+
headers: {
|
|
38590
|
+
[name: string]: unknown;
|
|
38591
|
+
};
|
|
38592
|
+
content: {
|
|
38593
|
+
"application/json": {
|
|
38594
|
+
error: string;
|
|
38595
|
+
message?: string;
|
|
38596
|
+
} & {
|
|
38597
|
+
[key: string]: unknown;
|
|
38598
|
+
};
|
|
38599
|
+
};
|
|
38600
|
+
};
|
|
38601
|
+
};
|
|
38602
|
+
};
|
|
38331
38603
|
get_bonds: {
|
|
38332
38604
|
parameters: {
|
|
38333
38605
|
query?: {
|
|
@@ -38928,6 +39200,70 @@ export interface operations {
|
|
|
38928
39200
|
};
|
|
38929
39201
|
};
|
|
38930
39202
|
};
|
|
39203
|
+
get_staking_signer_stakers: {
|
|
39204
|
+
parameters: {
|
|
39205
|
+
query?: {
|
|
39206
|
+
/** @description Number of results per page */
|
|
39207
|
+
limit?: number;
|
|
39208
|
+
/** @description Cursor for paginating a signer's stakers (sorted by staker). Format: staker principal */
|
|
39209
|
+
cursor?: string;
|
|
39210
|
+
};
|
|
39211
|
+
header?: never;
|
|
39212
|
+
path: {
|
|
39213
|
+
principal: string;
|
|
39214
|
+
};
|
|
39215
|
+
cookie?: never;
|
|
39216
|
+
};
|
|
39217
|
+
requestBody?: never;
|
|
39218
|
+
responses: {
|
|
39219
|
+
/** @description Default Response */
|
|
39220
|
+
200: {
|
|
39221
|
+
headers: {
|
|
39222
|
+
[name: string]: unknown;
|
|
39223
|
+
};
|
|
39224
|
+
content: {
|
|
39225
|
+
"application/json": {
|
|
39226
|
+
/** @example 1 */
|
|
39227
|
+
total: number;
|
|
39228
|
+
/**
|
|
39229
|
+
* @description Number of results per page
|
|
39230
|
+
* @default 100
|
|
39231
|
+
*/
|
|
39232
|
+
limit: number;
|
|
39233
|
+
cursor: {
|
|
39234
|
+
next: string | null;
|
|
39235
|
+
previous: string | null;
|
|
39236
|
+
current: string | null;
|
|
39237
|
+
};
|
|
39238
|
+
results: {
|
|
39239
|
+
staker: string;
|
|
39240
|
+
/**
|
|
39241
|
+
* @description The staking types this staker participates in under this signer: `stx` for direct pox-5 STX staking, `btc` for BTC/sBTC bond staking. A staker doing both has both entries.
|
|
39242
|
+
* @example [
|
|
39243
|
+
* "stx"
|
|
39244
|
+
* ]
|
|
39245
|
+
*/
|
|
39246
|
+
types: ("stx" | "btc")[];
|
|
39247
|
+
}[];
|
|
39248
|
+
};
|
|
39249
|
+
};
|
|
39250
|
+
};
|
|
39251
|
+
/** @description Default Response */
|
|
39252
|
+
"4XX": {
|
|
39253
|
+
headers: {
|
|
39254
|
+
[name: string]: unknown;
|
|
39255
|
+
};
|
|
39256
|
+
content: {
|
|
39257
|
+
"application/json": {
|
|
39258
|
+
error: string;
|
|
39259
|
+
message?: string;
|
|
39260
|
+
} & {
|
|
39261
|
+
[key: string]: unknown;
|
|
39262
|
+
};
|
|
39263
|
+
};
|
|
39264
|
+
};
|
|
39265
|
+
};
|
|
39266
|
+
};
|
|
38931
39267
|
get_transactions: {
|
|
38932
39268
|
parameters: {
|
|
38933
39269
|
query?: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stacks/blockchain-api-client",
|
|
3
|
-
"version": "9.0.0-pox5.
|
|
3
|
+
"version": "9.0.0-pox5.15",
|
|
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",
|
|
@@ -120,8 +120,11 @@ export interface paths {
|
|
|
120
120
|
};
|
|
121
121
|
/**
|
|
122
122
|
* Transaction Events
|
|
123
|
+
* @deprecated
|
|
123
124
|
* @description Retrieves the list of events filtered by principal (STX address or Smart Contract ID), transaction id or event types.
|
|
124
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.
|
|
125
128
|
*/
|
|
126
129
|
get: operations["get_filtered_events"];
|
|
127
130
|
put?: never;
|
|
@@ -348,10 +351,13 @@ export interface paths {
|
|
|
348
351
|
};
|
|
349
352
|
/**
|
|
350
353
|
* Non-Fungible Token holdings
|
|
354
|
+
* @deprecated
|
|
351
355
|
* @description Retrieves the list of Non-Fungible Tokens owned by the given principal (STX address or Smart Contract ID).
|
|
352
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.
|
|
353
357
|
*
|
|
354
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.
|
|
355
361
|
*/
|
|
356
362
|
get: operations["get_nft_holdings"];
|
|
357
363
|
put?: never;
|
|
@@ -935,7 +941,8 @@ export interface paths {
|
|
|
935
941
|
};
|
|
936
942
|
/**
|
|
937
943
|
* Transactions for address
|
|
938
|
-
* @
|
|
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.
|
|
939
946
|
*/
|
|
940
947
|
get: operations["get_address_mempool_transactions"];
|
|
941
948
|
put?: never;
|
|
@@ -1972,6 +1979,26 @@ export interface paths {
|
|
|
1972
1979
|
patch?: never;
|
|
1973
1980
|
trace?: never;
|
|
1974
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
|
+
};
|
|
1975
2002
|
"/extended/v3/staking/bonds": {
|
|
1976
2003
|
parameters: {
|
|
1977
2004
|
query?: never;
|
|
@@ -2132,6 +2159,26 @@ export interface paths {
|
|
|
2132
2159
|
patch?: never;
|
|
2133
2160
|
trace?: never;
|
|
2134
2161
|
};
|
|
2162
|
+
"/extended/v3/staking/signers/{principal}/stakers": {
|
|
2163
|
+
parameters: {
|
|
2164
|
+
query?: never;
|
|
2165
|
+
header?: never;
|
|
2166
|
+
path?: never;
|
|
2167
|
+
cookie?: never;
|
|
2168
|
+
};
|
|
2169
|
+
/**
|
|
2170
|
+
* Get staking signer stakers
|
|
2171
|
+
* @description List the stakers that belong to a pox-5 signer, across both direct STX staking and BTC/sBTC bond staking. Each entry indicates which staking type(s) the staker participates in under this signer.
|
|
2172
|
+
*/
|
|
2173
|
+
get: operations["get_staking_signer_stakers"];
|
|
2174
|
+
put?: never;
|
|
2175
|
+
post?: never;
|
|
2176
|
+
delete?: never;
|
|
2177
|
+
options?: never;
|
|
2178
|
+
head?: never;
|
|
2179
|
+
patch?: never;
|
|
2180
|
+
trace?: never;
|
|
2181
|
+
};
|
|
2135
2182
|
"/extended/v3/transactions": {
|
|
2136
2183
|
parameters: {
|
|
2137
2184
|
query?: never;
|
|
@@ -38328,6 +38375,231 @@ export interface operations {
|
|
|
38328
38375
|
};
|
|
38329
38376
|
};
|
|
38330
38377
|
};
|
|
38378
|
+
get_principal_mempool_transactions: {
|
|
38379
|
+
parameters: {
|
|
38380
|
+
query?: {
|
|
38381
|
+
/** @description Number of results per page */
|
|
38382
|
+
limit?: number;
|
|
38383
|
+
/** @description Cursor for paginating mempool transactions. Format: receipt_time:tx_id */
|
|
38384
|
+
cursor?: string;
|
|
38385
|
+
};
|
|
38386
|
+
header?: never;
|
|
38387
|
+
path: {
|
|
38388
|
+
principal: string;
|
|
38389
|
+
};
|
|
38390
|
+
cookie?: never;
|
|
38391
|
+
};
|
|
38392
|
+
requestBody?: never;
|
|
38393
|
+
responses: {
|
|
38394
|
+
/** @description Default Response */
|
|
38395
|
+
200: {
|
|
38396
|
+
headers: {
|
|
38397
|
+
[name: string]: unknown;
|
|
38398
|
+
};
|
|
38399
|
+
content: {
|
|
38400
|
+
"application/json": {
|
|
38401
|
+
/** @example 1 */
|
|
38402
|
+
total: number;
|
|
38403
|
+
/**
|
|
38404
|
+
* @description Number of results per page
|
|
38405
|
+
* @default 20
|
|
38406
|
+
*/
|
|
38407
|
+
limit: number;
|
|
38408
|
+
cursor: {
|
|
38409
|
+
next: string | null;
|
|
38410
|
+
previous: string | null;
|
|
38411
|
+
current: string | null;
|
|
38412
|
+
};
|
|
38413
|
+
results: ({
|
|
38414
|
+
/** @description Transaction ID */
|
|
38415
|
+
tx_id: string;
|
|
38416
|
+
sender: {
|
|
38417
|
+
/** @description Address of the transaction initiator */
|
|
38418
|
+
address: string;
|
|
38419
|
+
/** @description Nonce of the transaction initiator */
|
|
38420
|
+
nonce: number;
|
|
38421
|
+
};
|
|
38422
|
+
sponsor: {
|
|
38423
|
+
/** @description Address of the transaction initiator */
|
|
38424
|
+
address: string;
|
|
38425
|
+
/** @description Nonce of the transaction initiator */
|
|
38426
|
+
nonce: number;
|
|
38427
|
+
} | null;
|
|
38428
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
38429
|
+
fee_rate: string;
|
|
38430
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
38431
|
+
receipt_time: number;
|
|
38432
|
+
/** @description Height of the block this transaction was received by the node */
|
|
38433
|
+
receipt_block_height: number;
|
|
38434
|
+
/** @description Status of the mempool transaction */
|
|
38435
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
38436
|
+
/** @enum {string} */
|
|
38437
|
+
type: "token_transfer";
|
|
38438
|
+
token_transfer: {
|
|
38439
|
+
recipient: string;
|
|
38440
|
+
/** @description Transfer amount as Integer string (64-bit unsigned integer) */
|
|
38441
|
+
amount: string;
|
|
38442
|
+
memo: {
|
|
38443
|
+
hex: string;
|
|
38444
|
+
repr: string;
|
|
38445
|
+
} | null;
|
|
38446
|
+
};
|
|
38447
|
+
} | {
|
|
38448
|
+
/** @description Transaction ID */
|
|
38449
|
+
tx_id: string;
|
|
38450
|
+
sender: {
|
|
38451
|
+
/** @description Address of the transaction initiator */
|
|
38452
|
+
address: string;
|
|
38453
|
+
/** @description Nonce of the transaction initiator */
|
|
38454
|
+
nonce: number;
|
|
38455
|
+
};
|
|
38456
|
+
sponsor: {
|
|
38457
|
+
/** @description Address of the transaction initiator */
|
|
38458
|
+
address: string;
|
|
38459
|
+
/** @description Nonce of the transaction initiator */
|
|
38460
|
+
nonce: number;
|
|
38461
|
+
} | null;
|
|
38462
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
38463
|
+
fee_rate: string;
|
|
38464
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
38465
|
+
receipt_time: number;
|
|
38466
|
+
/** @description Height of the block this transaction was received by the node */
|
|
38467
|
+
receipt_block_height: number;
|
|
38468
|
+
/** @description Status of the mempool transaction */
|
|
38469
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
38470
|
+
/** @enum {string} */
|
|
38471
|
+
type: "smart_contract";
|
|
38472
|
+
smart_contract: {
|
|
38473
|
+
clarity_version: number | null;
|
|
38474
|
+
/** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
|
|
38475
|
+
contract_id: string;
|
|
38476
|
+
};
|
|
38477
|
+
} | {
|
|
38478
|
+
/** @description Transaction ID */
|
|
38479
|
+
tx_id: string;
|
|
38480
|
+
sender: {
|
|
38481
|
+
/** @description Address of the transaction initiator */
|
|
38482
|
+
address: string;
|
|
38483
|
+
/** @description Nonce of the transaction initiator */
|
|
38484
|
+
nonce: number;
|
|
38485
|
+
};
|
|
38486
|
+
sponsor: {
|
|
38487
|
+
/** @description Address of the transaction initiator */
|
|
38488
|
+
address: string;
|
|
38489
|
+
/** @description Nonce of the transaction initiator */
|
|
38490
|
+
nonce: number;
|
|
38491
|
+
} | null;
|
|
38492
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
38493
|
+
fee_rate: string;
|
|
38494
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
38495
|
+
receipt_time: number;
|
|
38496
|
+
/** @description Height of the block this transaction was received by the node */
|
|
38497
|
+
receipt_block_height: number;
|
|
38498
|
+
/** @description Status of the mempool transaction */
|
|
38499
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
38500
|
+
/** @enum {string} */
|
|
38501
|
+
type: "contract_call";
|
|
38502
|
+
contract_call: {
|
|
38503
|
+
/** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
|
|
38504
|
+
contract_id: string;
|
|
38505
|
+
/** @description Name of the Clarity function to be invoked */
|
|
38506
|
+
function_name: string;
|
|
38507
|
+
};
|
|
38508
|
+
} | {
|
|
38509
|
+
/** @description Transaction ID */
|
|
38510
|
+
tx_id: string;
|
|
38511
|
+
sender: {
|
|
38512
|
+
/** @description Address of the transaction initiator */
|
|
38513
|
+
address: string;
|
|
38514
|
+
/** @description Nonce of the transaction initiator */
|
|
38515
|
+
nonce: number;
|
|
38516
|
+
};
|
|
38517
|
+
sponsor: {
|
|
38518
|
+
/** @description Address of the transaction initiator */
|
|
38519
|
+
address: string;
|
|
38520
|
+
/** @description Nonce of the transaction initiator */
|
|
38521
|
+
nonce: number;
|
|
38522
|
+
} | null;
|
|
38523
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
38524
|
+
fee_rate: string;
|
|
38525
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
38526
|
+
receipt_time: number;
|
|
38527
|
+
/** @description Height of the block this transaction was received by the node */
|
|
38528
|
+
receipt_block_height: number;
|
|
38529
|
+
/** @description Status of the mempool transaction */
|
|
38530
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
38531
|
+
/** @enum {string} */
|
|
38532
|
+
type: "poison_microblock";
|
|
38533
|
+
} | {
|
|
38534
|
+
/** @description Transaction ID */
|
|
38535
|
+
tx_id: string;
|
|
38536
|
+
sender: {
|
|
38537
|
+
/** @description Address of the transaction initiator */
|
|
38538
|
+
address: string;
|
|
38539
|
+
/** @description Nonce of the transaction initiator */
|
|
38540
|
+
nonce: number;
|
|
38541
|
+
};
|
|
38542
|
+
sponsor: {
|
|
38543
|
+
/** @description Address of the transaction initiator */
|
|
38544
|
+
address: string;
|
|
38545
|
+
/** @description Nonce of the transaction initiator */
|
|
38546
|
+
nonce: number;
|
|
38547
|
+
} | null;
|
|
38548
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
38549
|
+
fee_rate: string;
|
|
38550
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
38551
|
+
receipt_time: number;
|
|
38552
|
+
/** @description Height of the block this transaction was received by the node */
|
|
38553
|
+
receipt_block_height: number;
|
|
38554
|
+
/** @description Status of the mempool transaction */
|
|
38555
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
38556
|
+
/** @enum {string} */
|
|
38557
|
+
type: "coinbase";
|
|
38558
|
+
} | {
|
|
38559
|
+
/** @description Transaction ID */
|
|
38560
|
+
tx_id: string;
|
|
38561
|
+
sender: {
|
|
38562
|
+
/** @description Address of the transaction initiator */
|
|
38563
|
+
address: string;
|
|
38564
|
+
/** @description Nonce of the transaction initiator */
|
|
38565
|
+
nonce: number;
|
|
38566
|
+
};
|
|
38567
|
+
sponsor: {
|
|
38568
|
+
/** @description Address of the transaction initiator */
|
|
38569
|
+
address: string;
|
|
38570
|
+
/** @description Nonce of the transaction initiator */
|
|
38571
|
+
nonce: number;
|
|
38572
|
+
} | null;
|
|
38573
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
38574
|
+
fee_rate: string;
|
|
38575
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
38576
|
+
receipt_time: number;
|
|
38577
|
+
/** @description Height of the block this transaction was received by the node */
|
|
38578
|
+
receipt_block_height: number;
|
|
38579
|
+
/** @description Status of the mempool transaction */
|
|
38580
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
38581
|
+
/** @enum {string} */
|
|
38582
|
+
type: "tenure_change";
|
|
38583
|
+
})[];
|
|
38584
|
+
};
|
|
38585
|
+
};
|
|
38586
|
+
};
|
|
38587
|
+
/** @description Default Response */
|
|
38588
|
+
"4XX": {
|
|
38589
|
+
headers: {
|
|
38590
|
+
[name: string]: unknown;
|
|
38591
|
+
};
|
|
38592
|
+
content: {
|
|
38593
|
+
"application/json": {
|
|
38594
|
+
error: string;
|
|
38595
|
+
message?: string;
|
|
38596
|
+
} & {
|
|
38597
|
+
[key: string]: unknown;
|
|
38598
|
+
};
|
|
38599
|
+
};
|
|
38600
|
+
};
|
|
38601
|
+
};
|
|
38602
|
+
};
|
|
38331
38603
|
get_bonds: {
|
|
38332
38604
|
parameters: {
|
|
38333
38605
|
query?: {
|
|
@@ -38928,6 +39200,70 @@ export interface operations {
|
|
|
38928
39200
|
};
|
|
38929
39201
|
};
|
|
38930
39202
|
};
|
|
39203
|
+
get_staking_signer_stakers: {
|
|
39204
|
+
parameters: {
|
|
39205
|
+
query?: {
|
|
39206
|
+
/** @description Number of results per page */
|
|
39207
|
+
limit?: number;
|
|
39208
|
+
/** @description Cursor for paginating a signer's stakers (sorted by staker). Format: staker principal */
|
|
39209
|
+
cursor?: string;
|
|
39210
|
+
};
|
|
39211
|
+
header?: never;
|
|
39212
|
+
path: {
|
|
39213
|
+
principal: string;
|
|
39214
|
+
};
|
|
39215
|
+
cookie?: never;
|
|
39216
|
+
};
|
|
39217
|
+
requestBody?: never;
|
|
39218
|
+
responses: {
|
|
39219
|
+
/** @description Default Response */
|
|
39220
|
+
200: {
|
|
39221
|
+
headers: {
|
|
39222
|
+
[name: string]: unknown;
|
|
39223
|
+
};
|
|
39224
|
+
content: {
|
|
39225
|
+
"application/json": {
|
|
39226
|
+
/** @example 1 */
|
|
39227
|
+
total: number;
|
|
39228
|
+
/**
|
|
39229
|
+
* @description Number of results per page
|
|
39230
|
+
* @default 100
|
|
39231
|
+
*/
|
|
39232
|
+
limit: number;
|
|
39233
|
+
cursor: {
|
|
39234
|
+
next: string | null;
|
|
39235
|
+
previous: string | null;
|
|
39236
|
+
current: string | null;
|
|
39237
|
+
};
|
|
39238
|
+
results: {
|
|
39239
|
+
staker: string;
|
|
39240
|
+
/**
|
|
39241
|
+
* @description The staking types this staker participates in under this signer: `stx` for direct pox-5 STX staking, `btc` for BTC/sBTC bond staking. A staker doing both has both entries.
|
|
39242
|
+
* @example [
|
|
39243
|
+
* "stx"
|
|
39244
|
+
* ]
|
|
39245
|
+
*/
|
|
39246
|
+
types: ("stx" | "btc")[];
|
|
39247
|
+
}[];
|
|
39248
|
+
};
|
|
39249
|
+
};
|
|
39250
|
+
};
|
|
39251
|
+
/** @description Default Response */
|
|
39252
|
+
"4XX": {
|
|
39253
|
+
headers: {
|
|
39254
|
+
[name: string]: unknown;
|
|
39255
|
+
};
|
|
39256
|
+
content: {
|
|
39257
|
+
"application/json": {
|
|
39258
|
+
error: string;
|
|
39259
|
+
message?: string;
|
|
39260
|
+
} & {
|
|
39261
|
+
[key: string]: unknown;
|
|
39262
|
+
};
|
|
39263
|
+
};
|
|
39264
|
+
};
|
|
39265
|
+
};
|
|
39266
|
+
};
|
|
38931
39267
|
get_transactions: {
|
|
38932
39268
|
parameters: {
|
|
38933
39269
|
query?: {
|