Skip to content

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
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
class OrderbookManager:
    """Manages orderbook state and maker selection."""

    def __init__(
        self,
        max_cj_fee: MaxCjFee,
        bondless_makers_allowance: float = 0.2,
        bondless_require_zero_fee: bool = True,
        data_dir: Any = None,  # Path | None, but avoid import
        own_wallet_nicks: set[str] | None = None,
    ):
        self.max_cj_fee = max_cj_fee
        self.bondless_makers_allowance = bondless_makers_allowance
        self.bondless_require_zero_fee = bondless_require_zero_fee
        self.offers: list[Offer] = []
        self.bonds: dict[str, Any] = {}  # maker -> bond info
        self.ignored_makers: set[str] = set()
        self.honest_makers: set[str] = set()

        # Own wallet nicks to exclude from peer selection (e.g., same wallet's maker nick)
        # This is populated from state files and protects against self-CoinJoins
        self.own_wallet_nicks: set[str] = own_wallet_nicks or set()
        if self.own_wallet_nicks:
            logger.info(f"Excluding own wallet nicks from peer selection: {self.own_wallet_nicks}")

        # Persistence for ignored makers
        self.ignored_makers_path = get_ignored_makers_path(data_dir)
        self._load_ignored_makers()

    def _load_ignored_makers(self) -> None:
        """Load ignored makers from disk."""
        if not self.ignored_makers_path.exists():
            logger.debug(f"No existing ignored makers file at {self.ignored_makers_path}")
            return

        try:
            with open(self.ignored_makers_path, encoding="utf-8") as f:
                for line in f:
                    maker = line.strip()
                    if maker:
                        self.ignored_makers.add(maker)
            if self.ignored_makers:
                logger.info(
                    f"Loaded {len(self.ignored_makers)} ignored makers from "
                    f"{self.ignored_makers_path}"
                )
        except Exception as e:
            logger.error(f"Failed to load ignored makers from {self.ignored_makers_path}: {e}")

    def _save_ignored_makers(self) -> None:
        """Save ignored makers to disk."""
        try:
            # Ensure parent directory exists
            self.ignored_makers_path.parent.mkdir(parents=True, exist_ok=True)

            with open(self.ignored_makers_path, "w", encoding="utf-8") as f:
                for maker in sorted(self.ignored_makers):
                    f.write(maker + "\n")
                f.flush()
            logger.debug(
                f"Saved {len(self.ignored_makers)} ignored makers to {self.ignored_makers_path}"
            )
        except Exception as e:
            logger.error(f"Failed to save ignored makers to {self.ignored_makers_path}: {e}")

    def update_offers(self, offers: list[Offer]) -> None:
        """Update orderbook with new offers."""
        self.offers = offers
        logger.info(f"Updated orderbook with {len(offers)} offers")

    def add_ignored_maker(self, maker: str) -> None:
        """Add a maker to the ignored list and persist to disk."""
        self.ignored_makers.add(maker)
        logger.info(f"Added {maker} to ignored makers list")
        self._save_ignored_makers()

    def clear_ignored_makers(self) -> None:
        """Clear all ignored makers and delete the persistence file."""
        count = len(self.ignored_makers)
        self.ignored_makers.clear()
        logger.info(f"Cleared {count} ignored makers")

        # Delete the file if it exists
        try:
            if self.ignored_makers_path.exists():
                self.ignored_makers_path.unlink()
                logger.debug(f"Deleted {self.ignored_makers_path}")
        except Exception as e:
            logger.error(f"Failed to delete {self.ignored_makers_path}: {e}")

    def add_honest_maker(self, maker: str) -> None:
        """Mark a maker as honest (completed a CoinJoin successfully)."""
        self.honest_makers.add(maker)
        logger.debug(f"Added {maker} to honest makers list")

    def select_makers(
        self,
        cj_amount: int,
        n: int,
        honest_only: bool = False,
        min_nick_version: int | None = None,
        exclude_nicks: set[str] | None = None,
        required_features: 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)
            required_features: Feature names that makers must support

        Returns:
            (selected offers dict, total fee)
        """
        available_offers = self.offers

        if honest_only:
            available_offers = [o for o in self.offers if o.counterparty in self.honest_makers]

        # Combine ignored_makers, own_wallet_nicks, and any additional excluded nicks
        combined_ignored = self.ignored_makers.copy()
        combined_ignored.update(self.own_wallet_nicks)
        if exclude_nicks:
            combined_ignored.update(exclude_nicks)

        return choose_orders(
            offers=available_offers,
            cj_amount=cj_amount,
            n=n,
            max_cj_fee=self.max_cj_fee,
            ignored_makers=combined_ignored,
            min_nick_version=min_nick_version,
            bondless_makers_allowance=self.bondless_makers_allowance,
            bondless_require_zero_fee=self.bondless_require_zero_fee,
            required_features=required_features,
        )

    def select_makers_for_sweep(
        self,
        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,
        required_features: 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)
            required_features: Feature names that makers must support

        Returns:
            (selected offers dict, cj_amount, total fee)
        """
        available_offers = self.offers

        if honest_only:
            available_offers = [o for o in self.offers if o.counterparty in self.honest_makers]

        # Combine ignored_makers, own_wallet_nicks, and any additional excluded nicks
        combined_ignored = self.ignored_makers.copy()
        combined_ignored.update(self.own_wallet_nicks)
        if exclude_nicks:
            combined_ignored.update(exclude_nicks)

        return choose_sweep_orders(
            offers=available_offers,
            total_input_value=total_input_value,
            my_txfee=my_txfee,
            n=n,
            max_cj_fee=self.max_cj_fee,
            ignored_makers=combined_ignored,
            min_nick_version=min_nick_version,
            bondless_makers_allowance=self.bondless_makers_allowance,
            bondless_require_zero_fee=self.bondless_require_zero_fee,
            required_features=required_features,
        )
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.2, 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
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
def __init__(
    self,
    max_cj_fee: MaxCjFee,
    bondless_makers_allowance: float = 0.2,
    bondless_require_zero_fee: bool = True,
    data_dir: Any = None,  # Path | None, but avoid import
    own_wallet_nicks: set[str] | None = None,
):
    self.max_cj_fee = max_cj_fee
    self.bondless_makers_allowance = bondless_makers_allowance
    self.bondless_require_zero_fee = bondless_require_zero_fee
    self.offers: list[Offer] = []
    self.bonds: dict[str, Any] = {}  # maker -> bond info
    self.ignored_makers: set[str] = set()
    self.honest_makers: set[str] = set()

    # Own wallet nicks to exclude from peer selection (e.g., same wallet's maker nick)
    # This is populated from state files and protects against self-CoinJoins
    self.own_wallet_nicks: set[str] = own_wallet_nicks or set()
    if self.own_wallet_nicks:
        logger.info(f"Excluding own wallet nicks from peer selection: {self.own_wallet_nicks}")

    # Persistence for ignored makers
    self.ignored_makers_path = get_ignored_makers_path(data_dir)
    self._load_ignored_makers()
