taker.taker
taker.taker
Main Taker class for CoinJoin execution.
Orchestrates the complete CoinJoin protocol: 1. Fetch orderbook from directory nodes 2. Select makers and generate PoDLE commitment 3. Send !fill requests and receive !pubkey responses 4. Send !auth with PoDLE proof and receive !ioauth (maker UTXOs) 5. Build unsigned transaction and send !tx 6. Collect !sig responses and broadcast
Reference: Original joinmarket-clientserver/src/jmclient/taker.py
Attributes
__all__ = ['MultiDirectoryClient', 'TakerState', 'MakerSession', 'PhaseResult', 'Taker', 'warn_if_destination_script_mismatch']
module-attribute
Classes
MakerSession
Session data for a single maker.
Source code in taker/src/taker/models.py
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 | |
Attributes
auth_pubkey: str = ''
class-attribute
instance-attribute
change_address: str = ''
class-attribute
instance-attribute
cj_address: str = ''
class-attribute
instance-attribute
comm_channel: str = ''
class-attribute
instance-attribute
crypto: CryptoSession | None = None
class-attribute
instance-attribute
nick: str
instance-attribute
offer: Offer
instance-attribute
pubkey: str = ''
class-attribute
instance-attribute
responded_auth: bool = False
class-attribute
instance-attribute
responded_fill: bool = False
class-attribute
instance-attribute
responded_sig: bool = False
class-attribute
instance-attribute
signature: dict[str, Any] | None = None
class-attribute
instance-attribute
supports_neutrino_compat: bool = False
class-attribute
instance-attribute
utxos: list[dict[str, Any]] = Field(default_factory=list)
class-attribute
instance-attribute
MultiDirectoryClient
Bases: DirectoryClientPool
Wrapper for managing multiple DirectoryClient connections.
Provides a unified interface for connecting to multiple directory servers and aggregating orderbook data. Implements multi-directory aware nick tracking - a nick is only considered "gone" when ALL directories report it as disconnected.
Direct Peer Connections: When enabled (prefer_direct_connections=True), the client will establish direct Tor connections to makers when possible, bypassing directory servers for private messages. This improves privacy by preventing directories from observing who is communicating with whom.
Connection flow: 1. First message to a maker goes via directory relay 2. Opportunistically starts direct connection in background 3. Subsequent messages prefer direct connection if available 4. Falls back to directory relay if direct connection fails
This prevents premature maker removal when: - A maker temporarily disconnects from one directory but remains on others - Directory connections are flaky or experiencing network issues - There's a race condition between directory updates
Reference: JoinMarket onionmc.py lines 1078-1103
Source code in taker/src/taker/multi_directory.py
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 | |
Attributes
neutrino_compat = neutrino_compat
instance-attribute
nick = nick_identity.nick
instance-attribute
on_nick_leave = on_nick_leave
instance-attribute
our_location = our_location
instance-attribute
prefer_direct_connections = prefer_direct_connections
instance-attribute
Methods:
__init__(directory_servers: list[str], network: str, nick_identity: NickIdentity, socks_host: str = '127.0.0.1', socks_port: int = 9050, connection_timeout: float = 120.0, neutrino_compat: bool = False, on_nick_leave: Any | None = None, prefer_direct_connections: bool = True, our_location: str = 'NOT-SERVING-ONION', stream_isolation: bool = False, nick_auth_mode: NickAuthMode = NickAuthMode.PREFER_VERIFIED, nick_auth_directory_ids: dict[str, str] | None = None)
Source code in taker/src/taker/multi_directory.py
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 | |
bind_session(nick: str) -> ChannelBinding | None
Pick and pin a single transport channel for a session with nick.
Encapsulates the channel-selection algorithm that callers
previously open-coded by reaching into private attributes
(_get_connected_peer, _active_nicks, clients,
_active_peers). The order is:
- If a direct peer connection is established and direct
connections are preferred, bind to
"direct". - Otherwise, prefer a directory server that our nick-tracking
layer marks as currently carrying
nick. - Otherwise, fall back to any directory whose peerlist lists the nick.
- Otherwise, fall back to an arbitrary connected directory.
Returns None only when no directories are connected, in which
case the caller cannot send anything anyway.
The returned :class:ChannelBinding should be reused for every
subsequent message to nick in the same session: makers reject
sessions whose !fill and !auth arrive via different
channels.
Source code in taker/src/taker/multi_directory.py
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 | |
close_all() -> None
async
Close all directory and peer connections.
Peer (direct onion) connections are torn down first so any
outgoing per-peer messages have a chance to flush before we
close the relay channels. Directory client teardown is handled
by :meth:DirectoryClientPool.close_all.
Source code in taker/src/taker/multi_directory.py
495 496 497 498 499 500 501 502 503 504 | |
connect_all() -> int
async
Connect to all directory servers in parallel.
Thin compatibility wrapper around
:meth:DirectoryClientPool.connect_all_parallel that preserves
the historical name used by the taker codebase.
Source code in taker/src/taker/multi_directory.py
486 487 488 489 490 491 492 493 | |
fetch_orderbook(max_wait: float = 120.0, min_wait: float = 30.0, quiet_period: float = 15.0) -> list[Offer]
async
Fetch orderbook from all connected directory servers in parallel.
Trusts the directory's orderbook as authoritative - if a maker has an offer in the directory, they are considered online. This avoids incorrectly filtering offers as "stale" based on slow peerlist responses.
Args: max_wait: Hard ceiling in seconds (default: 120s). min_wait: Minimum seconds before early exit is allowed (default: 30s). quiet_period: Seconds of silence before exiting early (default: 15s).
Source code in taker/src/taker/multi_directory.py
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 | |
get_connected_peer(nick: str) -> OnionPeer | None
Public alias for _get_connected_peer.
Source code in taker/src/taker/multi_directory.py
385 386 387 | |
get_peer_location(nick: str) -> str | None
Public alias for _get_peer_location.
Source code in taker/src/taker/multi_directory.py
381 382 383 | |
get_pending_connect_task(nick: str) -> asyncio.Task[bool] | None
Return the in-flight direct-connect task for nick, if any.
Source code in taker/src/taker/multi_directory.py
389 390 391 | |
is_nick_active(nick: str) -> bool
Check if a nick is active on at least one directory server.
Returns: True if nick is present on at least one server
Source code in taker/src/taker/multi_directory.py
177 178 179 180 181 182 183 184 185 186 | |
send_privmsg(recipient: str, command: str, data: str, log_routing: bool = False, force_channel: str | None = None) -> str
async
Send a private message, respecting channel consistency for CoinJoin sessions.
CRITICAL: Within a single CoinJoin session, all messages to a maker MUST use the same communication channel (either direct or a specific directory). Mixing channels causes the maker to reject messages as they appear to be from different sessions.
Message routing priority (when force_channel is None): 1. Direct peer connection (if connected and prefer_direct_connections=True) 2. Directory relay (fallback)
Args:
recipient: Target maker nick
command: Command name (without ! prefix)
data: Command arguments
log_routing: If True, log detailed routing information
force_channel: If set, only use this channel:
- "direct" = peer-to-peer onion connection
- "directory:
Returns:
Channel used: "direct" or "directory:
Source code in taker/src/taker/multi_directory.py
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 | |
sync_nicks_with_peerlist(server: str, active_nicks: set[str]) -> None
Synchronize nick tracking with a directory's peerlist.
This is called after fetching a peerlist from a directory to update the nick tracking state. Nicks not in the peerlist are marked as gone from that directory.
Args: server: The server identifier reporting the peerlist active_nicks: Set of nicks currently active on this server
Source code in taker/src/taker/multi_directory.py
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | |
try_direct_connect(nick: str) -> None
Public alias for _try_direct_connect.
Kicks off an opportunistic background connection attempt to
nick. Safe to call repeatedly: the underlying method is a
no-op when a connection (or pending task) already exists.
Source code in taker/src/taker/multi_directory.py
371 372 373 374 375 376 377 378 379 | |
upgrade_channel_prefer_direct(nick: str, current_channel: str) -> str
Opportunistically upgrade a session channel to a direct connection.
A session pins one channel before sending !fill (see
:meth:bind_session). When !fill is sent via a directory while a
direct connection is still being established, that connection often
finishes handshaking before the taker sends !auth/!tx. This
mirrors the reference taker, which routes each privmsg
opportunistically (jmdaemon/onionmc.py::_privmsg): once the direct
peer is handshaked, later messages travel directly.
Makers accept such mid-session directory->direct switches (the signed
hostid is the fixed onion-network for all onion transports), so
upgrading improves privacy and latency without breaking compatibility.
We only ever upgrade directory->direct, never the reverse: if the session is already direct we keep it, and we never downgrade a direct session to a directory relay here.
Args:
nick: The maker nick whose session channel to re-evaluate.
current_channel: The channel currently pinned for the session
("direct" or "directory:<server>").
Returns:
"direct" if a handshaked direct connection is now available,
otherwise current_channel unchanged.
Source code in taker/src/taker/multi_directory.py
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 | |
wait_for_response(from_nick: str, expected_command: str, timeout: float = 30.0) -> dict[str, Any] | None
async
Wait for a specific response from a maker (legacy method).
Source code in taker/src/taker/multi_directory.py
898 899 900 901 902 903 904 905 906 | |
wait_for_responses(expected_nicks: list[str], expected_command: str, timeout: float = 60.0, expected_counts: dict[str, int] | None = None) -> dict[str, dict[str, Any]]
async
Wait for responses from multiple makers at once.
Listens for responses from BOTH: - Directory server message streams (via client.listen_for_messages()) - Direct peer connections (via self._direct_message_queue)
Returns a dict of nick -> response data for all makers that responded. Responses can include: - Normal responses matching expected_command - Error responses marked with "error": True
Error handling: - Makers may send !error messages instead of the expected response - These indicate protocol failures (e.g., blacklisted PoDLE commitment) - Errors are returned in the response dict with {"error": True, "data": "reason"}
Deduplication: - When connected to multiple directory servers, the same response may arrive multiple times. ResponseDeduplicator tracks which responses we've seen and logs duplicates for debugging.
Special handling for !sig: - Makers send multiple !sig messages (one per UTXO) - We accumulate all messages in a list instead of keeping just the last one - Use expected_counts to specify how many signatures to expect per maker - Returns as soon as all expected signatures are received
Args: expected_nicks: List of maker nicks to expect responses from expected_command: Command to wait for (e.g., "!pubkey", "!sig") timeout: Maximum time to wait in seconds expected_counts: For !sig, dict of nick -> expected signature count
Source code in taker/src/taker/multi_directory.py
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 | |
PhaseResult
Result from a CoinJoin phase with failed maker tracking.
Used to communicate phase outcomes and enable maker replacement logic.
Source code in taker/src/taker/models.py
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 | |
Attributes
blacklist_error: bool = False
class-attribute
instance-attribute
blacklist_makers: list[str] = Field(default_factory=list)
class-attribute
instance-attribute
failed_makers: list[str] = Field(default_factory=list)
class-attribute
instance-attribute
needs_replacement: bool
property
True if phase failed due to non-responsive makers (not other errors).
success: bool
instance-attribute
Taker
Bases: TakerMonitoringMixin
Main Taker class for executing CoinJoin transactions.
Source code in taker/src/taker/taker.py
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 | |
Attributes
backend = backend
instance-attribute
config = config
instance-attribute
confirmation_callback = confirmation_callback
instance-attribute
directory_client = MultiDirectoryClient(directory_servers=(config.directory_servers), network=(config.network.value), nick_identity=(self.nick_identity), socks_host=(config.socks_host), socks_port=(config.socks_port), connection_timeout=(config.connection_timeout), nick_auth_mode=(config.nick_auth_mode), nick_auth_directory_ids=(config.nick_auth_directory_ids), neutrino_compat=neutrino_compat, stream_isolation=(config.stream_isolation))
instance-attribute
last_failure_reason: str | None
property
Reason the most recent do_coinjoin call failed (or None).
Forwarded from the per-round :class:CoinJoinSession so external
consumers (e.g. the tumbler runner) can surface why a round did not
broadcast without reaching into private session state.
last_source_mixdepth: int | None = None
instance-attribute
last_used_nicks: set[str]
property
Maker nicks used by the most recent do_coinjoin call.
nick = self.nick_identity.nick
instance-attribute
nick_identity = NickIdentity(JM_VERSION)
instance-attribute
orderbook_manager = OrderbookManager(config.max_cj_fee, bondless_makers_allowance=(config.bondless_makers_allowance), bondless_require_zero_fee=(config.bondless_makers_allowance_require_zero_fee), data_dir=(config.data_dir), own_wallet_nicks=own_wallet_nicks)
instance-attribute
podle_manager = PoDLEManager(config.data_dir)
instance-attribute
running = False
instance-attribute
schedule: Schedule | None = None
instance-attribute
state = TakerState.IDLE
instance-attribute
wallet = wallet
instance-attribute
Methods:
__init__(wallet: WalletService, backend: BlockchainBackend, config: TakerConfig, confirmation_callback: Any | None = None)
Initialize the Taker.
Args: wallet: Wallet service for UTXO management and signing backend: Blockchain backend for broadcasting config: Taker configuration confirmation_callback: Optional callback for user confirmation before proceeding
Source code in taker/src/taker/taker.py
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 | |
check_utxo_eligibility(amount: int, mixdepth: int | None) -> str | None
async
Validate that mixdepth can fund a CoinJoin of amount.
Runs the same eligibility filters used later in :meth:do_coinjoin
(confirmations, frozen, fidelity bonds, in-flight locks, the mixdepth-0
merge restriction and the PoDLE size requirement) before any network
operation, so an ineligible wallet fails fast instead of after a long
directory/orderbook/bond cycle (issue #528).
Args:
amount: Target amount in satoshis (0 for sweep).
mixdepth: Source mixdepth. None is only meaningful with
interactive selection (select_utxos), where it means "any
mixdepth" (the source is derived from the selection later);
otherwise it falls back to mixdepth 0.
Returns:
None when a CoinJoin can proceed, otherwise a human-readable
reason describing why it cannot.
Source code in taker/src/taker/taker.py
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 | |
connect() -> None
async
Connect to directory servers and start background tasks.
This should be called after sync_wallet() and any fund validation.
Source code in taker/src/taker/taker.py
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 | |
do_coinjoin(amount: int, destination: str, mixdepth: int | None = None, counterparty_count: int | None = None, exclude_nicks: set[str] | None = None) -> str | None
async
Run one CoinJoin with fresh, non-reusable per-round state.
Source code in taker/src/taker/taker.py
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 | |
release_input_locks() -> None
Clean up persisted CoinJoin locks held on this round's taker inputs.
Pre-sign failures release immediately. Once signatures may exist, the owner-qualified leases are renewed through the pending window instead.
Source code in taker/src/taker/taker.py
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 | |
run_schedule(schedule: Schedule) -> bool
async
Run a tumbler-style schedule of CoinJoins.
Args: schedule: Schedule with multiple CoinJoin entries
Returns: True if all entries completed successfully
Source code in taker/src/taker/taker.py
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 | |
start() -> None
async
Start the taker: sync wallet and connect to directory servers.
This is a convenience method that calls sync_wallet() followed by connect(). For early fund validation, call sync_wallet() first, validate, then call connect().
Source code in taker/src/taker/taker.py
272 273 274 275 276 277 278 279 280 | |
stop(*, close_wallet: bool = True) -> None
async
Stop the taker and close connections.
Args:
close_wallet: If True (the default), also close the wallet's
backend connection. Pass False when the wallet is shared
with another component (e.g. a jmwalletd tumbler runner that
will reuse the same :class:~jmwallet.wallet.service.WalletService
instance across multiple taker phases) to avoid tearing down a
still-in-use wallet.
Source code in taker/src/taker/taker.py
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 | |
sync_wallet() -> int
async
Sync the wallet and return total balance.
This method is separated from start() to allow callers to check funds before connecting to directory servers (avoiding unnecessary network connections when funds are insufficient).
Returns: Total wallet balance in satoshis.
Source code in taker/src/taker/taker.py
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 | |
TakerState
Bases: StrEnum
Taker protocol states.
Source code in taker/src/taker/models.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 | |
Attributes
AUTHENTICATING = 'authenticating'
class-attribute
instance-attribute
BROADCASTING = 'broadcasting'
class-attribute
instance-attribute
BUILDING_TX = 'building_tx'
class-attribute
instance-attribute
CANCELLED = 'cancelled'
class-attribute
instance-attribute
COLLECTING_SIGNATURES = 'collecting_signatures'
class-attribute
instance-attribute
COMPLETE = 'complete'
class-attribute
instance-attribute
FAILED = 'failed'
class-attribute
instance-attribute
FETCHING_ORDERBOOK = 'fetching_orderbook'
class-attribute
instance-attribute
FILLING = 'filling'
class-attribute
instance-attribute
IDLE = 'idle'
class-attribute
instance-attribute
SELECTING_MAKERS = 'selecting_makers'
class-attribute
instance-attribute
Functions:
warn_if_destination_script_mismatch(destination: str) -> str | None
Emit a warning when the destination address does not match the wallet's native script type. Returns the detected destination type on mismatch, None otherwise (matched type, or unparseable address - the canonical validation error is produced later in the pipeline).
See issue #113.
Source code in taker/src/taker/taker.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | |