jmwallet.backends.neutrino
jmwallet.backends.neutrino
Neutrino (BIP157/BIP158) light client blockchain backend.
Lightweight alternative to running a full Bitcoin node. Uses compact block filters for privacy-preserving SPV operation.
The Neutrino client runs as a separate Go process and communicates via gRPC. This backend wraps the neutrino gRPC API for the JoinMarket wallet.
Reference: https://github.com/lightninglabs/neutrino
Neutrino-compatible Protocol Support: This backend implements verify_utxo_with_metadata() for Neutrino-compatible UTXO verification. When peers provide scriptPubKey and blockheight hints (via neutrino_compat feature flag), this backend can verify UTXOs without arbitrary queries by: 1. Adding the scriptPubKey to the watch list 2. Rescanning from the hinted blockheight 3. Downloading matching blocks via compact block filters 4. Extracting and verifying the UTXO
Attributes
GENESIS_BLOCK_HASHES: dict[str, str] = {'mainnet': '000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f', 'testnet': '000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943', 'signet': '00000008819873e925422c1ff0f99f7cc9bbb232af63a077a480a3633bee1ef6', 'regtest': '0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206'}
module-attribute
Classes
NeutrinoBackend
Bases: BlockchainBackend
Blockchain backend using Neutrino light client.
Neutrino is a privacy-preserving Bitcoin light client that uses BIP157/BIP158 compact block filters instead of traditional SPV.
Communication with the neutrino daemon is via REST API. The neutrino daemon should be running alongside this client.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 | |
Attributes
add_peers = add_peers or []
instance-attribute
client = self._build_http_client()
instance-attribute
data_dir = data_dir
instance-attribute
include_mempool = include_mempool
instance-attribute
network = network
instance-attribute
neutrino_url = neutrino_url.rstrip('/')
instance-attribute
server_capabilities: ServerCapabilities
property
Return the detected server capabilities (read-only).
supports_tx_enumeration: bool = True
class-attribute
instance-attribute
supports_watch_address: bool = True
class-attribute
instance-attribute
Methods:
__init__(neutrino_url: str = 'http://127.0.0.1:8334', network: str = 'mainnet', add_peers: list[str] | None = None, data_dir: str = '/data/neutrino', scan_start_height: int | None = None, scan_lookback_blocks: int = 105120, tls_cert_path: str | None = None, auth_token: str | None = None, include_mempool: bool = True, fee_estimate_url: str | None = None, fee_estimate_proxy: str | None = None)
Initialize Neutrino backend.
Args:
neutrino_url: URL of the neutrino REST API (default port 8334)
network: Bitcoin network (mainnet, testnet, regtest, signet)
add_peers: Preferred peer addresses to add (optional)
data_dir: Directory for neutrino data (headers, filters)
scan_start_height: Block height to start initial rescan from (optional).
If set, skips scanning blocks before this height during initial wallet sync.
Critical for performance on mainnet/signet where scanning from genesis is slow.
If None, a smart default is computed at first sync using scan_lookback_blocks.
scan_lookback_blocks: Number of blocks to look back from the chain tip when
scan_start_height is not set. Defaults to 105120 (~2 years of blocks).
Only used on networks where _min_valid_blockheight is 0 (signet, regtest).
tls_cert_path: Path to neutrino-api TLS certificate for HTTPS verification.
When set, the client connects over HTTPS and pins the server certificate.
auth_token: API bearer token for neutrino-api authentication.
Sent as Authorization: Bearer <token> on every request.
include_mempool: When true (default), include unconfirmed entries from the
neutrino-api watched-mempool tracker in UTXO listings, and overlay
mempool spends on single-UTXO checks. Has no effect when the server
does not expose the tracker (older neutrino-api or operator-disabled).
fee_estimate_url: External HTTP fee estimate source (mempool.space
recommended, Esplora /fee-estimates, or LND fee.url JSON format).
Several comma-separated URLs are tried in order. None selects
the network's onion-first fallback chain, but only when
fee_estimate_proxy is available, so no third-party clearnet
request happens by default. "off" (or empty) disables external
fee estimation entirely.
fee_estimate_proxy: SOCKS proxy URL (socks5h://host:port) used for
fee source requests, typically the Tor SOCKS port.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 | |
add_watch_address(address: str) -> None
async
Add an address to the local watch list.
In neutrino-api v0.4, address watching is implicit - you just query UTXOs or do rescans with the addresses you care about. This method tracks addresses locally for convenience.
Security: Limits the number of watched addresses to prevent memory exhaustion attacks.
Args: address: Bitcoin address to watch
Raises: ValueError: If watch list limit exceeded
Source code in jmwallet/src/jmwallet/backends/neutrino.py
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 | |
add_watch_outpoint(txid: str, vout: int) -> None
async
Add an outpoint to the local watch list.
In neutrino-api v0.4, outpoint watching is done via UTXO queries with the address parameter. This method tracks outpoints locally.
Args: txid: Transaction ID vout: Output index
Source code in jmwallet/src/jmwallet/backends/neutrino.py
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 | |
broadcast_transaction(tx_hex: str) -> str
async
Broadcast transaction via neutrino to the P2P network.
Neutrino maintains P2P connections and can broadcast transactions directly to connected peers.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 | |
can_estimate_fee() -> bool
Whether reliable fee estimation is available.
True only when an external fee source is configured; neutrino itself cannot estimate fees (requires a full node).
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1368 1369 1370 1371 1372 1373 1374 | |
can_get_confirmations_by_txid() -> bool
Neutrino's get_transaction() is mempool-only and never reports
confirmation depth.
Even with the watched mempool tracker enabled, GET /v1/tx/{txid}
returns a transaction only while it is an unconfirmed watched entry
(confirmations=0) and 501 once it confirms. Pending-transaction
confirmation is therefore detected via :meth:verify_tx_output
(compact block filter match on the output address), regardless of
whether the mempool tracker is available.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 | |
can_provide_neutrino_metadata() -> bool
Neutrino backend CAN provide metadata for its own wallet UTXOs.
A neutrino maker knows its own scriptpubkeys (derived from the wallet) and block heights (from its own transaction history). This metadata is included in !ioauth responses so that neutrino takers can verify the maker's UTXOs via compact block filters.
Note: This is distinct from requires_neutrino_metadata(), which asks whether this backend needs metadata FROM counterparties to verify THEIR UTXOs. A neutrino backend both requires metadata from others AND can provide metadata about its own UTXOs.
Returns: True - Neutrino can provide scriptpubkey + blockheight for own UTXOs
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 | |
close() -> None
async
Close the HTTP client connection and reset so the backend can be reused.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 | |
ensure_addresses_scanned(addresses: list[str]) -> None
async
Rescan addresses over the wallet's full history.
Neutrino only rescans new blocks for already-watched addresses, so an
address added after the initial sync (e.g. a freshly registered
fidelity bond) would miss outputs funded in already-scanned blocks.
This forces a rescan that re-covers the historical range for the given
addresses, then arms the async-indexing retry so the next
:meth:get_utxos waits for results.
neutrino-api skips a requested range when start_height is within the
already-scanned span (start_height >= last_start_height), keying off
a global scanned-tip rather than per-address coverage. To genuinely
backfill a newly watched address we must request a start height strictly
below the persisted last_start_height so the skip is bypassed and the
old blocks are re-evaluated against the new address' filter.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 | |
estimate_fee(target_blocks: int) -> float
async
Estimate fee in sat/vbyte for target confirmation blocks.
Neutrino itself cannot estimate fees (no mempool, no full node).
When an external fee source is configured (fee_estimate_url),
estimates are fetched from it (over Tor when a proxy is set) and
cached briefly. Without a fee source, conservative static defaults
are returned; use can_estimate_fee() to check whether reliable
estimation is available.
Note: callers (taker, direct send) additionally enforce the wallet's
max_fee_rate_sat_vb cap on the returned rate, so a compromised
fee source cannot push spending beyond the configured maximum.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 | |
get_address_balance(address: str) -> int
async
Get balance for an address in satoshis.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1153 1154 1155 1156 1157 1158 | |
get_block_hash(block_height: int) -> str
async
Get block hash for given height.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 | |
get_block_height() -> int
async
Get current blockchain height from neutrino.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 | |
get_block_time(block_height: int) -> int
async
Get block time (unix timestamp) for given height.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 | |
get_connected_peers() -> list[dict[str, Any]]
async
Get list of connected P2P peers.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1853 1854 1855 1856 1857 1858 1859 1860 1861 | |
get_filter_header(block_height: int) -> str
async
Get compact block filter header for given height.
BIP157 filter headers form a chain for validation.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 | |
get_transaction(txid: str) -> Transaction | None
async
Get transaction by txid.
Neutrino uses BIP157/158 compact block filters and cannot fetch
arbitrary historical transactions by txid alone. The neutrino-api
watched-only mempool tracker (v1.3.0+) does, however, expose any
transaction it has observed touching a watched script via
GET /v1/tx/{txid}. We try that endpoint when the operator has
not disabled mempool overlay; on a miss (404 / 501) we fall back
to None to preserve the legacy behaviour.
Returned transactions are always unconfirmed
(confirmations=0, block_height=None).
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 | |
get_utxo(txid: str, vout: int) -> UTXO | None
async
Get a specific UTXO from the blockchain. Returns None if the UTXO does not exist or has been spent.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 | |
get_utxos(addresses: list[str]) -> list[UTXO]
async
Get UTXOs for given addresses using neutrino's rescan capability.
Neutrino will scan the blockchain using compact block filters to find transactions relevant to the watched addresses.
On first call, ensures the neutrino node is fully synced (headers + compact block filters up to the chain tip) before triggering a blockchain rescan. This is critical because scanBlocks() can only check filters it has already downloaded -- if the node is still syncing, blocks containing funded transactions will be silently missed.
After initial rescan, automatically rescans if new blocks have arrived to detect transactions that occurred after the last scan.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 | |
has_mempool_access() -> bool
Whether this backend can observe unconfirmed transactions.
Returns true only when (1) the operator has not disabled mempool
overlay client-side via include_mempool=False, and (2) the
connected neutrino-api server reports the watched-only mempool
tracker is enabled (mempool_enabled: true on /v1/status).
Older neutrino-api builds (pre-1.3.0) lack the tracker and report false here; callers must use chain-only verification (e.g., wait for confirmation, trust maker ACKs, multi-maker broadcast).
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 | |
list_wallet_transactions_since(cursor: str | None) -> tuple[list[WalletTxEntry], str | None]
async
Enumerate watched transactions via GET /v1/transactions.
The cursor is the since_height as a decimal string; None starts
from height 0. Confirmed records include raw hex inline (so the tx
monitor need not fetch them separately, which neutrino cannot do for
confirmed txs). Returns an empty result -- with a one-time warning --
when the connected server predates neutrino-api 1.4.0 and does not
advertise tx_history_enabled.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 | |
requires_neutrino_metadata() -> bool
Neutrino backend requires metadata for arbitrary UTXO verification.
Without scriptPubKey and blockheight hints, Neutrino cannot verify UTXOs that it hasn't been watching from the start.
Returns: True - Neutrino always requires metadata for counterparty UTXOs
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 | |
rescan_from_height(start_height: int, addresses: list[str] | None = None, outpoints: list[tuple[str, int]] | None = None) -> None
async
Rescan blockchain from a specific height for addresses.
This triggers neutrino to re-check compact block filters from the specified height for relevant transactions.
Uses the neutrino-api v0.4 rescan endpoint: POST /v1/rescan with {"start_height": N, "addresses": [...]}
Note: The v0.4 API only supports address-based rescans. Outpoints are tracked via address watches instead.
Args: start_height: Block height to start rescan from addresses: List of addresses to scan for (required for v0.4) outpoints: List of (txid, vout) outpoints - not directly supported, will be ignored (use add_watch_outpoint instead)
Raises: ValueError: If start_height is invalid or rescan depth exceeds limits
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 | |
set_wallet_creation_height(height: int | None) -> None
Use wallet creation height as scan start if no explicit override.
When the wallet was created at a known block height, there is no
need to scan blocks before that point. This takes priority over
the lookback-based default but NOT over an explicit
scan_start_height set by the user in config.
Passing None clears any previously set creation height hint.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 | |
verify_bonds(bonds: list[BondVerificationRequest]) -> list[BondVerificationResult]
async
Verify fidelity bond UTXOs using compact block filter address scanning.
Since the neutrino backend cannot do arbitrary UTXO lookups (get_utxo returns None), this method uses the pre-computed bond address from each request to scan the UTXO set via the neutrino-api's address-based endpoint.
For each bond:
1. Use the pre-computed P2WSH address (derived from utxo_pub + locktime)
2. Query v1/utxo/{txid}/{vout}?address={addr}&start_height={scan_start_height}
3. Parse the response to determine value, confirmations, and block time
Uses scan_start_height (defaulting to the network's minimum valid blockheight) instead of scanning from genesis. This is safe because fidelity bonds can only exist after SegWit activation, and dramatically faster on long chains.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 | |
verify_tx_output(txid: str, vout: int, address: str, start_height: int | None = None) -> bool
async
Verify that a specific transaction output exists using neutrino's UTXO endpoint.
Uses GET /v1/utxo/{txid}/{vout}?address=...&start_height=... to check if the output exists. This works because neutrino uses compact block filters that can match on addresses.
Args: txid: Transaction ID to verify vout: Output index to check address: The address that should own this output start_height: Block height hint for efficient scanning (recommended)
Returns: True if the output exists, False otherwise
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 | |
verify_utxo_with_metadata(txid: str, vout: int, scriptpubkey: str, blockheight: int) -> UTXOVerificationResult
async
Verify a UTXO using provided metadata (neutrino_compat feature).
This is the key method that enables Neutrino light clients to verify counterparty UTXOs in CoinJoin without arbitrary blockchain queries.
Uses the neutrino-api v0.4 UTXO check endpoint which requires: - address: The Bitcoin address that owns the UTXO (derived from scriptPubKey) - start_height: Block height to start scanning from (for efficiency)
The API scans from start_height to chain tip using compact block filters to determine if the UTXO exists and whether it has been spent.
Security: Validates blockheight to prevent rescan abuse attacks where malicious peers provide very low blockheights to trigger expensive rescans.
Args: txid: Transaction ID vout: Output index scriptpubkey: Expected scriptPubKey (hex) - used to derive address blockheight: Block height where UTXO was confirmed - scan start hint
Returns: UTXOVerificationResult with verification status and UTXO data
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 | |
wait_for_sync(timeout: float = 300.0) -> bool
async
Wait for neutrino to sync block headers and filters.
Args: timeout: Maximum time to wait in seconds
Returns: True if synced, False if timeout
Source code in jmwallet/src/jmwallet/backends/neutrino.py
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 | |
NeutrinoConfig
Configuration for running a neutrino daemon.
This configuration can be used to start a neutrino process programmatically or generate a config file.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 | |
Attributes
clearnet_initial_sync = clearnet_initial_sync
instance-attribute
data_dir = data_dir
instance-attribute
listen_port = listen_port
instance-attribute
network = network
instance-attribute
peers = peers or []
instance-attribute
prefetch_filters = prefetch_filters
instance-attribute
prefetch_lookback_blocks = prefetch_lookback_blocks
instance-attribute
tor_socks = tor_socks
instance-attribute
Methods:
__init__(network: str = 'mainnet', data_dir: str = '/data/neutrino', listen_port: int = 8334, peers: list[str] | None = None, tor_socks: str | None = None, clearnet_initial_sync: bool = True, prefetch_filters: bool = True, prefetch_lookback_blocks: int = 105120)
Initialize neutrino configuration.
Args: network: Bitcoin network (mainnet, testnet, regtest, signet) data_dir: Directory for neutrino data listen_port: Port for REST API peers: List of peer addresses to connect to tor_socks: Tor SOCKS5 proxy address (e.g., "127.0.0.1:9050") clearnet_initial_sync: Sync headers over clearnet before switching to Tor. Safe because headers are public deterministic data. Typically ~2x faster than Tor for initial header sync. Default: True. prefetch_filters: Enable background prefetch of compact block filters. Enabled by default because jm-wallet info scans these filters anyway, so prefetching saves time. With the default lookback of ~2 years, takes ~3 hours on clearnet and ~3GB disk on mainnet. Default: True. prefetch_lookback_blocks: When prefetch is enabled, only prefetch filters for this many recent blocks. 0 = prefetch all from genesis. Default: 105120 (~2 years).
Source code in jmwallet/src/jmwallet/backends/neutrino.py
2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 | |
get_chain_params() -> dict[str, Any]
Get chain-specific parameters.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 | |
to_args() -> list[str]
Generate command-line arguments for neutrino daemon.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 | |
to_env() -> dict[str, str]
Generate environment variables for neutrino daemon (Docker).
Source code in jmwallet/src/jmwallet/backends/neutrino.py
2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 | |
NeutrinoNetworkMismatchError
Bases: Exception
Raised when the neutrino server is serving a different network.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
58 59 | |
ServerCapabilities
dataclass
Detected capabilities of the neutrino-api server.
Populated once on first successful connection via
NeutrinoBackend._detect_server_capabilities(). Provides
feature-flag information that allows the backend to degrade
gracefully when running against older server versions.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 | |