charli3_dendrite 1.5.19.dev0__tar.gz → 1.5.20.dev0__tar.gz

{charli3_dendrite-1.5.19.dev0 → charli3_dendrite-1.5.20.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: charli3_dendrite
-Version: 1.5.19.dev0
+Version: 1.5.20.dev0
 Summary: 
 License-File: LICENSE
 Author: Elder Millenial

{charli3_dendrite-1.5.19.dev0 → charli3_dendrite-1.5.20.dev0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "charli3_dendrite"
-version = "1.5.19-dev0"
+version = "1.5.20-dev0"
 description = ""
 authors = ["Elder Millenial <eldermillenial@protonmail.com>"]
 readme = "README.md"
@@ -50,7 +50,7 @@ module = ["pycardano", "pycardano.*", "dotenv", "nox", "uplc", "uplc.*"]
 ignore_missing_imports = true
 
 [tool.bumpversion]
-current_version = "1.5.19-dev0"
+current_version = "1.5.20-dev0"
 parse = """(?x)
     (?P<major>\\d+)\\.
     (?P<minor>\\d+)\\.

{charli3_dendrite-1.5.19.dev0 → charli3_dendrite-1.5.20.dev0}/src/charli3_dendrite/dexs/amm/sundae_v4.py

@@ -2868,6 +2868,15 @@ class _SundaeV4BoundPool(_SundaeV4OrderBuilders):
         """The lovelace rider returned with the order's payout."""
         return self._deposit_rider
 
+    @property
+    def swap_forward(self) -> bool:
+        """A V4 order pays a fixed destination, its datum inline: it can forward a fill.
+
+        ``swap_utxo(address_target=..., datum_target=...)`` points the destination at
+        another order's address, with that order's datum inline.
+        """
+        return True
+
     def swap_utxo(
         self,
         address_source: Address,
@@ -2878,6 +2887,7 @@ class _SundaeV4BoundPool(_SundaeV4OrderBuilders):
         datum_target: PlutusData | None = None,
         *,
         fee_budget: int | None = None,
+        rider: int | None = None,
     ) -> tuple[TransactionOutput, PlutusData]:
         """The order output for a swap: input + fee budget + rider, inline datum.
 
@@ -2886,9 +2896,16 @@ class _SundaeV4BoundPool(_SundaeV4OrderBuilders):
         ``max_per_execution`` are both ``fee_budget`` and the order locks it: the
         budget a multi-vault route needs (:meth:`SundaeV4Vault.route_fee_budget`).
 
+        ``rider`` is the lovelace returned with the payout. Everything in the order
+        but the consumed offer and the fee leaves with the output, so an order that
+        forwards its fill into another (``address_target`` / ``datum_target``)
+        carries the next order's fee and deposit here. Unset, the 2 ADA rider. The
+        datum does not name it.
+
         Raises:
-            ValueError: more than one asset offered or asked, or ``fee_budget``
-                below the live base fee (the scooper never includes such an order).
+            ValueError: more than one asset offered or asked, ``fee_budget`` below
+                the live base fee (the scooper never includes such an order), or
+                ``rider`` below the 2 ADA rider.
         """
         if len(in_assets) != 1 or len(out_assets) != 1:
             msg = "Only one asset can be supplied as input, and one asset as output."
@@ -2897,6 +2914,12 @@ class _SundaeV4BoundPool(_SundaeV4OrderBuilders):
         if fee_budget is not None and fee_budget < base_fee:
             msg = f"A fee budget of {fee_budget} is below the base fee {base_fee}."
             raise ValueError(msg)
+        if rider is not None and rider < _ORDER_RIDER:
+            msg = (
+                f"A rider of {rider} lovelace is below the {_ORDER_RIDER} "
+                "lovelace order rider."
+            )
+            raise ValueError(msg)
         order_datum = self.swap_datum(
             address_source=address_source,
             in_assets=in_assets,
@@ -2908,7 +2931,8 @@ class _SundaeV4BoundPool(_SundaeV4OrderBuilders):
             max_per_execution=fee_budget,
         )
         fee = base_fee if fee_budget is None else fee_budget
-        rider = self.deposit(in_assets=in_assets, out_assets=out_assets).quantity()
+        if rider is None:
+            rider = self.deposit(in_assets=in_assets, out_assets=out_assets).quantity()
         return self._order_output(in_assets, fee, rider, order_datum), order_datum
 
     def apply_swap(self, asset_in: Assets, asset_out: Assets) -> None: