@stacks/blockchain-api-client 9.0.0-pox5.3 → 9.0.0-pox5.4

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.
@@ -1690,6 +1690,46 @@ export interface paths {
1690
1690
  patch?: never;
1691
1691
  trace?: never;
1692
1692
  };
1693
+ "/extended/v3/blocks/{height_or_hash}/transactions": {
1694
+ parameters: {
1695
+ query?: never;
1696
+ header?: never;
1697
+ path?: never;
1698
+ cookie?: never;
1699
+ };
1700
+ /**
1701
+ * Get block transactions
1702
+ * @description Retrieves transactions confirmed in a single block
1703
+ */
1704
+ get: operations["get_block_transactions"];
1705
+ put?: never;
1706
+ post?: never;
1707
+ delete?: never;
1708
+ options?: never;
1709
+ head?: never;
1710
+ patch?: never;
1711
+ trace?: never;
1712
+ };
1713
+ "/extended/v3/mempool/transactions": {
1714
+ parameters: {
1715
+ query?: never;
1716
+ header?: never;
1717
+ path?: never;
1718
+ cookie?: never;
1719
+ };
1720
+ /**
1721
+ * Get mempool transactions
1722
+ * @description Retrieves a list of recently broadcasted transactions
1723
+ */
1724
+ get: operations["get_mempool_transactions"];
1725
+ put?: never;
1726
+ post?: never;
1727
+ delete?: never;
1728
+ options?: never;
1729
+ head?: never;
1730
+ patch?: never;
1731
+ trace?: never;
1732
+ };
1693
1733
  "/extended/v3/principals/{principal}/transactions": {
1694
1734
  parameters: {
1695
1735
  query?: never;
@@ -1730,7 +1770,7 @@ export interface paths {
1730
1770
  patch?: never;
1731
1771
  trace?: never;
1732
1772
  };
1733
- "/extended/v3/transactions": {
1773
+ "/extended/v3/staking/bonds": {
1734
1774
  parameters: {
1735
1775
  query?: never;
1736
1776
  header?: never;
@@ -1738,10 +1778,10 @@ export interface paths {
1738
1778
  cookie?: never;
1739
1779
  };
1740
1780
  /**
1741
- * Get transactions
1742
- * @description Retrieves a list of recently mined transactions
1781
+ * Get bonds
1782
+ * @description Get bonds
1743
1783
  */
1744
- get: operations["get_transactions"];
1784
+ get: operations["get_bonds"];
1745
1785
  put?: never;
1746
1786
  post?: never;
1747
1787
  delete?: never;
@@ -1750,7 +1790,7 @@ export interface paths {
1750
1790
  patch?: never;
1751
1791
  trace?: never;
1752
1792
  };
1753
- "/extended/v3/transactions/{tx_id}": {
1793
+ "/extended/v3/staking/bonds/{bond_index}": {
1754
1794
  parameters: {
1755
1795
  query?: never;
1756
1796
  header?: never;
@@ -1758,10 +1798,10 @@ export interface paths {
1758
1798
  cookie?: never;
1759
1799
  };
1760
1800
  /**
1761
- * Get transaction
1762
- * @description Retrieves details for a given transaction, including both mined and mempool transactions
1801
+ * Get bond
1802
+ * @description Get bond
1763
1803
  */
1764
- get: operations["get_transaction"];
1804
+ get: operations["get_bond"];
1765
1805
  put?: never;
1766
1806
  post?: never;
1767
1807
  delete?: never;
@@ -1770,7 +1810,7 @@ export interface paths {
1770
1810
  patch?: never;
1771
1811
  trace?: never;
1772
1812
  };
1773
- "/extended/v3/transactions/{tx_id}/events": {
1813
+ "/extended/v3/staking/bonds/{bond_index}/allowlist": {
1774
1814
  parameters: {
1775
1815
  query?: never;
1776
1816
  header?: never;
@@ -1778,10 +1818,10 @@ export interface paths {
1778
1818
  cookie?: never;
1779
1819
  };
1780
1820
  /**
1781
- * Get transaction events
1782
- * @description Retrieves events for a given transaction ID
1821
+ * Get bond allowlist entries
1822
+ * @description Get bond allowlist entries
1783
1823
  */
1784
- get: operations["get_transaction_events"];
1824
+ get: operations["get_bond_allowlist_entries"];
1785
1825
  put?: never;
1786
1826
  post?: never;
1787
1827
  delete?: never;
@@ -1790,7 +1830,7 @@ export interface paths {
1790
1830
  patch?: never;
1791
1831
  trace?: never;
1792
1832
  };
1793
- "/extended/v3/mempool/transactions": {
1833
+ "/extended/v3/staking/bonds/{bond_index}/allowlist/{principal}": {
1794
1834
  parameters: {
1795
1835
  query?: never;
1796
1836
  header?: never;
@@ -1798,10 +1838,10 @@ export interface paths {
1798
1838
  cookie?: never;
1799
1839
  };
1800
1840
  /**
1801
- * Get mempool transactions
1802
- * @description Retrieves a list of recently broadcasted transactions
1841
+ * Get bond allowlist entry
1842
+ * @description Get bond allowlist entry
1803
1843
  */
1804
- get: operations["get_mempool_transactions"];
1844
+ get: operations["get_bond_allowlist_entry"];
1805
1845
  put?: never;
1806
1846
  post?: never;
1807
1847
  delete?: never;
@@ -1810,7 +1850,7 @@ export interface paths {
1810
1850
  patch?: never;
1811
1851
  trace?: never;
1812
1852
  };
1813
- "/extended/v3/blocks/{height_or_hash}/transactions": {
1853
+ "/extended/v3/staking/bonds/{bond_index}/registrations": {
1814
1854
  parameters: {
1815
1855
  query?: never;
1816
1856
  header?: never;
@@ -1818,10 +1858,110 @@ export interface paths {
1818
1858
  cookie?: never;
1819
1859
  };
1820
1860
  /**
1821
- * Get block transactions
1822
- * @description Retrieves transactions confirmed in a single block
1861
+ * Get bond registrations
1862
+ * @description Get bond registrations
1823
1863
  */
1824
- get: operations["get_block_transactions"];
1864
+ get: operations["get_bond_registrations"];
1865
+ put?: never;
1866
+ post?: never;
1867
+ delete?: never;
1868
+ options?: never;
1869
+ head?: never;
1870
+ patch?: never;
1871
+ trace?: never;
1872
+ };
1873
+ "/extended/v3/staking/bonds/{bond_index}/registrations/{principal}": {
1874
+ parameters: {
1875
+ query?: never;
1876
+ header?: never;
1877
+ path?: never;
1878
+ cookie?: never;
1879
+ };
1880
+ /**
1881
+ * Get bond registration
1882
+ * @description Get bond registration
1883
+ */
1884
+ get: operations["get_bond_registration"];
1885
+ put?: never;
1886
+ post?: never;
1887
+ delete?: never;
1888
+ options?: never;
1889
+ head?: never;
1890
+ patch?: never;
1891
+ trace?: never;
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
+ "/extended/v3/transactions": {
1914
+ parameters: {
1915
+ query?: never;
1916
+ header?: never;
1917
+ path?: never;
1918
+ cookie?: never;
1919
+ };
1920
+ /**
1921
+ * Get transactions
1922
+ * @description Retrieves a list of recently mined transactions
1923
+ */
1924
+ get: operations["get_transactions"];
1925
+ put?: never;
1926
+ post?: never;
1927
+ delete?: never;
1928
+ options?: never;
1929
+ head?: never;
1930
+ patch?: never;
1931
+ trace?: never;
1932
+ };
1933
+ "/extended/v3/transactions/{tx_id}": {
1934
+ parameters: {
1935
+ query?: never;
1936
+ header?: never;
1937
+ path?: never;
1938
+ cookie?: never;
1939
+ };
1940
+ /**
1941
+ * Get transaction
1942
+ * @description Retrieves details for a given transaction, including both mined and mempool transactions
1943
+ */
1944
+ get: operations["get_transaction"];
1945
+ put?: never;
1946
+ post?: never;
1947
+ delete?: never;
1948
+ options?: never;
1949
+ head?: never;
1950
+ patch?: never;
1951
+ trace?: never;
1952
+ };
1953
+ "/extended/v3/transactions/{tx_id}/events": {
1954
+ parameters: {
1955
+ query?: never;
1956
+ header?: never;
1957
+ path?: never;
1958
+ cookie?: never;
1959
+ };
1960
+ /**
1961
+ * Get transaction events
1962
+ * @description Retrieves events for a given transaction ID
1963
+ */
1964
+ get: operations["get_transaction_events"];
1825
1965
  put?: never;
1826
1966
  post?: never;
1827
1967
  delete?: never;
@@ -31801,7 +31941,7 @@ export interface operations {
31801
31941
  };
31802
31942
  };
31803
31943
  };
31804
- get_principal_transactions: {
31944
+ get_block_transactions: {
31805
31945
  parameters: {
31806
31946
  query?: {
31807
31947
  /** @description Number of results per page */
@@ -31811,364 +31951,1393 @@ export interface operations {
31811
31951
  };
31812
31952
  header?: never;
31813
31953
  path: {
31814
- principal: string;
31815
- };
31816
- cookie?: never;
31817
- };
31818
- requestBody?: never;
31819
- responses: {
31820
- /** @description Default Response */
31821
- 200: {
31822
- headers: {
31823
- [name: string]: unknown;
31824
- };
31825
- content: {
31826
- "application/json": {
31827
- /** @example 1 */
31828
- total: number;
31829
- /**
31830
- * @description Number of results per page
31831
- * @default 20
31832
- */
31833
- limit: number;
31834
- cursor: {
31835
- next: string | null;
31836
- previous: string | null;
31837
- current: string | null;
31838
- };
31839
- results: {
31840
- transaction: {
31841
- /** @description Transaction ID */
31842
- tx_id: string;
31843
- sender: {
31844
- /** @description Address of the transaction initiator */
31845
- address: string;
31846
- /** @description Nonce of the transaction initiator */
31847
- nonce: number;
31848
- };
31849
- sponsor: {
31850
- /** @description Address of the transaction initiator */
31851
- address: string;
31852
- /** @description Nonce of the transaction initiator */
31853
- nonce: number;
31854
- } | null;
31855
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
31856
- fee_rate: string;
31857
- block: {
31858
- /** @description Height of the block this transactions was associated with */
31859
- height: number;
31860
- /** @description Hash of the blocked this transactions was associated with */
31861
- hash: string;
31862
- /** @description Hash of the index block this transactions was associated with */
31863
- index_hash: string;
31864
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
31865
- time: number;
31866
- /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
31867
- tx_index: number;
31868
- };
31869
- bitcoin_block: {
31870
- /** @description Height of the anchor burn block. */
31871
- height: number;
31872
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
31873
- time: number;
31874
- };
31875
- /** @description Status of the transaction */
31876
- status: "success" | "abort_by_response" | "abort_by_post_condition";
31877
- /** @enum {string} */
31878
- type: "token_transfer";
31879
- token_transfer: {
31880
- recipient: string;
31881
- /** @description Transfer amount as Integer string (64-bit unsigned integer) */
31882
- amount: string;
31883
- memo: {
31884
- hex: string;
31885
- repr: string;
31886
- } | null;
31887
- };
31888
- } | {
31889
- /** @description Transaction ID */
31890
- tx_id: string;
31891
- sender: {
31892
- /** @description Address of the transaction initiator */
31893
- address: string;
31894
- /** @description Nonce of the transaction initiator */
31895
- nonce: number;
31896
- };
31897
- sponsor: {
31898
- /** @description Address of the transaction initiator */
31899
- address: string;
31900
- /** @description Nonce of the transaction initiator */
31901
- nonce: number;
31902
- } | null;
31903
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
31904
- fee_rate: string;
31905
- block: {
31906
- /** @description Height of the block this transactions was associated with */
31907
- height: number;
31908
- /** @description Hash of the blocked this transactions was associated with */
31909
- hash: string;
31910
- /** @description Hash of the index block this transactions was associated with */
31911
- index_hash: string;
31912
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
31913
- time: number;
31914
- /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
31915
- tx_index: number;
31916
- };
31917
- bitcoin_block: {
31918
- /** @description Height of the anchor burn block. */
31919
- height: number;
31920
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
31921
- time: number;
31922
- };
31923
- /** @description Status of the transaction */
31924
- status: "success" | "abort_by_response" | "abort_by_post_condition";
31925
- /** @enum {string} */
31926
- type: "smart_contract";
31927
- smart_contract: {
31928
- clarity_version: number | null;
31929
- /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
31930
- contract_id: string;
31931
- };
31932
- } | {
31933
- /** @description Transaction ID */
31934
- tx_id: string;
31935
- sender: {
31936
- /** @description Address of the transaction initiator */
31937
- address: string;
31938
- /** @description Nonce of the transaction initiator */
31939
- nonce: number;
31940
- };
31941
- sponsor: {
31942
- /** @description Address of the transaction initiator */
31943
- address: string;
31944
- /** @description Nonce of the transaction initiator */
31945
- nonce: number;
31946
- } | null;
31947
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
31948
- fee_rate: string;
31949
- block: {
31950
- /** @description Height of the block this transactions was associated with */
31951
- height: number;
31952
- /** @description Hash of the blocked this transactions was associated with */
31953
- hash: string;
31954
- /** @description Hash of the index block this transactions was associated with */
31955
- index_hash: string;
31956
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
31957
- time: number;
31958
- /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
31959
- tx_index: number;
31960
- };
31961
- bitcoin_block: {
31962
- /** @description Height of the anchor burn block. */
31963
- height: number;
31964
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
31965
- time: number;
31966
- };
31967
- /** @description Status of the transaction */
31968
- status: "success" | "abort_by_response" | "abort_by_post_condition";
31969
- /** @enum {string} */
31970
- type: "contract_call";
31971
- contract_call: {
31972
- /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
31973
- contract_id: string;
31974
- /** @description Name of the Clarity function to be invoked */
31975
- function_name: string;
31976
- };
31977
- } | {
31978
- /** @description Transaction ID */
31979
- tx_id: string;
31980
- sender: {
31981
- /** @description Address of the transaction initiator */
31982
- address: string;
31983
- /** @description Nonce of the transaction initiator */
31984
- nonce: number;
31985
- };
31986
- sponsor: {
31987
- /** @description Address of the transaction initiator */
31988
- address: string;
31989
- /** @description Nonce of the transaction initiator */
31990
- nonce: number;
31991
- } | null;
31992
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
31993
- fee_rate: string;
31994
- block: {
31995
- /** @description Height of the block this transactions was associated with */
31996
- height: number;
31997
- /** @description Hash of the blocked this transactions was associated with */
31998
- hash: string;
31999
- /** @description Hash of the index block this transactions was associated with */
32000
- index_hash: string;
32001
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32002
- time: number;
32003
- /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32004
- tx_index: number;
32005
- };
32006
- bitcoin_block: {
32007
- /** @description Height of the anchor burn block. */
32008
- height: number;
32009
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32010
- time: number;
32011
- };
32012
- /** @description Status of the transaction */
32013
- status: "success" | "abort_by_response" | "abort_by_post_condition";
32014
- /** @enum {string} */
32015
- type: "poison_microblock";
32016
- } | {
32017
- /** @description Transaction ID */
32018
- tx_id: string;
32019
- sender: {
32020
- /** @description Address of the transaction initiator */
32021
- address: string;
32022
- /** @description Nonce of the transaction initiator */
32023
- nonce: number;
32024
- };
32025
- sponsor: {
32026
- /** @description Address of the transaction initiator */
32027
- address: string;
32028
- /** @description Nonce of the transaction initiator */
32029
- nonce: number;
32030
- } | null;
32031
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32032
- fee_rate: string;
32033
- block: {
32034
- /** @description Height of the block this transactions was associated with */
32035
- height: number;
32036
- /** @description Hash of the blocked this transactions was associated with */
32037
- hash: string;
32038
- /** @description Hash of the index block this transactions was associated with */
32039
- index_hash: string;
32040
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32041
- time: number;
32042
- /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32043
- tx_index: number;
32044
- };
32045
- bitcoin_block: {
32046
- /** @description Height of the anchor burn block. */
32047
- height: number;
32048
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32049
- time: number;
32050
- };
32051
- /** @description Status of the transaction */
32052
- status: "success" | "abort_by_response" | "abort_by_post_condition";
32053
- /** @enum {string} */
32054
- type: "coinbase";
32055
- coinbase: {
32056
- alt_recipient: string | null;
32057
- };
32058
- } | {
32059
- /** @description Transaction ID */
32060
- tx_id: string;
32061
- sender: {
32062
- /** @description Address of the transaction initiator */
32063
- address: string;
32064
- /** @description Nonce of the transaction initiator */
32065
- nonce: number;
32066
- };
32067
- sponsor: {
32068
- /** @description Address of the transaction initiator */
32069
- address: string;
32070
- /** @description Nonce of the transaction initiator */
32071
- nonce: number;
32072
- } | null;
32073
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32074
- fee_rate: string;
32075
- block: {
32076
- /** @description Height of the block this transactions was associated with */
32077
- height: number;
32078
- /** @description Hash of the blocked this transactions was associated with */
32079
- hash: string;
32080
- /** @description Hash of the index block this transactions was associated with */
32081
- index_hash: string;
32082
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32083
- time: number;
32084
- /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32085
- tx_index: number;
32086
- };
32087
- bitcoin_block: {
32088
- /** @description Height of the anchor burn block. */
32089
- height: number;
32090
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32091
- time: number;
32092
- };
32093
- /** @description Status of the transaction */
32094
- status: "success" | "abort_by_response" | "abort_by_post_condition";
32095
- /** @enum {string} */
32096
- type: "tenure_change";
32097
- tenure_change: {
32098
- /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */
32099
- cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length";
32100
- };
32101
- };
32102
- /** @description How the principal is involved in the transaction. */
32103
- involvement: "sender" | "sponsor" | "affected";
32104
- balance_changes: {
32105
- stx: {
32106
- /** @description Total sent from the given address, including the tx fee, in micro-STX as an integer string. */
32107
- sent: string;
32108
- /** @description Total received by the given address in micro-STX as an integer string. */
32109
- received: string;
32110
- /** @description Net change in the principal's STX balance in micro-STX as an integer string. */
32111
- net: string;
32112
- };
32113
- };
32114
- affected_balances: {
32115
- /** @description Whether the principal's STX balance was affected by the transaction */
32116
- stx: boolean;
32117
- /** @description Whether the principal's FT balance was affected by the transaction */
32118
- ft: boolean;
32119
- /** @description Whether the principal's NFT balance was affected by the transaction */
32120
- nft: boolean;
32121
- };
32122
- }[];
32123
- };
32124
- };
32125
- };
32126
- /** @description Default Response */
32127
- "4XX": {
32128
- headers: {
32129
- [name: string]: unknown;
32130
- };
32131
- content: {
32132
- "application/json": {
32133
- error: string;
32134
- message?: string;
32135
- } & {
32136
- [key: string]: unknown;
32137
- };
32138
- };
32139
- };
32140
- };
32141
- };
32142
- get_principal_staking_balances: {
32143
- parameters: {
32144
- query?: never;
32145
- header?: never;
32146
- path: {
32147
- principal: string;
32148
- };
32149
- cookie?: never;
32150
- };
32151
- requestBody?: never;
32152
- responses: {
32153
- /** @description Default Response */
32154
- 200: {
32155
- headers: {
32156
- [name: string]: unknown;
32157
- };
32158
- content?: never;
32159
- };
32160
- };
32161
- };
32162
- get_transactions: {
32163
- parameters: {
32164
- query?: {
32165
- /** @description Number of results per page */
32166
- limit?: number;
32167
- /** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */
32168
- cursor?: string;
31954
+ height_or_hash: "latest" | string | number;
32169
31955
  };
32170
- header?: never;
32171
- path?: never;
31956
+ cookie?: never;
31957
+ };
31958
+ requestBody?: never;
31959
+ responses: {
31960
+ /** @description Default Response */
31961
+ 200: {
31962
+ headers: {
31963
+ [name: string]: unknown;
31964
+ };
31965
+ content: {
31966
+ "application/json": {
31967
+ /** @example 1 */
31968
+ total: number;
31969
+ /**
31970
+ * @description Number of results per page
31971
+ * @default 20
31972
+ */
31973
+ limit: number;
31974
+ cursor: {
31975
+ next: string | null;
31976
+ previous: string | null;
31977
+ current: string | null;
31978
+ };
31979
+ results: ({
31980
+ /** @description Transaction ID */
31981
+ tx_id: string;
31982
+ sender: {
31983
+ /** @description Address of the transaction initiator */
31984
+ address: string;
31985
+ /** @description Nonce of the transaction initiator */
31986
+ nonce: number;
31987
+ };
31988
+ sponsor: {
31989
+ /** @description Address of the transaction initiator */
31990
+ address: string;
31991
+ /** @description Nonce of the transaction initiator */
31992
+ nonce: number;
31993
+ } | null;
31994
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
31995
+ fee_rate: string;
31996
+ block: {
31997
+ /** @description Height of the block this transactions was associated with */
31998
+ height: number;
31999
+ /** @description Hash of the blocked this transactions was associated with */
32000
+ hash: string;
32001
+ /** @description Hash of the index block this transactions was associated with */
32002
+ index_hash: string;
32003
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32004
+ time: number;
32005
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32006
+ tx_index: number;
32007
+ };
32008
+ bitcoin_block: {
32009
+ /** @description Height of the anchor burn block. */
32010
+ height: number;
32011
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32012
+ time: number;
32013
+ };
32014
+ /** @description Status of the transaction */
32015
+ status: "success" | "abort_by_response" | "abort_by_post_condition";
32016
+ /** @enum {string} */
32017
+ type: "token_transfer";
32018
+ token_transfer: {
32019
+ recipient: string;
32020
+ /** @description Transfer amount as Integer string (64-bit unsigned integer) */
32021
+ amount: string;
32022
+ memo: {
32023
+ hex: string;
32024
+ repr: string;
32025
+ } | null;
32026
+ };
32027
+ } | {
32028
+ /** @description Transaction ID */
32029
+ tx_id: string;
32030
+ sender: {
32031
+ /** @description Address of the transaction initiator */
32032
+ address: string;
32033
+ /** @description Nonce of the transaction initiator */
32034
+ nonce: number;
32035
+ };
32036
+ sponsor: {
32037
+ /** @description Address of the transaction initiator */
32038
+ address: string;
32039
+ /** @description Nonce of the transaction initiator */
32040
+ nonce: number;
32041
+ } | null;
32042
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32043
+ fee_rate: string;
32044
+ block: {
32045
+ /** @description Height of the block this transactions was associated with */
32046
+ height: number;
32047
+ /** @description Hash of the blocked this transactions was associated with */
32048
+ hash: string;
32049
+ /** @description Hash of the index block this transactions was associated with */
32050
+ index_hash: string;
32051
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32052
+ time: number;
32053
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32054
+ tx_index: number;
32055
+ };
32056
+ bitcoin_block: {
32057
+ /** @description Height of the anchor burn block. */
32058
+ height: number;
32059
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32060
+ time: number;
32061
+ };
32062
+ /** @description Status of the transaction */
32063
+ status: "success" | "abort_by_response" | "abort_by_post_condition";
32064
+ /** @enum {string} */
32065
+ type: "smart_contract";
32066
+ smart_contract: {
32067
+ clarity_version: number | null;
32068
+ /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
32069
+ contract_id: string;
32070
+ };
32071
+ } | {
32072
+ /** @description Transaction ID */
32073
+ tx_id: string;
32074
+ sender: {
32075
+ /** @description Address of the transaction initiator */
32076
+ address: string;
32077
+ /** @description Nonce of the transaction initiator */
32078
+ nonce: number;
32079
+ };
32080
+ sponsor: {
32081
+ /** @description Address of the transaction initiator */
32082
+ address: string;
32083
+ /** @description Nonce of the transaction initiator */
32084
+ nonce: number;
32085
+ } | null;
32086
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32087
+ fee_rate: string;
32088
+ block: {
32089
+ /** @description Height of the block this transactions was associated with */
32090
+ height: number;
32091
+ /** @description Hash of the blocked this transactions was associated with */
32092
+ hash: string;
32093
+ /** @description Hash of the index block this transactions was associated with */
32094
+ index_hash: string;
32095
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32096
+ time: number;
32097
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32098
+ tx_index: number;
32099
+ };
32100
+ bitcoin_block: {
32101
+ /** @description Height of the anchor burn block. */
32102
+ height: number;
32103
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32104
+ time: number;
32105
+ };
32106
+ /** @description Status of the transaction */
32107
+ status: "success" | "abort_by_response" | "abort_by_post_condition";
32108
+ /** @enum {string} */
32109
+ type: "contract_call";
32110
+ contract_call: {
32111
+ /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
32112
+ contract_id: string;
32113
+ /** @description Name of the Clarity function to be invoked */
32114
+ function_name: string;
32115
+ };
32116
+ } | {
32117
+ /** @description Transaction ID */
32118
+ tx_id: string;
32119
+ sender: {
32120
+ /** @description Address of the transaction initiator */
32121
+ address: string;
32122
+ /** @description Nonce of the transaction initiator */
32123
+ nonce: number;
32124
+ };
32125
+ sponsor: {
32126
+ /** @description Address of the transaction initiator */
32127
+ address: string;
32128
+ /** @description Nonce of the transaction initiator */
32129
+ nonce: number;
32130
+ } | null;
32131
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32132
+ fee_rate: string;
32133
+ block: {
32134
+ /** @description Height of the block this transactions was associated with */
32135
+ height: number;
32136
+ /** @description Hash of the blocked this transactions was associated with */
32137
+ hash: string;
32138
+ /** @description Hash of the index block this transactions was associated with */
32139
+ index_hash: string;
32140
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32141
+ time: number;
32142
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32143
+ tx_index: number;
32144
+ };
32145
+ bitcoin_block: {
32146
+ /** @description Height of the anchor burn block. */
32147
+ height: number;
32148
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32149
+ time: number;
32150
+ };
32151
+ /** @description Status of the transaction */
32152
+ status: "success" | "abort_by_response" | "abort_by_post_condition";
32153
+ /** @enum {string} */
32154
+ type: "poison_microblock";
32155
+ } | {
32156
+ /** @description Transaction ID */
32157
+ tx_id: string;
32158
+ sender: {
32159
+ /** @description Address of the transaction initiator */
32160
+ address: string;
32161
+ /** @description Nonce of the transaction initiator */
32162
+ nonce: number;
32163
+ };
32164
+ sponsor: {
32165
+ /** @description Address of the transaction initiator */
32166
+ address: string;
32167
+ /** @description Nonce of the transaction initiator */
32168
+ nonce: number;
32169
+ } | null;
32170
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32171
+ fee_rate: string;
32172
+ block: {
32173
+ /** @description Height of the block this transactions was associated with */
32174
+ height: number;
32175
+ /** @description Hash of the blocked this transactions was associated with */
32176
+ hash: string;
32177
+ /** @description Hash of the index block this transactions was associated with */
32178
+ index_hash: string;
32179
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32180
+ time: number;
32181
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32182
+ tx_index: number;
32183
+ };
32184
+ bitcoin_block: {
32185
+ /** @description Height of the anchor burn block. */
32186
+ height: number;
32187
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32188
+ time: number;
32189
+ };
32190
+ /** @description Status of the transaction */
32191
+ status: "success" | "abort_by_response" | "abort_by_post_condition";
32192
+ /** @enum {string} */
32193
+ type: "coinbase";
32194
+ coinbase: {
32195
+ alt_recipient: string | null;
32196
+ };
32197
+ } | {
32198
+ /** @description Transaction ID */
32199
+ tx_id: string;
32200
+ sender: {
32201
+ /** @description Address of the transaction initiator */
32202
+ address: string;
32203
+ /** @description Nonce of the transaction initiator */
32204
+ nonce: number;
32205
+ };
32206
+ sponsor: {
32207
+ /** @description Address of the transaction initiator */
32208
+ address: string;
32209
+ /** @description Nonce of the transaction initiator */
32210
+ nonce: number;
32211
+ } | null;
32212
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32213
+ fee_rate: string;
32214
+ block: {
32215
+ /** @description Height of the block this transactions was associated with */
32216
+ height: number;
32217
+ /** @description Hash of the blocked this transactions was associated with */
32218
+ hash: string;
32219
+ /** @description Hash of the index block this transactions was associated with */
32220
+ index_hash: string;
32221
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32222
+ time: number;
32223
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32224
+ tx_index: number;
32225
+ };
32226
+ bitcoin_block: {
32227
+ /** @description Height of the anchor burn block. */
32228
+ height: number;
32229
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32230
+ time: number;
32231
+ };
32232
+ /** @description Status of the transaction */
32233
+ status: "success" | "abort_by_response" | "abort_by_post_condition";
32234
+ /** @enum {string} */
32235
+ type: "tenure_change";
32236
+ tenure_change: {
32237
+ /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */
32238
+ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length";
32239
+ };
32240
+ })[];
32241
+ };
32242
+ };
32243
+ };
32244
+ /** @description Default Response */
32245
+ "4XX": {
32246
+ headers: {
32247
+ [name: string]: unknown;
32248
+ };
32249
+ content: {
32250
+ "application/json": {
32251
+ error: string;
32252
+ message?: string;
32253
+ } & {
32254
+ [key: string]: unknown;
32255
+ };
32256
+ };
32257
+ };
32258
+ };
32259
+ };
32260
+ get_mempool_transactions: {
32261
+ parameters: {
32262
+ query?: {
32263
+ /** @description Number of results per page */
32264
+ limit?: number;
32265
+ /** @description Cursor for paginating mempool transactions. Format: receipt_time:tx_id */
32266
+ cursor?: string;
32267
+ };
32268
+ header?: never;
32269
+ path?: never;
32270
+ cookie?: never;
32271
+ };
32272
+ requestBody?: never;
32273
+ responses: {
32274
+ /** @description Default Response */
32275
+ 200: {
32276
+ headers: {
32277
+ [name: string]: unknown;
32278
+ };
32279
+ content: {
32280
+ "application/json": {
32281
+ /** @example 1 */
32282
+ total: number;
32283
+ /**
32284
+ * @description Number of results per page
32285
+ * @default 20
32286
+ */
32287
+ limit: number;
32288
+ cursor: {
32289
+ next: string | null;
32290
+ previous: string | null;
32291
+ current: string | null;
32292
+ };
32293
+ results: ({
32294
+ /** @description Transaction ID */
32295
+ tx_id: string;
32296
+ sender: {
32297
+ /** @description Address of the transaction initiator */
32298
+ address: string;
32299
+ /** @description Nonce of the transaction initiator */
32300
+ nonce: number;
32301
+ };
32302
+ sponsor: {
32303
+ /** @description Address of the transaction initiator */
32304
+ address: string;
32305
+ /** @description Nonce of the transaction initiator */
32306
+ nonce: number;
32307
+ } | null;
32308
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32309
+ fee_rate: string;
32310
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
32311
+ receipt_time: number;
32312
+ /** @description Height of the block this transaction was received by the node */
32313
+ receipt_block_height: number;
32314
+ /** @description Status of the mempool transaction */
32315
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
32316
+ /** @enum {string} */
32317
+ type: "token_transfer";
32318
+ token_transfer: {
32319
+ recipient: string;
32320
+ /** @description Transfer amount as Integer string (64-bit unsigned integer) */
32321
+ amount: string;
32322
+ memo: {
32323
+ hex: string;
32324
+ repr: string;
32325
+ } | null;
32326
+ };
32327
+ } | {
32328
+ /** @description Transaction ID */
32329
+ tx_id: string;
32330
+ sender: {
32331
+ /** @description Address of the transaction initiator */
32332
+ address: string;
32333
+ /** @description Nonce of the transaction initiator */
32334
+ nonce: number;
32335
+ };
32336
+ sponsor: {
32337
+ /** @description Address of the transaction initiator */
32338
+ address: string;
32339
+ /** @description Nonce of the transaction initiator */
32340
+ nonce: number;
32341
+ } | null;
32342
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32343
+ fee_rate: string;
32344
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
32345
+ receipt_time: number;
32346
+ /** @description Height of the block this transaction was received by the node */
32347
+ receipt_block_height: number;
32348
+ /** @description Status of the mempool transaction */
32349
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
32350
+ /** @enum {string} */
32351
+ type: "smart_contract";
32352
+ smart_contract: {
32353
+ clarity_version: number | null;
32354
+ /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
32355
+ contract_id: string;
32356
+ };
32357
+ } | {
32358
+ /** @description Transaction ID */
32359
+ tx_id: string;
32360
+ sender: {
32361
+ /** @description Address of the transaction initiator */
32362
+ address: string;
32363
+ /** @description Nonce of the transaction initiator */
32364
+ nonce: number;
32365
+ };
32366
+ sponsor: {
32367
+ /** @description Address of the transaction initiator */
32368
+ address: string;
32369
+ /** @description Nonce of the transaction initiator */
32370
+ nonce: number;
32371
+ } | null;
32372
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32373
+ fee_rate: string;
32374
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
32375
+ receipt_time: number;
32376
+ /** @description Height of the block this transaction was received by the node */
32377
+ receipt_block_height: number;
32378
+ /** @description Status of the mempool transaction */
32379
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
32380
+ /** @enum {string} */
32381
+ type: "contract_call";
32382
+ contract_call: {
32383
+ /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
32384
+ contract_id: string;
32385
+ /** @description Name of the Clarity function to be invoked */
32386
+ function_name: string;
32387
+ };
32388
+ } | {
32389
+ /** @description Transaction ID */
32390
+ tx_id: string;
32391
+ sender: {
32392
+ /** @description Address of the transaction initiator */
32393
+ address: string;
32394
+ /** @description Nonce of the transaction initiator */
32395
+ nonce: number;
32396
+ };
32397
+ sponsor: {
32398
+ /** @description Address of the transaction initiator */
32399
+ address: string;
32400
+ /** @description Nonce of the transaction initiator */
32401
+ nonce: number;
32402
+ } | null;
32403
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32404
+ fee_rate: string;
32405
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
32406
+ receipt_time: number;
32407
+ /** @description Height of the block this transaction was received by the node */
32408
+ receipt_block_height: number;
32409
+ /** @description Status of the mempool transaction */
32410
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
32411
+ /** @enum {string} */
32412
+ type: "poison_microblock";
32413
+ } | {
32414
+ /** @description Transaction ID */
32415
+ tx_id: string;
32416
+ sender: {
32417
+ /** @description Address of the transaction initiator */
32418
+ address: string;
32419
+ /** @description Nonce of the transaction initiator */
32420
+ nonce: number;
32421
+ };
32422
+ sponsor: {
32423
+ /** @description Address of the transaction initiator */
32424
+ address: string;
32425
+ /** @description Nonce of the transaction initiator */
32426
+ nonce: number;
32427
+ } | null;
32428
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32429
+ fee_rate: string;
32430
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
32431
+ receipt_time: number;
32432
+ /** @description Height of the block this transaction was received by the node */
32433
+ receipt_block_height: number;
32434
+ /** @description Status of the mempool transaction */
32435
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
32436
+ /** @enum {string} */
32437
+ type: "coinbase";
32438
+ } | {
32439
+ /** @description Transaction ID */
32440
+ tx_id: string;
32441
+ sender: {
32442
+ /** @description Address of the transaction initiator */
32443
+ address: string;
32444
+ /** @description Nonce of the transaction initiator */
32445
+ nonce: number;
32446
+ };
32447
+ sponsor: {
32448
+ /** @description Address of the transaction initiator */
32449
+ address: string;
32450
+ /** @description Nonce of the transaction initiator */
32451
+ nonce: number;
32452
+ } | null;
32453
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32454
+ fee_rate: string;
32455
+ /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
32456
+ receipt_time: number;
32457
+ /** @description Height of the block this transaction was received by the node */
32458
+ receipt_block_height: number;
32459
+ /** @description Status of the mempool transaction */
32460
+ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
32461
+ /** @enum {string} */
32462
+ type: "tenure_change";
32463
+ })[];
32464
+ };
32465
+ };
32466
+ };
32467
+ /** @description Default Response */
32468
+ "4XX": {
32469
+ headers: {
32470
+ [name: string]: unknown;
32471
+ };
32472
+ content: {
32473
+ "application/json": {
32474
+ error: string;
32475
+ message?: string;
32476
+ } & {
32477
+ [key: string]: unknown;
32478
+ };
32479
+ };
32480
+ };
32481
+ };
32482
+ };
32483
+ get_principal_transactions: {
32484
+ parameters: {
32485
+ query?: {
32486
+ /** @description Number of results per page */
32487
+ limit?: number;
32488
+ /** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */
32489
+ cursor?: string;
32490
+ };
32491
+ header?: never;
32492
+ path: {
32493
+ principal: string;
32494
+ };
32495
+ cookie?: never;
32496
+ };
32497
+ requestBody?: never;
32498
+ responses: {
32499
+ /** @description Default Response */
32500
+ 200: {
32501
+ headers: {
32502
+ [name: string]: unknown;
32503
+ };
32504
+ content: {
32505
+ "application/json": {
32506
+ /** @example 1 */
32507
+ total: number;
32508
+ /**
32509
+ * @description Number of results per page
32510
+ * @default 20
32511
+ */
32512
+ limit: number;
32513
+ cursor: {
32514
+ next: string | null;
32515
+ previous: string | null;
32516
+ current: string | null;
32517
+ };
32518
+ results: {
32519
+ transaction: {
32520
+ /** @description Transaction ID */
32521
+ tx_id: string;
32522
+ sender: {
32523
+ /** @description Address of the transaction initiator */
32524
+ address: string;
32525
+ /** @description Nonce of the transaction initiator */
32526
+ nonce: number;
32527
+ };
32528
+ sponsor: {
32529
+ /** @description Address of the transaction initiator */
32530
+ address: string;
32531
+ /** @description Nonce of the transaction initiator */
32532
+ nonce: number;
32533
+ } | null;
32534
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32535
+ fee_rate: string;
32536
+ block: {
32537
+ /** @description Height of the block this transactions was associated with */
32538
+ height: number;
32539
+ /** @description Hash of the blocked this transactions was associated with */
32540
+ hash: string;
32541
+ /** @description Hash of the index block this transactions was associated with */
32542
+ index_hash: string;
32543
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32544
+ time: number;
32545
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32546
+ tx_index: number;
32547
+ };
32548
+ bitcoin_block: {
32549
+ /** @description Height of the anchor burn block. */
32550
+ height: number;
32551
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32552
+ time: number;
32553
+ };
32554
+ /** @description Status of the transaction */
32555
+ status: "success" | "abort_by_response" | "abort_by_post_condition";
32556
+ /** @enum {string} */
32557
+ type: "token_transfer";
32558
+ token_transfer: {
32559
+ recipient: string;
32560
+ /** @description Transfer amount as Integer string (64-bit unsigned integer) */
32561
+ amount: string;
32562
+ memo: {
32563
+ hex: string;
32564
+ repr: string;
32565
+ } | null;
32566
+ };
32567
+ } | {
32568
+ /** @description Transaction ID */
32569
+ tx_id: string;
32570
+ sender: {
32571
+ /** @description Address of the transaction initiator */
32572
+ address: string;
32573
+ /** @description Nonce of the transaction initiator */
32574
+ nonce: number;
32575
+ };
32576
+ sponsor: {
32577
+ /** @description Address of the transaction initiator */
32578
+ address: string;
32579
+ /** @description Nonce of the transaction initiator */
32580
+ nonce: number;
32581
+ } | null;
32582
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32583
+ fee_rate: string;
32584
+ block: {
32585
+ /** @description Height of the block this transactions was associated with */
32586
+ height: number;
32587
+ /** @description Hash of the blocked this transactions was associated with */
32588
+ hash: string;
32589
+ /** @description Hash of the index block this transactions was associated with */
32590
+ index_hash: string;
32591
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32592
+ time: number;
32593
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32594
+ tx_index: number;
32595
+ };
32596
+ bitcoin_block: {
32597
+ /** @description Height of the anchor burn block. */
32598
+ height: number;
32599
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32600
+ time: number;
32601
+ };
32602
+ /** @description Status of the transaction */
32603
+ status: "success" | "abort_by_response" | "abort_by_post_condition";
32604
+ /** @enum {string} */
32605
+ type: "smart_contract";
32606
+ smart_contract: {
32607
+ clarity_version: number | null;
32608
+ /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
32609
+ contract_id: string;
32610
+ };
32611
+ } | {
32612
+ /** @description Transaction ID */
32613
+ tx_id: string;
32614
+ sender: {
32615
+ /** @description Address of the transaction initiator */
32616
+ address: string;
32617
+ /** @description Nonce of the transaction initiator */
32618
+ nonce: number;
32619
+ };
32620
+ sponsor: {
32621
+ /** @description Address of the transaction initiator */
32622
+ address: string;
32623
+ /** @description Nonce of the transaction initiator */
32624
+ nonce: number;
32625
+ } | null;
32626
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32627
+ fee_rate: string;
32628
+ block: {
32629
+ /** @description Height of the block this transactions was associated with */
32630
+ height: number;
32631
+ /** @description Hash of the blocked this transactions was associated with */
32632
+ hash: string;
32633
+ /** @description Hash of the index block this transactions was associated with */
32634
+ index_hash: string;
32635
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32636
+ time: number;
32637
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32638
+ tx_index: number;
32639
+ };
32640
+ bitcoin_block: {
32641
+ /** @description Height of the anchor burn block. */
32642
+ height: number;
32643
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32644
+ time: number;
32645
+ };
32646
+ /** @description Status of the transaction */
32647
+ status: "success" | "abort_by_response" | "abort_by_post_condition";
32648
+ /** @enum {string} */
32649
+ type: "contract_call";
32650
+ contract_call: {
32651
+ /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
32652
+ contract_id: string;
32653
+ /** @description Name of the Clarity function to be invoked */
32654
+ function_name: string;
32655
+ };
32656
+ } | {
32657
+ /** @description Transaction ID */
32658
+ tx_id: string;
32659
+ sender: {
32660
+ /** @description Address of the transaction initiator */
32661
+ address: string;
32662
+ /** @description Nonce of the transaction initiator */
32663
+ nonce: number;
32664
+ };
32665
+ sponsor: {
32666
+ /** @description Address of the transaction initiator */
32667
+ address: string;
32668
+ /** @description Nonce of the transaction initiator */
32669
+ nonce: number;
32670
+ } | null;
32671
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32672
+ fee_rate: string;
32673
+ block: {
32674
+ /** @description Height of the block this transactions was associated with */
32675
+ height: number;
32676
+ /** @description Hash of the blocked this transactions was associated with */
32677
+ hash: string;
32678
+ /** @description Hash of the index block this transactions was associated with */
32679
+ index_hash: string;
32680
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32681
+ time: number;
32682
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32683
+ tx_index: number;
32684
+ };
32685
+ bitcoin_block: {
32686
+ /** @description Height of the anchor burn block. */
32687
+ height: number;
32688
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32689
+ time: number;
32690
+ };
32691
+ /** @description Status of the transaction */
32692
+ status: "success" | "abort_by_response" | "abort_by_post_condition";
32693
+ /** @enum {string} */
32694
+ type: "poison_microblock";
32695
+ } | {
32696
+ /** @description Transaction ID */
32697
+ tx_id: string;
32698
+ sender: {
32699
+ /** @description Address of the transaction initiator */
32700
+ address: string;
32701
+ /** @description Nonce of the transaction initiator */
32702
+ nonce: number;
32703
+ };
32704
+ sponsor: {
32705
+ /** @description Address of the transaction initiator */
32706
+ address: string;
32707
+ /** @description Nonce of the transaction initiator */
32708
+ nonce: number;
32709
+ } | null;
32710
+ /** @description Transaction fee as Integer string (64-bit unsigned integer). */
32711
+ fee_rate: string;
32712
+ block: {
32713
+ /** @description Height of the block this transactions was associated with */
32714
+ height: number;
32715
+ /** @description Hash of the blocked this transactions was associated with */
32716
+ hash: string;
32717
+ /** @description Hash of the index block this transactions was associated with */
32718
+ index_hash: string;
32719
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32720
+ time: number;
32721
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
32722
+ tx_index: number;
32723
+ };
32724
+ bitcoin_block: {
32725
+ /** @description Height of the anchor burn block. */
32726
+ height: number;
32727
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
32728
+ time: number;
32729
+ };
32730
+ /** @description Status of the transaction */
32731
+ status: "success" | "abort_by_response" | "abort_by_post_condition";
32732
+ /** @enum {string} */
32733
+ type: "coinbase";
32734
+ coinbase: {
32735
+ alt_recipient: string | null;
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: "tenure_change";
32776
+ tenure_change: {
32777
+ /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */
32778
+ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length";
32779
+ };
32780
+ };
32781
+ /** @description How the principal is involved in the transaction. */
32782
+ involvement: "sender" | "sponsor" | "affected";
32783
+ balance_changes: {
32784
+ stx: {
32785
+ /** @description Total sent from the given address, including the tx fee, in micro-STX as an integer string. */
32786
+ sent: string;
32787
+ /** @description Total received by the given address in micro-STX as an integer string. */
32788
+ received: string;
32789
+ /** @description Net change in the principal's STX balance in micro-STX as an integer string. */
32790
+ net: string;
32791
+ };
32792
+ };
32793
+ affected_balances: {
32794
+ /** @description Whether the principal's STX balance was affected by the transaction */
32795
+ stx: boolean;
32796
+ /** @description Whether the principal's FT balance was affected by the transaction */
32797
+ ft: boolean;
32798
+ /** @description Whether the principal's NFT balance was affected by the transaction */
32799
+ nft: boolean;
32800
+ };
32801
+ }[];
32802
+ };
32803
+ };
32804
+ };
32805
+ /** @description Default Response */
32806
+ "4XX": {
32807
+ headers: {
32808
+ [name: string]: unknown;
32809
+ };
32810
+ content: {
32811
+ "application/json": {
32812
+ error: string;
32813
+ message?: string;
32814
+ } & {
32815
+ [key: string]: unknown;
32816
+ };
32817
+ };
32818
+ };
32819
+ };
32820
+ };
32821
+ get_principal_staking_balances: {
32822
+ parameters: {
32823
+ query?: never;
32824
+ header?: never;
32825
+ path: {
32826
+ principal: string;
32827
+ };
32828
+ cookie?: never;
32829
+ };
32830
+ requestBody?: never;
32831
+ responses: {
32832
+ /** @description Default Response */
32833
+ 200: {
32834
+ headers: {
32835
+ [name: string]: unknown;
32836
+ };
32837
+ content?: never;
32838
+ };
32839
+ };
32840
+ };
32841
+ get_bonds: {
32842
+ parameters: {
32843
+ query?: {
32844
+ /** @description Number of results per page */
32845
+ limit?: number;
32846
+ /** @description Cursor for paginating bonds. Format: bond_index */
32847
+ cursor?: string;
32848
+ };
32849
+ header?: never;
32850
+ path?: never;
32851
+ cookie?: never;
32852
+ };
32853
+ requestBody?: never;
32854
+ responses: {
32855
+ /** @description Default Response */
32856
+ 200: {
32857
+ headers: {
32858
+ [name: string]: unknown;
32859
+ };
32860
+ content: {
32861
+ "application/json": {
32862
+ /** @example 1 */
32863
+ total: number;
32864
+ /**
32865
+ * @description Number of results per page
32866
+ * @default 20
32867
+ */
32868
+ limit: number;
32869
+ cursor: {
32870
+ next: string | null;
32871
+ previous: string | null;
32872
+ current: string | null;
32873
+ };
32874
+ results: {
32875
+ /** @description The index of the bond in the PoX-5 bond list */
32876
+ index: number;
32877
+ /** @enum {string} */
32878
+ pox_version: "pox5";
32879
+ status: "upcoming" | "active" | "unlocked";
32880
+ parameters: {
32881
+ /** @description The target yield rate (APY) in basis points */
32882
+ target_rate_bps: number;
32883
+ /** @description This is a representation of the STXBTC price. The value represents "uSTX per 100 sats" */
32884
+ stx_value_ratio: number;
32885
+ /** @description The amount of STX that must be locked relative to BTC, in equal-valued terms (ie in USD terms). This value is represented in basis points. */
32886
+ minimum_stx_ratio: number;
32887
+ /** @description The total capacity of BTC that can be locked up for this bond */
32888
+ btc_capacity: string;
32889
+ };
32890
+ registrations: {
32891
+ /** @description The number of entries in the allowlist for this bond */
32892
+ allowed_count: number;
32893
+ /** @description The number of registrations for this bond */
32894
+ registered_count: number;
32895
+ };
32896
+ schedule: {
32897
+ activation: {
32898
+ /** @description The height at which the bond was activated */
32899
+ bitcoin_height: number;
32900
+ /** @description The POX cycle at which the bond was activated */
32901
+ pox_cycle: number;
32902
+ };
32903
+ unlock: {
32904
+ /** @description The height at which the bond can be unlocked */
32905
+ bitcoin_height: number;
32906
+ /** @description The POX cycle at which the bond can be unlocked */
32907
+ pox_cycle: number;
32908
+ };
32909
+ };
32910
+ balances: {
32911
+ locked: {
32912
+ /** @description The total amount of BTC that is locked up for this bond */
32913
+ btc: string;
32914
+ /** @description The total amount of STX that is locked up for this bond */
32915
+ stx: string;
32916
+ };
32917
+ paid_out: {
32918
+ /** @description The total amount of BTC that has been paid out for this bond */
32919
+ btc: string;
32920
+ };
32921
+ };
32922
+ }[];
32923
+ };
32924
+ };
32925
+ };
32926
+ /** @description Default Response */
32927
+ "4XX": {
32928
+ headers: {
32929
+ [name: string]: unknown;
32930
+ };
32931
+ content: {
32932
+ "application/json": {
32933
+ error: string;
32934
+ message?: string;
32935
+ } & {
32936
+ [key: string]: unknown;
32937
+ };
32938
+ };
32939
+ };
32940
+ };
32941
+ };
32942
+ get_bond: {
32943
+ parameters: {
32944
+ query?: never;
32945
+ header?: never;
32946
+ path: {
32947
+ /** @description The index of the bond in the PoX-5 bond list */
32948
+ bond_index: number;
32949
+ };
32950
+ cookie?: never;
32951
+ };
32952
+ requestBody?: never;
32953
+ responses: {
32954
+ /** @description Default Response */
32955
+ 200: {
32956
+ headers: {
32957
+ [name: string]: unknown;
32958
+ };
32959
+ content: {
32960
+ "application/json": {
32961
+ /** @description The index of the bond in the PoX-5 bond list */
32962
+ index: number;
32963
+ /** @enum {string} */
32964
+ pox_version: "pox5";
32965
+ status: "upcoming" | "active" | "unlocked";
32966
+ parameters: {
32967
+ /** @description The target yield rate (APY) in basis points */
32968
+ target_rate_bps: number;
32969
+ /** @description This is a representation of the STXBTC price. The value represents "uSTX per 100 sats" */
32970
+ stx_value_ratio: number;
32971
+ /** @description The amount of STX that must be locked relative to BTC, in equal-valued terms (ie in USD terms). This value is represented in basis points. */
32972
+ minimum_stx_ratio: number;
32973
+ /** @description The total capacity of BTC that can be locked up for this bond */
32974
+ btc_capacity: string;
32975
+ };
32976
+ registrations: {
32977
+ /** @description The number of entries in the allowlist for this bond */
32978
+ allowed_count: number;
32979
+ /** @description The number of registrations for this bond */
32980
+ registered_count: number;
32981
+ };
32982
+ schedule: {
32983
+ activation: {
32984
+ /** @description The height at which the bond was activated */
32985
+ bitcoin_height: number;
32986
+ /** @description The POX cycle at which the bond was activated */
32987
+ pox_cycle: number;
32988
+ };
32989
+ unlock: {
32990
+ /** @description The height at which the bond can be unlocked */
32991
+ bitcoin_height: number;
32992
+ /** @description The POX cycle at which the bond can be unlocked */
32993
+ pox_cycle: number;
32994
+ };
32995
+ };
32996
+ balances: {
32997
+ locked: {
32998
+ /** @description The total amount of BTC that is locked up for this bond */
32999
+ btc: string;
33000
+ /** @description The total amount of STX that is locked up for this bond */
33001
+ stx: string;
33002
+ };
33003
+ paid_out: {
33004
+ /** @description The total amount of BTC that has been paid out for this bond */
33005
+ btc: string;
33006
+ };
33007
+ };
33008
+ transaction: {
33009
+ /** @description The transaction ID that created the bond */
33010
+ tx_id: string;
33011
+ block: {
33012
+ /** @description Height of the block this transactions was associated with */
33013
+ height: number;
33014
+ /** @description Hash of the blocked this transactions was associated with */
33015
+ hash: string;
33016
+ /** @description Hash of the index block this transactions was associated with */
33017
+ index_hash: string;
33018
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
33019
+ time: number;
33020
+ /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
33021
+ tx_index: number;
33022
+ };
33023
+ bitcoin_block: {
33024
+ /** @description Height of the anchor burn block. */
33025
+ height: number;
33026
+ /** @description Unix timestamp (in seconds) indicating when this block was mined. */
33027
+ time: number;
33028
+ };
33029
+ };
33030
+ };
33031
+ };
33032
+ };
33033
+ /** @description Default Response */
33034
+ "4XX": {
33035
+ headers: {
33036
+ [name: string]: unknown;
33037
+ };
33038
+ content: {
33039
+ "application/json": {
33040
+ error: string;
33041
+ message?: string;
33042
+ } & {
33043
+ [key: string]: unknown;
33044
+ };
33045
+ };
33046
+ };
33047
+ };
33048
+ };
33049
+ get_bond_allowlist_entries: {
33050
+ parameters: {
33051
+ query?: {
33052
+ /** @description Number of results per page */
33053
+ limit?: number;
33054
+ /** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */
33055
+ cursor?: string;
33056
+ };
33057
+ header?: never;
33058
+ path: {
33059
+ /** @description The index of the bond in the PoX-5 bond list */
33060
+ bond_index: number;
33061
+ };
33062
+ cookie?: never;
33063
+ };
33064
+ requestBody?: never;
33065
+ responses: {
33066
+ /** @description Default Response */
33067
+ 200: {
33068
+ headers: {
33069
+ [name: string]: unknown;
33070
+ };
33071
+ content: {
33072
+ "application/json": {
33073
+ /** @example 1 */
33074
+ total: number;
33075
+ /**
33076
+ * @description Number of results per page
33077
+ * @default 20
33078
+ */
33079
+ limit: number;
33080
+ cursor: {
33081
+ next: string | null;
33082
+ previous: string | null;
33083
+ current: string | null;
33084
+ };
33085
+ results: {
33086
+ staker: string;
33087
+ max_sats: string;
33088
+ }[];
33089
+ };
33090
+ };
33091
+ };
33092
+ /** @description Default Response */
33093
+ "4XX": {
33094
+ headers: {
33095
+ [name: string]: unknown;
33096
+ };
33097
+ content: {
33098
+ "application/json": {
33099
+ error: string;
33100
+ message?: string;
33101
+ } & {
33102
+ [key: string]: unknown;
33103
+ };
33104
+ };
33105
+ };
33106
+ };
33107
+ };
33108
+ get_bond_allowlist_entry: {
33109
+ parameters: {
33110
+ query?: never;
33111
+ header?: never;
33112
+ path: {
33113
+ /** @description The index of the bond in the PoX-5 bond list */
33114
+ bond_index: number;
33115
+ principal: string;
33116
+ };
33117
+ cookie?: never;
33118
+ };
33119
+ requestBody?: never;
33120
+ responses: {
33121
+ /** @description Default Response */
33122
+ 200: {
33123
+ headers: {
33124
+ [name: string]: unknown;
33125
+ };
33126
+ content: {
33127
+ "application/json": {
33128
+ staker: string;
33129
+ max_sats: string;
33130
+ };
33131
+ };
33132
+ };
33133
+ /** @description Default Response */
33134
+ "4XX": {
33135
+ headers: {
33136
+ [name: string]: unknown;
33137
+ };
33138
+ content: {
33139
+ "application/json": {
33140
+ error: string;
33141
+ message?: string;
33142
+ } & {
33143
+ [key: string]: unknown;
33144
+ };
33145
+ };
33146
+ };
33147
+ };
33148
+ };
33149
+ get_bond_registrations: {
33150
+ parameters: {
33151
+ query?: {
33152
+ /** @description Number of results per page */
33153
+ limit?: number;
33154
+ /** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */
33155
+ cursor?: string;
33156
+ };
33157
+ header?: never;
33158
+ path: {
33159
+ /** @description The index of the bond in the PoX-5 bond list */
33160
+ bond_index: number;
33161
+ };
33162
+ cookie?: never;
33163
+ };
33164
+ requestBody?: never;
33165
+ responses: {
33166
+ /** @description Default Response */
33167
+ 200: {
33168
+ headers: {
33169
+ [name: string]: unknown;
33170
+ };
33171
+ content: {
33172
+ "application/json": {
33173
+ /** @example 1 */
33174
+ total: number;
33175
+ /**
33176
+ * @description Number of results per page
33177
+ * @default 20
33178
+ */
33179
+ limit: number;
33180
+ cursor: {
33181
+ next: string | null;
33182
+ previous: string | null;
33183
+ current: string | null;
33184
+ };
33185
+ results: {
33186
+ bond_index: number;
33187
+ signer: string;
33188
+ staker: string;
33189
+ amount_ustx: string;
33190
+ sats_total: string;
33191
+ first_reward_cycle: number;
33192
+ unlock_burn_height: number;
33193
+ unlock_cycle: number;
33194
+ is_l1_lock: boolean;
33195
+ }[];
33196
+ };
33197
+ };
33198
+ };
33199
+ /** @description Default Response */
33200
+ "4XX": {
33201
+ headers: {
33202
+ [name: string]: unknown;
33203
+ };
33204
+ content: {
33205
+ "application/json": {
33206
+ error: string;
33207
+ message?: string;
33208
+ } & {
33209
+ [key: string]: unknown;
33210
+ };
33211
+ };
33212
+ };
33213
+ };
33214
+ };
33215
+ get_bond_registration: {
33216
+ parameters: {
33217
+ query?: never;
33218
+ header?: never;
33219
+ path: {
33220
+ /** @description The index of the bond in the PoX-5 bond list */
33221
+ bond_index: number;
33222
+ principal: string;
33223
+ };
33224
+ cookie?: never;
33225
+ };
33226
+ requestBody?: never;
33227
+ responses: {
33228
+ /** @description Default Response */
33229
+ 200: {
33230
+ headers: {
33231
+ [name: string]: unknown;
33232
+ };
33233
+ content: {
33234
+ "application/json": {
33235
+ bond_index: number;
33236
+ signer: string;
33237
+ staker: string;
33238
+ amount_ustx: string;
33239
+ sats_total: string;
33240
+ first_reward_cycle: number;
33241
+ unlock_burn_height: number;
33242
+ unlock_cycle: number;
33243
+ is_l1_lock: boolean;
33244
+ };
33245
+ };
33246
+ };
33247
+ /** @description Default Response */
33248
+ "4XX": {
33249
+ headers: {
33250
+ [name: string]: unknown;
33251
+ };
33252
+ content: {
33253
+ "application/json": {
33254
+ error: string;
33255
+ message?: string;
33256
+ } & {
33257
+ [key: string]: unknown;
33258
+ };
33259
+ };
33260
+ };
33261
+ };
33262
+ };
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
+ get_transactions: {
33332
+ parameters: {
33333
+ query?: {
33334
+ /** @description Number of results per page */
33335
+ limit?: number;
33336
+ /** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */
33337
+ cursor?: string;
33338
+ };
33339
+ header?: never;
33340
+ path?: never;
32172
33341
  cookie?: never;
32173
33342
  };
32174
33343
  requestBody?: never;
@@ -33880,516 +35049,70 @@ export interface operations {
33880
35049
  /** @enum {string} */
33881
35050
  type_id: "principal_standard";
33882
35051
  address: string;
33883
- } | {
33884
- /** @enum {string} */
33885
- type_id: "principal_contract";
33886
- address: string;
33887
- contract_name: string;
33888
- };
33889
- condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to";
33890
- amount: string;
33891
- /** @enum {string} */
33892
- type: "stx";
33893
- } | {
33894
- principal: {
33895
- /** @enum {string} */
33896
- type_id: "principal_origin";
33897
- } | {
33898
- /** @enum {string} */
33899
- type_id: "principal_standard";
33900
- address: string;
33901
- } | {
33902
- /** @enum {string} */
33903
- type_id: "principal_contract";
33904
- address: string;
33905
- contract_name: string;
33906
- };
33907
- condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to";
33908
- amount: string;
33909
- /** @enum {string} */
33910
- type: "fungible";
33911
- asset: {
33912
- asset_name: string;
33913
- contract_address: string;
33914
- contract_name: string;
33915
- };
33916
- } | {
33917
- principal: {
33918
- /** @enum {string} */
33919
- type_id: "principal_origin";
33920
- } | {
33921
- /** @enum {string} */
33922
- type_id: "principal_standard";
33923
- address: string;
33924
- } | {
33925
- /** @enum {string} */
33926
- type_id: "principal_contract";
33927
- address: string;
33928
- contract_name: string;
33929
- };
33930
- condition_code: "sent" | "not_sent" | "maybe_sent";
33931
- /** @enum {string} */
33932
- type: "non_fungible";
33933
- asset_value: {
33934
- hex: string;
33935
- repr: string;
33936
- };
33937
- asset: {
33938
- asset_name: string;
33939
- contract_address: string;
33940
- contract_name: string;
33941
- };
33942
- })[];
33943
- replaced_by_tx_id: string | null;
33944
- /** @enum {string} */
33945
- type: "coinbase";
33946
- });
33947
- };
33948
- };
33949
- /** @description Default Response */
33950
- "4XX": {
33951
- headers: {
33952
- [name: string]: unknown;
33953
- };
33954
- content: {
33955
- "application/json": {
33956
- error: string;
33957
- message?: string;
33958
- } & {
33959
- [key: string]: unknown;
33960
- };
33961
- };
33962
- };
33963
- };
33964
- };
33965
- get_transaction_events: {
33966
- parameters: {
33967
- query?: {
33968
- /** @description Number of results per page */
33969
- limit?: number;
33970
- /** @description Cursor for paginating transaction events. Format: event_index */
33971
- cursor?: string;
33972
- };
33973
- header?: never;
33974
- path: {
33975
- /**
33976
- * @description Transaction ID
33977
- * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
33978
- */
33979
- tx_id: string;
33980
- };
33981
- cookie?: never;
33982
- };
33983
- requestBody?: never;
33984
- responses: {
33985
- /** @description Default Response */
33986
- 200: {
33987
- headers: {
33988
- [name: string]: unknown;
33989
- };
33990
- content: {
33991
- "application/json": {
33992
- /** @example 1 */
33993
- total: number;
33994
- /**
33995
- * @description Number of results per page
33996
- * @default 20
33997
- */
33998
- limit: number;
33999
- cursor: {
34000
- next: string | null;
34001
- previous: string | null;
34002
- current: string | null;
34003
- };
34004
- results: ({
34005
- event_index: number;
34006
- /** @enum {string} */
34007
- type: "contract_log";
34008
- contract_log: {
34009
- /**
34010
- * Smart Contract ID
34011
- * @description Smart Contract ID
34012
- */
34013
- contract_id: string;
34014
- /** @enum {string} */
34015
- topic: "print";
34016
- value: {
34017
- hex: string;
34018
- repr: string;
34019
- };
34020
- };
34021
- } | {
34022
- event_index: number;
34023
- /** @enum {string} */
34024
- type: "stx_lock";
34025
- stx_lock: {
34026
- /**
34027
- * Amount
34028
- * @description Amount
34029
- */
34030
- amount: string;
34031
- /**
34032
- * Block height
34033
- * @description Block height
34034
- */
34035
- unlock_bitcoin_height: number;
34036
- address: string;
34037
- };
34038
- } | {
34039
- event_index: number;
34040
- /** @enum {string} */
34041
- type: "stx_asset";
34042
- stx_asset: {
34043
- /** @enum {string} */
34044
- type: "transfer";
34045
- sender: string;
34046
- recipient: string;
34047
- /**
34048
- * Amount
34049
- * @description Amount
34050
- */
34051
- amount: string;
34052
- memo: {
34053
- hex: string;
34054
- repr: string;
34055
- } | null;
34056
- } | {
34057
- /** @enum {string} */
34058
- type: "mint";
34059
- recipient: string;
34060
- /**
34061
- * Amount
34062
- * @description Amount
34063
- */
34064
- amount: string;
34065
- } | {
34066
- /** @enum {string} */
34067
- type: "burn";
34068
- sender: string;
34069
- /**
34070
- * Amount
34071
- * @description Amount
34072
- */
34073
- amount: string;
34074
- };
34075
- } | {
34076
- event_index: number;
34077
- /** @enum {string} */
34078
- type: "ft_asset";
34079
- ft_asset: {
34080
- /** @enum {string} */
34081
- type: "transfer";
34082
- /**
34083
- * Asset Identifier
34084
- * @description Asset Identifier
34085
- */
34086
- asset_identifier: string;
34087
- sender: string;
34088
- recipient: string;
34089
- /**
34090
- * Amount
34091
- * @description Amount
34092
- */
34093
- amount: string;
34094
- } | {
34095
- /** @enum {string} */
34096
- type: "mint";
34097
- recipient: string;
34098
- /**
34099
- * Asset Identifier
34100
- * @description Asset Identifier
34101
- */
34102
- asset_identifier: string;
34103
- /**
34104
- * Amount
34105
- * @description Amount
34106
- */
34107
- amount: string;
34108
- } | {
34109
- /** @enum {string} */
34110
- type: "burn";
34111
- sender: string;
34112
- /**
34113
- * Asset Identifier
34114
- * @description Asset Identifier
34115
- */
34116
- asset_identifier: string;
34117
- /**
34118
- * Amount
34119
- * @description Amount
34120
- */
34121
- amount: string;
34122
- };
34123
- } | {
34124
- event_index: number;
34125
- /** @enum {string} */
34126
- type: "nft_asset";
34127
- nft_asset: {
34128
- /** @enum {string} */
34129
- type: "transfer";
34130
- /**
34131
- * Asset Identifier
34132
- * @description Asset Identifier
34133
- */
34134
- asset_identifier: string;
34135
- sender: string;
34136
- recipient: string;
34137
- value: {
34138
- hex: string;
34139
- repr: string;
34140
- };
34141
- } | {
34142
- /** @enum {string} */
34143
- type: "mint";
34144
- recipient: string;
34145
- /**
34146
- * Asset Identifier
34147
- * @description Asset Identifier
34148
- */
34149
- asset_identifier: string;
34150
- value: {
34151
- hex: string;
34152
- repr: string;
34153
- };
34154
- } | {
34155
- /** @enum {string} */
34156
- type: "burn";
34157
- sender: string;
34158
- /**
34159
- * Asset Identifier
34160
- * @description Asset Identifier
34161
- */
34162
- asset_identifier: string;
34163
- value: {
34164
- hex: string;
34165
- repr: string;
34166
- };
34167
- };
34168
- })[];
34169
- };
34170
- };
34171
- };
34172
- /** @description Default Response */
34173
- "4XX": {
34174
- headers: {
34175
- [name: string]: unknown;
34176
- };
34177
- content: {
34178
- "application/json": {
34179
- error: string;
34180
- message?: string;
34181
- } & {
34182
- [key: string]: unknown;
34183
- };
34184
- };
34185
- };
34186
- };
34187
- };
34188
- get_mempool_transactions: {
34189
- parameters: {
34190
- query?: {
34191
- /** @description Number of results per page */
34192
- limit?: number;
34193
- /** @description Cursor for paginating mempool transactions. Format: receipt_time:tx_id */
34194
- cursor?: string;
34195
- };
34196
- header?: never;
34197
- path?: never;
34198
- cookie?: never;
34199
- };
34200
- requestBody?: never;
34201
- responses: {
34202
- /** @description Default Response */
34203
- 200: {
34204
- headers: {
34205
- [name: string]: unknown;
34206
- };
34207
- content: {
34208
- "application/json": {
34209
- /** @example 1 */
34210
- total: number;
34211
- /**
34212
- * @description Number of results per page
34213
- * @default 20
34214
- */
34215
- limit: number;
34216
- cursor: {
34217
- next: string | null;
34218
- previous: string | null;
34219
- current: string | null;
34220
- };
34221
- results: ({
34222
- /** @description Transaction ID */
34223
- tx_id: string;
34224
- sender: {
34225
- /** @description Address of the transaction initiator */
34226
- address: string;
34227
- /** @description Nonce of the transaction initiator */
34228
- nonce: number;
34229
- };
34230
- sponsor: {
34231
- /** @description Address of the transaction initiator */
34232
- address: string;
34233
- /** @description Nonce of the transaction initiator */
34234
- nonce: number;
34235
- } | null;
34236
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
34237
- fee_rate: string;
34238
- /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
34239
- receipt_time: number;
34240
- /** @description Height of the block this transaction was received by the node */
34241
- receipt_block_height: number;
34242
- /** @description Status of the mempool transaction */
34243
- status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
34244
- /** @enum {string} */
34245
- type: "token_transfer";
34246
- token_transfer: {
34247
- recipient: string;
34248
- /** @description Transfer amount as Integer string (64-bit unsigned integer) */
34249
- amount: string;
34250
- memo: {
34251
- hex: string;
34252
- repr: string;
34253
- } | null;
34254
- };
34255
- } | {
34256
- /** @description Transaction ID */
34257
- tx_id: string;
34258
- sender: {
34259
- /** @description Address of the transaction initiator */
34260
- address: string;
34261
- /** @description Nonce of the transaction initiator */
34262
- nonce: number;
34263
- };
34264
- sponsor: {
34265
- /** @description Address of the transaction initiator */
34266
- address: string;
34267
- /** @description Nonce of the transaction initiator */
34268
- nonce: number;
34269
- } | null;
34270
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
34271
- fee_rate: string;
34272
- /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
34273
- receipt_time: number;
34274
- /** @description Height of the block this transaction was received by the node */
34275
- receipt_block_height: number;
34276
- /** @description Status of the mempool transaction */
34277
- status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
34278
- /** @enum {string} */
34279
- type: "smart_contract";
34280
- smart_contract: {
34281
- clarity_version: number | null;
34282
- /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
34283
- contract_id: string;
34284
- };
34285
- } | {
34286
- /** @description Transaction ID */
34287
- tx_id: string;
34288
- sender: {
34289
- /** @description Address of the transaction initiator */
34290
- address: string;
34291
- /** @description Nonce of the transaction initiator */
34292
- nonce: number;
34293
- };
34294
- sponsor: {
34295
- /** @description Address of the transaction initiator */
34296
- address: string;
34297
- /** @description Nonce of the transaction initiator */
34298
- nonce: number;
34299
- } | null;
34300
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
34301
- fee_rate: string;
34302
- /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
34303
- receipt_time: number;
34304
- /** @description Height of the block this transaction was received by the node */
34305
- receipt_block_height: number;
34306
- /** @description Status of the mempool transaction */
34307
- status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
34308
- /** @enum {string} */
34309
- type: "contract_call";
34310
- contract_call: {
34311
- /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
34312
- contract_id: string;
34313
- /** @description Name of the Clarity function to be invoked */
34314
- function_name: string;
34315
- };
34316
- } | {
34317
- /** @description Transaction ID */
34318
- tx_id: string;
34319
- sender: {
34320
- /** @description Address of the transaction initiator */
34321
- address: string;
34322
- /** @description Nonce of the transaction initiator */
34323
- nonce: number;
34324
- };
34325
- sponsor: {
34326
- /** @description Address of the transaction initiator */
35052
+ } | {
35053
+ /** @enum {string} */
35054
+ type_id: "principal_contract";
34327
35055
  address: string;
34328
- /** @description Nonce of the transaction initiator */
34329
- nonce: number;
34330
- } | null;
34331
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
34332
- fee_rate: string;
34333
- /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
34334
- receipt_time: number;
34335
- /** @description Height of the block this transaction was received by the node */
34336
- receipt_block_height: number;
34337
- /** @description Status of the mempool transaction */
34338
- status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
35056
+ contract_name: string;
35057
+ };
35058
+ condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to";
35059
+ amount: string;
34339
35060
  /** @enum {string} */
34340
- type: "poison_microblock";
35061
+ type: "stx";
34341
35062
  } | {
34342
- /** @description Transaction ID */
34343
- tx_id: string;
34344
- sender: {
34345
- /** @description Address of the transaction initiator */
35063
+ principal: {
35064
+ /** @enum {string} */
35065
+ type_id: "principal_origin";
35066
+ } | {
35067
+ /** @enum {string} */
35068
+ type_id: "principal_standard";
34346
35069
  address: string;
34347
- /** @description Nonce of the transaction initiator */
34348
- nonce: number;
34349
- };
34350
- sponsor: {
34351
- /** @description Address of the transaction initiator */
35070
+ } | {
35071
+ /** @enum {string} */
35072
+ type_id: "principal_contract";
34352
35073
  address: string;
34353
- /** @description Nonce of the transaction initiator */
34354
- nonce: number;
34355
- } | null;
34356
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
34357
- fee_rate: string;
34358
- /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
34359
- receipt_time: number;
34360
- /** @description Height of the block this transaction was received by the node */
34361
- receipt_block_height: number;
34362
- /** @description Status of the mempool transaction */
34363
- status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
35074
+ contract_name: string;
35075
+ };
35076
+ condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to";
35077
+ amount: string;
34364
35078
  /** @enum {string} */
34365
- type: "coinbase";
35079
+ type: "fungible";
35080
+ asset: {
35081
+ asset_name: string;
35082
+ contract_address: string;
35083
+ contract_name: string;
35084
+ };
34366
35085
  } | {
34367
- /** @description Transaction ID */
34368
- tx_id: string;
34369
- sender: {
34370
- /** @description Address of the transaction initiator */
35086
+ principal: {
35087
+ /** @enum {string} */
35088
+ type_id: "principal_origin";
35089
+ } | {
35090
+ /** @enum {string} */
35091
+ type_id: "principal_standard";
34371
35092
  address: string;
34372
- /** @description Nonce of the transaction initiator */
34373
- nonce: number;
34374
- };
34375
- sponsor: {
34376
- /** @description Address of the transaction initiator */
35093
+ } | {
35094
+ /** @enum {string} */
35095
+ type_id: "principal_contract";
34377
35096
  address: string;
34378
- /** @description Nonce of the transaction initiator */
34379
- nonce: number;
34380
- } | null;
34381
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
34382
- fee_rate: string;
34383
- /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */
34384
- receipt_time: number;
34385
- /** @description Height of the block this transaction was received by the node */
34386
- receipt_block_height: number;
34387
- /** @description Status of the mempool transaction */
34388
- status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic";
35097
+ contract_name: string;
35098
+ };
35099
+ condition_code: "sent" | "not_sent" | "maybe_sent";
34389
35100
  /** @enum {string} */
34390
- type: "tenure_change";
35101
+ type: "non_fungible";
35102
+ asset_value: {
35103
+ hex: string;
35104
+ repr: string;
35105
+ };
35106
+ asset: {
35107
+ asset_name: string;
35108
+ contract_address: string;
35109
+ contract_name: string;
35110
+ };
34391
35111
  })[];
34392
- };
35112
+ replaced_by_tx_id: string | null;
35113
+ /** @enum {string} */
35114
+ type: "coinbase";
35115
+ });
34393
35116
  };
34394
35117
  };
34395
35118
  /** @description Default Response */
@@ -34408,17 +35131,21 @@ export interface operations {
34408
35131
  };
34409
35132
  };
34410
35133
  };
34411
- get_block_transactions: {
35134
+ get_transaction_events: {
34412
35135
  parameters: {
34413
35136
  query?: {
34414
35137
  /** @description Number of results per page */
34415
35138
  limit?: number;
34416
- /** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */
35139
+ /** @description Cursor for paginating transaction events. Format: event_index */
34417
35140
  cursor?: string;
34418
35141
  };
34419
35142
  header?: never;
34420
35143
  path: {
34421
- height_or_hash: "latest" | string | number;
35144
+ /**
35145
+ * @description Transaction ID
35146
+ * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6
35147
+ */
35148
+ tx_id: string;
34422
35149
  };
34423
35150
  cookie?: never;
34424
35151
  };
@@ -34444,265 +35171,168 @@ export interface operations {
34444
35171
  current: string | null;
34445
35172
  };
34446
35173
  results: ({
34447
- /** @description Transaction ID */
34448
- tx_id: string;
34449
- sender: {
34450
- /** @description Address of the transaction initiator */
34451
- address: string;
34452
- /** @description Nonce of the transaction initiator */
34453
- nonce: number;
35174
+ event_index: number;
35175
+ /** @enum {string} */
35176
+ type: "contract_log";
35177
+ contract_log: {
35178
+ /**
35179
+ * Smart Contract ID
35180
+ * @description Smart Contract ID
35181
+ */
35182
+ contract_id: string;
35183
+ /** @enum {string} */
35184
+ topic: "print";
35185
+ value: {
35186
+ hex: string;
35187
+ repr: string;
35188
+ };
34454
35189
  };
34455
- sponsor: {
34456
- /** @description Address of the transaction initiator */
35190
+ } | {
35191
+ event_index: number;
35192
+ /** @enum {string} */
35193
+ type: "stx_lock";
35194
+ stx_lock: {
35195
+ /**
35196
+ * Amount
35197
+ * @description Amount
35198
+ */
35199
+ amount: string;
35200
+ /**
35201
+ * Block height
35202
+ * @description Block height
35203
+ */
35204
+ unlock_bitcoin_height: number;
34457
35205
  address: string;
34458
- /** @description Nonce of the transaction initiator */
34459
- nonce: number;
34460
- } | null;
34461
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
34462
- fee_rate: string;
34463
- block: {
34464
- /** @description Height of the block this transactions was associated with */
34465
- height: number;
34466
- /** @description Hash of the blocked this transactions was associated with */
34467
- hash: string;
34468
- /** @description Hash of the index block this transactions was associated with */
34469
- index_hash: string;
34470
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34471
- time: number;
34472
- /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
34473
- tx_index: number;
34474
- };
34475
- bitcoin_block: {
34476
- /** @description Height of the anchor burn block. */
34477
- height: number;
34478
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34479
- time: number;
34480
35206
  };
34481
- /** @description Status of the transaction */
34482
- status: "success" | "abort_by_response" | "abort_by_post_condition";
35207
+ } | {
35208
+ event_index: number;
34483
35209
  /** @enum {string} */
34484
- type: "token_transfer";
34485
- token_transfer: {
35210
+ type: "stx_asset";
35211
+ stx_asset: {
35212
+ /** @enum {string} */
35213
+ type: "transfer";
35214
+ sender: string;
34486
35215
  recipient: string;
34487
- /** @description Transfer amount as Integer string (64-bit unsigned integer) */
35216
+ /**
35217
+ * Amount
35218
+ * @description Amount
35219
+ */
34488
35220
  amount: string;
34489
35221
  memo: {
34490
35222
  hex: string;
34491
35223
  repr: string;
34492
35224
  } | null;
35225
+ } | {
35226
+ /** @enum {string} */
35227
+ type: "mint";
35228
+ recipient: string;
35229
+ /**
35230
+ * Amount
35231
+ * @description Amount
35232
+ */
35233
+ amount: string;
35234
+ } | {
35235
+ /** @enum {string} */
35236
+ type: "burn";
35237
+ sender: string;
35238
+ /**
35239
+ * Amount
35240
+ * @description Amount
35241
+ */
35242
+ amount: string;
34493
35243
  };
34494
35244
  } | {
34495
- /** @description Transaction ID */
34496
- tx_id: string;
34497
- sender: {
34498
- /** @description Address of the transaction initiator */
34499
- address: string;
34500
- /** @description Nonce of the transaction initiator */
34501
- nonce: number;
34502
- };
34503
- sponsor: {
34504
- /** @description Address of the transaction initiator */
34505
- address: string;
34506
- /** @description Nonce of the transaction initiator */
34507
- nonce: number;
34508
- } | null;
34509
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
34510
- fee_rate: string;
34511
- block: {
34512
- /** @description Height of the block this transactions was associated with */
34513
- height: number;
34514
- /** @description Hash of the blocked this transactions was associated with */
34515
- hash: string;
34516
- /** @description Hash of the index block this transactions was associated with */
34517
- index_hash: string;
34518
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34519
- time: number;
34520
- /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
34521
- tx_index: number;
34522
- };
34523
- bitcoin_block: {
34524
- /** @description Height of the anchor burn block. */
34525
- height: number;
34526
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34527
- time: number;
34528
- };
34529
- /** @description Status of the transaction */
34530
- status: "success" | "abort_by_response" | "abort_by_post_condition";
34531
- /** @enum {string} */
34532
- type: "smart_contract";
34533
- smart_contract: {
34534
- clarity_version: number | null;
34535
- /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
34536
- contract_id: string;
34537
- };
34538
- } | {
34539
- /** @description Transaction ID */
34540
- tx_id: string;
34541
- sender: {
34542
- /** @description Address of the transaction initiator */
34543
- address: string;
34544
- /** @description Nonce of the transaction initiator */
34545
- nonce: number;
34546
- };
34547
- sponsor: {
34548
- /** @description Address of the transaction initiator */
34549
- address: string;
34550
- /** @description Nonce of the transaction initiator */
34551
- nonce: number;
34552
- } | null;
34553
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
34554
- fee_rate: string;
34555
- block: {
34556
- /** @description Height of the block this transactions was associated with */
34557
- height: number;
34558
- /** @description Hash of the blocked this transactions was associated with */
34559
- hash: string;
34560
- /** @description Hash of the index block this transactions was associated with */
34561
- index_hash: string;
34562
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34563
- time: number;
34564
- /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
34565
- tx_index: number;
34566
- };
34567
- bitcoin_block: {
34568
- /** @description Height of the anchor burn block. */
34569
- height: number;
34570
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34571
- time: number;
34572
- };
34573
- /** @description Status of the transaction */
34574
- status: "success" | "abort_by_response" | "abort_by_post_condition";
34575
- /** @enum {string} */
34576
- type: "contract_call";
34577
- contract_call: {
34578
- /** @description Contract identifier formatted as `<principaladdress>.<contract_name>` */
34579
- contract_id: string;
34580
- /** @description Name of the Clarity function to be invoked */
34581
- function_name: string;
34582
- };
34583
- } | {
34584
- /** @description Transaction ID */
34585
- tx_id: string;
34586
- sender: {
34587
- /** @description Address of the transaction initiator */
34588
- address: string;
34589
- /** @description Nonce of the transaction initiator */
34590
- nonce: number;
34591
- };
34592
- sponsor: {
34593
- /** @description Address of the transaction initiator */
34594
- address: string;
34595
- /** @description Nonce of the transaction initiator */
34596
- nonce: number;
34597
- } | null;
34598
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
34599
- fee_rate: string;
34600
- block: {
34601
- /** @description Height of the block this transactions was associated with */
34602
- height: number;
34603
- /** @description Hash of the blocked this transactions was associated with */
34604
- hash: string;
34605
- /** @description Hash of the index block this transactions was associated with */
34606
- index_hash: string;
34607
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34608
- time: number;
34609
- /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
34610
- tx_index: number;
34611
- };
34612
- bitcoin_block: {
34613
- /** @description Height of the anchor burn block. */
34614
- height: number;
34615
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34616
- time: number;
34617
- };
34618
- /** @description Status of the transaction */
34619
- status: "success" | "abort_by_response" | "abort_by_post_condition";
34620
- /** @enum {string} */
34621
- type: "poison_microblock";
34622
- } | {
34623
- /** @description Transaction ID */
34624
- tx_id: string;
34625
- sender: {
34626
- /** @description Address of the transaction initiator */
34627
- address: string;
34628
- /** @description Nonce of the transaction initiator */
34629
- nonce: number;
34630
- };
34631
- sponsor: {
34632
- /** @description Address of the transaction initiator */
34633
- address: string;
34634
- /** @description Nonce of the transaction initiator */
34635
- nonce: number;
34636
- } | null;
34637
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
34638
- fee_rate: string;
34639
- block: {
34640
- /** @description Height of the block this transactions was associated with */
34641
- height: number;
34642
- /** @description Hash of the blocked this transactions was associated with */
34643
- hash: string;
34644
- /** @description Hash of the index block this transactions was associated with */
34645
- index_hash: string;
34646
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34647
- time: number;
34648
- /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
34649
- tx_index: number;
34650
- };
34651
- bitcoin_block: {
34652
- /** @description Height of the anchor burn block. */
34653
- height: number;
34654
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34655
- time: number;
34656
- };
34657
- /** @description Status of the transaction */
34658
- status: "success" | "abort_by_response" | "abort_by_post_condition";
35245
+ event_index: number;
34659
35246
  /** @enum {string} */
34660
- type: "coinbase";
34661
- coinbase: {
34662
- alt_recipient: string | null;
35247
+ type: "ft_asset";
35248
+ ft_asset: {
35249
+ /** @enum {string} */
35250
+ type: "transfer";
35251
+ /**
35252
+ * Asset Identifier
35253
+ * @description Asset Identifier
35254
+ */
35255
+ asset_identifier: string;
35256
+ sender: string;
35257
+ recipient: string;
35258
+ /**
35259
+ * Amount
35260
+ * @description Amount
35261
+ */
35262
+ amount: string;
35263
+ } | {
35264
+ /** @enum {string} */
35265
+ type: "mint";
35266
+ recipient: string;
35267
+ /**
35268
+ * Asset Identifier
35269
+ * @description Asset Identifier
35270
+ */
35271
+ asset_identifier: string;
35272
+ /**
35273
+ * Amount
35274
+ * @description Amount
35275
+ */
35276
+ amount: string;
35277
+ } | {
35278
+ /** @enum {string} */
35279
+ type: "burn";
35280
+ sender: string;
35281
+ /**
35282
+ * Asset Identifier
35283
+ * @description Asset Identifier
35284
+ */
35285
+ asset_identifier: string;
35286
+ /**
35287
+ * Amount
35288
+ * @description Amount
35289
+ */
35290
+ amount: string;
34663
35291
  };
34664
35292
  } | {
34665
- /** @description Transaction ID */
34666
- tx_id: string;
34667
- sender: {
34668
- /** @description Address of the transaction initiator */
34669
- address: string;
34670
- /** @description Nonce of the transaction initiator */
34671
- nonce: number;
34672
- };
34673
- sponsor: {
34674
- /** @description Address of the transaction initiator */
34675
- address: string;
34676
- /** @description Nonce of the transaction initiator */
34677
- nonce: number;
34678
- } | null;
34679
- /** @description Transaction fee as Integer string (64-bit unsigned integer). */
34680
- fee_rate: string;
34681
- block: {
34682
- /** @description Height of the block this transactions was associated with */
34683
- height: number;
34684
- /** @description Hash of the blocked this transactions was associated with */
34685
- hash: string;
34686
- /** @description Hash of the index block this transactions was associated with */
34687
- index_hash: string;
34688
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34689
- time: number;
34690
- /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */
34691
- tx_index: number;
34692
- };
34693
- bitcoin_block: {
34694
- /** @description Height of the anchor burn block. */
34695
- height: number;
34696
- /** @description Unix timestamp (in seconds) indicating when this block was mined. */
34697
- time: number;
34698
- };
34699
- /** @description Status of the transaction */
34700
- status: "success" | "abort_by_response" | "abort_by_post_condition";
35293
+ event_index: number;
34701
35294
  /** @enum {string} */
34702
- type: "tenure_change";
34703
- tenure_change: {
34704
- /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */
34705
- cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length";
35295
+ type: "nft_asset";
35296
+ nft_asset: {
35297
+ /** @enum {string} */
35298
+ type: "transfer";
35299
+ /**
35300
+ * Asset Identifier
35301
+ * @description Asset Identifier
35302
+ */
35303
+ asset_identifier: string;
35304
+ sender: string;
35305
+ recipient: string;
35306
+ value: {
35307
+ hex: string;
35308
+ repr: string;
35309
+ };
35310
+ } | {
35311
+ /** @enum {string} */
35312
+ type: "mint";
35313
+ recipient: string;
35314
+ /**
35315
+ * Asset Identifier
35316
+ * @description Asset Identifier
35317
+ */
35318
+ asset_identifier: string;
35319
+ value: {
35320
+ hex: string;
35321
+ repr: string;
35322
+ };
35323
+ } | {
35324
+ /** @enum {string} */
35325
+ type: "burn";
35326
+ sender: string;
35327
+ /**
35328
+ * Asset Identifier
35329
+ * @description Asset Identifier
35330
+ */
35331
+ asset_identifier: string;
35332
+ value: {
35333
+ hex: string;
35334
+ repr: string;
35335
+ };
34706
35336
  };
34707
35337
  })[];
34708
35338
  };