add_honest_maker(maker: str) -> None

Mark a maker as honest (completed a CoinJoin successfully).

Source code in taker/src/taker/orderbook.py
803
804
805
806
def add_honest_maker(self, maker: str) -> None:
    """Mark a maker as honest (completed a CoinJoin successfully)."""
    self.honest_makers.add(maker)
    logger.debug(f"Added {maker} to honest makers list")
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
783
784
785
786
787
def add_ignored_maker(self, maker: str) -> None:
    """Add a maker to the ignored list and persist to disk."""
    self.ignored_makers.add(maker)
    logger.info(f"Added {maker} to ignored makers list")
    self._save_ignored_makers()
clear_ignored_makers() -> None

Clear all ignored makers and delete the persistence file.

Source code in taker/src/taker/orderbook.py
789
790
791
792
793
794
795
796
797
798
799
800
801
def clear_ignored_makers(self) -> None:
    """Clear all ignored makers and delete the persistence file."""
    count = len(self.ignored_makers)
    self.ignored_makers.clear()
    logger.info(f"Cleared {count} ignored makers")

    # Delete the file if it exists
    try:
        if self.ignored_makers_path.exists():
            self.ignored_makers_path.unlink()
            logger.debug(f"Deleted {self.ignored_makers_path}")
    except Exception as e:
        logger.error(f"Failed to delete {self.ignored_makers_path}: {e}")
select_makers(cj_amount: int, n: int, honest_only: bool = False, min_nick_version: int | None = None, exclude_nicks: set[str] | None = None, required_features: 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) required_features: Feature names that makers must support

Returns: (selected offers dict, total fee)

Source code in taker/src/taker/orderbook.py
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
def select_makers(
    self,
    cj_amount: int,
    n: int,
    honest_only: bool = False,
    min_nick_version: int | None = None,
    exclude_nicks: set[str] | None = None,
    required_features: 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)
        required_features: Feature names that makers must support

    Returns:
        (selected offers dict, total fee)
    """
    available_offers = self.offers

    if honest_only:
        available_offers = [o for o in self.offers if o.counterparty in self.honest_makers]

    # Combine ignored_makers, own_wallet_nicks, and any additional excluded nicks
    combined_ignored = self.ignored_makers.copy()
    combined_ignored.update(self.own_wallet_nicks)
    if exclude_nicks:
        combined_ignored.update(exclude_nicks)

    return choose_orders(
        offers=available_offers,
        cj_amount=cj_amount,
        n=n,
        max_cj_fee=self.max_cj_fee,
        ignored_makers=combined_ignored,
        min_nick_version=min_nick_version,
        bondless_makers_allowance=self.bondless_makers_allowance,
        bondless_require_zero_fee=self.bondless_require_zero_fee,
        required_features=required_features,
    )
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, required_features: 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) required_features: Feature names that makers must support

Returns: (selected offers dict, cj_amount, total fee)

Source code in taker/src/taker/orderbook.py
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
def select_makers_for_sweep(
    self,
    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,
    required_features: 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)
        required_features: Feature names that makers must support

    Returns:
        (selected offers dict, cj_amount, total fee)
    """
    available_offers = self.offers

    if honest_only:
        available_offers = [o for o in self.offers if o.counterparty in self.honest_makers]

    # Combine ignored_makers, own_wallet_nicks, and any additional excluded nicks
    combined_ignored = self.ignored_makers.copy()
    combined_ignored.update(self.own_wallet_nicks)
    if exclude_nicks:
        combined_ignored.update(exclude_nicks)

    return choose_sweep_orders(
        offers=available_offers,
        total_input_value=total_input_value,
        my_txfee=my_txfee,
        n=n,
        max_cj_fee=self.max_cj_fee,
        ignored_makers=combined_ignored,
        min_nick_version=min_nick_version,
        bondless_makers_allowance=self.bondless_makers_allowance,
        bondless_require_zero_fee=self.bondless_require_zero_fee,
        required_features=required_features,
    )
update_offers(offers: list[Offer]) -> None

Update orderbook with new offers.

Source code in taker/src/taker/orderbook.py
778
779
780
781
def update_offers(self, offers: list[Offer]) -> None:
    """Update orderbook with new offers."""
    self.offers = offers
    logger.info(f"Updated orderbook with {len(offers)} offers")

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
def 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
    """
    return _calculate_cj_fee_raw(offer.ordertype, offer.cjfee, cj_amount)

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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
def 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)
    """
    if cj_amount == 0:
        cj_amount = 100_000_000  # 1 BTC

    sorted_offers = sorted(offers, key=lambda o: calculate_cj_fee(o, cj_amount))
    return sorted_offers[:n]

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.2, bondless_require_zero_fee: bool = True, required_features: set[str] | None = None) -> 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 required_features: Feature names that makers must support (passed to filter_offers)

