charli3_dendrite 1.5.13.dev1__tar.gz → 1.5.14.dev0__tar.gz

{charli3_dendrite-1.5.13.dev1 → charli3_dendrite-1.5.14.dev0}/PKG-INFO

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

{charli3_dendrite-1.5.13.dev1 → charli3_dendrite-1.5.14.dev0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "charli3_dendrite"
-version = "1.5.13-dev1"
+version = "1.5.14-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.13-dev1"
+current_version = "1.5.14-dev0"
 parse = """(?x)
     (?P<major>\\d+)\\.
     (?P<minor>\\d+)\\.

{charli3_dendrite-1.5.13.dev1 → charli3_dendrite-1.5.14.dev0}/src/charli3_dendrite/lending/fluidtokens/constants.py

@@ -14,9 +14,8 @@ from typing import TYPE_CHECKING
 from typing import TypedDict
 
 import cbor2  # type: ignore[import-not-found]
-from pycardano import Address
-from pycardano import Network
-from pycardano import ScriptHash
+
+from charli3_dendrite.lending.units import script_payment_address
 
 if TYPE_CHECKING:
     from charli3_dendrite.backend.backend_base import AbstractBackend
@@ -156,19 +155,6 @@ class FluidConfig:
         )
 
 
-def _payment_address(script_hash_hex: str) -> str:
-    """A mainnet payment-credential (enterprise) address for a spend script hash.
-
-    Entity UTxOs sit at base addresses whose stake part is not carried by the config
-    datum, but the backend discovers them by payment credential only, so a
-    payment-credential address is the stable, redeploy-proof identity to match on.
-    """
-    return Address(
-        payment_part=ScriptHash(bytes.fromhex(script_hash_hex)),
-        network=Network.MAINNET,
-    ).encode()
-
-
 def resolve_config(backend: AbstractBackend) -> FluidConfig:
     """Read the live config NFT datum into a :class:`FluidConfig`.
 
@@ -183,7 +169,7 @@ def resolve_config(backend: AbstractBackend) -> FluidConfig:
         )
 
         utxo = resolve_config_utxo(backend)
-        return FluidConfig.parse(utxo.datum)
+        return FluidConfig.parse(utxo.datum or "")
     except (TypeError, ValueError, IndexError, KeyError, AttributeError):
         return FluidConfig.defaults()
 
@@ -194,13 +180,13 @@ def resolve_addresses(backend: AbstractBackend) -> FluidScriptAddresses:
     Re-reads the config datum through `backend` so pool / loan / request discovery
     self-heals across a protocol redeploy (new spend scripts / policies); falls back to
     the static mainnet constants when the datum cannot be read. Addresses are
-    payment-credential identities (see :func:`_payment_address`).
+    payment-credential identities (see :func:`script_payment_address`).
     """
     config = resolve_config(backend)
     return FluidScriptAddresses(
-        pool=_payment_address(config.pool_spend_skh),
-        loan=_payment_address(config.loan_spend_skh),
-        request=_payment_address(config.request_spend_skh),
+        pool=script_payment_address(config.pool_spend_skh),
+        loan=script_payment_address(config.loan_spend_skh),
+        request=script_payment_address(config.request_spend_skh),
         pool_policy=config.pool_policy,
         loan_policy=config.loan_policy,
         request_policy=config.request_policy,

{charli3_dendrite-1.5.13.dev1 → charli3_dendrite-1.5.14.dev0}/src/charli3_dendrite/lending/fluidtokens/datums.py

@@ -1,19 +1,38 @@
-"""pycardano mirrors of the deployed FluidTokens V3 datums (mainnet)."""
+"""pycardano mirrors of the deployed FluidTokens V3 datums (mainnet).
+
+Every class decodes strictly: a constructor with more or fewer fields than the class
+raises ``DeserializeException`` instead of decoding a different layout silently.
+"""
 from __future__ import annotations
 
 from dataclasses import dataclass
 from typing import List
 from typing import TypeAlias
+from typing import Union
 
 from pycardano import Datum
 from pycardano import IndefiniteList
-from pycardano import PlutusData
 
+from charli3_dendrite.lending.plutus import StrictPlutusData
 from charli3_dendrite.lending.units import asset_unit
 
+# A loan datum's ``origin_id`` is one of these tags followed by the originating pool's
+# or request's NFT asset name.
+ORIGIN_POOL_TAG = b"POOL"
+ORIGIN_REQUEST_TAG = b"REQUEST"
+
+
+@dataclass
+class TxOutRef(StrictPlutusData):
+    """A transaction output reference == Constr0([tx_id_bytes, index])."""
+
+    CONSTR_ID = 0
+    tx_id: bytes
+    index: int
+
 
 @dataclass
-class Asset(PlutusData):
+class Asset(StrictPlutusData):
     """(policy_id, asset_name) as a `Constr`; ADA is (b"", b"")."""
 
     CONSTR_ID = 0
@@ -26,7 +45,7 @@ class Asset(PlutusData):
 
 
 @dataclass
-class CollateralAsset(PlutusData):
+class CollateralAsset(StrictPlutusData):
     """A collateral type: policy, optional asset name, and its oracle token."""
 
     CONSTR_ID = 0
@@ -36,21 +55,21 @@ class CollateralAsset(PlutusData):
 
 
 @dataclass
-class NoLiquidationFullCollateralClaim(PlutusData):
+class NoLiquidationFullCollateralClaim(StrictPlutusData):
     """LiquidationMode variant: on default the lender claims all collateral."""
 
     CONSTR_ID = 0
 
 
 @dataclass
-class NoLiquidationDutchAuctionClaim(PlutusData):
+class NoLiquidationDutchAuctionClaim(StrictPlutusData):
     """LiquidationMode variant: on default the collateral is dutch-auctioned."""
 
     CONSTR_ID = 1
 
 
 @dataclass
-class Liquidation(PlutusData):
+class Liquidation(StrictPlutusData):
     """LiquidationMode variant: liquidate against a loan-to-value threshold.
 
     Three fields, matching the deployed datum and `ft-cardano-loans-v3` lib
@@ -67,7 +86,7 @@ class Liquidation(PlutusData):
 
 
 @dataclass
-class InterestOnRemainingPrincipal(PlutusData):
+class InterestOnRemainingPrincipal(StrictPlutusData):
     """RepaymentMode variant: interest accrues on the remaining principal."""
 
     CONSTR_ID = 0
@@ -75,14 +94,14 @@ class InterestOnRemainingPrincipal(PlutusData):
 
 
 @dataclass
-class PrincipalAndInterestOnInstallments(PlutusData):
+class PrincipalAndInterestOnInstallments(StrictPlutusData):
     """RepaymentMode variant: principal and interest split across installments."""
 
     CONSTR_ID = 1
 
 
 @dataclass
-class PerpetualLoan(PlutusData):
+class PerpetualLoan(StrictPlutusData):
     """RepaymentMode variant: perpetual loan with a linear APY increase."""
 
     CONSTR_ID = 2
@@ -90,13 +109,18 @@ class PerpetualLoan(PlutusData):
     max_possible_recasts: int
 
 
-# Unions; parse via from_primitive dispatch where needed.
-LiquidationMode: TypeAlias = Datum
+# LiquidationMode is typed so a constructor with another layout (such as the V4
+# four-field Liquidation) fails to decode. RepaymentMode stays an untyped Datum.
+LiquidationMode: TypeAlias = Union[
+    NoLiquidationFullCollateralClaim,
+    NoLiquidationDutchAuctionClaim,
+    Liquidation,
+]
 RepaymentMode: TypeAlias = Datum
 
 
 @dataclass
-class CommonData(PlutusData):
+class CommonData(StrictPlutusData):
     """Loan terms shared by pool, request, and loan datums."""
 
     CONSTR_ID = 0
