@stacks/blockchain-api-client 9.0.0-pox5.4 → 9.0.0-pox5.5
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 +52 -90
- package/package.json +1 -1
- package/src/generated/schema.d.ts +52 -90
|
@@ -1759,7 +1759,7 @@ export interface paths {
|
|
|
1759
1759
|
};
|
|
1760
1760
|
/**
|
|
1761
1761
|
* Get principal staking balances
|
|
1762
|
-
* @description Get principal staking balances
|
|
1762
|
+
* @description Get a principal's staking balances: its bond positions (staked amounts and accrued rewards) across all bonds it is enrolled in
|
|
1763
1763
|
*/
|
|
1764
1764
|
get: operations["get_principal_staking_balances"];
|
|
1765
1765
|
put?: never;
|
|
@@ -1890,26 +1890,6 @@ export interface paths {
|
|
|
1890
1890
|
patch?: never;
|
|
1891
1891
|
trace?: never;
|
|
1892
1892
|
};
|
|
1893
|
-
"/extended/v3/staking/principals/{principal}/positions": {
|
|
1894
|
-
parameters: {
|
|
1895
|
-
query?: never;
|
|
1896
|
-
header?: never;
|
|
1897
|
-
path?: never;
|
|
1898
|
-
cookie?: never;
|
|
1899
|
-
};
|
|
1900
|
-
/**
|
|
1901
|
-
* Get principal staking positions
|
|
1902
|
-
* @description Get a principal's bond positions across all bonds it is enrolled in
|
|
1903
|
-
*/
|
|
1904
|
-
get: operations["get_principal_staking_positions"];
|
|
1905
|
-
put?: never;
|
|
1906
|
-
post?: never;
|
|
1907
|
-
delete?: never;
|
|
1908
|
-
options?: never;
|
|
1909
|
-
head?: never;
|
|
1910
|
-
patch?: never;
|
|
1911
|
-
trace?: never;
|
|
1912
|
-
};
|
|
1913
1893
|
"/extended/v3/transactions": {
|
|
1914
1894
|
parameters: {
|
|
1915
1895
|
query?: never;
|
|
@@ -32834,7 +32814,57 @@ export interface operations {
|
|
|
32834
32814
|
headers: {
|
|
32835
32815
|
[name: string]: unknown;
|
|
32836
32816
|
};
|
|
32837
|
-
content
|
|
32817
|
+
content: {
|
|
32818
|
+
"application/json": {
|
|
32819
|
+
/** @description The index of the bond in the PoX-5 bond list */
|
|
32820
|
+
bond_index: number;
|
|
32821
|
+
status: "enrolled" | "running" | "early_exit" | "unlocked";
|
|
32822
|
+
/** @description Whether the position is active */
|
|
32823
|
+
active: boolean;
|
|
32824
|
+
balances: {
|
|
32825
|
+
locked: {
|
|
32826
|
+
/** @description The total amount of BTC that is locked up for this bond */
|
|
32827
|
+
btc: string;
|
|
32828
|
+
/** @description The total amount of STX that is locked up for this bond */
|
|
32829
|
+
stx: string;
|
|
32830
|
+
};
|
|
32831
|
+
paid_out: {
|
|
32832
|
+
/** @description The total amount of BTC that has been paid out for this bond */
|
|
32833
|
+
btc: string;
|
|
32834
|
+
};
|
|
32835
|
+
};
|
|
32836
|
+
enrollment: {
|
|
32837
|
+
/**
|
|
32838
|
+
* Transaction ID
|
|
32839
|
+
* @description Transaction ID
|
|
32840
|
+
* @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
|
|
32841
|
+
*/
|
|
32842
|
+
tx_id: string;
|
|
32843
|
+
btc_lockup: {
|
|
32844
|
+
/** @description The amount of BTC that is locked up for this principal */
|
|
32845
|
+
amount: string;
|
|
32846
|
+
};
|
|
32847
|
+
};
|
|
32848
|
+
/** @description The amount of STX that is locked up for this principal */
|
|
32849
|
+
amount: string;
|
|
32850
|
+
/** @description The sBTC reward sats accrued to this participant's position */
|
|
32851
|
+
accrued_rewards: string;
|
|
32852
|
+
}[];
|
|
32853
|
+
};
|
|
32854
|
+
};
|
|
32855
|
+
/** @description Default Response */
|
|
32856
|
+
"4XX": {
|
|
32857
|
+
headers: {
|
|
32858
|
+
[name: string]: unknown;
|
|
32859
|
+
};
|
|
32860
|
+
content: {
|
|
32861
|
+
"application/json": {
|
|
32862
|
+
error: string;
|
|
32863
|
+
message?: string;
|
|
32864
|
+
} & {
|
|
32865
|
+
[key: string]: unknown;
|
|
32866
|
+
};
|
|
32867
|
+
};
|
|
32838
32868
|
};
|
|
32839
32869
|
};
|
|
32840
32870
|
};
|
|
@@ -33260,74 +33290,6 @@ export interface operations {
|
|
|
33260
33290
|
};
|
|
33261
33291
|
};
|
|
33262
33292
|
};
|
|
33263
|
-
get_principal_staking_positions: {
|
|
33264
|
-
parameters: {
|
|
33265
|
-
query?: never;
|
|
33266
|
-
header?: never;
|
|
33267
|
-
path: {
|
|
33268
|
-
principal: string;
|
|
33269
|
-
};
|
|
33270
|
-
cookie?: never;
|
|
33271
|
-
};
|
|
33272
|
-
requestBody?: never;
|
|
33273
|
-
responses: {
|
|
33274
|
-
/** @description Default Response */
|
|
33275
|
-
200: {
|
|
33276
|
-
headers: {
|
|
33277
|
-
[name: string]: unknown;
|
|
33278
|
-
};
|
|
33279
|
-
content: {
|
|
33280
|
-
"application/json": {
|
|
33281
|
-
/** @description The index of the bond in the PoX-5 bond list */
|
|
33282
|
-
bond_index: number;
|
|
33283
|
-
status: "enrolled" | "running" | "early_exit" | "unlocked";
|
|
33284
|
-
/** @description Whether the position is active */
|
|
33285
|
-
active: boolean;
|
|
33286
|
-
balances: {
|
|
33287
|
-
locked: {
|
|
33288
|
-
/** @description The total amount of BTC that is locked up for this bond */
|
|
33289
|
-
btc: string;
|
|
33290
|
-
/** @description The total amount of STX that is locked up for this bond */
|
|
33291
|
-
stx: string;
|
|
33292
|
-
};
|
|
33293
|
-
paid_out: {
|
|
33294
|
-
/** @description The total amount of BTC that has been paid out for this bond */
|
|
33295
|
-
btc: string;
|
|
33296
|
-
};
|
|
33297
|
-
};
|
|
33298
|
-
enrollment: {
|
|
33299
|
-
/**
|
|
33300
|
-
* Transaction ID
|
|
33301
|
-
* @description Transaction ID
|
|
33302
|
-
* @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
|
|
33303
|
-
*/
|
|
33304
|
-
tx_id: string;
|
|
33305
|
-
btc_lockup: {
|
|
33306
|
-
/** @description The amount of BTC that is locked up for this principal */
|
|
33307
|
-
amount: string;
|
|
33308
|
-
};
|
|
33309
|
-
};
|
|
33310
|
-
/** @description The amount of STX that is locked up for this principal */
|
|
33311
|
-
amount: string;
|
|
33312
|
-
}[];
|
|
33313
|
-
};
|
|
33314
|
-
};
|
|
33315
|
-
/** @description Default Response */
|
|
33316
|
-
"4XX": {
|
|
33317
|
-
headers: {
|
|
33318
|
-
[name: string]: unknown;
|
|
33319
|
-
};
|
|
33320
|
-
content: {
|
|
33321
|
-
"application/json": {
|
|
33322
|
-
error: string;
|
|
33323
|
-
message?: string;
|
|
33324
|
-
} & {
|
|
33325
|
-
[key: string]: unknown;
|
|
33326
|
-
};
|
|
33327
|
-
};
|
|
33328
|
-
};
|
|
33329
|
-
};
|
|
33330
|
-
};
|
|
33331
33293
|
get_transactions: {
|
|
33332
33294
|
parameters: {
|
|
33333
33295
|
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.5",
|
|
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",
|
|
@@ -1759,7 +1759,7 @@ export interface paths {
|
|
|
1759
1759
|
};
|
|
1760
1760
|
/**
|
|
1761
1761
|
* Get principal staking balances
|
|
1762
|
-
* @description Get principal staking balances
|
|
1762
|
+
* @description Get a principal's staking balances: its bond positions (staked amounts and accrued rewards) across all bonds it is enrolled in
|
|
1763
1763
|
*/
|
|
1764
1764
|
get: operations["get_principal_staking_balances"];
|
|
1765
1765
|
put?: never;
|
|
@@ -1890,26 +1890,6 @@ export interface paths {
|
|
|
1890
1890
|
patch?: never;
|
|
1891
1891
|
trace?: never;
|
|
1892
1892
|
};
|
|
1893
|
-
"/extended/v3/staking/principals/{principal}/positions": {
|
|
1894
|
-
parameters: {
|
|
1895
|
-
query?: never;
|
|
1896
|
-
header?: never;
|
|
1897
|
-
path?: never;
|
|
1898
|
-
cookie?: never;
|
|
1899
|
-
};
|
|
1900
|
-
/**
|
|
1901
|
-
* Get principal staking positions
|
|
1902
|
-
* @description Get a principal's bond positions across all bonds it is enrolled in
|
|
1903
|
-
*/
|
|
1904
|
-
get: operations["get_principal_staking_positions"];
|
|
1905
|
-
put?: never;
|
|
1906
|
-
post?: never;
|
|
1907
|
-
delete?: never;
|
|
1908
|
-
options?: never;
|
|
1909
|
-
head?: never;
|
|
1910
|
-
patch?: never;
|
|
1911
|
-
trace?: never;
|
|
1912
|
-
};
|
|
1913
1893
|
"/extended/v3/transactions": {
|
|
1914
1894
|
parameters: {
|
|
1915
1895
|
query?: never;
|
|
@@ -32834,7 +32814,57 @@ export interface operations {
|
|
|
32834
32814
|
headers: {
|
|
32835
32815
|
[name: string]: unknown;
|
|
32836
32816
|
};
|
|
32837
|
-
content
|
|
32817
|
+
content: {
|
|
32818
|
+
"application/json": {
|
|
32819
|
+
/** @description The index of the bond in the PoX-5 bond list */
|
|
32820
|
+
bond_index: number;
|
|
32821
|
+
status: "enrolled" | "running" | "early_exit" | "unlocked";
|
|
32822
|
+
/** @description Whether the position is active */
|
|
32823
|
+
active: boolean;
|
|
32824
|
+
balances: {
|
|
32825
|
+
locked: {
|
|
32826
|
+
/** @description The total amount of BTC that is locked up for this bond */
|
|
32827
|
+
btc: string;
|
|
32828
|
+
/** @description The total amount of STX that is locked up for this bond */
|
|
32829
|
+
stx: string;
|
|
32830
|
+
};
|
|
32831
|
+
paid_out: {
|
|
32832
|
+
/** @description The total amount of BTC that has been paid out for this bond */
|
|
32833
|
+
btc: string;
|
|
32834
|
+
};
|
|
32835
|
+
};
|
|
32836
|
+
enrollment: {
|
|
32837
|
+
/**
|
|
32838
|
+
* Transaction ID
|
|
32839
|
+
* @description Transaction ID
|
|
32840
|
+
* @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
|
|
32841
|
+
*/
|
|
32842
|
+
tx_id: string;
|
|
32843
|
+
btc_lockup: {
|
|
32844
|
+
/** @description The amount of BTC that is locked up for this principal */
|
|
32845
|
+
amount: string;
|
|
32846
|
+
};
|
|
32847
|
+
};
|
|
32848
|
+
/** @description The amount of STX that is locked up for this principal */
|
|
32849
|
+
amount: string;
|
|
32850
|
+
/** @description The sBTC reward sats accrued to this participant's position */
|
|
32851
|
+
accrued_rewards: string;
|
|
32852
|
+
}[];
|
|
32853
|
+
};
|
|
32854
|
+
};
|
|
32855
|
+
/** @description Default Response */
|
|
32856
|
+
"4XX": {
|
|
32857
|
+
headers: {
|
|
32858
|
+
[name: string]: unknown;
|
|
32859
|
+
};
|
|
32860
|
+
content: {
|
|
32861
|
+
"application/json": {
|
|
32862
|
+
error: string;
|
|
32863
|
+
message?: string;
|
|
32864
|
+
} & {
|
|
32865
|
+
[key: string]: unknown;
|
|
32866
|
+
};
|
|
32867
|
+
};
|
|
32838
32868
|
};
|
|
32839
32869
|
};
|
|
32840
32870
|
};
|
|
@@ -33260,74 +33290,6 @@ export interface operations {
|
|
|
33260
33290
|
};
|
|
33261
33291
|
};
|
|
33262
33292
|
};
|
|
33263
|
-
get_principal_staking_positions: {
|
|
33264
|
-
parameters: {
|
|
33265
|
-
query?: never;
|
|
33266
|
-
header?: never;
|
|
33267
|
-
path: {
|
|
33268
|
-
principal: string;
|
|
33269
|
-
};
|
|
33270
|
-
cookie?: never;
|
|
33271
|
-
};
|
|
33272
|
-
requestBody?: never;
|
|
33273
|
-
responses: {
|
|
33274
|
-
/** @description Default Response */
|
|
33275
|
-
200: {
|
|
33276
|
-
headers: {
|
|
33277
|
-
[name: string]: unknown;
|
|
33278
|
-
};
|
|
33279
|
-
content: {
|
|
33280
|
-
"application/json": {
|
|
33281
|
-
/** @description The index of the bond in the PoX-5 bond list */
|
|
33282
|
-
bond_index: number;
|
|
33283
|
-
status: "enrolled" | "running" | "early_exit" | "unlocked";
|
|
33284
|
-
/** @description Whether the position is active */
|
|
33285
|
-
active: boolean;
|
|
33286
|
-
balances: {
|
|
33287
|
-
locked: {
|
|
33288
|
-
/** @description The total amount of BTC that is locked up for this bond */
|
|
33289
|
-
btc: string;
|
|
33290
|
-
/** @description The total amount of STX that is locked up for this bond */
|
|
33291
|
-
stx: string;
|
|
33292
|
-
};
|
|
33293
|
-
paid_out: {
|
|
33294
|
-
/** @description The total amount of BTC that has been paid out for this bond */
|
|
33295
|
-
btc: string;
|
|
33296
|
-
};
|
|
33297
|
-
};
|
|
33298
|
-
enrollment: {
|
|
33299
|
-
/**
|
|
33300
|
-
* Transaction ID
|
|
33301
|
-
* @description Transaction ID
|
|
33302
|
-
* @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
|
|
33303
|
-
*/
|
|
33304
|
-
tx_id: string;
|
|
33305
|
-
btc_lockup: {
|
|
33306
|
-
/** @description The amount of BTC that is locked up for this principal */
|
|
33307
|
-
amount: string;
|
|
33308
|
-
};
|
|
33309
|
-
};
|
|
33310
|
-
/** @description The amount of STX that is locked up for this principal */
|
|
33311
|
-
amount: string;
|
|
33312
|
-
}[];
|
|
33313
|
-
};
|
|
33314
|
-
};
|
|
33315
|
-
/** @description Default Response */
|
|
33316
|
-
"4XX": {
|
|
33317
|
-
headers: {
|
|
33318
|
-
[name: string]: unknown;
|
|
33319
|
-
};
|
|
33320
|
-
content: {
|
|
33321
|
-
"application/json": {
|
|
33322
|
-
error: string;
|
|
33323
|
-
message?: string;
|
|
33324
|
-
} & {
|
|
33325
|
-
[key: string]: unknown;
|
|
33326
|
-
};
|
|
33327
|
-
};
|
|
33328
|
-
};
|
|
33329
|
-
};
|
|
33330
|
-
};
|
|
33331
33293
|
get_transactions: {
|
|
33332
33294
|
parameters: {
|
|
33333
33295
|
query?: {
|