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
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
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 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 96 97 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 | |
Attributes
client = httpx.AsyncClient(timeout=60.0)
instance-attribute
connect_peers = connect_peers or []
instance-attribute
data_dir = data_dir
instance-attribute
network = network
instance-attribute
neutrino_url = neutrino_url.rstrip('/')
instance-attribute
Functions
__init__(neutrino_url: str = 'http://127.0.0.1:8334', network: str = 'mainnet', connect_peers: list[str] | None = None, data_dir: str = '/data/neutrino')
Initialize Neutrino backend.
Args: neutrino_url: URL of the neutrino REST API (default port 8334) network: Bitcoin network (mainnet, testnet, regtest, signet) connect_peers: List of peer addresses to connect to (optional) data_dir: Directory for neutrino data (headers, filters)
Source code in jmwallet/src/jmwallet/backends/neutrino.py
52 53 54 55 56 57 58 59 60 61 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 96 97 98 99 100 101 102 103 104 105 106 | |
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
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 | |
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
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 | |
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
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 | |
can_estimate_fee() -> bool
Neutrino cannot reliably estimate fees - requires full node.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
510 511 512 | |
can_provide_neutrino_metadata() -> bool
Neutrino backend cannot reliably provide metadata for all UTXOs.
Light clients can only provide metadata for UTXOs they've been watching. They cannot provide metadata for arbitrary addresses like full nodes can.
Returns: False - Neutrino cannot provide metadata for arbitrary UTXOs
Source code in jmwallet/src/jmwallet/backends/neutrino.py
729 730 731 732 733 734 735 736 737 738 739 | |
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
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 | |
estimate_fee(target_blocks: int) -> float
async
Estimate fee in sat/vbyte for target confirmation blocks.
Neutrino does not support fee estimation - returns conservative defaults. Use can_estimate_fee() to check if reliable estimation is available.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 | |
get_address_balance(address: str) -> int
async
Get balance for an address in satoshis.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
394 395 396 397 398 399 | |
get_block_hash(block_height: int) -> str
async
Get block hash for given height.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
554 555 556 557 558 559 560 561 562 563 564 565 566 567 | |
get_block_height() -> int
async
Get current blockchain height from neutrino.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
527 528 529 530 531 532 533 534 535 536 537 | |
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
539 540 541 542 543 544 545 546 547 548 549 550 551 552 | |
get_connected_peers() -> list[dict[str, Any]]
async
Get list of connected P2P peers.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
925 926 927 928 929 930 931 932 933 | |
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
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 | |
get_transaction(txid: str) -> Transaction | None
async
Get transaction by txid.
Note: Neutrino uses compact block filters (BIP158) and can only fetch transactions for addresses it has rescanned. It cannot fetch arbitrary transactions by txid alone. This method always returns None.
For verification after broadcast, rely on UTXO checks with known addresses and block heights instead.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
422 423 424 425 426 427 428 429 430 431 432 433 434 435 | |
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
569 570 571 572 573 574 575 576 577 578 | |
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, triggers a full blockchain rescan from genesis to ensure all historical UTXOs are found (critical for wallets funded before neutrino started).
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
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 | |
has_mempool_access() -> bool
Neutrino cannot access mempool - only sees confirmed transactions.
BIP157/158 compact block filters only match confirmed blocks. Unconfirmed transactions in the mempool are not visible to Neutrino.
This means verify_tx_output() will return False for valid transactions that are in the mempool but not yet confirmed. Takers using Neutrino must use alternative verification strategies (e.g., trust maker ACKs, multi-maker broadcast, wait for confirmation).
Source code in jmwallet/src/jmwallet/backends/neutrino.py
514 515 516 517 518 519 520 521 522 523 524 525 | |
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
717 718 719 720 721 722 723 724 725 726 727 | |
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
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 | |
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=0
3. Parse the response to determine value, confirmations, and block time
Note: start_height=0 means a full scan from genesis. This is the safe default when we don't know when the bond UTXO was created. The neutrino-api caches filter data, so subsequent calls are faster.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
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 | |
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
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 | |
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
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 | |
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
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 | |
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
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 | |
Attributes
data_dir = data_dir
instance-attribute
listen_port = listen_port
instance-attribute
network = network
instance-attribute
peers = peers or []
instance-attribute
tor_socks = tor_socks
instance-attribute
Functions
__init__(network: str = 'mainnet', data_dir: str = '/data/neutrino', listen_port: int = 8334, peers: list[str] | None = None, tor_socks: str | None = None)
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")
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 | |
get_chain_params() -> dict[str, Any]
Get chain-specific parameters.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
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 | |
to_args() -> list[str]
Generate command-line arguments for neutrino daemon.
Source code in jmwallet/src/jmwallet/backends/neutrino.py
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 | |