@@ -114,7 +138,7 @@ class CommonData(PlutusData):
 
 
 @dataclass
-class AuthCardanoSignature(PlutusData):
+class AuthCardanoSignature(StrictPlutusData):
     """AuthorizationMethod variant: authorize by a verification-key hash."""
 
     CONSTR_ID = 0
@@ -122,7 +146,7 @@ class AuthCardanoSignature(PlutusData):
 
 
 @dataclass
-class AuthCardanoSpendScript(PlutusData):
+class AuthCardanoSpendScript(StrictPlutusData):
     """AuthorizationMethod variant: authorize by a spending script hash."""
 
     CONSTR_ID = 1
@@ -130,7 +154,7 @@ class AuthCardanoSpendScript(PlutusData):
 
 
 @dataclass
-class AuthCardanoWithdrawScript(PlutusData):
+class AuthCardanoWithdrawScript(StrictPlutusData):
     """AuthorizationMethod variant: authorize by a withdrawal script hash."""
 
     CONSTR_ID = 2
@@ -138,7 +162,7 @@ class AuthCardanoWithdrawScript(PlutusData):
 
 
 @dataclass
-class AuthCardanoMintScript(PlutusData):
+class AuthCardanoMintScript(StrictPlutusData):
     """AuthorizationMethod variant: authorize by a minting script hash."""
 
     CONSTR_ID = 3
@@ -146,7 +170,7 @@ class AuthCardanoMintScript(PlutusData):
 
 
 @dataclass
-class PoolDatum(PlutusData):
+class PoolDatum(StrictPlutusData):
     """Deployed PoolDatum — Constr0, 10 fields.
 
     ``collateral_options``, ``min_collateral``, and ``min_collateral_divider`` follow
@@ -190,7 +214,7 @@ class PoolDatum(PlutusData):
 
 
 @dataclass
-class LoanDatum(PlutusData):
+class LoanDatum(StrictPlutusData):
     """Deployed LoanDatum — Constr0, 17 fields."""
 
     CONSTR_ID = 0
@@ -214,7 +238,7 @@ class LoanDatum(PlutusData):
 
 
 @dataclass
-class RequestDatum(PlutusData):
+class RequestDatum(StrictPlutusData):
     """Deployed RequestDatum — Constr0, 12 fields."""
 
     CONSTR_ID = 0

{charli3_dendrite-1.5.13.dev1 → charli3_dendrite-1.5.14.dev0}/src/charli3_dendrite/lending/fluidtokens/state.py

@@ -336,11 +336,18 @@ class FluidRequestState(DendriteBaseModel):
 
     _request_datum_parsed: RequestDatum | None = PrivateAttr(default=None)
 
+    @classmethod
+    def request_datum_class(cls) -> type[RequestDatum]:
+        """Request datum type."""
+        return RequestDatum
+
     @property
     def request_datum(self) -> RequestDatum:
         """Parsed request datum (lazily decoded from CBOR)."""
         if self._request_datum_parsed is None:
-            self._request_datum_parsed = RequestDatum.from_cbor(self.datum_cbor)
+            self._request_datum_parsed = self.request_datum_class().from_cbor(
+                self.datum_cbor,
+            )
         return self._request_datum_parsed
 
     @property

{charli3_dendrite-1.5.13.dev1 → charli3_dendrite-1.5.14.dev0}/src/charli3_dendrite/lending/fluidtokens/transactions/datum_synth.py

@@ -14,32 +14,19 @@ from dataclasses import dataclass
 from pycardano import Datum
 from pycardano import PlutusData
 
+from charli3_dendrite.lending.fluidtokens.datums import ORIGIN_POOL_TAG
+from charli3_dendrite.lending.fluidtokens.datums import ORIGIN_REQUEST_TAG
 from charli3_dendrite.lending.fluidtokens.datums import CollateralAsset
 from charli3_dendrite.lending.fluidtokens.datums import CommonData
 from charli3_dendrite.lending.fluidtokens.datums import LoanDatum
 from charli3_dendrite.lending.fluidtokens.datums import PoolDatum
 from charli3_dendrite.lending.fluidtokens.datums import RequestDatum
-
-# Origin-id tag a pool-origin loan datum carries: the loan's ``origin_id`` is this tag
-# followed by the originating pool's NFT asset name (`b"POOL" + pool_id`).
-ORIGIN_POOL_TAG = b"POOL"
-
-# Origin-id tag a request-origin loan datum carries: ``b"REQUEST" + request_id``.
-ORIGIN_REQUEST_TAG = b"REQUEST"
+from charli3_dendrite.lending.fluidtokens.datums import TxOutRef
 
 # The receipt's tag bytestring identifying an installment repayment.
 INSTALLMENT_REPAYMENT_TAG = b"installment_repayment"
 
 
-@dataclass
-class TxOutRef(PlutusData):
-    """A transaction output reference == Constr0([tx_id_bytes, index])."""
-
-    CONSTR_ID = 0
-    tx_id: bytes
-    index: int
-
-
 @dataclass
 class RepaymentInfo(PlutusData):
     """The loan terms recorded on the receipt == Constr0([...]).