Returns: (dict of counterparty -> offer, total_cj_fee)

Source code in taker/src/taker/orderbook.py
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
def 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.2,
    bondless_require_zero_fee: bool = True,
    required_features: set[str] | None = None,
) -> 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
        required_features: Feature names that makers must support (passed to filter_offers)

    Returns:
        (dict of counterparty -> offer, total_cj_fee)
    """
    if choose_fn is None:
        # Use partial to bind bondless_makers_allowance and bondless_require_zero_fee
        from functools import partial

        choose_fn = partial(
            fidelity_bond_weighted_choose,
            bondless_makers_allowance=bondless_makers_allowance,
            bondless_require_zero_fee=bondless_require_zero_fee,
            cj_amount=cj_amount,
        )

    # Filter offers
    eligible = filter_offers(
        offers=offers,
        cj_amount=cj_amount,
        max_cj_fee=max_cj_fee,
        ignored_makers=ignored_makers,
        min_nick_version=min_nick_version,
        required_features=required_features,
    )

    # Dedupe by maker (keep cheapest offer per counterparty)
    deduped_by_maker = dedupe_offers_by_maker(eligible)

    # Dedupe by bond UTXO (sybil protection: keep cheapest offer per bond)
    # This must come after maker dedup so we compare the best offer from each nick
    deduped = dedupe_offers_by_bond(deduped_by_maker, cj_amount)

    if len(deduped) < n:
        logger.warning(
            f"Not enough makers: need {n}, found {len(deduped)} (from {len(offers)} total offers)"
        )
        n = len(deduped)

    # Select makers
    selected = choose_fn(deduped, n)

    # Build result
    result = {offer.counterparty: offer for offer in selected}

    # Calculate total fee
    total_fee = sum(calculate_cj_fee(offer, cj_amount) for offer in selected)

    logger.info(
        f"Selected {len(result)} makers from {len(offers)} offers, total fee: {total_fee} sats"
    )

    return result, total_fee

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.2, bondless_require_zero_fee: bool = True, required_features: set[str] | None = None) -> 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 required_features: Feature names that makers must support (passed to filter_offers)

Returns: (dict of counterparty -> offer, cj_amount, total_cj_fee)

Source code in taker/src/taker/orderbook.py
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
def 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.2,
    bondless_require_zero_fee: bool = True,
    required_features: set[str] | None = None,
) -> 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
        required_features: Feature names that makers must support (passed to filter_offers)

    Returns:
        (dict of counterparty -> offer, cj_amount, total_cj_fee)
    """
    if choose_fn is None:
        from functools import partial

        choose_fn = partial(
            fidelity_bond_weighted_choose,
            bondless_makers_allowance=bondless_makers_allowance,
            bondless_require_zero_fee=bondless_require_zero_fee,
        )

    if ignored_makers is None:
        ignored_makers = set()

    # For sweep, we need to find offers that work for the available amount
    # First estimate: cj_amount = total_input - my_txfee - estimated_fees
    # Assume ~0.1% per maker for estimation
    estimated_rel_fees = ["0.001"] * n
    estimated_cj_amount = calculate_sweep_amount(total_input_value - my_txfee, estimated_rel_fees)

    # Filter with estimated amount
    eligible = filter_offers(
        offers=offers,
        cj_amount=estimated_cj_amount,
        max_cj_fee=max_cj_fee,
        ignored_makers=ignored_makers,
        min_nick_version=min_nick_version,
        required_features=required_features,
    )

    # Dedupe by maker
    deduped_by_maker = dedupe_offers_by_maker(eligible)

    # Dedupe by bond UTXO (sybil protection)
    # Use estimated_cj_amount for fee comparison since we don't know exact amount yet
    deduped = dedupe_offers_by_bond(deduped_by_maker, estimated_cj_amount)

    logger.debug(
        f"After deduplication: {len(deduped)} unique makers from {len(eligible)} eligible offers"
    )
    if len(deduped) < len(eligible):
        # Show which makers had multiple offers
        from collections import Counter

        maker_counts = Counter(o.counterparty for o in eligible)
        multi_offer_makers = {m: c for m, c in maker_counts.items() if c > 1}
        if multi_offer_makers:
            logger.debug(f"Makers with multiple offers: {multi_offer_makers}")

    if len(deduped) < n:
        logger.warning(
            f"Not enough makers for sweep: need {n}, found {len(deduped)} "
            f"(filtered from {len(offers)} total offers)"
        )
        # Can't proceed if we don't have at least 1 maker (minimum for a CoinJoin)
        if len(deduped) < 1:
            logger.error(
                "No makers available. "
                "Try relaxing fee limits or checking if makers are in ignored list."
            )
            return {}, 0, 0
        n = len(deduped)

    if n == 0:
        return {}, 0, 0

    # Select makers
    selected = choose_fn(deduped, n)

    # Now solve for exact cj_amount
    sum_abs_fees = 0
    rel_fees = []

    for offer in selected:
        if offer.ordertype in (OfferType.SW0_ABSOLUTE, OfferType.SWA_ABSOLUTE):
            sum_abs_fees += int(offer.cjfee)
        else:
            rel_fees.append(str(offer.cjfee))

    available = total_input_value - my_txfee - sum_abs_fees
    cj_amount = calculate_sweep_amount(available, rel_fees)

    # Verify this works for all selected offers
    for offer in selected:
        if cj_amount < offer.minsize or cj_amount > offer.maxsize:
            logger.error(
                f"Sweep amount {cj_amount} outside range for {offer.counterparty}: "
                f"{offer.minsize}-{offer.maxsize}"
            )
            # Could retry with fewer makers here

    result = {offer.counterparty: offer for offer in selected}
    total_fee = sum(calculate_cj_fee(offer, cj_amount) for offer in selected)

    logger.info(f"Sweep: selected {len(result)} makers, cj_amount={cj_amount}, fee={total_fee}")

    return result, cj_amount, total_fee

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
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
def 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
    """
    # Group bonded offers by bond UTXO
    by_bond: dict[str, list[Offer]] = {}
    unbonded: list[Offer] = []

    for offer in offers:
        bond_key = None
        if offer.fidelity_bond_data:
            # Use txid:vout as unique key
            bond_key = (
                f"{offer.fidelity_bond_data['utxo_txid']}:{offer.fidelity_bond_data['utxo_vout']}"
            )

        if bond_key:
            if bond_key not in by_bond:
                by_bond[bond_key] = []
            by_bond[bond_key].append(offer)
        else:
            unbonded.append(offer)

    # For each bond UTXO, keep only the cheapest offer
    result = []
    for bond_key, bond_offers in by_bond.items():
        sorted_offers = sorted(bond_offers, key=lambda o: calculate_cj_fee(o, cj_amount))
        result.append(sorted_offers[0])
        if len(bond_offers) > 1:
            kept = sorted_offers[0]
            dropped = [o.counterparty for o in sorted_offers[1:]]
            kept_fee = calculate_cj_fee(kept, cj_amount)
            logger.warning(
                f"Bond sybil protection: Kept {kept.counterparty} (fee={kept_fee}), "
                f"dropped {dropped} sharing same bond UTXO {bond_key[:16]}..."
            )

    # Add unbonded offers unchanged
    result.extend(unbonded)

    return result

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
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
def 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)
    """
    by_maker: dict[str, list[Offer]] = {}

    for offer in offers:
        if offer.counterparty not in by_maker:
            by_maker[offer.counterparty] = []
        by_maker[offer.counterparty].append(offer)

    result = []
    for maker, maker_offers in by_maker.items():
        # Sort by absolute fee equivalent at some reference amount (1 BTC)
        reference_amount = 100_000_000  # 1 BTC
        sorted_offers = sorted(maker_offers, key=lambda o: calculate_cj_fee(o, reference_amount))
        result.append(sorted_offers[0])
        if len(maker_offers) > 1:
            logger.debug(f"Kept cheapest of {len(maker_offers)} offers from {maker}")

    return result

