Cleanup: remove internal references and scaffolding

This commit is contained in:
Sulkta 2026-05-27 11:15:03 -07:00
parent b4a81e0ab8
commit 812393d030
10 changed files with 72 additions and 141 deletions

View file

@ -1,17 +1,16 @@
"""cardano-checkout — merchant-side Cardano payment lifecycle in Python.
Zero-custody by design: the merchant brings a wallet xpub and an
Zero-custody: the merchant brings a wallet xpub and an
:class:`~cardano_checkout.store.InvoiceStore` implementation. The SDK
owns the payment lifecycle per-invoice receive-address bookkeeping,
Koios UTxO polling, confirm / underpay / overpay classification, and
time-windowed repricing against a consumer-supplied oracle.
**The SDK deliberately does NOT ship Cardano primitives.** Address
derivation, transaction building, chain context, and native-script
minting all live in `pycardano <https://github.com/Python-Cardano/pycardano>`_
and are consumer concerns. See the README for the pairing pattern and
for the CIP-25 v2 metadata-builder snippet (a 60-line helper that fits
anywhere in your own code without needing a separate dep).
Does NOT ship Cardano primitives. Address derivation, transaction
building, chain context, and native-script minting live in
`pycardano <https://github.com/Python-Cardano/pycardano>`_. See the
README for the pairing pattern and the CIP-25 v2 metadata-builder
snippet.
Quick start::
@ -20,7 +19,6 @@ Quick start::
store = InMemoryStore() # or your SQLAlchemy / asyncpg / sqlite adapter
async def my_price_fn(usd: float) -> int:
# your oracle — CoinGecko / Koios ticker / fixed rate in tests
rate = await fetch_ada_usd_rate()
return int(round(usd / rate * 1_000_000))