@stacks/blockchain-api-client 9.0.0-next.36 → 9.0.0-next.38
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 +199 -0
- package/package.json +1 -1
- package/src/generated/schema.d.ts +199 -0
|
@@ -1710,6 +1710,46 @@ export interface paths {
|
|
|
1710
1710
|
patch?: never;
|
|
1711
1711
|
trace?: never;
|
|
1712
1712
|
};
|
|
1713
|
+
"/extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes": {
|
|
1714
|
+
parameters: {
|
|
1715
|
+
query?: never;
|
|
1716
|
+
header?: never;
|
|
1717
|
+
path?: never;
|
|
1718
|
+
cookie?: never;
|
|
1719
|
+
};
|
|
1720
|
+
/**
|
|
1721
|
+
* Get principal transaction balance changes
|
|
1722
|
+
* @description Returns the balance changes for a principal's transaction
|
|
1723
|
+
*/
|
|
1724
|
+
get: operations["get_principal_transaction_balance_changes"];
|
|
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/principals/{principal}/balance-changes": {
|
|
1734
|
+
parameters: {
|
|
1735
|
+
query?: never;
|
|
1736
|
+
header?: never;
|
|
1737
|
+
path?: never;
|
|
1738
|
+
cookie?: never;
|
|
1739
|
+
};
|
|
1740
|
+
/**
|
|
1741
|
+
* Get principal balance changes
|
|
1742
|
+
* @description Returns the balance changes for a principal across one or more transactions, as a single paginated flat array ordered by chain position descending then by asset.
|
|
1743
|
+
*/
|
|
1744
|
+
get: operations["get_principal_balance_changes"];
|
|
1745
|
+
put?: never;
|
|
1746
|
+
post?: never;
|
|
1747
|
+
delete?: never;
|
|
1748
|
+
options?: never;
|
|
1749
|
+
head?: never;
|
|
1750
|
+
patch?: never;
|
|
1751
|
+
trace?: never;
|
|
1752
|
+
};
|
|
1713
1753
|
"/extended/v3/transactions": {
|
|
1714
1754
|
parameters: {
|
|
1715
1755
|
query?: never;
|
|
@@ -32122,6 +32162,165 @@ export interface operations {
|
|
|
32122
32162
|
};
|
|
32123
32163
|
};
|
|
32124
32164
|
};
|
|
32165
|
+
get_principal_transaction_balance_changes: {
|
|
32166
|
+
parameters: {
|
|
32167
|
+
query?: {
|
|
32168
|
+
/** @description Number of results per page */
|
|
32169
|
+
limit?: number;
|
|
32170
|
+
/** @description Cursor for paginating principal transaction balance changes. Format: `<asset_type>:<asset_identifier>` where `asset_type` is a numeric tag (1=STX, 2=FT, 3=NFT) and `asset_identifier` is `<stx>` for STX or a fully-qualified Clarity asset id such as `SP000…contract-name::asset-name` for FT/NFT. */
|
|
32171
|
+
cursor?: string;
|
|
32172
|
+
};
|
|
32173
|
+
header?: never;
|
|
32174
|
+
path: {
|
|
32175
|
+
principal: string;
|
|
32176
|
+
/**
|
|
32177
|
+
* @description Transaction ID
|
|
32178
|
+
* @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
|
|
32179
|
+
*/
|
|
32180
|
+
tx_id: string;
|
|
32181
|
+
};
|
|
32182
|
+
cookie?: never;
|
|
32183
|
+
};
|
|
32184
|
+
requestBody?: never;
|
|
32185
|
+
responses: {
|
|
32186
|
+
/** @description Default Response */
|
|
32187
|
+
200: {
|
|
32188
|
+
headers: {
|
|
32189
|
+
[name: string]: unknown;
|
|
32190
|
+
};
|
|
32191
|
+
content: {
|
|
32192
|
+
"application/json": {
|
|
32193
|
+
/** @example 1 */
|
|
32194
|
+
total: number;
|
|
32195
|
+
/**
|
|
32196
|
+
* @description Number of results per page
|
|
32197
|
+
* @default 20
|
|
32198
|
+
*/
|
|
32199
|
+
limit: number;
|
|
32200
|
+
cursor: {
|
|
32201
|
+
next: string | null;
|
|
32202
|
+
previous: string | null;
|
|
32203
|
+
current: string | null;
|
|
32204
|
+
};
|
|
32205
|
+
results: {
|
|
32206
|
+
asset: {
|
|
32207
|
+
/** @enum {string} */
|
|
32208
|
+
type: "stx";
|
|
32209
|
+
} | {
|
|
32210
|
+
/** @description The asset type that was affected by the balance change. */
|
|
32211
|
+
type: "ft" | "nft";
|
|
32212
|
+
/** @description The identifier of the asset that was affected by the balance change. */
|
|
32213
|
+
identifier: string;
|
|
32214
|
+
};
|
|
32215
|
+
balance_change: {
|
|
32216
|
+
/** @description Amount sent by the principal */
|
|
32217
|
+
sent: string;
|
|
32218
|
+
/** @description Amount received by the principal */
|
|
32219
|
+
received: string;
|
|
32220
|
+
/** @description Net balance change for the principal */
|
|
32221
|
+
net: string;
|
|
32222
|
+
};
|
|
32223
|
+
}[];
|
|
32224
|
+
};
|
|
32225
|
+
};
|
|
32226
|
+
};
|
|
32227
|
+
/** @description Default Response */
|
|
32228
|
+
"4XX": {
|
|
32229
|
+
headers: {
|
|
32230
|
+
[name: string]: unknown;
|
|
32231
|
+
};
|
|
32232
|
+
content: {
|
|
32233
|
+
"application/json": {
|
|
32234
|
+
error: string;
|
|
32235
|
+
message?: string;
|
|
32236
|
+
} & {
|
|
32237
|
+
[key: string]: unknown;
|
|
32238
|
+
};
|
|
32239
|
+
};
|
|
32240
|
+
};
|
|
32241
|
+
};
|
|
32242
|
+
};
|
|
32243
|
+
get_principal_balance_changes: {
|
|
32244
|
+
parameters: {
|
|
32245
|
+
query: {
|
|
32246
|
+
/** @description Number of results per page */
|
|
32247
|
+
limit?: number;
|
|
32248
|
+
/** @description Cursor for paginating principal balance changes across multiple transactions. Format: `<block_height>:<microblock_sequence>:<tx_index>:<asset_type>:<asset_identifier>`. */
|
|
32249
|
+
cursor?: string;
|
|
32250
|
+
/** @description Transaction IDs to query balance changes for. Provide as repeated querystring values (`?tx_id=A&tx_id=B`) or as a single comma-separated value (`?tx_id=A,B`). */
|
|
32251
|
+
tx_id: string[];
|
|
32252
|
+
};
|
|
32253
|
+
header?: never;
|
|
32254
|
+
path: {
|
|
32255
|
+
principal: string;
|
|
32256
|
+
};
|
|
32257
|
+
cookie?: never;
|
|
32258
|
+
};
|
|
32259
|
+
requestBody?: never;
|
|
32260
|
+
responses: {
|
|
32261
|
+
/** @description Default Response */
|
|
32262
|
+
200: {
|
|
32263
|
+
headers: {
|
|
32264
|
+
[name: string]: unknown;
|
|
32265
|
+
};
|
|
32266
|
+
content: {
|
|
32267
|
+
"application/json": {
|
|
32268
|
+
/** @example 1 */
|
|
32269
|
+
total: number;
|
|
32270
|
+
/**
|
|
32271
|
+
* @description Number of results per page
|
|
32272
|
+
* @default 20
|
|
32273
|
+
*/
|
|
32274
|
+
limit: number;
|
|
32275
|
+
cursor: {
|
|
32276
|
+
next: string | null;
|
|
32277
|
+
previous: string | null;
|
|
32278
|
+
current: string | null;
|
|
32279
|
+
};
|
|
32280
|
+
results: {
|
|
32281
|
+
/**
|
|
32282
|
+
* Transaction ID
|
|
32283
|
+
* @description Transaction ID
|
|
32284
|
+
* @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
|
|
32285
|
+
*/
|
|
32286
|
+
tx_id: string;
|
|
32287
|
+
asset: {
|
|
32288
|
+
/** @enum {string} */
|
|
32289
|
+
type: "stx";
|
|
32290
|
+
} | {
|
|
32291
|
+
/** @description The asset type that was affected by the balance change. */
|
|
32292
|
+
type: "ft" | "nft";
|
|
32293
|
+
/** @description The identifier of the asset that was affected by the balance change. */
|
|
32294
|
+
identifier: string;
|
|
32295
|
+
};
|
|
32296
|
+
balance_change: {
|
|
32297
|
+
/** @description Amount sent by the principal */
|
|
32298
|
+
sent: string;
|
|
32299
|
+
/** @description Amount received by the principal */
|
|
32300
|
+
received: string;
|
|
32301
|
+
/** @description Net balance change for the principal */
|
|
32302
|
+
net: string;
|
|
32303
|
+
};
|
|
32304
|
+
}[];
|
|
32305
|
+
};
|
|
32306
|
+
};
|
|
32307
|
+
};
|
|
32308
|
+
/** @description Default Response */
|
|
32309
|
+
"4XX": {
|
|
32310
|
+
headers: {
|
|
32311
|
+
[name: string]: unknown;
|
|
32312
|
+
};
|
|
32313
|
+
content: {
|
|
32314
|
+
"application/json": {
|
|
32315
|
+
error: string;
|
|
32316
|
+
message?: string;
|
|
32317
|
+
} & {
|
|
32318
|
+
[key: string]: unknown;
|
|
32319
|
+
};
|
|
32320
|
+
};
|
|
32321
|
+
};
|
|
32322
|
+
};
|
|
32323
|
+
};
|
|
32125
32324
|
get_transactions: {
|
|
32126
32325
|
parameters: {
|
|
32127
32326
|
query?: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stacks/blockchain-api-client",
|
|
3
|
-
"version": "9.0.0-next.
|
|
3
|
+
"version": "9.0.0-next.38",
|
|
4
4
|
"access": "public",
|
|
5
5
|
"description": "Client for the Stacks Blockchain API",
|
|
6
6
|
"homepage": "https://github.com/hirosystems/stacks-blockchain-api/tree/master/client#readme",
|
|
@@ -1710,6 +1710,46 @@ export interface paths {
|
|
|
1710
1710
|
patch?: never;
|
|
1711
1711
|
trace?: never;
|
|
1712
1712
|
};
|
|
1713
|
+
"/extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes": {
|
|
1714
|
+
parameters: {
|
|
1715
|
+
query?: never;
|
|
1716
|
+
header?: never;
|
|
1717
|
+
path?: never;
|
|
1718
|
+
cookie?: never;
|
|
1719
|
+
};
|
|
1720
|
+
/**
|
|
1721
|
+
* Get principal transaction balance changes
|
|
1722
|
+
* @description Returns the balance changes for a principal's transaction
|
|
1723
|
+
*/
|
|
1724
|
+
get: operations["get_principal_transaction_balance_changes"];
|
|
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/principals/{principal}/balance-changes": {
|
|
1734
|
+
parameters: {
|
|
1735
|
+
query?: never;
|
|
1736
|
+
header?: never;
|
|
1737
|
+
path?: never;
|
|
1738
|
+
cookie?: never;
|
|
1739
|
+
};
|
|
1740
|
+
/**
|
|
1741
|
+
* Get principal balance changes
|
|
1742
|
+
* @description Returns the balance changes for a principal across one or more transactions, as a single paginated flat array ordered by chain position descending then by asset.
|
|
1743
|
+
*/
|
|
1744
|
+
get: operations["get_principal_balance_changes"];
|
|
1745
|
+
put?: never;
|
|
1746
|
+
post?: never;
|
|
1747
|
+
delete?: never;
|
|
1748
|
+
options?: never;
|
|
1749
|
+
head?: never;
|
|
1750
|
+
patch?: never;
|
|
1751
|
+
trace?: never;
|
|
1752
|
+
};
|
|
1713
1753
|
"/extended/v3/transactions": {
|
|
1714
1754
|
parameters: {
|
|
1715
1755
|
query?: never;
|
|
@@ -32122,6 +32162,165 @@ export interface operations {
|
|
|
32122
32162
|
};
|
|
32123
32163
|
};
|
|
32124
32164
|
};
|
|
32165
|
+
get_principal_transaction_balance_changes: {
|
|
32166
|
+
parameters: {
|
|
32167
|
+
query?: {
|
|
32168
|
+
/** @description Number of results per page */
|
|
32169
|
+
limit?: number;
|
|
32170
|
+
/** @description Cursor for paginating principal transaction balance changes. Format: `<asset_type>:<asset_identifier>` where `asset_type` is a numeric tag (1=STX, 2=FT, 3=NFT) and `asset_identifier` is `<stx>` for STX or a fully-qualified Clarity asset id such as `SP000…contract-name::asset-name` for FT/NFT. */
|
|
32171
|
+
cursor?: string;
|
|
32172
|
+
};
|
|
32173
|
+
header?: never;
|
|
32174
|
+
path: {
|
|
32175
|
+
principal: string;
|
|
32176
|
+
/**
|
|
32177
|
+
* @description Transaction ID
|
|
32178
|
+
* @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
|
|
32179
|
+
*/
|
|
32180
|
+
tx_id: string;
|
|
32181
|
+
};
|
|
32182
|
+
cookie?: never;
|
|
32183
|
+
};
|
|
32184
|
+
requestBody?: never;
|
|
32185
|
+
responses: {
|
|
32186
|
+
/** @description Default Response */
|
|
32187
|
+
200: {
|
|
32188
|
+
headers: {
|
|
32189
|
+
[name: string]: unknown;
|
|
32190
|
+
};
|
|
32191
|
+
content: {
|
|
32192
|
+
"application/json": {
|
|
32193
|
+
/** @example 1 */
|
|
32194
|
+
total: number;
|
|
32195
|
+
/**
|
|
32196
|
+
* @description Number of results per page
|
|
32197
|
+
* @default 20
|
|
32198
|
+
*/
|
|
32199
|
+
limit: number;
|
|
32200
|
+
cursor: {
|
|
32201
|
+
next: string | null;
|
|
32202
|
+
previous: string | null;
|
|
32203
|
+
current: string | null;
|
|
32204
|
+
};
|
|
32205
|
+
results: {
|
|
32206
|
+
asset: {
|
|
32207
|
+
/** @enum {string} */
|
|
32208
|
+
type: "stx";
|
|
32209
|
+
} | {
|
|
32210
|
+
/** @description The asset type that was affected by the balance change. */
|
|
32211
|
+
type: "ft" | "nft";
|
|
32212
|
+
/** @description The identifier of the asset that was affected by the balance change. */
|
|
32213
|
+
identifier: string;
|
|
32214
|
+
};
|
|
32215
|
+
balance_change: {
|
|
32216
|
+
/** @description Amount sent by the principal */
|
|
32217
|
+
sent: string;
|
|
32218
|
+
/** @description Amount received by the principal */
|
|
32219
|
+
received: string;
|
|
32220
|
+
/** @description Net balance change for the principal */
|
|
32221
|
+
net: string;
|
|
32222
|
+
};
|
|
32223
|
+
}[];
|
|
32224
|
+
};
|
|
32225
|
+
};
|
|
32226
|
+
};
|
|
32227
|
+
/** @description Default Response */
|
|
32228
|
+
"4XX": {
|
|
32229
|
+
headers: {
|
|
32230
|
+
[name: string]: unknown;
|
|
32231
|
+
};
|
|
32232
|
+
content: {
|
|
32233
|
+
"application/json": {
|
|
32234
|
+
error: string;
|
|
32235
|
+
message?: string;
|
|
32236
|
+
} & {
|
|
32237
|
+
[key: string]: unknown;
|
|
32238
|
+
};
|
|
32239
|
+
};
|
|
32240
|
+
};
|
|
32241
|
+
};
|
|
32242
|
+
};
|
|
32243
|
+
get_principal_balance_changes: {
|
|
32244
|
+
parameters: {
|
|
32245
|
+
query: {
|
|
32246
|
+
/** @description Number of results per page */
|
|
32247
|
+
limit?: number;
|
|
32248
|
+
/** @description Cursor for paginating principal balance changes across multiple transactions. Format: `<block_height>:<microblock_sequence>:<tx_index>:<asset_type>:<asset_identifier>`. */
|
|
32249
|
+
cursor?: string;
|
|
32250
|
+
/** @description Transaction IDs to query balance changes for. Provide as repeated querystring values (`?tx_id=A&tx_id=B`) or as a single comma-separated value (`?tx_id=A,B`). */
|
|
32251
|
+
tx_id: string[];
|
|
32252
|
+
};
|
|
32253
|
+
header?: never;
|
|
32254
|
+
path: {
|
|
32255
|
+
principal: string;
|
|
32256
|
+
};
|
|
32257
|
+
cookie?: never;
|
|
32258
|
+
};
|
|
32259
|
+
requestBody?: never;
|
|
32260
|
+
responses: {
|
|
32261
|
+
/** @description Default Response */
|
|
32262
|
+
200: {
|
|
32263
|
+
headers: {
|
|
32264
|
+
[name: string]: unknown;
|
|
32265
|
+
};
|
|
32266
|
+
content: {
|
|
32267
|
+
"application/json": {
|
|
32268
|
+
/** @example 1 */
|
|
32269
|
+
total: number;
|
|
32270
|
+
/**
|
|
32271
|
+
* @description Number of results per page
|
|
32272
|
+
* @default 20
|
|
32273
|
+
*/
|
|
32274
|
+
limit: number;
|
|
32275
|
+
cursor: {
|
|
32276
|
+
next: string | null;
|
|
32277
|
+
previous: string | null;
|
|
32278
|
+
current: string | null;
|
|
32279
|
+
};
|
|
32280
|
+
results: {
|
|
32281
|
+
/**
|
|
32282
|
+
* Transaction ID
|
|
32283
|
+
* @description Transaction ID
|
|
32284
|
+
* @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
|
|
32285
|
+
*/
|
|
32286
|
+
tx_id: string;
|
|
32287
|
+
asset: {
|
|
32288
|
+
/** @enum {string} */
|
|
32289
|
+
type: "stx";
|
|
32290
|
+
} | {
|
|
32291
|
+
/** @description The asset type that was affected by the balance change. */
|
|
32292
|
+
type: "ft" | "nft";
|
|
32293
|
+
/** @description The identifier of the asset that was affected by the balance change. */
|
|
32294
|
+
identifier: string;
|
|
32295
|
+
};
|
|
32296
|
+
balance_change: {
|
|
32297
|
+
/** @description Amount sent by the principal */
|
|
32298
|
+
sent: string;
|
|
32299
|
+
/** @description Amount received by the principal */
|
|
32300
|
+
received: string;
|
|
32301
|
+
/** @description Net balance change for the principal */
|
|
32302
|
+
net: string;
|
|
32303
|
+
};
|
|
32304
|
+
}[];
|
|
32305
|
+
};
|
|
32306
|
+
};
|
|
32307
|
+
};
|
|
32308
|
+
/** @description Default Response */
|
|
32309
|
+
"4XX": {
|
|
32310
|
+
headers: {
|
|
32311
|
+
[name: string]: unknown;
|
|
32312
|
+
};
|
|
32313
|
+
content: {
|
|
32314
|
+
"application/json": {
|
|
32315
|
+
error: string;
|
|
32316
|
+
message?: string;
|
|
32317
|
+
} & {
|
|
32318
|
+
[key: string]: unknown;
|
|
32319
|
+
};
|
|
32320
|
+
};
|
|
32321
|
+
};
|
|
32322
|
+
};
|
|
32323
|
+
};
|
|
32125
32324
|
get_transactions: {
|
|
32126
32325
|
parameters: {
|
|
32127
32326
|
query?: {
|