fidelity_bond_weighted_choose(offers: list[Offer], n: int, bondless_makers_allowance: float = 0.2, bondless_require_zero_fee: bool = True, cj_amount: int = 0) -> list[Offer]

Choose n offers using per-slot probabilistic selection.

Pre-filtering (when bondless_require_zero_fee is True): Bondless offers (fidelity_bond_value == 0) that charge a non-zero absolute fee are removed before selection. This prevents an attacker from flooding the orderbook with fee-charging bondless offers to steal fees while still allowing genuine zero-fee bondless makers to participate. Relative-fee offers are kept because their effective fee depends on the CoinJoin amount and is evaluated elsewhere.

Per-slot selection (for each of the n slots independently):

  • With probability bondless_makers_allowance: pick uniformly at random from all remaining offers (bonded and bondless alike). This gives every surviving offer equal probability, so a rare bondless maker naturally has low selection odds (~ allowance / total_offers per slot).
  • Otherwise: pick from the bonded pool (fidelity_bond_value > 0) weighted by bond value.

Fallback: if the chosen pool is empty the other pool is tried, then uniform random over everything remaining.

This mirrors the reference JoinMarket implementation and ensures:

  • High-bond makers are strongly favoured (~80% of slots with default 0.2 allowance).
  • When many bondless zero-fee makers exist, roughly n * bondless_makers_allowance of them appear in the final set (e.g. 2 out of 10).
  • When only a few bondless makers exist, each has low individual selection probability (proportional to 1 / total_remaining), avoiding taker fingerprinting.
  • Smaller bonded makers also benefit from the uniform-random slots.

