@stacks/blockchain-api-client 9.0.0-next.31 → 9.0.0-next.32
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 +904 -0
- package/package.json +1 -1
- package/src/generated/schema.d.ts +904 -0
|
@@ -1710,6 +1710,66 @@ export interface paths {
|
|
|
1710
1710
|
patch?: never;
|
|
1711
1711
|
trace?: never;
|
|
1712
1712
|
};
|
|
1713
|
+
"/extended/v3/transactions": {
|
|
1714
|
+
parameters: {
|
|
1715
|
+
query?: never;
|
|
1716
|
+
header?: never;
|
|
1717
|
+
path?: never;
|
|
1718
|
+
cookie?: never;
|
|
1719
|
+
};
|
|
1720
|
+
/**
|
|
1721
|
+
* Get transactions
|
|
1722
|
+
* @description Retrieves a list of recently mined transactions
|
|
1723
|
+
*/
|
|
1724
|
+
get: operations["get_transactions"];
|
|
1725
|
+
put?: never;
|
|
1726
|
+
post?: never;
|
|
1727
|
+
delete?: never;
|
|
1728
|
+
options?: never;
|
|
1729
|
+
head?: never;
|
|
1730
|
+
patch?: never;
|
|
1731
|
+
trace?: never;
|
|
1732
|
+
};
|
|
1733
|
+
"/extended/v3/mempool/transactions": {
|
|
1734
|
+
parameters: {
|
|
1735
|
+
query?: never;
|
|
1736
|
+
header?: never;
|
|
1737
|
+
path?: never;
|
|
1738
|
+
cookie?: never;
|
|
1739
|
+
};
|
|
1740
|
+
/**
|
|
1741
|
+
* Get mempool transactions
|
|
1742
|
+
* @description Retrieves a list of recently broadcasted transactions
|
|
1743
|
+
*/
|
|
1744
|
+
get: operations["get_mempool_transactions"];
|
|
1745
|
+
put?: never;
|
|
1746
|
+
post?: never;
|
|
1747
|
+
delete?: never;
|
|
1748
|
+
options?: never;
|
|
1749
|
+
head?: never;
|
|
1750
|
+
patch?: never;
|
|
1751
|
+
trace?: never;
|
|
1752
|
+
};
|
|
1753
|
+
"/extended/v3/blocks/{height_or_hash}/transactions": {
|
|
1754
|
+
parameters: {
|
|
1755
|
+
query?: never;
|
|
1756
|
+
header?: never;
|
|
1757
|
+
path?: never;
|
|
1758
|
+
cookie?: never;
|
|
1759
|
+
};
|
|
1760
|
+
/**
|
|
1761
|
+
* Get block transactions
|
|
1762
|
+
* @description Retrieves transactions confirmed in a single block
|
|
1763
|
+
*/
|
|
1764
|
+
get: operations["get_block_transactions"];
|
|
1765
|
+
put?: never;
|
|
1766
|
+
post?: never;
|
|
1767
|
+
delete?: never;
|
|
1768
|
+
options?: never;
|
|
1769
|
+
head?: never;
|
|
1770
|
+
patch?: never;
|
|
1771
|
+
trace?: never;
|
|
1772
|
+
};
|
|
1713
1773
|
"/v1/names/{name}/zonefile/{zoneFileHash}": {
|
|
1714
1774
|
parameters: {
|
|
1715
1775
|
query?: never;
|
|
@@ -32019,6 +32079,850 @@ export interface operations {
|
|
|
32019
32079
|
};
|
|
32020
32080
|
};
|
|
32021
32081
|
};
|
|
32082
|
+
get_transactions: {
|
|
32083
|
+
parameters: {
|
|
32084
|
+
query?: {
|
|
32085
|
+
/** @description Number of results per page */
|
|
32086
|
+
limit?: number;
|
|
32087
|
+
/** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */
|
|
32088
|
+
cursor?: string;
|
|
32089
|
+
};
|
|
32090
|
+
header?: never;
|
|
32091
|
+
path?: never;
|
|
32092
|
+
cookie?: never;
|
|
32093
|
+
};
|
|
32094
|
+
requestBody?: never;
|
|
32095
|
+
responses: {
|
|
32096
|
+
/** @description Default Response */
|
|
32097
|
+
200: {
|
|
32098
|
+
headers: {
|
|
32099
|
+
[name: string]: unknown;
|
|
32100
|
+
};
|
|
32101
|
+
content: {
|
|
32102
|
+
"application/json": {
|
|
32103
|
+
/** @example 1 */
|
|
32104
|
+
total: number;
|
|
32105
|
+
/**
|
|
32106
|
+
* @description Number of results per page
|
|
32107
|
+
* @default 20
|
|
32108
|
+
*/
|
|
32109
|
+
limit: number;
|
|
32110
|
+
cursor: {
|
|
32111
|
+
next: string | null;
|
|
32112
|
+
previous: string | null;
|
|
32113
|
+
current: string | null;
|
|
32114
|
+
};
|
|
32115
|
+
results: ({
|
|
32116
|
+
/** @description Transaction ID */
|
|
32117
|
+
tx_id: string;
|
|
32118
|
+
sender: {
|
|
32119
|
+
/** @description Address of the transaction initiator */
|
|
32120
|
+
address: string;
|
|
32121
|
+
/** @description Nonce of the transaction initiator */
|
|
32122
|
+
nonce: number;
|
|
32123
|
+
};
|
|
32124
|
+
sponsor: {
|
|
32125
|
+
/** @description Address of the transaction initiator */
|
|
32126
|
+
address: string;
|
|
32127
|
+
/** @description Nonce of the transaction initiator */
|
|
32128
|
+
nonce: number;
|
|
32129
|
+
} | null;
|
|
32130
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32131
|
+
fee_rate: string;
|
|
32132
|
+
block: {
|
|
32133
|
+
/** @description Height of the block this transactions was associated with */
|
|
32134
|
+
height: number;
|
|
32135
|
+
/** @description Hash of the blocked this transactions was associated with */
|
|
32136
|
+
hash: string;
|
|
32137
|
+
/** @description Hash of the index block this transactions was associated with */
|
|
32138
|
+
index_hash: string;
|
|
32139
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32140
|
+
time: number;
|
|
32141
|
+
/** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
|
|
32142
|
+
tx_index: number;
|
|
32143
|
+
};
|
|
32144
|
+
bitcoin_block: {
|
|
32145
|
+
/** @description Height of the anchor burn block. */
|
|
32146
|
+
height: number;
|
|
32147
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32148
|
+
time: number;
|
|
32149
|
+
};
|
|
32150
|
+
/** @description Status of the transaction */
|
|
32151
|
+
status: "success" | "abort_by_response" | "abort_by_post_condition";
|
|
32152
|
+
/** @enum {string} */
|
|
32153
|
+
type: "token_transfer";
|
|
32154
|
+
token_transfer: {
|
|
32155
|
+
recipient: string;
|
|
32156
|
+
/** @description Transfer amount as Integer string (64-bit unsigned integer) */
|
|
32157
|
+
amount: string;
|
|
32158
|
+
memo: string | null;
|
|
32159
|
+
};
|
|
32160
|
+
} | {
|
|
32161
|
+
/** @description Transaction ID */
|
|
32162
|
+
tx_id: string;
|
|
32163
|
+
sender: {
|
|
32164
|
+
/** @description Address of the transaction initiator */
|
|
32165
|
+
address: string;
|
|
32166
|
+
/** @description Nonce of the transaction initiator */
|
|
32167
|
+
nonce: number;
|
|
32168
|
+
};
|
|
32169
|
+
sponsor: {
|
|
32170
|
+
/** @description Address of the transaction initiator */
|
|
32171
|
+
address: string;
|
|
32172
|
+
/** @description Nonce of the transaction initiator */
|
|
32173
|
+
nonce: number;
|
|
32174
|
+
} | null;
|
|
32175
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32176
|
+
fee_rate: string;
|
|
32177
|
+
block: {
|
|
32178
|
+
/** @description Height of the block this transactions was associated with */
|
|
32179
|
+
height: number;
|
|
32180
|
+
/** @description Hash of the blocked this transactions was associated with */
|
|
32181
|
+
hash: string;
|
|
32182
|
+
/** @description Hash of the index block this transactions was associated with */
|
|
32183
|
+
index_hash: string;
|
|
32184
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32185
|
+
time: number;
|
|
32186
|
+
/** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
|
|
32187
|
+
tx_index: number;
|
|
32188
|
+
};
|
|
32189
|
+
bitcoin_block: {
|
|
32190
|
+
/** @description Height of the anchor burn block. */
|
|
32191
|
+
height: number;
|
|
32192
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32193
|
+
time: number;
|
|
32194
|
+
};
|
|
32195
|
+
/** @description Status of the transaction */
|
|
32196
|
+
status: "success" | "abort_by_response" | "abort_by_post_condition";
|
|
32197
|
+
/** @enum {string} */
|
|
32198
|
+
type: "smart_contract";
|
|
32199
|
+
smart_contract: {
|
|
32200
|
+
clarity_version: number | null;
|
|
32201
|
+
/** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
|
|
32202
|
+
contract_id: string;
|
|
32203
|
+
};
|
|
32204
|
+
} | {
|
|
32205
|
+
/** @description Transaction ID */
|
|
32206
|
+
tx_id: string;
|
|
32207
|
+
sender: {
|
|
32208
|
+
/** @description Address of the transaction initiator */
|
|
32209
|
+
address: string;
|
|
32210
|
+
/** @description Nonce of the transaction initiator */
|
|
32211
|
+
nonce: number;
|
|
32212
|
+
};
|
|
32213
|
+
sponsor: {
|
|
32214
|
+
/** @description Address of the transaction initiator */
|
|
32215
|
+
address: string;
|
|
32216
|
+
/** @description Nonce of the transaction initiator */
|
|
32217
|
+
nonce: number;
|
|
32218
|
+
} | null;
|
|
32219
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32220
|
+
fee_rate: string;
|
|
32221
|
+
block: {
|
|
32222
|
+
/** @description Height of the block this transactions was associated with */
|
|
32223
|
+
height: number;
|
|
32224
|
+
/** @description Hash of the blocked this transactions was associated with */
|
|
32225
|
+
hash: string;
|
|
32226
|
+
/** @description Hash of the index block this transactions was associated with */
|
|
32227
|
+
index_hash: string;
|
|
32228
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32229
|
+
time: number;
|
|
32230
|
+
/** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
|
|
32231
|
+
tx_index: number;
|
|
32232
|
+
};
|
|
32233
|
+
bitcoin_block: {
|
|
32234
|
+
/** @description Height of the anchor burn block. */
|
|
32235
|
+
height: number;
|
|
32236
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32237
|
+
time: number;
|
|
32238
|
+
};
|
|
32239
|
+
/** @description Status of the transaction */
|
|
32240
|
+
status: "success" | "abort_by_response" | "abort_by_post_condition";
|
|
32241
|
+
/** @enum {string} */
|
|
32242
|
+
type: "contract_call";
|
|
32243
|
+
contract_call: {
|
|
32244
|
+
/** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
|
|
32245
|
+
contract_id: string;
|
|
32246
|
+
/** @description Name of the Clarity function to be invoked */
|
|
32247
|
+
function_name: string;
|
|
32248
|
+
};
|
|
32249
|
+
} | {
|
|
32250
|
+
/** @description Transaction ID */
|
|
32251
|
+
tx_id: string;
|
|
32252
|
+
sender: {
|
|
32253
|
+
/** @description Address of the transaction initiator */
|
|
32254
|
+
address: string;
|
|
32255
|
+
/** @description Nonce of the transaction initiator */
|
|
32256
|
+
nonce: number;
|
|
32257
|
+
};
|
|
32258
|
+
sponsor: {
|
|
32259
|
+
/** @description Address of the transaction initiator */
|
|
32260
|
+
address: string;
|
|
32261
|
+
/** @description Nonce of the transaction initiator */
|
|
32262
|
+
nonce: number;
|
|
32263
|
+
} | null;
|
|
32264
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32265
|
+
fee_rate: string;
|
|
32266
|
+
block: {
|
|
32267
|
+
/** @description Height of the block this transactions was associated with */
|
|
32268
|
+
height: number;
|
|
32269
|
+
/** @description Hash of the blocked this transactions was associated with */
|
|
32270
|
+
hash: string;
|
|
32271
|
+
/** @description Hash of the index block this transactions was associated with */
|
|
32272
|
+
index_hash: string;
|
|
32273
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32274
|
+
time: number;
|
|
32275
|
+
/** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
|
|
32276
|
+
tx_index: number;
|
|
32277
|
+
};
|
|
32278
|
+
bitcoin_block: {
|
|
32279
|
+
/** @description Height of the anchor burn block. */
|
|
32280
|
+
height: number;
|
|
32281
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32282
|
+
time: number;
|
|
32283
|
+
};
|
|
32284
|
+
/** @description Status of the transaction */
|
|
32285
|
+
status: "success" | "abort_by_response" | "abort_by_post_condition";
|
|
32286
|
+
/** @enum {string} */
|
|
32287
|
+
type: "poison_microblock";
|
|
32288
|
+
} | {
|
|
32289
|
+
/** @description Transaction ID */
|
|
32290
|
+
tx_id: string;
|
|
32291
|
+
sender: {
|
|
32292
|
+
/** @description Address of the transaction initiator */
|
|
32293
|
+
address: string;
|
|
32294
|
+
/** @description Nonce of the transaction initiator */
|
|
32295
|
+
nonce: number;
|
|
32296
|
+
};
|
|
32297
|
+
sponsor: {
|
|
32298
|
+
/** @description Address of the transaction initiator */
|
|
32299
|
+
address: string;
|
|
32300
|
+
/** @description Nonce of the transaction initiator */
|
|
32301
|
+
nonce: number;
|
|
32302
|
+
} | null;
|
|
32303
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32304
|
+
fee_rate: string;
|
|
32305
|
+
block: {
|
|
32306
|
+
/** @description Height of the block this transactions was associated with */
|
|
32307
|
+
height: number;
|
|
32308
|
+
/** @description Hash of the blocked this transactions was associated with */
|
|
32309
|
+
hash: string;
|
|
32310
|
+
/** @description Hash of the index block this transactions was associated with */
|
|
32311
|
+
index_hash: string;
|
|
32312
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32313
|
+
time: number;
|
|
32314
|
+
/** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
|
|
32315
|
+
tx_index: number;
|
|
32316
|
+
};
|
|
32317
|
+
bitcoin_block: {
|
|
32318
|
+
/** @description Height of the anchor burn block. */
|
|
32319
|
+
height: number;
|
|
32320
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32321
|
+
time: number;
|
|
32322
|
+
};
|
|
32323
|
+
/** @description Status of the transaction */
|
|
32324
|
+
status: "success" | "abort_by_response" | "abort_by_post_condition";
|
|
32325
|
+
/** @enum {string} */
|
|
32326
|
+
type: "coinbase";
|
|
32327
|
+
coinbase: {
|
|
32328
|
+
alt_recipient: string | null;
|
|
32329
|
+
};
|
|
32330
|
+
} | {
|
|
32331
|
+
/** @description Transaction ID */
|
|
32332
|
+
tx_id: string;
|
|
32333
|
+
sender: {
|
|
32334
|
+
/** @description Address of the transaction initiator */
|
|
32335
|
+
address: string;
|
|
32336
|
+
/** @description Nonce of the transaction initiator */
|
|
32337
|
+
nonce: number;
|
|
32338
|
+
};
|
|
32339
|
+
sponsor: {
|
|
32340
|
+
/** @description Address of the transaction initiator */
|
|
32341
|
+
address: string;
|
|
32342
|
+
/** @description Nonce of the transaction initiator */
|
|
32343
|
+
nonce: number;
|
|
32344
|
+
} | null;
|
|
32345
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32346
|
+
fee_rate: string;
|
|
32347
|
+
block: {
|
|
32348
|
+
/** @description Height of the block this transactions was associated with */
|
|
32349
|
+
height: number;
|
|
32350
|
+
/** @description Hash of the blocked this transactions was associated with */
|
|
32351
|
+
hash: string;
|
|
32352
|
+
/** @description Hash of the index block this transactions was associated with */
|
|
32353
|
+
index_hash: string;
|
|
32354
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32355
|
+
time: number;
|
|
32356
|
+
/** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
|
|
32357
|
+
tx_index: number;
|
|
32358
|
+
};
|
|
32359
|
+
bitcoin_block: {
|
|
32360
|
+
/** @description Height of the anchor burn block. */
|
|
32361
|
+
height: number;
|
|
32362
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32363
|
+
time: number;
|
|
32364
|
+
};
|
|
32365
|
+
/** @description Status of the transaction */
|
|
32366
|
+
status: "success" | "abort_by_response" | "abort_by_post_condition";
|
|
32367
|
+
/** @enum {string} */
|
|
32368
|
+
type: "tenure_change";
|
|
32369
|
+
tenure_change: {
|
|
32370
|
+
/** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */
|
|
32371
|
+
cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length";
|
|
32372
|
+
};
|
|
32373
|
+
})[];
|
|
32374
|
+
};
|
|
32375
|
+
};
|
|
32376
|
+
};
|
|
32377
|
+
/** @description Default Response */
|
|
32378
|
+
"4XX": {
|
|
32379
|
+
headers: {
|
|
32380
|
+
[name: string]: unknown;
|
|
32381
|
+
};
|
|
32382
|
+
content: {
|
|
32383
|
+
"application/json": {
|
|
32384
|
+
error: string;
|
|
32385
|
+
message?: string;
|
|
32386
|
+
} & {
|
|
32387
|
+
[key: string]: unknown;
|
|
32388
|
+
};
|
|
32389
|
+
};
|
|
32390
|
+
};
|
|
32391
|
+
};
|
|
32392
|
+
};
|
|
32393
|
+
get_mempool_transactions: {
|
|
32394
|
+
parameters: {
|
|
32395
|
+
query?: {
|
|
32396
|
+
/** @description Number of results per page */
|
|
32397
|
+
limit?: number;
|
|
32398
|
+
/** @description Cursor for paginating mempool transactions. Format: receipt_time:tx_id */
|
|
32399
|
+
cursor?: string;
|
|
32400
|
+
};
|
|
32401
|
+
header?: never;
|
|
32402
|
+
path?: never;
|
|
32403
|
+
cookie?: never;
|
|
32404
|
+
};
|
|
32405
|
+
requestBody?: never;
|
|
32406
|
+
responses: {
|
|
32407
|
+
/** @description Default Response */
|
|
32408
|
+
200: {
|
|
32409
|
+
headers: {
|
|
32410
|
+
[name: string]: unknown;
|
|
32411
|
+
};
|
|
32412
|
+
content: {
|
|
32413
|
+
"application/json": {
|
|
32414
|
+
/** @example 1 */
|
|
32415
|
+
total: number;
|
|
32416
|
+
/**
|
|
32417
|
+
* @description Number of results per page
|
|
32418
|
+
* @default 20
|
|
32419
|
+
*/
|
|
32420
|
+
limit: number;
|
|
32421
|
+
cursor: {
|
|
32422
|
+
next: string | null;
|
|
32423
|
+
previous: string | null;
|
|
32424
|
+
current: string | null;
|
|
32425
|
+
};
|
|
32426
|
+
results: ({
|
|
32427
|
+
/** @description Transaction ID */
|
|
32428
|
+
tx_id: string;
|
|
32429
|
+
sender: {
|
|
32430
|
+
/** @description Address of the transaction initiator */
|
|
32431
|
+
address: string;
|
|
32432
|
+
/** @description Nonce of the transaction initiator */
|
|
32433
|
+
nonce: number;
|
|
32434
|
+
};
|
|
32435
|
+
sponsor: {
|
|
32436
|
+
/** @description Address of the transaction initiator */
|
|
32437
|
+
address: string;
|
|
32438
|
+
/** @description Nonce of the transaction initiator */
|
|
32439
|
+
nonce: number;
|
|
32440
|
+
} | null;
|
|
32441
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32442
|
+
fee_rate: string;
|
|
32443
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
32444
|
+
receipt_time: number;
|
|
32445
|
+
/** @description Height of the block this transaction was received by the node */
|
|
32446
|
+
receipt_block_height: number;
|
|
32447
|
+
/** @description Status of the mempool transaction */
|
|
32448
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
32449
|
+
/** @enum {string} */
|
|
32450
|
+
type: "token_transfer";
|
|
32451
|
+
token_transfer: {
|
|
32452
|
+
recipient: string;
|
|
32453
|
+
/** @description Transfer amount as Integer string (64-bit unsigned integer) */
|
|
32454
|
+
amount: string;
|
|
32455
|
+
memo: string | null;
|
|
32456
|
+
};
|
|
32457
|
+
} | {
|
|
32458
|
+
/** @description Transaction ID */
|
|
32459
|
+
tx_id: string;
|
|
32460
|
+
sender: {
|
|
32461
|
+
/** @description Address of the transaction initiator */
|
|
32462
|
+
address: string;
|
|
32463
|
+
/** @description Nonce of the transaction initiator */
|
|
32464
|
+
nonce: number;
|
|
32465
|
+
};
|
|
32466
|
+
sponsor: {
|
|
32467
|
+
/** @description Address of the transaction initiator */
|
|
32468
|
+
address: string;
|
|
32469
|
+
/** @description Nonce of the transaction initiator */
|
|
32470
|
+
nonce: number;
|
|
32471
|
+
} | null;
|
|
32472
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32473
|
+
fee_rate: string;
|
|
32474
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
32475
|
+
receipt_time: number;
|
|
32476
|
+
/** @description Height of the block this transaction was received by the node */
|
|
32477
|
+
receipt_block_height: number;
|
|
32478
|
+
/** @description Status of the mempool transaction */
|
|
32479
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
32480
|
+
/** @enum {string} */
|
|
32481
|
+
type: "smart_contract";
|
|
32482
|
+
smart_contract: {
|
|
32483
|
+
clarity_version: number | null;
|
|
32484
|
+
/** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
|
|
32485
|
+
contract_id: string;
|
|
32486
|
+
};
|
|
32487
|
+
} | {
|
|
32488
|
+
/** @description Transaction ID */
|
|
32489
|
+
tx_id: string;
|
|
32490
|
+
sender: {
|
|
32491
|
+
/** @description Address of the transaction initiator */
|
|
32492
|
+
address: string;
|
|
32493
|
+
/** @description Nonce of the transaction initiator */
|
|
32494
|
+
nonce: number;
|
|
32495
|
+
};
|
|
32496
|
+
sponsor: {
|
|
32497
|
+
/** @description Address of the transaction initiator */
|
|
32498
|
+
address: string;
|
|
32499
|
+
/** @description Nonce of the transaction initiator */
|
|
32500
|
+
nonce: number;
|
|
32501
|
+
} | null;
|
|
32502
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32503
|
+
fee_rate: string;
|
|
32504
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
32505
|
+
receipt_time: number;
|
|
32506
|
+
/** @description Height of the block this transaction was received by the node */
|
|
32507
|
+
receipt_block_height: number;
|
|
32508
|
+
/** @description Status of the mempool transaction */
|
|
32509
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
32510
|
+
/** @enum {string} */
|
|
32511
|
+
type: "contract_call";
|
|
32512
|
+
contract_call: {
|
|
32513
|
+
/** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
|
|
32514
|
+
contract_id: string;
|
|
32515
|
+
/** @description Name of the Clarity function to be invoked */
|
|
32516
|
+
function_name: string;
|
|
32517
|
+
};
|
|
32518
|
+
} | {
|
|
32519
|
+
/** @description Transaction ID */
|
|
32520
|
+
tx_id: string;
|
|
32521
|
+
sender: {
|
|
32522
|
+
/** @description Address of the transaction initiator */
|
|
32523
|
+
address: string;
|
|
32524
|
+
/** @description Nonce of the transaction initiator */
|
|
32525
|
+
nonce: number;
|
|
32526
|
+
};
|
|
32527
|
+
sponsor: {
|
|
32528
|
+
/** @description Address of the transaction initiator */
|
|
32529
|
+
address: string;
|
|
32530
|
+
/** @description Nonce of the transaction initiator */
|
|
32531
|
+
nonce: number;
|
|
32532
|
+
} | null;
|
|
32533
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32534
|
+
fee_rate: string;
|
|
32535
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
32536
|
+
receipt_time: number;
|
|
32537
|
+
/** @description Height of the block this transaction was received by the node */
|
|
32538
|
+
receipt_block_height: number;
|
|
32539
|
+
/** @description Status of the mempool transaction */
|
|
32540
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
32541
|
+
/** @enum {string} */
|
|
32542
|
+
type: "poison_microblock";
|
|
32543
|
+
} | {
|
|
32544
|
+
/** @description Transaction ID */
|
|
32545
|
+
tx_id: string;
|
|
32546
|
+
sender: {
|
|
32547
|
+
/** @description Address of the transaction initiator */
|
|
32548
|
+
address: string;
|
|
32549
|
+
/** @description Nonce of the transaction initiator */
|
|
32550
|
+
nonce: number;
|
|
32551
|
+
};
|
|
32552
|
+
sponsor: {
|
|
32553
|
+
/** @description Address of the transaction initiator */
|
|
32554
|
+
address: string;
|
|
32555
|
+
/** @description Nonce of the transaction initiator */
|
|
32556
|
+
nonce: number;
|
|
32557
|
+
} | null;
|
|
32558
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32559
|
+
fee_rate: string;
|
|
32560
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
32561
|
+
receipt_time: number;
|
|
32562
|
+
/** @description Height of the block this transaction was received by the node */
|
|
32563
|
+
receipt_block_height: number;
|
|
32564
|
+
/** @description Status of the mempool transaction */
|
|
32565
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
32566
|
+
/** @enum {string} */
|
|
32567
|
+
type: "coinbase";
|
|
32568
|
+
} | {
|
|
32569
|
+
/** @description Transaction ID */
|
|
32570
|
+
tx_id: string;
|
|
32571
|
+
sender: {
|
|
32572
|
+
/** @description Address of the transaction initiator */
|
|
32573
|
+
address: string;
|
|
32574
|
+
/** @description Nonce of the transaction initiator */
|
|
32575
|
+
nonce: number;
|
|
32576
|
+
};
|
|
32577
|
+
sponsor: {
|
|
32578
|
+
/** @description Address of the transaction initiator */
|
|
32579
|
+
address: string;
|
|
32580
|
+
/** @description Nonce of the transaction initiator */
|
|
32581
|
+
nonce: number;
|
|
32582
|
+
} | null;
|
|
32583
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32584
|
+
fee_rate: string;
|
|
32585
|
+
/** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
|
|
32586
|
+
receipt_time: number;
|
|
32587
|
+
/** @description Height of the block this transaction was received by the node */
|
|
32588
|
+
receipt_block_height: number;
|
|
32589
|
+
/** @description Status of the mempool transaction */
|
|
32590
|
+
status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
|
|
32591
|
+
/** @enum {string} */
|
|
32592
|
+
type: "tenure_change";
|
|
32593
|
+
})[];
|
|
32594
|
+
};
|
|
32595
|
+
};
|
|
32596
|
+
};
|
|
32597
|
+
/** @description Default Response */
|
|
32598
|
+
"4XX": {
|
|
32599
|
+
headers: {
|
|
32600
|
+
[name: string]: unknown;
|
|
32601
|
+
};
|
|
32602
|
+
content: {
|
|
32603
|
+
"application/json": {
|
|
32604
|
+
error: string;
|
|
32605
|
+
message?: string;
|
|
32606
|
+
} & {
|
|
32607
|
+
[key: string]: unknown;
|
|
32608
|
+
};
|
|
32609
|
+
};
|
|
32610
|
+
};
|
|
32611
|
+
};
|
|
32612
|
+
};
|
|
32613
|
+
get_block_transactions: {
|
|
32614
|
+
parameters: {
|
|
32615
|
+
query?: {
|
|
32616
|
+
/** @description Number of results per page */
|
|
32617
|
+
limit?: number;
|
|
32618
|
+
/** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */
|
|
32619
|
+
cursor?: string;
|
|
32620
|
+
};
|
|
32621
|
+
header?: never;
|
|
32622
|
+
path: {
|
|
32623
|
+
height_or_hash: "latest" | string | number;
|
|
32624
|
+
};
|
|
32625
|
+
cookie?: never;
|
|
32626
|
+
};
|
|
32627
|
+
requestBody?: never;
|
|
32628
|
+
responses: {
|
|
32629
|
+
/** @description Default Response */
|
|
32630
|
+
200: {
|
|
32631
|
+
headers: {
|
|
32632
|
+
[name: string]: unknown;
|
|
32633
|
+
};
|
|
32634
|
+
content: {
|
|
32635
|
+
"application/json": {
|
|
32636
|
+
/** @example 1 */
|
|
32637
|
+
total: number;
|
|
32638
|
+
/**
|
|
32639
|
+
* @description Number of results per page
|
|
32640
|
+
* @default 20
|
|
32641
|
+
*/
|
|
32642
|
+
limit: number;
|
|
32643
|
+
cursor: {
|
|
32644
|
+
next: string | null;
|
|
32645
|
+
previous: string | null;
|
|
32646
|
+
current: string | null;
|
|
32647
|
+
};
|
|
32648
|
+
results: ({
|
|
32649
|
+
/** @description Transaction ID */
|
|
32650
|
+
tx_id: string;
|
|
32651
|
+
sender: {
|
|
32652
|
+
/** @description Address of the transaction initiator */
|
|
32653
|
+
address: string;
|
|
32654
|
+
/** @description Nonce of the transaction initiator */
|
|
32655
|
+
nonce: number;
|
|
32656
|
+
};
|
|
32657
|
+
sponsor: {
|
|
32658
|
+
/** @description Address of the transaction initiator */
|
|
32659
|
+
address: string;
|
|
32660
|
+
/** @description Nonce of the transaction initiator */
|
|
32661
|
+
nonce: number;
|
|
32662
|
+
} | null;
|
|
32663
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32664
|
+
fee_rate: string;
|
|
32665
|
+
block: {
|
|
32666
|
+
/** @description Height of the block this transactions was associated with */
|
|
32667
|
+
height: number;
|
|
32668
|
+
/** @description Hash of the blocked this transactions was associated with */
|
|
32669
|
+
hash: string;
|
|
32670
|
+
/** @description Hash of the index block this transactions was associated with */
|
|
32671
|
+
index_hash: string;
|
|
32672
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32673
|
+
time: number;
|
|
32674
|
+
/** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
|
|
32675
|
+
tx_index: number;
|
|
32676
|
+
};
|
|
32677
|
+
bitcoin_block: {
|
|
32678
|
+
/** @description Height of the anchor burn block. */
|
|
32679
|
+
height: number;
|
|
32680
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32681
|
+
time: number;
|
|
32682
|
+
};
|
|
32683
|
+
/** @description Status of the transaction */
|
|
32684
|
+
status: "success" | "abort_by_response" | "abort_by_post_condition";
|
|
32685
|
+
/** @enum {string} */
|
|
32686
|
+
type: "token_transfer";
|
|
32687
|
+
token_transfer: {
|
|
32688
|
+
recipient: string;
|
|
32689
|
+
/** @description Transfer amount as Integer string (64-bit unsigned integer) */
|
|
32690
|
+
amount: string;
|
|
32691
|
+
memo: string | null;
|
|
32692
|
+
};
|
|
32693
|
+
} | {
|
|
32694
|
+
/** @description Transaction ID */
|
|
32695
|
+
tx_id: string;
|
|
32696
|
+
sender: {
|
|
32697
|
+
/** @description Address of the transaction initiator */
|
|
32698
|
+
address: string;
|
|
32699
|
+
/** @description Nonce of the transaction initiator */
|
|
32700
|
+
nonce: number;
|
|
32701
|
+
};
|
|
32702
|
+
sponsor: {
|
|
32703
|
+
/** @description Address of the transaction initiator */
|
|
32704
|
+
address: string;
|
|
32705
|
+
/** @description Nonce of the transaction initiator */
|
|
32706
|
+
nonce: number;
|
|
32707
|
+
} | null;
|
|
32708
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32709
|
+
fee_rate: string;
|
|
32710
|
+
block: {
|
|
32711
|
+
/** @description Height of the block this transactions was associated with */
|
|
32712
|
+
height: number;
|
|
32713
|
+
/** @description Hash of the blocked this transactions was associated with */
|
|
32714
|
+
hash: string;
|
|
32715
|
+
/** @description Hash of the index block this transactions was associated with */
|
|
32716
|
+
index_hash: string;
|
|
32717
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32718
|
+
time: number;
|
|
32719
|
+
/** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
|
|
32720
|
+
tx_index: number;
|
|
32721
|
+
};
|
|
32722
|
+
bitcoin_block: {
|
|
32723
|
+
/** @description Height of the anchor burn block. */
|
|
32724
|
+
height: number;
|
|
32725
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32726
|
+
time: number;
|
|
32727
|
+
};
|
|
32728
|
+
/** @description Status of the transaction */
|
|
32729
|
+
status: "success" | "abort_by_response" | "abort_by_post_condition";
|
|
32730
|
+
/** @enum {string} */
|
|
32731
|
+
type: "smart_contract";
|
|
32732
|
+
smart_contract: {
|
|
32733
|
+
clarity_version: number | null;
|
|
32734
|
+
/** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
|
|
32735
|
+
contract_id: string;
|
|
32736
|
+
};
|
|
32737
|
+
} | {
|
|
32738
|
+
/** @description Transaction ID */
|
|
32739
|
+
tx_id: string;
|
|
32740
|
+
sender: {
|
|
32741
|
+
/** @description Address of the transaction initiator */
|
|
32742
|
+
address: string;
|
|
32743
|
+
/** @description Nonce of the transaction initiator */
|
|
32744
|
+
nonce: number;
|
|
32745
|
+
};
|
|
32746
|
+
sponsor: {
|
|
32747
|
+
/** @description Address of the transaction initiator */
|
|
32748
|
+
address: string;
|
|
32749
|
+
/** @description Nonce of the transaction initiator */
|
|
32750
|
+
nonce: number;
|
|
32751
|
+
} | null;
|
|
32752
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32753
|
+
fee_rate: string;
|
|
32754
|
+
block: {
|
|
32755
|
+
/** @description Height of the block this transactions was associated with */
|
|
32756
|
+
height: number;
|
|
32757
|
+
/** @description Hash of the blocked this transactions was associated with */
|
|
32758
|
+
hash: string;
|
|
32759
|
+
/** @description Hash of the index block this transactions was associated with */
|
|
32760
|
+
index_hash: string;
|
|
32761
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32762
|
+
time: number;
|
|
32763
|
+
/** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
|
|
32764
|
+
tx_index: number;
|
|
32765
|
+
};
|
|
32766
|
+
bitcoin_block: {
|
|
32767
|
+
/** @description Height of the anchor burn block. */
|
|
32768
|
+
height: number;
|
|
32769
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32770
|
+
time: number;
|
|
32771
|
+
};
|
|
32772
|
+
/** @description Status of the transaction */
|
|
32773
|
+
status: "success" | "abort_by_response" | "abort_by_post_condition";
|
|
32774
|
+
/** @enum {string} */
|
|
32775
|
+
type: "contract_call";
|
|
32776
|
+
contract_call: {
|
|
32777
|
+
/** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
|
|
32778
|
+
contract_id: string;
|
|
32779
|
+
/** @description Name of the Clarity function to be invoked */
|
|
32780
|
+
function_name: string;
|
|
32781
|
+
};
|
|
32782
|
+
} | {
|
|
32783
|
+
/** @description Transaction ID */
|
|
32784
|
+
tx_id: string;
|
|
32785
|
+
sender: {
|
|
32786
|
+
/** @description Address of the transaction initiator */
|
|
32787
|
+
address: string;
|
|
32788
|
+
/** @description Nonce of the transaction initiator */
|
|
32789
|
+
nonce: number;
|
|
32790
|
+
};
|
|
32791
|
+
sponsor: {
|
|
32792
|
+
/** @description Address of the transaction initiator */
|
|
32793
|
+
address: string;
|
|
32794
|
+
/** @description Nonce of the transaction initiator */
|
|
32795
|
+
nonce: number;
|
|
32796
|
+
} | null;
|
|
32797
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32798
|
+
fee_rate: string;
|
|
32799
|
+
block: {
|
|
32800
|
+
/** @description Height of the block this transactions was associated with */
|
|
32801
|
+
height: number;
|
|
32802
|
+
/** @description Hash of the blocked this transactions was associated with */
|
|
32803
|
+
hash: string;
|
|
32804
|
+
/** @description Hash of the index block this transactions was associated with */
|
|
32805
|
+
index_hash: string;
|
|
32806
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32807
|
+
time: number;
|
|
32808
|
+
/** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
|
|
32809
|
+
tx_index: number;
|
|
32810
|
+
};
|
|
32811
|
+
bitcoin_block: {
|
|
32812
|
+
/** @description Height of the anchor burn block. */
|
|
32813
|
+
height: number;
|
|
32814
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32815
|
+
time: number;
|
|
32816
|
+
};
|
|
32817
|
+
/** @description Status of the transaction */
|
|
32818
|
+
status: "success" | "abort_by_response" | "abort_by_post_condition";
|
|
32819
|
+
/** @enum {string} */
|
|
32820
|
+
type: "poison_microblock";
|
|
32821
|
+
} | {
|
|
32822
|
+
/** @description Transaction ID */
|
|
32823
|
+
tx_id: string;
|
|
32824
|
+
sender: {
|
|
32825
|
+
/** @description Address of the transaction initiator */
|
|
32826
|
+
address: string;
|
|
32827
|
+
/** @description Nonce of the transaction initiator */
|
|
32828
|
+
nonce: number;
|
|
32829
|
+
};
|
|
32830
|
+
sponsor: {
|
|
32831
|
+
/** @description Address of the transaction initiator */
|
|
32832
|
+
address: string;
|
|
32833
|
+
/** @description Nonce of the transaction initiator */
|
|
32834
|
+
nonce: number;
|
|
32835
|
+
} | null;
|
|
32836
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32837
|
+
fee_rate: string;
|
|
32838
|
+
block: {
|
|
32839
|
+
/** @description Height of the block this transactions was associated with */
|
|
32840
|
+
height: number;
|
|
32841
|
+
/** @description Hash of the blocked this transactions was associated with */
|
|
32842
|
+
hash: string;
|
|
32843
|
+
/** @description Hash of the index block this transactions was associated with */
|
|
32844
|
+
index_hash: string;
|
|
32845
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32846
|
+
time: number;
|
|
32847
|
+
/** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
|
|
32848
|
+
tx_index: number;
|
|
32849
|
+
};
|
|
32850
|
+
bitcoin_block: {
|
|
32851
|
+
/** @description Height of the anchor burn block. */
|
|
32852
|
+
height: number;
|
|
32853
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32854
|
+
time: number;
|
|
32855
|
+
};
|
|
32856
|
+
/** @description Status of the transaction */
|
|
32857
|
+
status: "success" | "abort_by_response" | "abort_by_post_condition";
|
|
32858
|
+
/** @enum {string} */
|
|
32859
|
+
type: "coinbase";
|
|
32860
|
+
coinbase: {
|
|
32861
|
+
alt_recipient: string | null;
|
|
32862
|
+
};
|
|
32863
|
+
} | {
|
|
32864
|
+
/** @description Transaction ID */
|
|
32865
|
+
tx_id: string;
|
|
32866
|
+
sender: {
|
|
32867
|
+
/** @description Address of the transaction initiator */
|
|
32868
|
+
address: string;
|
|
32869
|
+
/** @description Nonce of the transaction initiator */
|
|
32870
|
+
nonce: number;
|
|
32871
|
+
};
|
|
32872
|
+
sponsor: {
|
|
32873
|
+
/** @description Address of the transaction initiator */
|
|
32874
|
+
address: string;
|
|
32875
|
+
/** @description Nonce of the transaction initiator */
|
|
32876
|
+
nonce: number;
|
|
32877
|
+
} | null;
|
|
32878
|
+
/** @description Transaction fee as Integer string (64-bit unsigned integer). */
|
|
32879
|
+
fee_rate: string;
|
|
32880
|
+
block: {
|
|
32881
|
+
/** @description Height of the block this transactions was associated with */
|
|
32882
|
+
height: number;
|
|
32883
|
+
/** @description Hash of the blocked this transactions was associated with */
|
|
32884
|
+
hash: string;
|
|
32885
|
+
/** @description Hash of the index block this transactions was associated with */
|
|
32886
|
+
index_hash: string;
|
|
32887
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32888
|
+
time: number;
|
|
32889
|
+
/** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
|
|
32890
|
+
tx_index: number;
|
|
32891
|
+
};
|
|
32892
|
+
bitcoin_block: {
|
|
32893
|
+
/** @description Height of the anchor burn block. */
|
|
32894
|
+
height: number;
|
|
32895
|
+
/** @description Unix timestamp (in seconds) indicating when this block was mined. */
|
|
32896
|
+
time: number;
|
|
32897
|
+
};
|
|
32898
|
+
/** @description Status of the transaction */
|
|
32899
|
+
status: "success" | "abort_by_response" | "abort_by_post_condition";
|
|
32900
|
+
/** @enum {string} */
|
|
32901
|
+
type: "tenure_change";
|
|
32902
|
+
tenure_change: {
|
|
32903
|
+
/** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */
|
|
32904
|
+
cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length";
|
|
32905
|
+
};
|
|
32906
|
+
})[];
|
|
32907
|
+
};
|
|
32908
|
+
};
|
|
32909
|
+
};
|
|
32910
|
+
/** @description Default Response */
|
|
32911
|
+
"4XX": {
|
|
32912
|
+
headers: {
|
|
32913
|
+
[name: string]: unknown;
|
|
32914
|
+
};
|
|
32915
|
+
content: {
|
|
32916
|
+
"application/json": {
|
|
32917
|
+
error: string;
|
|
32918
|
+
message?: string;
|
|
32919
|
+
} & {
|
|
32920
|
+
[key: string]: unknown;
|
|
32921
|
+
};
|
|
32922
|
+
};
|
|
32923
|
+
};
|
|
32924
|
+
};
|
|
32925
|
+
};
|
|
32022
32926
|
get_historical_zone_file: {
|
|
32023
32927
|
parameters: {
|
|
32024
32928
|
query?: {
|