@stacks/blockchain-api-client 9.0.0-pox5.8 → 9.0.0-pox5.9

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.
@@ -1777,7 +1777,7 @@ export interface paths {
1777
1777
  patch?: never;
1778
1778
  trace?: never;
1779
1779
  };
1780
- "/extended/v3/principals/{principal}/balances/staking": {
1780
+ "/extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes": {
1781
1781
  parameters: {
1782
1782
  query?: never;
1783
1783
  header?: never;
@@ -1785,10 +1785,70 @@ export interface paths {
1785
1785
  cookie?: never;
1786
1786
  };
1787
1787
  /**
1788
- * Get principal staking balances
1789
- * @description Get a principal's staking balances: its bond positions (staked amounts and accrued rewards) across all bonds it is enrolled in
1788
+ * Get principal transaction balance changes
1789
+ * @description Returns the balance changes for a principal's transaction
1790
1790
  */
1791
- get: operations["get_principal_balances_staking"];
1791
+ get: operations["get_principal_transaction_balance_changes"];
1792
+ put?: never;
1793
+ post?: never;
1794
+ delete?: never;
1795
+ options?: never;
1796
+ head?: never;
1797
+ patch?: never;
1798
+ trace?: never;
1799
+ };
1800
+ "/extended/v3/principals/{principal}/balance-changes": {
1801
+ parameters: {
1802
+ query?: never;
1803
+ header?: never;
1804
+ path?: never;
1805
+ cookie?: never;
1806
+ };
1807
+ /**
1808
+ * Get principal balance changes
1809
+ * @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.
1810
+ */
1811
+ get: operations["get_principal_balance_changes"];
1812
+ put?: never;
1813
+ post?: never;
1814
+ delete?: never;
1815
+ options?: never;
1816
+ head?: never;
1817
+ patch?: never;
1818
+ trace?: never;
1819
+ };
1820
+ "/extended/v3/principals/{principal}/staking": {
1821
+ parameters: {
1822
+ query?: never;
1823
+ header?: never;
1824
+ path?: never;
1825
+ cookie?: never;
1826
+ };
1827
+ /**
1828
+ * Get principal staking summary
1829
+ * @description A one-call overview of a principal's staking: its pox-5 STX-staking position (locked STX and its sBTC rewards) plus aggregate totals across all of its bond positions. The per-bond breakdown is paginated at `/principals/:principal/staking/bonds`.
1830
+ */
1831
+ get: operations["get_principal_staking_summary"];
1832
+ put?: never;
1833
+ post?: never;
1834
+ delete?: never;
1835
+ options?: never;
1836
+ head?: never;
1837
+ patch?: never;
1838
+ trace?: never;
1839
+ };
1840
+ "/extended/v3/principals/{principal}/staking/bonds": {
1841
+ parameters: {
1842
+ query?: never;
1843
+ header?: never;
1844
+ path?: never;
1845
+ cookie?: never;
1846
+ };
1847
+ /**
1848
+ * Get principal bond positions
1849
+ * @description Get a principal's bond positions — its enrollment, lock, status, and sBTC rewards in each bond it participates in.
1850
+ */
1851
+ get: operations["get_principal_bond_positions"];
1792
1852
  put?: never;
1793
1853
  post?: never;
1794
1854
  delete?: never;
@@ -1977,6 +2037,46 @@ export interface paths {
1977
2037
  patch?: never;
1978
2038
  trace?: never;
1979
2039
  };
2040
+ "/extended/v3/staking/signers": {
2041
+ parameters: {
2042
+ query?: never;
2043
+ header?: never;
2044
+ path?: never;
2045
+ cookie?: never;
2046
+ };
2047
+ /**
2048
+ * Get staking signers
2049
+ * @description Get the registered pox-5 staking signers and their current signing keys.
2050
+ */
2051
+ get: operations["get_staking_signers"];
2052
+ put?: never;
2053
+ post?: never;
2054
+ delete?: never;
2055
+ options?: never;
2056
+ head?: never;
2057
+ patch?: never;
2058
+ trace?: never;
2059
+ };
2060
+ "/extended/v3/staking/signers/{principal}": {
2061
+ parameters: {
2062
+ query?: never;
2063
+ header?: never;
2064
+ path?: never;
2065
+ cookie?: never;
2066
+ };
2067
+ /**
2068
+ * Get staking signer
2069
+ * @description Get a registered pox-5 staking signer along with the details of the transaction that registered its current key.
2070
+ */
2071
+ get: operations["get_staking_signer"];
2072
+ put?: never;
2073
+ post?: never;
2074
+ delete?: never;
2075
+ options?: never;
2076
+ head?: never;
2077
+ patch?: never;
2078
+ trace?: never;
2079
+ };
1980
2080
  "/extended/v3/transactions": {
1981
2081
  parameters: {
1982
2082
  query?: never;
@@ -32938,12 +33038,22 @@ export interface operations {
32938
33038
  };
32939
33039
  };
32940
33040
  };
32941
- get_principal_balances_staking: {
33041
+ get_principal_transaction_balance_changes: {
32942
33042
  parameters: {
32943
- query?: never;
33043
+ query?: {
33044
+ /** @description Number of results per page */
33045
+ limit?: number;
33046
+ /** @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. */
33047
+ cursor?: string;
33048
+ };
32944
33049
  header?: never;
32945
33050
  path: {
32946
33051
  principal: string;
33052
+ /**
33053
+ * @description Transaction ID
33054
+ * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
33055
+ */
33056
+ tx_id: string;
32947
33057
  };
32948
33058
  cookie?: never;
32949
33059
  };
@@ -32956,40 +33066,279 @@ export interface operations {
32956
33066
  };
32957
33067
  content: {
32958
33068
  "application/json": {
32959
- /** @description The index of the bond in the PoX-5 bond list */
32960
- bond_index: number;
32961
- status: "enrolled" | "running" | "early_exit" | "unlocked";
32962
- /** @description Whether the position is active */
32963
- active: boolean;
32964
- balances: {
32965
- locked: {
32966
- /** @description The total amount of BTC that is locked up for this bond */
32967
- btc: string;
32968
- /** @description The total amount of STX that is locked up for this bond */
32969
- stx: string;
33069
+ /** @example 1 */
33070
+ total: number;
33071
+ /**
33072
+ * @description Number of results per page
33073
+ * @default 20
33074
+ */
33075
+ limit: number;
33076
+ cursor: {
33077
+ next: string | null;
33078
+ previous: string | null;
33079
+ current: string | null;
33080
+ };
33081
+ results: {
33082
+ asset: {
33083
+ /** @enum {string} */
33084
+ type: "stx";
33085
+ } | {
33086
+ /** @description The asset type that was affected by the balance change. */
33087
+ type: "ft" | "nft";
33088
+ /** @description The identifier of the asset that was affected by the balance change. */
33089
+ identifier: string;
32970
33090
  };
32971
- paid_out: {
32972
- /** @description The total amount of BTC that has been paid out for this bond */
32973
- btc: string;
33091
+ balance_change: {
33092
+ /** @description Amount sent by the principal */
33093
+ sent: string;
33094
+ /** @description Amount received by the principal */
33095
+ received: string;
33096
+ /** @description Net balance change for the principal */
33097
+ net: string;
32974
33098
  };
33099
+ }[];
33100
+ };
33101
+ };
33102
+ };
33103
+ /** @description Default Response */
33104
+ "4XX": {
33105
+ headers: {
33106
+ [name: string]: unknown;
33107
+ };
33108
+ content: {
33109
+ "application/json": {
33110
+ error: string;
33111
+ message?: string;
33112
+ } & {
33113
+ [key: string]: unknown;
33114
+ };
33115
+ };
33116
+ };
33117
+ };
33118
+ };
33119
+ get_principal_balance_changes: {
33120
+ parameters: {
33121
+ query: {
33122
+ /** @description Number of results per page */
33123
+ limit?: number;
33124
+ /** @description Cursor for paginating principal balance changes across multiple transactions. Format: `<block_height>:<microblock_sequence>:<tx_index>:<asset_type>:<asset_identifier>`. */
33125
+ cursor?: string;
33126
+ /** @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`). */
33127
+ tx_id: string[];
33128
+ };
33129
+ header?: never;
33130
+ path: {
33131
+ principal: string;
33132
+ };
33133
+ cookie?: never;
33134
+ };
33135
+ requestBody?: never;
33136
+ responses: {
33137
+ /** @description Default Response */
33138
+ 200: {
33139
+ headers: {
33140
+ [name: string]: unknown;
33141
+ };
33142
+ content: {
33143
+ "application/json": {
33144
+ /** @example 1 */
33145
+ total: number;
33146
+ /**
33147
+ * @description Number of results per page
33148
+ * @default 20
33149
+ */
33150
+ limit: number;
33151
+ cursor: {
33152
+ next: string | null;
33153
+ previous: string | null;
33154
+ current: string | null;
32975
33155
  };
32976
- enrollment: {
33156
+ results: {
32977
33157
  /**
32978
33158
  * Transaction ID
32979
33159
  * @description Transaction ID
32980
33160
  * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
32981
33161
  */
32982
33162
  tx_id: string;
32983
- btc_lockup: {
32984
- /** @description The amount of BTC that is locked up for this principal */
32985
- amount: string;
33163
+ asset: {
33164
+ /** @enum {string} */
33165
+ type: "stx";
33166
+ } | {
33167
+ /** @description The asset type that was affected by the balance change. */
33168
+ type: "ft" | "nft";
33169
+ /** @description The identifier of the asset that was affected by the balance change. */
33170
+ identifier: string;
33171
+ };
33172
+ balance_change: {
33173
+ /** @description Amount sent by the principal */
33174
+ sent: string;
33175
+ /** @description Amount received by the principal */
33176
+ received: string;
33177
+ /** @description Net balance change for the principal */
33178
+ net: string;
33179
+ };
33180
+ }[];
33181
+ };
33182
+ };
33183
+ };
33184
+ /** @description Default Response */
33185
+ "4XX": {
33186
+ headers: {
33187
+ [name: string]: unknown;
33188
+ };
33189
+ content: {
33190
+ "application/json": {
33191
+ error: string;
33192
+ message?: string;
33193
+ } & {
33194
+ [key: string]: unknown;
33195
+ };
33196
+ };
33197
+ };
33198
+ };
33199
+ };
33200
+ get_principal_staking_summary: {
33201
+ parameters: {
33202
+ query?: never;
33203
+ header?: never;
33204
+ path: {
33205
+ principal: string;
33206
+ };
33207
+ cookie?: never;
33208
+ };
33209
+ requestBody?: never;
33210
+ responses: {
33211
+ /** @description Default Response */
33212
+ 200: {
33213
+ headers: {
33214
+ [name: string]: unknown;
33215
+ };
33216
+ content: {
33217
+ "application/json": {
33218
+ stx: {
33219
+ /** @description The amount of uSTX currently locked in pox-5 STX staking */
33220
+ locked: string;
33221
+ rewards: {
33222
+ btc: {
33223
+ /** @description The lifetime sBTC reward sats accrued to this position */
33224
+ accrued: string;
33225
+ /** @description The lifetime sBTC reward sats already claimed against this position */
33226
+ claimed: string;
33227
+ /** @description The sBTC reward sats currently claimable (accrued minus claimed) */
33228
+ claimable: string;
33229
+ };
32986
33230
  };
32987
33231
  };
32988
- /** @description The amount of STX that is locked up for this principal */
32989
- amount: string;
32990
- /** @description The sBTC reward sats accrued to this participant's position */
32991
- accrued_rewards: string;
32992
- }[];
33232
+ bonds: {
33233
+ /** @description Number of bonds this principal has a position in */
33234
+ count: number;
33235
+ locked: {
33236
+ /** @description Total BTC locked across all bond positions */
33237
+ btc: string;
33238
+ /** @description Total STX locked across all bond positions */
33239
+ stx: string;
33240
+ };
33241
+ rewards: {
33242
+ btc: {
33243
+ /** @description The lifetime sBTC reward sats accrued to this position */
33244
+ accrued: string;
33245
+ /** @description The lifetime sBTC reward sats already claimed against this position */
33246
+ claimed: string;
33247
+ /** @description The sBTC reward sats currently claimable (accrued minus claimed) */
33248
+ claimable: string;
33249
+ };
33250
+ };
33251
+ };
33252
+ };
33253
+ };
33254
+ };
33255
+ /** @description Default Response */
33256
+ "4XX": {
33257
+ headers: {
33258
+ [name: string]: unknown;
33259
+ };
33260
+ content: {
33261
+ "application/json": {
33262
+ error: string;
33263
+ message?: string;
33264
+ } & {
33265
+ [key: string]: unknown;
33266
+ };
33267
+ };
33268
+ };
33269
+ };
33270
+ };
33271
+ get_principal_bond_positions: {
33272
+ parameters: {
33273
+ query?: {
33274
+ /** @description Number of results per page */
33275
+ limit?: number;
33276
+ /** @description Cursor for paginating bonds. Format: bond_index */
33277
+ cursor?: string;
33278
+ };
33279
+ header?: never;
33280
+ path: {
33281
+ principal: string;
33282
+ };
33283
+ cookie?: never;
33284
+ };
33285
+ requestBody?: never;
33286
+ responses: {
33287
+ /** @description Default Response */
33288
+ 200: {
33289
+ headers: {
33290
+ [name: string]: unknown;
33291
+ };
33292
+ content: {
33293
+ "application/json": {
33294
+ /** @example 1 */
33295
+ total: number;
33296
+ /**
33297
+ * @description Number of results per page
33298
+ * @default 20
33299
+ */
33300
+ limit: number;
33301
+ cursor: {
33302
+ next: string | null;
33303
+ previous: string | null;
33304
+ current: string | null;
33305
+ };
33306
+ results: {
33307
+ /** @description The index of the bond in the PoX-5 bond list */
33308
+ bond_index: number;
33309
+ status: "enrolled" | "running" | "early_exit" | "unlocked";
33310
+ /** @description Whether the position is active */
33311
+ active: boolean;
33312
+ enrollment: {
33313
+ /**
33314
+ * Transaction ID
33315
+ * @description Transaction ID
33316
+ * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
33317
+ */
33318
+ tx_id: string;
33319
+ btc_lockup: {
33320
+ /** @description The amount of BTC that is locked up for this principal */
33321
+ amount: string;
33322
+ };
33323
+ };
33324
+ locked: {
33325
+ /** @description The amount of BTC locked in this bond position */
33326
+ btc: string;
33327
+ /** @description The amount of STX locked in this bond position */
33328
+ stx: string;
33329
+ };
33330
+ rewards: {
33331
+ btc: {
33332
+ /** @description The lifetime sBTC reward sats accrued to this position */
33333
+ accrued: string;
33334
+ /** @description The lifetime sBTC reward sats already claimed against this position */
33335
+ claimed: string;
33336
+ /** @description The sBTC reward sats currently claimable (accrued minus claimed) */
33337
+ claimable: string;
33338
+ };
33339
+ };
33340
+ }[];
33341
+ };
32993
33342
  };
32994
33343
  };
32995
33344
  /** @description Default Response */
@@ -33674,6 +34023,135 @@ export interface operations {
33674
34023
  };
33675
34024
  };
33676
34025
  };
34026
+ get_staking_signers: {
34027
+ parameters: {
34028
+ query?: {
34029
+ /** @description Number of results per page */
34030
+ limit?: number;
34031
+ /** @description Cursor for paginating staking signers (sorted by signer). Format: signer principal */
34032
+ cursor?: string;
34033
+ };
34034
+ header?: never;
34035
+ path?: never;
34036
+ cookie?: never;
34037
+ };
34038
+ requestBody?: never;
34039
+ responses: {
34040
+ /** @description Default Response */
34041
+ 200: {
34042
+ headers: {
34043
+ [name: string]: unknown;
34044
+ };
34045
+ content: {
34046
+ "application/json": {
34047
+ /** @example 1 */
34048
+ total: number;
34049
+ /**
34050
+ * @description Number of results per page
34051
+ * @default 100
34052
+ */
34053
+ limit: number;
34054
+ cursor: {
34055
+ next: string | null;
34056
+ previous: string | null;
34057
+ current: string | null;
34058
+ };
34059
+ results: {
34060
+ signer: string;
34061
+ /**
34062
+ * @description The registered compressed secp256k1 public key, as a `0x`-prefixed hex string
34063
+ * @example 0x03a0f9e1...
34064
+ */
34065
+ signer_key: string;
34066
+ }[];
34067
+ };
34068
+ };
34069
+ };
34070
+ /** @description Default Response */
34071
+ "4XX": {
34072
+ headers: {
34073
+ [name: string]: unknown;
34074
+ };
34075
+ content: {
34076
+ "application/json": {
34077
+ error: string;
34078
+ message?: string;
34079
+ } & {
34080
+ [key: string]: unknown;
34081
+ };
34082
+ };
34083
+ };
34084
+ };
34085
+ };
34086
+ get_staking_signer: {
34087
+ parameters: {
34088
+ query?: never;
34089
+ header?: never;
34090
+ path: {
34091
+ principal: string;
34092
+ };
34093
+ cookie?: never;
34094
+ };
34095
+ requestBody?: never;
34096
+ responses: {
34097
+ /** @description Default Response */
34098
+ 200: {
34099
+ headers: {
34100
+ [name: string]: unknown;
34101
+ };
34102
+ content: {
34103
+ "application/json": {
34104
+ signer: string;
34105
+ /**
34106
+ * @description The registered compressed secp256k1 public key, as a `0x`-prefixed hex string
34107
+ * @example 0x03a0f9e1...
34108
+ */
34109
+ signer_key: string;
34110
+ transaction: {
34111
+ /**
34112
+ * Transaction ID
34113
+ * @description Transaction ID
34114
+ * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
34115
+ */
34116
+ tx_id: string;
34117
+ block: {
34118
+ /** @description Height of the block this transactions was associated with */
34119
+ height: number;
34120
+ /** @description Hash of the blocked this transactions was associated with */
34121
+ hash: string;
34122
+ /** @description Hash of the index block this transactions was associated with */
34123
+ index_hash: string;
34124
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34125
+ time: number;
34126
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
34127
+ tx_index: number;
34128
+ };
34129
+ bitcoin_block: {
34130
+ /** @description Height of the anchor burn block. */
34131
+ height: number;
34132
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34133
+ time: number;
34134
+ };
34135
+ };
34136
+ };
34137
+ };
34138
+ };
34139
+ /** @description Default Response */
34140
+ "4XX": {
34141
+ headers: {
34142
+ [name: string]: unknown;
34143
+ };
34144
+ content: {
34145
+ "application/json": {
34146
+ error: string;
34147
+ message?: string;
34148
+ } & {
34149
+ [key: string]: unknown;
34150
+ };
34151
+ };
34152
+ };
34153
+ };
34154
+ };
33677
34155
  get_transactions: {
33678
34156
  parameters: {
33679
34157
  query?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stacks/blockchain-api-client",
3
- "version": "9.0.0-pox5.8",
3
+ "version": "9.0.0-pox5.9",
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",
@@ -1777,7 +1777,7 @@ export interface paths {
1777
1777
  patch?: never;
1778
1778
  trace?: never;
1779
1779
  };
1780
- "/extended/v3/principals/{principal}/balances/staking": {
1780
+ "/extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes": {
1781
1781
  parameters: {
1782
1782
  query?: never;
1783
1783
  header?: never;
@@ -1785,10 +1785,70 @@ export interface paths {
1785
1785
  cookie?: never;
1786
1786
  };
1787
1787
  /**
1788
- * Get principal staking balances
1789
- * @description Get a principal's staking balances: its bond positions (staked amounts and accrued rewards) across all bonds it is enrolled in
1788
+ * Get principal transaction balance changes
1789
+ * @description Returns the balance changes for a principal's transaction
1790
1790
  */
1791
- get: operations["get_principal_balances_staking"];
1791
+ get: operations["get_principal_transaction_balance_changes"];
1792
+ put?: never;
1793
+ post?: never;
1794
+ delete?: never;
1795
+ options?: never;
1796
+ head?: never;
1797
+ patch?: never;
1798
+ trace?: never;
1799
+ };
1800
+ "/extended/v3/principals/{principal}/balance-changes": {
1801
+ parameters: {
1802
+ query?: never;
1803
+ header?: never;
1804
+ path?: never;
1805
+ cookie?: never;
1806
+ };
1807
+ /**
1808
+ * Get principal balance changes
1809
+ * @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.
1810
+ */
1811
+ get: operations["get_principal_balance_changes"];
1812
+ put?: never;
1813
+ post?: never;
1814
+ delete?: never;
1815
+ options?: never;
1816
+ head?: never;
1817
+ patch?: never;
1818
+ trace?: never;
1819
+ };
1820
+ "/extended/v3/principals/{principal}/staking": {
1821
+ parameters: {
1822
+ query?: never;
1823
+ header?: never;
1824
+ path?: never;
1825
+ cookie?: never;
1826
+ };
1827
+ /**
1828
+ * Get principal staking summary
1829
+ * @description A one-call overview of a principal's staking: its pox-5 STX-staking position (locked STX and its sBTC rewards) plus aggregate totals across all of its bond positions. The per-bond breakdown is paginated at `/principals/:principal/staking/bonds`.
1830
+ */
1831
+ get: operations["get_principal_staking_summary"];
1832
+ put?: never;
1833
+ post?: never;
1834
+ delete?: never;
1835
+ options?: never;
1836
+ head?: never;
1837
+ patch?: never;
1838
+ trace?: never;
1839
+ };
1840
+ "/extended/v3/principals/{principal}/staking/bonds": {
1841
+ parameters: {
1842
+ query?: never;
1843
+ header?: never;
1844
+ path?: never;
1845
+ cookie?: never;
1846
+ };
1847
+ /**
1848
+ * Get principal bond positions
1849
+ * @description Get a principal's bond positions — its enrollment, lock, status, and sBTC rewards in each bond it participates in.
1850
+ */
1851
+ get: operations["get_principal_bond_positions"];
1792
1852
  put?: never;
1793
1853
  post?: never;
1794
1854
  delete?: never;
@@ -1977,6 +2037,46 @@ export interface paths {
1977
2037
  patch?: never;
1978
2038
  trace?: never;
1979
2039
  };
2040
+ "/extended/v3/staking/signers": {
2041
+ parameters: {
2042
+ query?: never;
2043
+ header?: never;
2044
+ path?: never;
2045
+ cookie?: never;
2046
+ };
2047
+ /**
2048
+ * Get staking signers
2049
+ * @description Get the registered pox-5 staking signers and their current signing keys.
2050
+ */
2051
+ get: operations["get_staking_signers"];
2052
+ put?: never;
2053
+ post?: never;
2054
+ delete?: never;
2055
+ options?: never;
2056
+ head?: never;
2057
+ patch?: never;
2058
+ trace?: never;
2059
+ };
2060
+ "/extended/v3/staking/signers/{principal}": {
2061
+ parameters: {
2062
+ query?: never;
2063
+ header?: never;
2064
+ path?: never;
2065
+ cookie?: never;
2066
+ };
2067
+ /**
2068
+ * Get staking signer
2069
+ * @description Get a registered pox-5 staking signer along with the details of the transaction that registered its current key.
2070
+ */
2071
+ get: operations["get_staking_signer"];
2072
+ put?: never;
2073
+ post?: never;
2074
+ delete?: never;
2075
+ options?: never;
2076
+ head?: never;
2077
+ patch?: never;
2078
+ trace?: never;
2079
+ };
1980
2080
  "/extended/v3/transactions": {
1981
2081
  parameters: {
1982
2082
  query?: never;
@@ -32938,12 +33038,22 @@ export interface operations {
32938
33038
  };
32939
33039
  };
32940
33040
  };
32941
- get_principal_balances_staking: {
33041
+ get_principal_transaction_balance_changes: {
32942
33042
  parameters: {
32943
- query?: never;
33043
+ query?: {
33044
+ /** @description Number of results per page */
33045
+ limit?: number;
33046
+ /** @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. */
33047
+ cursor?: string;
33048
+ };
32944
33049
  header?: never;
32945
33050
  path: {
32946
33051
  principal: string;
33052
+ /**
33053
+ * @description Transaction ID
33054
+ * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
33055
+ */
33056
+ tx_id: string;
32947
33057
  };
32948
33058
  cookie?: never;
32949
33059
  };
@@ -32956,40 +33066,279 @@ export interface operations {
32956
33066
  };
32957
33067
  content: {
32958
33068
  "application/json": {
32959
- /** @description The index of the bond in the PoX-5 bond list */
32960
- bond_index: number;
32961
- status: "enrolled" | "running" | "early_exit" | "unlocked";
32962
- /** @description Whether the position is active */
32963
- active: boolean;
32964
- balances: {
32965
- locked: {
32966
- /** @description The total amount of BTC that is locked up for this bond */
32967
- btc: string;
32968
- /** @description The total amount of STX that is locked up for this bond */
32969
- stx: string;
33069
+ /** @example 1 */
33070
+ total: number;
33071
+ /**
33072
+ * @description Number of results per page
33073
+ * @default 20
33074
+ */
33075
+ limit: number;
33076
+ cursor: {
33077
+ next: string | null;
33078
+ previous: string | null;
33079
+ current: string | null;
33080
+ };
33081
+ results: {
33082
+ asset: {
33083
+ /** @enum {string} */
33084
+ type: "stx";
33085
+ } | {
33086
+ /** @description The asset type that was affected by the balance change. */
33087
+ type: "ft" | "nft";
33088
+ /** @description The identifier of the asset that was affected by the balance change. */
33089
+ identifier: string;
32970
33090
  };
32971
- paid_out: {
32972
- /** @description The total amount of BTC that has been paid out for this bond */
32973
- btc: string;
33091
+ balance_change: {
33092
+ /** @description Amount sent by the principal */
33093
+ sent: string;
33094
+ /** @description Amount received by the principal */
33095
+ received: string;
33096
+ /** @description Net balance change for the principal */
33097
+ net: string;
32974
33098
  };
33099
+ }[];
33100
+ };
33101
+ };
33102
+ };
33103
+ /** @description Default Response */
33104
+ "4XX": {
33105
+ headers: {
33106
+ [name: string]: unknown;
33107
+ };
33108
+ content: {
33109
+ "application/json": {
33110
+ error: string;
33111
+ message?: string;
33112
+ } & {
33113
+ [key: string]: unknown;
33114
+ };
33115
+ };
33116
+ };
33117
+ };
33118
+ };
33119
+ get_principal_balance_changes: {
33120
+ parameters: {
33121
+ query: {
33122
+ /** @description Number of results per page */
33123
+ limit?: number;
33124
+ /** @description Cursor for paginating principal balance changes across multiple transactions. Format: `<block_height>:<microblock_sequence>:<tx_index>:<asset_type>:<asset_identifier>`. */
33125
+ cursor?: string;
33126
+ /** @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`). */
33127
+ tx_id: string[];
33128
+ };
33129
+ header?: never;
33130
+ path: {
33131
+ principal: string;
33132
+ };
33133
+ cookie?: never;
33134
+ };
33135
+ requestBody?: never;
33136
+ responses: {
33137
+ /** @description Default Response */
33138
+ 200: {
33139
+ headers: {
33140
+ [name: string]: unknown;
33141
+ };
33142
+ content: {
33143
+ "application/json": {
33144
+ /** @example 1 */
33145
+ total: number;
33146
+ /**
33147
+ * @description Number of results per page
33148
+ * @default 20
33149
+ */
33150
+ limit: number;
33151
+ cursor: {
33152
+ next: string | null;
33153
+ previous: string | null;
33154
+ current: string | null;
32975
33155
  };
32976
- enrollment: {
33156
+ results: {
32977
33157
  /**
32978
33158
  * Transaction ID
32979
33159
  * @description Transaction ID
32980
33160
  * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
32981
33161
  */
32982
33162
  tx_id: string;
32983
- btc_lockup: {
32984
- /** @description The amount of BTC that is locked up for this principal */
32985
- amount: string;
33163
+ asset: {
33164
+ /** @enum {string} */
33165
+ type: "stx";
33166
+ } | {
33167
+ /** @description The asset type that was affected by the balance change. */
33168
+ type: "ft" | "nft";
33169
+ /** @description The identifier of the asset that was affected by the balance change. */
33170
+ identifier: string;
33171
+ };
33172
+ balance_change: {
33173
+ /** @description Amount sent by the principal */
33174
+ sent: string;
33175
+ /** @description Amount received by the principal */
33176
+ received: string;
33177
+ /** @description Net balance change for the principal */
33178
+ net: string;
33179
+ };
33180
+ }[];
33181
+ };
33182
+ };
33183
+ };
33184
+ /** @description Default Response */
33185
+ "4XX": {
33186
+ headers: {
33187
+ [name: string]: unknown;
33188
+ };
33189
+ content: {
33190
+ "application/json": {
33191
+ error: string;
33192
+ message?: string;
33193
+ } & {
33194
+ [key: string]: unknown;
33195
+ };
33196
+ };
33197
+ };
33198
+ };
33199
+ };
33200
+ get_principal_staking_summary: {
33201
+ parameters: {
33202
+ query?: never;
33203
+ header?: never;
33204
+ path: {
33205
+ principal: string;
33206
+ };
33207
+ cookie?: never;
33208
+ };
33209
+ requestBody?: never;
33210
+ responses: {
33211
+ /** @description Default Response */
33212
+ 200: {
33213
+ headers: {
33214
+ [name: string]: unknown;
33215
+ };
33216
+ content: {
33217
+ "application/json": {
33218
+ stx: {
33219
+ /** @description The amount of uSTX currently locked in pox-5 STX staking */
33220
+ locked: string;
33221
+ rewards: {
33222
+ btc: {
33223
+ /** @description The lifetime sBTC reward sats accrued to this position */
33224
+ accrued: string;
33225
+ /** @description The lifetime sBTC reward sats already claimed against this position */
33226
+ claimed: string;
33227
+ /** @description The sBTC reward sats currently claimable (accrued minus claimed) */
33228
+ claimable: string;
33229
+ };
32986
33230
  };
32987
33231
  };
32988
- /** @description The amount of STX that is locked up for this principal */
32989
- amount: string;
32990
- /** @description The sBTC reward sats accrued to this participant's position */
32991
- accrued_rewards: string;
32992
- }[];
33232
+ bonds: {
33233
+ /** @description Number of bonds this principal has a position in */
33234
+ count: number;
33235
+ locked: {
33236
+ /** @description Total BTC locked across all bond positions */
33237
+ btc: string;
33238
+ /** @description Total STX locked across all bond positions */
33239
+ stx: string;
33240
+ };
33241
+ rewards: {
33242
+ btc: {
33243
+ /** @description The lifetime sBTC reward sats accrued to this position */
33244
+ accrued: string;
33245
+ /** @description The lifetime sBTC reward sats already claimed against this position */
33246
+ claimed: string;
33247
+ /** @description The sBTC reward sats currently claimable (accrued minus claimed) */
33248
+ claimable: string;
33249
+ };
33250
+ };
33251
+ };
33252
+ };
33253
+ };
33254
+ };
33255
+ /** @description Default Response */
33256
+ "4XX": {
33257
+ headers: {
33258
+ [name: string]: unknown;
33259
+ };
33260
+ content: {
33261
+ "application/json": {
33262
+ error: string;
33263
+ message?: string;
33264
+ } & {
33265
+ [key: string]: unknown;
33266
+ };
33267
+ };
33268
+ };
33269
+ };
33270
+ };
33271
+ get_principal_bond_positions: {
33272
+ parameters: {
33273
+ query?: {
33274
+ /** @description Number of results per page */
33275
+ limit?: number;
33276
+ /** @description Cursor for paginating bonds. Format: bond_index */
33277
+ cursor?: string;
33278
+ };
33279
+ header?: never;
33280
+ path: {
33281
+ principal: string;
33282
+ };
33283
+ cookie?: never;
33284
+ };
33285
+ requestBody?: never;
33286
+ responses: {
33287
+ /** @description Default Response */
33288
+ 200: {
33289
+ headers: {
33290
+ [name: string]: unknown;
33291
+ };
33292
+ content: {
33293
+ "application/json": {
33294
+ /** @example 1 */
33295
+ total: number;
33296
+ /**
33297
+ * @description Number of results per page
33298
+ * @default 20
33299
+ */
33300
+ limit: number;
33301
+ cursor: {
33302
+ next: string | null;
33303
+ previous: string | null;
33304
+ current: string | null;
33305
+ };
33306
+ results: {
33307
+ /** @description The index of the bond in the PoX-5 bond list */
33308
+ bond_index: number;
33309
+ status: "enrolled" | "running" | "early_exit" | "unlocked";
33310
+ /** @description Whether the position is active */
33311
+ active: boolean;
33312
+ enrollment: {
33313
+ /**
33314
+ * Transaction ID
33315
+ * @description Transaction ID
33316
+ * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
33317
+ */
33318
+ tx_id: string;
33319
+ btc_lockup: {
33320
+ /** @description The amount of BTC that is locked up for this principal */
33321
+ amount: string;
33322
+ };
33323
+ };
33324
+ locked: {
33325
+ /** @description The amount of BTC locked in this bond position */
33326
+ btc: string;
33327
+ /** @description The amount of STX locked in this bond position */
33328
+ stx: string;
33329
+ };
33330
+ rewards: {
33331
+ btc: {
33332
+ /** @description The lifetime sBTC reward sats accrued to this position */
33333
+ accrued: string;
33334
+ /** @description The lifetime sBTC reward sats already claimed against this position */
33335
+ claimed: string;
33336
+ /** @description The sBTC reward sats currently claimable (accrued minus claimed) */
33337
+ claimable: string;
33338
+ };
33339
+ };
33340
+ }[];
33341
+ };
32993
33342
  };
32994
33343
  };
32995
33344
  /** @description Default Response */
@@ -33674,6 +34023,135 @@ export interface operations {
33674
34023
  };
33675
34024
  };
33676
34025
  };
34026
+ get_staking_signers: {
34027
+ parameters: {
34028
+ query?: {
34029
+ /** @description Number of results per page */
34030
+ limit?: number;
34031
+ /** @description Cursor for paginating staking signers (sorted by signer). Format: signer principal */
34032
+ cursor?: string;
34033
+ };
34034
+ header?: never;
34035
+ path?: never;
34036
+ cookie?: never;
34037
+ };
34038
+ requestBody?: never;
34039
+ responses: {
34040
+ /** @description Default Response */
34041
+ 200: {
34042
+ headers: {
34043
+ [name: string]: unknown;
34044
+ };
34045
+ content: {
34046
+ "application/json": {
34047
+ /** @example 1 */
34048
+ total: number;
34049
+ /**
34050
+ * @description Number of results per page
34051
+ * @default 100
34052
+ */
34053
+ limit: number;
34054
+ cursor: {
34055
+ next: string | null;
34056
+ previous: string | null;
34057
+ current: string | null;
34058
+ };
34059
+ results: {
34060
+ signer: string;
34061
+ /**
34062
+ * @description The registered compressed secp256k1 public key, as a `0x`-prefixed hex string
34063
+ * @example 0x03a0f9e1...
34064
+ */
34065
+ signer_key: string;
34066
+ }[];
34067
+ };
34068
+ };
34069
+ };
34070
+ /** @description Default Response */
34071
+ "4XX": {
34072
+ headers: {
34073
+ [name: string]: unknown;
34074
+ };
34075
+ content: {
34076
+ "application/json": {
34077
+ error: string;
34078
+ message?: string;
34079
+ } & {
34080
+ [key: string]: unknown;
34081
+ };
34082
+ };
34083
+ };
34084
+ };
34085
+ };
34086
+ get_staking_signer: {
34087
+ parameters: {
34088
+ query?: never;
34089
+ header?: never;
34090
+ path: {
34091
+ principal: string;
34092
+ };
34093
+ cookie?: never;
34094
+ };
34095
+ requestBody?: never;
34096
+ responses: {
34097
+ /** @description Default Response */
34098
+ 200: {
34099
+ headers: {
34100
+ [name: string]: unknown;
34101
+ };
34102
+ content: {
34103
+ "application/json": {
34104
+ signer: string;
34105
+ /**
34106
+ * @description The registered compressed secp256k1 public key, as a `0x`-prefixed hex string
34107
+ * @example 0x03a0f9e1...
34108
+ */
34109
+ signer_key: string;
34110
+ transaction: {
34111
+ /**
34112
+ * Transaction ID
34113
+ * @description Transaction ID
34114
+ * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
34115
+ */
34116
+ tx_id: string;
34117
+ block: {
34118
+ /** @description Height of the block this transactions was associated with */
34119
+ height: number;
34120
+ /** @description Hash of the blocked this transactions was associated with */
34121
+ hash: string;
34122
+ /** @description Hash of the index block this transactions was associated with */
34123
+ index_hash: string;
34124
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34125
+ time: number;
34126
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
34127
+ tx_index: number;
34128
+ };
34129
+ bitcoin_block: {
34130
+ /** @description Height of the anchor burn block. */
34131
+ height: number;
34132
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34133
+ time: number;
34134
+ };
34135
+ };
34136
+ };
34137
+ };
34138
+ };
34139
+ /** @description Default Response */
34140
+ "4XX": {
34141
+ headers: {
34142
+ [name: string]: unknown;
34143
+ };
34144
+ content: {
34145
+ "application/json": {
34146
+ error: string;
34147
+ message?: string;
34148
+ } & {
34149
+ [key: string]: unknown;
34150
+ };
34151
+ };
34152
+ };
34153
+ };
34154
+ };
33677
34155
  get_transactions: {
33678
34156
  parameters: {
33679
34157
  query?: {