Args: offers: Eligible offers (already filtered and deduped). n: Number of offers to choose. bondless_makers_allowance: Per-slot probability of uniform-random selection (0.0-1.0). bondless_require_zero_fee: If True, pre-filter removes bondless offers with non-zero absolute fee. cj_amount: CoinJoin amount (reserved for future fee filtering).

Returns: Selected offers.

Source code in taker/src/taker/orderbook.py
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
def fidelity_bond_weighted_choose(
    offers: list[Offer],
    n: int,
    bondless_makers_allowance: float = 0.2,
    bondless_require_zero_fee: bool = True,
    cj_amount: int = 0,
) -> list[Offer]:
    """
    Choose n offers using per-slot probabilistic selection.

    **Pre-filtering** (when ``bondless_require_zero_fee`` is True):
    Bondless offers (``fidelity_bond_value == 0``) that charge a non-zero
    absolute fee are removed before selection.  This prevents an attacker
    from flooding the orderbook with fee-charging bondless offers to steal
    fees while still allowing genuine zero-fee bondless makers to participate.
    Relative-fee offers are kept because their effective fee depends on the
    CoinJoin amount and is evaluated elsewhere.

    **Per-slot selection** (for each of the *n* slots independently):

    * With probability ``bondless_makers_allowance``: pick **uniformly at
      random** from all remaining offers (bonded and bondless alike).  This
      gives every surviving offer equal probability, so a rare bondless maker
      naturally has low selection odds (``~ allowance / total_offers`` per
      slot).
    * Otherwise: pick from the bonded pool (``fidelity_bond_value > 0``)
      **weighted by bond value**.

    Fallback: if the chosen pool is empty the other pool is tried, then
    uniform random over everything remaining.

    This mirrors the reference JoinMarket implementation and ensures:

    * High-bond makers are strongly favoured (~80% of slots with default
      0.2 allowance).
    * When many bondless zero-fee makers exist, roughly
      ``n * bondless_makers_allowance`` of them appear in the final set
      (e.g. 2 out of 10).
    * When only a few bondless makers exist, each has low individual
      selection probability (proportional to ``1 / total_remaining``),
      avoiding taker fingerprinting.
    * Smaller bonded makers also benefit from the uniform-random slots.

    Args:
        offers: Eligible offers (already filtered and deduped).
        n: Number of offers to choose.
        bondless_makers_allowance: Per-slot probability of uniform-random
            selection (0.0-1.0).
        bondless_require_zero_fee: If True, pre-filter removes bondless
            offers with non-zero absolute fee.
        cj_amount: CoinJoin amount (reserved for future fee filtering).

    Returns:
        Selected offers.
    """
    if len(offers) <= n:
        return offers[:]

    # --- Pre-filter: remove bondless offers charging a fee ---
    if bondless_require_zero_fee:
        filtered: list[Offer] = []
        removed = 0
        for o in offers:
            if o.fidelity_bond_value == 0 and _is_nonzero_absolute_fee(o):
                removed += 1
            else:
                filtered.append(o)
        if removed:
            logger.debug(f"Pre-filter: removed {removed} bondless offers with non-zero fee")
        if len(filtered) <= n:
            return filtered[:]
        remaining = filtered
    else:
        remaining = offers[:]

    selected: list[Offer] = []

    bonded_count = sum(1 for o in remaining if o.fidelity_bond_value > 0)
    logger.debug(
        f"Selection pool: {len(remaining)} offers ({bonded_count} bonded, "
        f"{len(remaining) - bonded_count} bondless), picking {n} with "
        f"bondless_allowance={bondless_makers_allowance}"
    )

    for _i in range(n):
        if not remaining:
            logger.warning(f"Exhausted offer pool after {len(selected)}/{n} picks")
            break

        picked: Offer | None = None

        if random.random() < bondless_makers_allowance:
            # Bondless slot: pick uniformly from ALL remaining offers.
            # Bonded and bondless compete on equal footing here, so a rare
            # bondless maker has probability ~1/len(remaining).
            picked = random.choice(remaining)
        else:
            # Bonded slot: pick weighted by bond value
            picked = _pick_weighted_bonded(remaining)

        if picked is None:
            # Bonded pool empty -- fall back to uniform random
            picked = random.choice(remaining)

        selected.append(picked)
        remaining.remove(picked)

    logger.debug(
        f"Final selection: {len(selected)} makers "
        f"({sum(1 for o in selected if o.fidelity_bond_value > 0)} bonded, "
        f"{sum(1 for o in selected if o.fidelity_bond_value == 0)} bondless)"
    )
    return selected

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, required_features: set[str] | 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) required_features: Feature names that makers must support. Offers from makers that are known NOT to support a required feature are filtered out. Offers with unknown feature status (empty features dict) pass through, since compatibility will be verified later during the handshake.

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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
def 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,
    required_features: set[str] | 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)
        required_features: Feature names that makers must support. Offers from makers
            that are known NOT to support a required feature are filtered out. Offers
            with unknown feature status (empty features dict) pass through, since
            compatibility will be verified later during the handshake.

    Returns:
        List of eligible offers
    """
    if ignored_makers is None:
        ignored_makers = set()

    if allowed_types is None:
        allowed_types = {OfferType.SW0_RELATIVE, OfferType.SW0_ABSOLUTE}

    if ignored_makers:
        logger.debug(
            f"Filtering offers: {len(ignored_makers)} makers in ignored list: {ignored_makers}"
        )

    eligible = []

    for offer in offers:
        # Filter by maker
        if offer.counterparty in ignored_makers:
            logger.info(f"Ignoring offer from {offer.counterparty} (in ignored list)")
            continue

        # Filter by nick version (reserved for potential future reference compatibility)
        # NOTE: This is NOT used for neutrino detection - that uses handshake features
        if min_nick_version is not None:
            nick_version = get_nick_version(offer.counterparty)
            if nick_version < min_nick_version:
                logger.debug(
                    f"Ignoring offer from {offer.counterparty}: "
                    f"nick version {nick_version} < required {min_nick_version}"
                )
                continue

        # Filter by required features (e.g., neutrino_compat).
        # Only reject offers where we KNOW the maker lacks a required feature
        # (features dict is populated but the feature is missing/false).
        # Offers with empty features (unknown status) pass through -- they will
        # be verified during the handshake in _phase_auth().
        if required_features and offer.features:
            missing = {f for f in required_features if not offer.features.get(f)}
            if missing:
                logger.debug(
                    f"Ignoring offer from {offer.counterparty}: missing required features {missing}"
                )
                continue

        # Filter by offer type
        if offer.ordertype not in allowed_types:
            logger.debug(
                f"Ignoring offer from {offer.counterparty}: "
                f"type {offer.ordertype} not in allowed types"
            )
            continue

        # Filter by amount range
        if cj_amount < offer.minsize:
            logger.trace(
                f"Ignoring offer from {offer.counterparty}: "
                f"amount {cj_amount} < minsize {offer.minsize}"
            )
            continue

        if cj_amount > offer.maxsize:
            logger.debug(
                f"Ignoring offer from {offer.counterparty}: "
                f"amount {cj_amount} > maxsize {offer.maxsize}"
            )
            continue

        # Filter by fee limits
        if not is_fee_within_limits(offer, cj_amount, max_cj_fee):
            fee = calculate_cj_fee(offer, cj_amount)
            logger.trace(f"Ignoring offer from {offer.counterparty}: fee {fee} exceeds limits")
            continue

        eligible.append(offer)

    logger.info(f"Filtered {len(offers)} offers to {len(eligible)} eligible offers")
    return eligible

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
def 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
    """
    if offer.ordertype in (OfferType.SW0_ABSOLUTE, OfferType.SWA_ABSOLUTE):
        # For absolute offers, check against absolute limit directly
        return int(offer.cjfee) <= max_cj_fee.abs_fee
    else:
        # For relative offers, check against relative limit directly
        # Compare by calculating fee on a large reference amount
        ref_amount = 100_000_000_000  # 1000 BTC
        fee_val = calculate_relative_fee(ref_amount, str(offer.cjfee))
        limit_val = calculate_relative_fee(ref_amount, max_cj_fee.rel_fee)
        return fee_val <= limit_val

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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
def 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
    """
    if len(offers) <= n:
        return offers[:]

    return random.sample(offers, n)

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
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
def 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
    """
    if len(offers) <= n:
        return offers[:]

    if cj_amount == 0:
        cj_amount = 100_000_000  # 1 BTC

    # Calculate weights (inverse fee, exponentially weighted)
    fees = [calculate_cj_fee(o, cj_amount) for o in offers]
    max_fee = max(fees) if fees else 1
    weights = [(max_fee - fee + 1) ** exponent for fee in fees]

    total_weight = sum(weights)
    if total_weight == 0:
        return random.sample(offers, n)

    selected = []
    remaining_offers = list(enumerate(offers))
    remaining_weights = list(weights)

    for _ in range(n):
        if not remaining_offers:
            break

        # Weighted random selection
        total = sum(remaining_weights)
        r = random.uniform(0, total)
        cumulative = 0

        for i, (idx, offer) in enumerate(remaining_offers):
            cumulative += remaining_weights[i]
            if r <= cumulative:
                selected.append(offer)
                remaining_offers.pop(i)
                remaining_weights.pop(i)
                break

    return selected