taker.orderbook
taker.orderbook
Orderbook management and order selection for taker.
Implements: - Orderbook fetching from directory nodes - Order filtering by fee limits and amount ranges - Maker selection algorithms (fidelity bond weighted, random, cheapest) - Fee calculation for CoinJoin transactions
Classes
OrderbookManager
Manages orderbook state and maker selection.
Source code in taker/src/taker/orderbook.py
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 | |
Attributes
bondless_makers_allowance = bondless_makers_allowance
instance-attribute
bondless_require_zero_fee = bondless_require_zero_fee
instance-attribute
bonds: dict[str, Any] = {}
instance-attribute
honest_makers: set[str] = set()
instance-attribute
ignored_makers: set[str] = set()
instance-attribute
ignored_makers_path = get_ignored_makers_path(data_dir)
instance-attribute
max_cj_fee = max_cj_fee
instance-attribute
offers: list[Offer] = []
instance-attribute
own_wallet_nicks: set[str] = own_wallet_nicks or set()
instance-attribute
Functions
__init__(max_cj_fee: MaxCjFee, bondless_makers_allowance: float = 0.125, bondless_require_zero_fee: bool = True, data_dir: Any = None, own_wallet_nicks: set[str] | None = None)
Source code in taker/src/taker/orderbook.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 | |
add_honest_maker(maker: str) -> None
Mark a maker as honest (completed a CoinJoin successfully).
Source code in taker/src/taker/orderbook.py
781 782 783 784 | |
add_ignored_maker(maker: str) -> None
Add a maker to the ignored list and persist to disk.
Source code in taker/src/taker/orderbook.py
761 762 763 764 765 | |
clear_ignored_makers() -> None
Clear all ignored makers and delete the persistence file.
Source code in taker/src/taker/orderbook.py
767 768 769 770 771 772 773 774 775 776 777 778 779 | |
select_makers(cj_amount: int, n: int, honest_only: bool = False, min_nick_version: int | None = None, exclude_nicks: set[str] | None = None) -> tuple[dict[str, Offer], int]
Select makers for a CoinJoin.
Args: cj_amount: Target amount n: Number of makers honest_only: Only select from honest makers min_nick_version: Minimum required nick version (e.g., 6 for neutrino takers) exclude_nicks: Additional nicks to exclude (e.g., current session makers)
Returns: (selected offers dict, total fee)
Source code in taker/src/taker/orderbook.py
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 | |
select_makers_for_sweep(total_input_value: int, my_txfee: int, n: int, honest_only: bool = False, min_nick_version: int | None = None, exclude_nicks: set[str] | None = None) -> tuple[dict[str, Offer], int, int]
Select makers for a sweep CoinJoin.
Args: total_input_value: Total input value my_txfee: Taker's tx fee portion n: Number of makers honest_only: Only select from honest makers min_nick_version: Minimum required nick version (e.g., 6 for neutrino takers) exclude_nicks: Additional nicks to exclude (e.g., current session makers)
Returns: (selected offers dict, cj_amount, total fee)
Source code in taker/src/taker/orderbook.py
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 | |
update_offers(offers: list[Offer]) -> None
Update orderbook with new offers.
Source code in taker/src/taker/orderbook.py
756 757 758 759 | |
Functions
calculate_cj_fee(offer: Offer, cj_amount: int) -> int
Calculate the CoinJoin fee for a specific offer and amount.
Convenience wrapper around jmcore.models.calculate_cj_fee that accepts an Offer object directly.
Args: offer: The maker's offer cj_amount: The CoinJoin amount in satoshis
Returns: Fee in satoshis
Source code in taker/src/taker/orderbook.py
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | |
cheapest_order_choose(offers: list[Offer], n: int, cj_amount: int = 0) -> list[Offer]
Choose n cheapest offers.
Args: offers: Eligible offers n: Number of offers to choose cj_amount: CoinJoin amount for fee calculation (default uses 1 BTC)
Returns: Selected offers (sorted by fee, cheapest first)
Source code in taker/src/taker/orderbook.py
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | |
choose_orders(offers: list[Offer], cj_amount: int, n: int, max_cj_fee: MaxCjFee, choose_fn: Callable[[list[Offer], int], list[Offer]] | None = None, ignored_makers: set[str] | None = None, min_nick_version: int | None = None, bondless_makers_allowance: float = 0.125, bondless_require_zero_fee: bool = True) -> tuple[dict[str, Offer], int]
Choose n orders from the orderbook for a CoinJoin.
Args: offers: All offers from orderbook cj_amount: Target CoinJoin amount n: Number of makers to select max_cj_fee: Fee limits choose_fn: Selection algorithm (default: fidelity_bond_weighted_choose) ignored_makers: Makers to exclude min_nick_version: Minimum required nick version (e.g., 6 for neutrino takers) bondless_makers_allowance: Probability of random selection vs fidelity bond weighting bondless_require_zero_fee: If True, bondless spots only select zero absolute fee offers
Returns: (dict of counterparty -> offer, total_cj_fee)
Source code in taker/src/taker/orderbook.py
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 | |
choose_sweep_orders(offers: list[Offer], total_input_value: int, my_txfee: int, n: int, max_cj_fee: MaxCjFee, choose_fn: Callable[[list[Offer], int], list[Offer]] | None = None, ignored_makers: set[str] | None = None, min_nick_version: int | None = None, bondless_makers_allowance: float = 0.125, bondless_require_zero_fee: bool = True) -> tuple[dict[str, Offer], int, int]
Choose n orders for a sweep transaction (no change).
For sweeps, we need to solve for cj_amount such that: my_change = total_input - cj_amount - sum(cjfees) - my_txfee = 0
Args: offers: All offers from orderbook total_input_value: Total value of taker's inputs my_txfee: Taker's portion of transaction fee n: Number of makers to select max_cj_fee: Fee limits choose_fn: Selection algorithm ignored_makers: Makers to exclude min_nick_version: Minimum required nick version (e.g., 6 for neutrino takers) bondless_makers_allowance: Probability of random selection vs fidelity bond weighting bondless_require_zero_fee: If True, bondless spots only select zero absolute fee offers
Returns: (dict of counterparty -> offer, cj_amount, total_cj_fee)
Source code in taker/src/taker/orderbook.py
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 | |
dedupe_offers_by_bond(offers: list[Offer], cj_amount: int) -> list[Offer]
Deduplicate offers by fidelity bond UTXO, keeping only the cheapest per bond.
This is a sybil protection measure: if two different counterparties (nicks) share the same fidelity bond UTXO, we should only select one of them. Otherwise, an attacker could create multiple nicks backed by the same bond and get selected multiple times in the same CoinJoin.
Offers without a fidelity bond are passed through unchanged.
Args: offers: List of offers (possibly from different makers using same bond) cj_amount: The actual CoinJoin amount for accurate fee comparison
Returns: List with at most one offer per bond UTXO (the cheapest), plus all unbonded offers
Source code in taker/src/taker/orderbook.py
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 | |
dedupe_offers_by_maker(offers: list[Offer]) -> list[Offer]
Keep only the cheapest offer from each maker.
Args: offers: List of offers (possibly multiple per maker)
Returns: List with at most one offer per maker (the cheapest)
Source code in taker/src/taker/orderbook.py
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 | |
fidelity_bond_weighted_choose(offers: list[Offer], n: int, bondless_makers_allowance: float = 0.125, bondless_require_zero_fee: bool = True, cj_amount: int = 0) -> list[Offer]
Choose n offers with mixed fidelity bond and random selection.
Strategy: 1. Calculate proportion of bonded slots: round(n * (1 - bondless_makers_allowance)) 2. Fill bonded slots using weighted selection by bond value 3. Fill remaining slots randomly from ALL remaining offers (bonded or bondless)
"Bondless" means bond-agnostic (equal probability), not anti-bond. The bondless slots give all remaining makers equal opportunity regardless of their bond status.
This ensures high-bond makers are prioritized while still allowing new/bondless makers to participate in a predictable proportion.
Args: offers: Eligible offers n: Number of offers to choose bondless_makers_allowance: Proportion of slots for random selection (0.0-1.0) bondless_require_zero_fee: If True, bondless spots only select zero-fee offers cj_amount: CoinJoin amount for fee filtering (unused currently)
Returns: Selected offers
Source code in taker/src/taker/orderbook.py
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 | |
filter_offers(offers: list[Offer], cj_amount: int, max_cj_fee: MaxCjFee, ignored_makers: set[str] | None = None, allowed_types: set[OfferType] | None = None, min_nick_version: int | None = None) -> list[Offer]
Filter offers based on amount range, fee limits, and other criteria.
Args: offers: List of all offers cj_amount: Target CoinJoin amount max_cj_fee: Fee limits ignored_makers: Set of maker nicks to exclude allowed_types: Set of allowed offer types (default: all sw0* types) min_nick_version: Minimum nick version for reference compatibility (not used for neutrino detection - that uses handshake features instead)
Returns: List of eligible offers
Source code in taker/src/taker/orderbook.py
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 | |
is_fee_within_limits(offer: Offer, cj_amount: int, max_cj_fee: MaxCjFee) -> bool
Check if an offer's fee is within the configured limits.
For absolute offers: check cjfee <= abs_fee For relative offers: check cjfee <= rel_fee
It's a logical OR - an offer passes if it meets either limit for its type.
Args: offer: The maker's offer cj_amount: The CoinJoin amount (not used in the new logic) max_cj_fee: Fee limits configuration
Returns: True if fee is acceptable
Source code in taker/src/taker/orderbook.py
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 | |
random_order_choose(offers: list[Offer], n: int) -> list[Offer]
Choose n offers randomly.
Args: offers: Eligible offers n: Number of offers to choose
Returns: Selected offers
Source code in taker/src/taker/orderbook.py
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 | |
weighted_order_choose(offers: list[Offer], n: int, cj_amount: int = 0, exponent: float = 3.0) -> list[Offer]
Choose n offers with exponential weighting by inverse fee.
Cheaper offers are more likely to be selected.
Args: offers: Eligible offers n: Number of offers to choose cj_amount: CoinJoin amount for fee calculation exponent: Higher values favor cheaper offers more strongly
Returns: Selected offers
Source code in taker/src/taker/orderbook.py
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 | |