charli3_dendrite-1.5.14.dev0/src/charli3_dendrite/lending/fluidtokens_v4/__init__.py

@@ -0,0 +1 @@
+"""FluidTokens V4 lending protocol integration (read side and indexing)."""

charli3_dendrite-1.5.14.dev0/src/charli3_dendrite/lending/fluidtokens_v4/constants.py

@@ -0,0 +1,149 @@
+"""FluidTokens V4 mainnet coordinates.
+
+The protocol is parameterized by a config NFT whose UTxO carries a
+:class:`~charli3_dendrite.lending.fluidtokens_v4.datums.ConfigDatum` with every
+policy id and script hash. The constants below are the live mainnet values:
+:func:`default_config` assembles them into that datum as an offline fallback, and
+:func:`resolve_config` re-reads the live datum through the backend so discovery
+follows a config update.
+
+The lender-manager spend script is not listed in the config datum: pools opt into it
+by pointing ``lender_bond_address`` at it, and it ships as a constant here. Its own
+action scripts are listed in the lender-manager config datum, held with a separate
+config NFT.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import cbor2  # type: ignore[import-not-found]
+from pycardano import IndefiniteList
+from pycardano import RawPlutusData
+from pycardano.exception import DeserializeException
+
+from charli3_dendrite.lending.fluidtokens_v4.datums import ConfigDatum
+
+if TYPE_CHECKING:
+    from charli3_dendrite.backend.backend_base import AbstractBackend
+
+CONFIG_NFT_POLICY = "235b32040fe1177c03b1d34febc470440c6eaaa2228a9c1b0e375200"
+CONFIG_NFT_NAME = "706172616d6574657273"  # "parameters"
+LENDER_MANAGER_CONFIG_NFT_POLICY = (
+    "fb6ae2027358b4a0b62710eb95102d87fa13f66ecf55d8943699c492"
+)
+LENDER_MANAGER_CONFIG_NFT_NAME = "706172616d6574657273"  # "parameters"
+
+# Config datum values, in datum field order.
+SMART_TOKENS_SPEND_SKH = "fca77bcce1e5e73c97a0bfa8c90f7cd2faff6fd6ed5b6fec1c04eefa"
+ADMIN_SCRIPT_HASH = "d5940dc2ad9e3f43544fb02a28240f215602603a7519588532b72c53"
+POOL_POLICY = "20f765d25da3a36644371f7619d97bdccf034f3067921921d9dce0f7"
+REQUEST_POLICY = "9b2e325cc15d14fa23101741e6cc17e8ba977a1563738439968356d2"
+BORROWER_BOND_POLICY = "eadc69a5d2d1357acc9b9d49ec5390fcdf6e080c7a40139917223dcb"
+LENDER_BOND_POLICY = "bcd713bb7858d4b08738bed90ee7068d8f9b38d02e0cae0b45ac7a9b"
+LOAN_POLICY = "20256f557cec14f61cc662468f7812a1e6531e628af257a5fc5dd0c5"
+REPAYMENT_POLICY = "addd060da203f54e8ffc8a5d363094bc5e63d85734fe9d2869614d79"
+POOL_SPEND_SKH = "ecd0c0fc554beb43ade65d45dd471ede4d9cfc9b22bb70de8e113458"
+REQUEST_SPEND_SKH = "390d27f97868840864922fb0b5657ae4982b5be8bf03bf9cec81125e"
+LOAN_SPEND_SKH = "b5763e3c9cb7f1a2167f74f76cb635d24d138a4cc5cf9d87659c662d"
+LOAN_CLAIM_ACTION_SKH = "63b26ff93c96ae391e0f838de5d62053ec562ea82371c3aaab444902"
+LOAN_REPAY_ACTION_SKH = "41ac9c9f0bd2acc2db8af9882b772daee90fcf1ad877f0451bd7af28"
+LOAN_CHANGE_COLLATERAL_ACTION_SKH = (
+    "7aa6795463a8dcb3534246a6c3d6b1f29a72f920ae1dad6d0bacd43d"
+)
+LOAN_RECAST_ACTION_SKH = "c0af09a3656074f444e1daec043896c235d18aba0567aba7afb55fe8"
+ASSET_MANAGER_SPEND_SKH = "b256da41be022ba1a28fe92b32eeea00109310e3f0aea1cb7791d98f"
+POOL_CANCEL_ACTION_SKH = "f7ed285d6a9b9772666c7f379ac3e70d777b9d651026385fd26c3e4d"
+POOL_BORROW_ACTION_SKH = "d86664db37ebf149386d3b26cc9b2e9c73bc11319052a6b4927c0a8f"
+POOL_SELL_LENDER_POSITION_ACTION_SKH = (
+    "fc16ccaa435f24833da06681fdc8a71ae460c41517e87d12baf644fa"
+)
+POOL_COMPOUND_ACTION_SKH = "fef12ea655d7d562bd419cad05723e201b1f292e6b6be5a874f073ba"
+POOL_EDIT_ACTION_SKH = "1ec1853344febb4f5de40fceca2316deb68baa3300161afed4ed6ae0"
+POOL_MANAGER_SPEND_SKH = "dfb1d21e529af28d82004eee5689e3304bb896c35ce8fe65c85612b0"
+POOL_MANAGER_POLICY = "1e0bf58a4ef7f8f7579b58e290ea9f9283239bb4f7932fe8f29df03a"
+LOCKED_BORROWER_MANAGER_SPEND_SKH = (
+    "072eee302404c8d869bbc61a2c45502d371d96ec7d6aae7b179bfaa3"
+)
+
+# Not carried by the config datum (see the module docstring).
+LENDER_MANAGER_SPEND_SKH = "6743f4b69446b4e066cfb89daa3d01ef041b6d2646968993be4cec09"
+
+# Plutus ``Credential``: ``ScriptCredential`` is constructor alternative 1 (tag 122).
+_SCRIPT_CREDENTIAL_TAG = 122
+
+
+def default_config() -> ConfigDatum:
+    """The mainnet config datum rebuilt from this module's constants.
+
+    The Dutch auction is disabled on mainnet: its script hashes are empty and its
+    parameters are zero.
+    """
+    return ConfigDatum(
+        smart_tokens_spend_script_hash=bytes.fromhex(SMART_TOKENS_SPEND_SKH),
+        admin_credential=RawPlutusData(
+            cbor2.CBORTag(
+                _SCRIPT_CREDENTIAL_TAG,
+                IndefiniteList([bytes.fromhex(ADMIN_SCRIPT_HASH)]),
+            ),
+        ),
+        pool_policy_id=bytes.fromhex(POOL_POLICY),
+        request_policy_id=bytes.fromhex(REQUEST_POLICY),
+        borrower_bond_policy_id=bytes.fromhex(BORROWER_BOND_POLICY),
+        lender_bond_policy_id=bytes.fromhex(LENDER_BOND_POLICY),
+        loan_policy_id=bytes.fromhex(LOAN_POLICY),
+        repayment_policy_id=bytes.fromhex(REPAYMENT_POLICY),
+        pool_spend_script_hash=bytes.fromhex(POOL_SPEND_SKH),
+        request_spend_script_hash=bytes.fromhex(REQUEST_SPEND_SKH),
+        loan_spend_script_hash=bytes.fromhex(LOAN_SPEND_SKH),
+        loan_claim_action_script_hash=bytes.fromhex(LOAN_CLAIM_ACTION_SKH),
+        loan_repay_action_script_hash=bytes.fromhex(LOAN_REPAY_ACTION_SKH),
+        loan_change_collateral_action_script_hash=bytes.fromhex(
+            LOAN_CHANGE_COLLATERAL_ACTION_SKH,
+        ),
+        loan_recast_action_script_hash=bytes.fromhex(LOAN_RECAST_ACTION_SKH),
+        asset_manager_spend_script_hash=bytes.fromhex(ASSET_MANAGER_SPEND_SKH),
+        dutch_auction_spend_script_hash=b"",
+        dutch_auction_withdraw_script_hash=b"",
+        dutch_auction_starting_increase_per_mille=0,
+        dutch_auction_lowering_amount=0,
+        dutch_auction_lowering_frequency=0,
+        dutch_auction_min_price_to_cancel=0,
+        pool_cancel_action_script_hash=bytes.fromhex(POOL_CANCEL_ACTION_SKH),
+        pool_borrow_action_script_hash=bytes.fromhex(POOL_BORROW_ACTION_SKH),
+        pool_sell_lender_position_action_script_hash=bytes.fromhex(
+            POOL_SELL_LENDER_POSITION_ACTION_SKH,
+        ),
+        pool_compound_action_script_hash=bytes.fromhex(POOL_COMPOUND_ACTION_SKH),
+        pool_edit_action_script_hash=bytes.fromhex(POOL_EDIT_ACTION_SKH),
+        pool_manager_spend_script_hash=bytes.fromhex(POOL_MANAGER_SPEND_SKH),
+        pool_manager_policy_id=bytes.fromhex(POOL_MANAGER_POLICY),
+        locked_borrower_manager_spend_script_hash=bytes.fromhex(
+            LOCKED_BORROWER_MANAGER_SPEND_SKH,
+        ),
+    )
+
+
+def resolve_config(backend: AbstractBackend) -> ConfigDatum:
+    """Read the live config datum held with the config NFT.
+
+    Falls back to :func:`default_config` when the datum cannot be read or decoded (a
+    backend without dbsync queries, a missing config UTxO or datum, or a datum whose
+    layout no longer matches :class:`ConfigDatum`), so discovery keeps working offline.
+    Database errors propagate.
+    """
+    # Imported lazily: the V3 resolver pulls in the V3 transaction context.
+    from charli3_dendrite.lending.fluidtokens.transactions.resolve import (
+        resolve_utxo_by_asset,
+    )
+
+    try:
+        utxo = resolve_utxo_by_asset(backend, CONFIG_NFT_POLICY, CONFIG_NFT_NAME)
+    except (TypeError, ValueError):
+        return default_config()
+    if not utxo.datum:
+        return default_config()
+    try:
+        return ConfigDatum.from_cbor(utxo.datum)
+    except (DeserializeException, ValueError, cbor2.CBORDecodeError):
+        return default_config()