Kayos
dc6378eda6
Sulkta Coop's Python SDK for merchant-side Cardano payments + NFT certificate-of-authenticity minting. Zero-custody by design. Extracted from TradeCraft's services/cardano_*.py (2,400+ lines of production Cardano-mainnet code) and restructured as an installable Python package. Package layout (cardano_checkout/): - addresses.py — lifted verbatim: CIP-1852 HD derivation, pure pycardano - oracles.py — lifted from cardano_price.py: Koios ADA/USD feed w/ 5m cache - monitor.py — lifted verbatim (SQLAlchemy-coupled; v0.2 refactors to Store) - scheduler.py — lifted verbatim (same refactor note) - invoice.py — NEW: framework-agnostic Invoice dataclass + lifecycle enum - store.py — NEW: InvoiceStore Protocol for pluggable persistence - mint.py — NEW: CIP-25 v2 metadata builder (works); tx submission stub for v0.2 - ipfs.py — NEW: kubo HTTP client with primary-pin + mirror-pin pattern - txbuild.py — NEW: v0.2 stub for PyCardano / Ogmios tx construction Design: - Consumers provide xpub + InvoiceStore impl. SDK provides everything else. - IPFS: local kubo for upload + serve, optional mirror pins for archival. Chromaticcraft pattern: Rackham kubo primary, Lucy kubo mirror. - NFT: single native-script policy per merchant studio (CIP-25 v2, not CIP-68 — full wallet coverage, no mutability needed for static certs). Policy skey stays under Sulkta cold-custody (Lucy pattern); signing is an external hand-off like ADAMaps payouts. Tests: pure-module smoke tests pass for invoice, store-protocol, CIP-25 metadata envelope, IPFS client import, txbuild stub module. Address derivation tests ship but require pycardano + will exercise in CI. LICENSE: Apache-2.0 (matches upstream Cardano tooling). Next (v0.2 scope): - Refactor monitor + scheduler around InvoiceStore (drop SQLAlchemy coupling) - Wire mint.mint_nft_cert to PyCardano + local Ogmios on Rackham - txbuild: Ogmios chain-context + cold-signer hand-off shape - chromaticcraft Phase 2 imports the SDK as its first external consumer
38 lines
1.4 KiB
Python
38 lines
1.4 KiB
Python
"""Transaction construction helpers wrapping PyCardano.
|
|
|
|
v0.1.0 surface stub — the chromaticcraft Phase-2 sprint will fill these in
|
|
with:
|
|
- Ogmios-backed `ChainContext` (via PyCardano's OgmiosChainContext)
|
|
- Build-transaction helpers for (a) plain ADA payment refunds, (b)
|
|
native-token mint+send, (c) reference-asset clones
|
|
- Cold-signer hand-off shape matching the ADAMaps payout pattern:
|
|
build_body_on_hot → transfer via temp dir → sign_offline_on_cold →
|
|
return signed_witness → submit_from_hot.
|
|
|
|
Exists as a named module in v0.1 so consumers can import the stable path
|
|
without having to update imports later.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
def _v0_2_sentinel(_name: str) -> None:
|
|
raise NotImplementedError(
|
|
f"txbuild.{_name} ships in cardano-checkout v0.2 alongside the "
|
|
"Ogmios chain-context wiring and cold-signer hand-off."
|
|
)
|
|
|
|
|
|
def build_mint_tx(*args, **kwargs): # noqa: D401, ANN002, ANN003
|
|
"""Build an unsigned mint transaction. v0.2."""
|
|
_v0_2_sentinel("build_mint_tx")
|
|
|
|
|
|
def build_payment_tx(*args, **kwargs): # noqa: D401, ANN002, ANN003
|
|
"""Build an unsigned payment transaction (e.g. refund path). v0.2."""
|
|
_v0_2_sentinel("build_payment_tx")
|
|
|
|
|
|
def submit_signed_tx(*args, **kwargs): # noqa: D401, ANN002, ANN003
|
|
"""Submit a signed tx to Ogmios. v0.2."""
|
|
_v0_2_sentinel("submit_signed_tx")
|