Skip to content

title: Python Wrappers — API Reference audience: industry_consumers game: WIKI-PYTHON-WRAPPERS-API-REFERENCE-001

API Reference

Generated from cells/python/gaiaftcl/src/gaiaftcl/. Package version 1.2.0.

For prose see Python-Wrappers-Franklin-Client-API and Python-Wrappers-Industry-Bridges.

Swift CLI parity

Swift top-level groups from GaiaFTCLCLIEntry.swift: franklin, prove, ask, qc020, qc, substrate, wiki, shor, patoshi, pq, subscription, mesh, admin, cell, wallet.

gaiaftcl-py mirrors the read-side of that surface through FranklinClient (append-only SQLite). Operator-mutating verbs (wallet import/withdraw, shor break-classical, cell sprout, admin v2, …) remain Swift-only.

Module: gaiaftcl

Top-level re-exports:

FranklinClient
FranklinClientError
FranklinAuthorityViolation
FranklinHeartbeat
FranklinResearchTelemetry
FranklinHealthObservation
FranklinHealingAction
FranklinSubstrateDevelopment
FranklinAlgorithmEvaluation
FranklinReplayAnchor
FranklinLocalWallet
WalletLedgerEntry
QFOTLedgerEntry
FranklinWound
FranklinRewardGradient
FranklinStrategicShift
ShorDemonstration
PQMigration
RandomnessProvenance
FounderWallet
FederationCosignature
FederationContext
verify_signature_quintet
MeshLoader
MeshLoaderError
load_from_mesh
Manifest
ManifestSigner
ManifestVerifier
prove_shor
ShorProveResult
ShorProveError
chi_coherence
ChiCoherenceResult

Module: gaiaftcl.client.franklin_client

Dataclasses

  • FranklinHeartbeat
  • FranklinResearchTelemetry
  • FranklinHealthObservation
  • FranklinHealingAction
  • FranklinSubstrateDevelopment
  • FranklinAlgorithmEvaluation
  • FranklinReplayAnchor
  • FranklinLocalWallet
  • WalletLedgerEntry
  • QFOTLedgerEntry
  • FranklinWound
  • FranklinRewardGradient
  • FranklinStrategicShift
  • ShorDemonstration
  • PQMigration
  • RandomnessProvenance
  • FounderWallet

class FranklinClient

FranklinClient.__init__(self, substrate_db_path: Path)
FranklinClient.__enter__(self) -> FranklinClient
FranklinClient.__exit__(self, *exc) -> None

@classmethod FranklinClient.connect(substrate_db_path: Optional[Path]) -> 'FranklinClient'
FranklinClient.close(self) -> None
FranklinClient.heartbeat_history(self, limit: int) -> list[FranklinHeartbeat]
FranklinClient.research_telemetry(self, limit: int) -> list[dict[str, Any]]
FranklinClient.health_observations(self, limit: int) -> list[FranklinHealthObservation]
FranklinClient.healing_history(self, limit: int) -> list[FranklinHealingAction]
FranklinClient.list_substrate_development(self, status: Optional[str], limit: int) -> list[FranklinSubstrateDevelopment]
FranklinClient.evaluate_algorithm(self, algorithm_id: Optional[str], limit: int) -> list[FranklinAlgorithmEvaluation]
FranklinClient.replay_session(self, limit: int) -> list[FranklinReplayAnchor]
FranklinClient.franklin_authority_show(self) -> dict[str, Any]
FranklinClient.local_wallet(self, cell_id: Optional[str]) -> Optional[FranklinLocalWallet]
FranklinClient.wallet_ledger(self, limit: int, asset_class: Optional[str]) -> list[WalletLedgerEntry]
FranklinClient.qfot_ledger(self, limit: int) -> list[QFOTLedgerEntry]
FranklinClient.wound_ledger(self, limit: int) -> list[FranklinWound]
FranklinClient.reward_gradient(self, limit: int) -> list[FranklinRewardGradient]
FranklinClient.strategic_shifts(self, limit: int) -> list[FranklinStrategicShift]
FranklinClient.shor_demonstrations(self, limit: int) -> list[ShorDemonstration]
FranklinClient.pq_migrations(self, limit: int) -> list[PQMigration]
FranklinClient.randomness_provenance(self, limit: int) -> list[RandomnessProvenance]
FranklinClient.founder_wallets(self) -> list[FounderWallet]
async FranklinClient.subscribe(self, subject: str) -> AsyncIterator[dict[str, Any]]

Exceptions

  • FranklinClientError(Exception) — base error
  • FranklinAuthorityViolation(FranklinClientError) — substrate-mutating bypass refused

CLI: gaiaftcl-py

Entry point: gaiaftcl.cli:main (pyproject.toml). JSON to stdout.

gaiaftcl-py health [--limit N]
gaiaftcl-py healing [--limit N]
gaiaftcl-py heartbeat [--limit N]
gaiaftcl-py research [--limit N]
gaiaftcl-py development [--status STATUS] [--limit N]
gaiaftcl-py evaluate [--algorithm-id ID] [--limit N]
gaiaftcl-py replay [--limit N]
gaiaftcl-py franklin wounds [--limit N]
gaiaftcl-py franklin rewards [--limit N]
gaiaftcl-py franklin strategy [--limit N]
gaiaftcl-py franklin randomness [--limit N]
gaiaftcl-py wallet show-state [--cell-id ID]
gaiaftcl-py wallet ledger [--limit N] [--asset-class CLASS]
gaiaftcl-py shor demonstrations [--limit N]
gaiaftcl-py pq migrations [--limit N]
gaiaftcl-py qfot ledger [--limit N]
gaiaftcl-py prove shor --target-pubkey HEX [--scale N] [--pubkey-encoding ENC] [--scheme S] [--script-type T] [--proof-mode M] [--source-outpoint TXID:VOUT]
gaiaftcl-py measure chi-coherence [--binary PATH]

See Python-Wrappers-Getting-Started for examples.

Federation-cosigned

This page's source is sealed in the GaiaFTCL federation manifest — page SHA-256 7be57d9b73e9b2db…, manifest witness 3d999b305397d96c…, signed 2026-07-17T15:45:53Z by cell gaiaftcl-mac-cell. Verify with gaiaftcl wiki sign --all and compare wiki-all-signatures.json.