cayu.collaboration.base
Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.
CollaborationStore
Section titled “CollaborationStore”from cayu.collaboration import CollaborationStoreTrusted owner API. Public authentication belongs to the application boundary.
Implementations must provide atomic native transactions, exact immutable receipts and cancellation settlement. No raw record write API is public.
Bases: ABC.
close (method)
Section titled “close (method)”async CollaborationStore.close() -> Nonecapabilities (method)
Section titled “capabilities (method)”CollaborationStore.capabilities(owner: OwnerRef) -> CapabilityDescriptorinitialize (method)
Section titled “initialize (method)”async CollaborationStore.initialize(binding: CollaborationBootstrap, *, redactor: SecretRedactor) -> CollaborationInitializationregister_wait (method)
Section titled “register_wait (method)”async CollaborationStore.register_wait(initialized, wait, *, redactor: SecretRedactor)load_wait (method)
Section titled “load_wait (method)”async CollaborationStore.load_wait(initialized, wait, *, redactor: SecretRedactor, wait_for_settlement=False)record_wait_evidence (method)
Section titled “record_wait_evidence (method)”async CollaborationStore.record_wait_evidence(initialized, wait, evidence, *, redactor: SecretRedactor, wait_for_settlement=False)release_wait_sources (method)
Section titled “release_wait_sources (method)”async CollaborationStore.release_wait_sources(initialized, wait, *, redactor: SecretRedactor, wait_for_settlement=False)record_wait_delivery (method)
Section titled “record_wait_delivery (method)”async CollaborationStore.record_wait_delivery(initialized, wait, *, receipt_digest: str, delivery: Literal['accepted', 'excluded']='accepted', redactor: SecretRedactor, wait_for_settlement=False)cancel_wait (method)
Section titled “cancel_wait (method)”async CollaborationStore.cancel_wait(initialized, wait, *, expired: bool, redactor: SecretRedactor)lookup (method)
Section titled “lookup (method)”async CollaborationStore.lookup(initialized: CollaborationInitialization, expected: ExpectedOperation[ParticipantIntent], *, redactor: SecretRedactor) -> ExactLookup[ParticipantReceipt]apply (method)
Section titled “apply (method)”async CollaborationStore.apply(initialized: CollaborationInitialization, expected: ExpectedOperation[ParticipantIntent], *, redactor: SecretRedactor) -> ParticipantReceiptinspect_namespace (method)
Section titled “inspect_namespace (method)”async CollaborationStore.inspect_namespace(initialized: CollaborationInitialization, *, redactor: SecretRedactor) -> NamespaceInspectioninspect_retirement (method)
Section titled “inspect_retirement (method)”async CollaborationStore.inspect_retirement(initialized: CollaborationInitialization, namespace: NamespaceRef, *, redactor: SecretRedactor) -> NamespaceRetirementEvidence | Nonescan_obligations (method)
Section titled “scan_obligations (method)”async CollaborationStore.scan_obligations(initialized: CollaborationInitialization, participant: ParticipantRef, *, after: int, limit: int, pending_only: bool, retention_revision: int | None, redactor: SecretRedactor) -> tuple[int, tuple[ParticipantObligation, ...]]apply_lifecycle (method)
Section titled “apply_lifecycle (method)”async CollaborationStore.apply_lifecycle(initialized: CollaborationInitialization, expected: LifecycleCommand, *, redactor: SecretRedactor) -> LifecycleReceiptlookup_lifecycle (method)
Section titled “lookup_lifecycle (method)”async CollaborationStore.lookup_lifecycle(initialized: CollaborationInitialization, expected: LifecycleCommand, *, redactor: SecretRedactor) -> ExactLookup[LifecycleReceipt]inspect (method)
Section titled “inspect (method)”async CollaborationStore.inspect(initialized: CollaborationInitialization, participant: ParticipantRef, *, redactor: SecretRedactor) -> ParticipantInspectionresolve_alias (method)
Section titled “resolve_alias (method)”async CollaborationStore.resolve_alias(initialized: CollaborationInitialization, alias: str, *, redactor: SecretRedactor) -> ParticipantAlias | Nonescan (method)
Section titled “scan (method)”async CollaborationStore.scan(initialized: CollaborationInitialization, *, table: Literal['participants', 'events'], after: str | int, limit: int, allowed: tuple[ParticipantRef, ...] | None, redactor: SecretRedactor) -> tuple[ParticipantSnapshot | ParticipantEvent, ...]scan_events (method)
Section titled “scan_events (method)”async CollaborationStore.scan_events(initialized: CollaborationInitialization, *, after: int, limit: int, allowed: tuple[ParticipantRef, ...] | None, retention_revision: int | None, redactor: SecretRedactor) -> tuple[int, tuple[ParticipantEvent, ...]]