Generated reference

Every operation, and the surface it answers on.

This page is written by docs-tools/gen_reference.py out of the frozen registry, the schemas, the descriptors and the daemon's own op list. Nothing on it is typed by hand, and ./run-checks.sh fails if it drifts from those sources.

99 registry rows 95 operations 7 bound surfaces 4 bundles 26 machines

The registry

The registry keys one row per (operation, surface) pair. It is the freeze source for a bundle and the dispatch truth for the daemon: a call whose (operation, surface) pair has no row is refused, not interpreted. Four operations carry two rows because they exist on both the participant and the governance surface.

SurfaceRowsWhat it is
governance24Decisions made about a Society: bootstrap, charter, membership offers, admission, mandates, and the two reconciliation seats. The seat where authority is granted.
candidate3The only surface an unadmitted candidate can reach — offer-scoped, minted with one MembershipOffer and fenced the moment that offer terminates. It can accept, refuse, or propose its own self-policy, and nothing else.
participant42What an admitted participant does on its own behalf: propose endeavors, fill seats, pledge, derive mandates, open activities, submit deliveries, record reviews.
runtime14The execution seam. Episode claim/start/complete, checkpoints, permit consumption, usage reports, placement admission — reached with a byomd-minted workload token bound to one (episode, generation).
projection11Reads only. Society and participant projections, the charter history, the event ledger and its payloads, snapshots, and the recovery checkpoint. No operation on this surface mutates anything.
pre_auth3Version and capability negotiation, answerable before any authority is established. Not a socket of its own: these operations answer on every socket.
originating2The two recovery reads a caller aims at its own prior request — idempotency_result and cursor_recover. Not a socket of its own: they answer on the mutation-capable socket the original request used.
admin0Named in the closed surface enum and bound to no operation at all. There is no admin.sock, and deny-by-absence means an admin call is not unauthorized — it is unaddressable.
ClassRowsWhat the meta looks like
read16Never mutates; carries no MutationMeta.
create40A mutation whose closed meta has no expected_revision member at all, so supplying one fails the schema.
update43A current-head CAS whose closed meta requires meta.expected_revision (RT-01).
BundleRowsFamilies
B0.180activities, acts, calls_and_pledges, candidates, charter, endeavors, events_and_recovery_core, mandates, negotiation, participants, society
B0.33host_integration, recovery
B0.411budgets, recovery, runtime
B0.55knowledge, runtime

Across 16 families. The served column below is read out of the daemon's own implemented() predicate: 85 of 95 operations are implemented, and the rest answer a typed feature_unavailable rather than being silently absent.

Operations by surface

Request and result schema names are the frozen files under spec/schemas/ops/; a -v2 name is an immutable successor publication, never an edit of the original.

governance — 24 rows

Decisions made about a Society: bootstrap, charter, membership offers, admission, mandates, and the two reconciliation seats. The seat where authority is granted.

OperationBindingFamilyClassBundleRequest / result schemaServed
act_intent_cancelR25actsupdateB0.1act-intent-cancel-request
act-intent-cancel-result
no
act_intent_finalizeR23actsupdateB0.1act-intent-finalize-request
act-intent-finalize-result
yes
act_intent_positionR21actscreateB0.1act-intent-position-request
act-intent-position-result
yes
budget_reconcileR38budgetscreateB0.4budget-reconcile-request
budget-reconcile-result
yes
charter_finalizeR8charterupdateB0.1charter-finalize-request
charter-finalize-result
yes
charter_positionR6chartercreateB0.1charter-position-request
charter-position-result
yes
effect_reconcileR38recoverycreateB0.4effect-reconcile-request
effect-reconcile-result
yes
external_command_terminalizeR40recoverycreateB0.3external-command-terminalize-request
external-command-terminalize-result
yes
kovee_endeavor_formR39host_integrationcreateB0.3kovee-endeavor-form-request
kovee-endeavor-form-result
yes
mandate_holdR18mandatesupdateB0.1mandate-hold-request
mandate-hold-result
yes
mandate_issueR18mandatesupdateB0.1mandate-issue-request
mandate-issue-result-v2
yes
mandate_positionR17mandatescreateB0.1mandate-position-request
mandate-position-result
yes
mandate_revokeR18mandatesupdateB0.1mandate-revoke-request
mandate-revoke-result
yes
manifestation_admitR8participantsupdateB0.1manifestation-admit-request
manifestation-admit-result
yes
membership_offerR10participantscreateB0.1membership-offer-request
membership-offer-result
yes
membership_offer_revokeR10participantsupdateB0.1membership-offer-revoke-request
membership-offer-revoke-result
yes
onboarding_offerR10participantscreateB0.1onboarding-offer-request
onboarding-offer-result
yes
participant_admitR8participantsupdateB0.1participant-admit-request
participant-admit-result
yes
participant_suspendR10participantsupdateB0.1participant-suspend-request
participant-suspend-result
no
society_bootstrapR2societyupdateB0.1society-bootstrap-request
society-bootstrap-result
yes
society_dissolveR3societyupdateB0.1society-dissolve-request
society-dissolve-result
no
society_holdR3societyupdateB0.1society-hold-request
society-hold-result
no
society_prepareR2societycreateB0.1society-prepare-request
society-prepare-result
yes
society_releaseR3societyupdateB0.1society-release-request
society-release-result
no

candidate — 3 rows

The only surface an unadmitted candidate can reach — offer-scoped, minted with one MembershipOffer and fenced the moment that offer terminates. It can accept, refuse, or propose its own self-policy, and nothing else.

OperationBindingFamilyClassBundleRequest / result schemaServed
candidate_self_policy_proposeR11candidatescreateB0.1candidate-self-policy-propose-request-v2
candidate-self-policy-propose-result
yes
membership_acceptR11candidatesupdateB0.1membership-accept-request
membership-accept-result
yes
membership_refuseR11candidatesupdateB0.1membership-refuse-request
membership-refuse-result
yes

participant — 42 rows

What an admitted participant does on its own behalf: propose endeavors, fill seats, pledge, derive mandates, open activities, submit deliveries, record reviews.

OperationBindingFamilyClassBundleRequest / result schemaServed
act_intent_cancelR24actsupdateB0.1act-intent-cancel-request
act-intent-cancel-result
no
act_intent_finalizeR22actsupdateB0.1act-intent-finalize-request
act-intent-finalize-result
yes
act_intent_positionR20actscreateB0.1act-intent-position-request
act-intent-position-result
yes
act_intent_prepareR19actscreateB0.1act-intent-prepare-request
act-intent-prepare-result
yes
activation_policy_adoptR13participantscreateB0.1activation-policy-adopt-request-v2
activation-policy-adopt-result
yes
activation_policy_revokeR13participantsupdateB0.1activation-policy-revoke-request
activation-policy-revoke-result
yes
activity_closeR29activitiesupdateB0.1activity-close-request
activity-close-result
yes
activity_holdR29activitiesupdateB0.1activity-hold-request
activity-hold-result
yes
activity_openR29activitiescreateB0.1activity-open-request
activity-open-result
yes
assent_policy_adoptR13participantscreateB0.1assent-policy-adopt-request-v2
assent-policy-adopt-result
yes
assent_policy_revokeR13participantsupdateB0.1assent-policy-revoke-request
assent-policy-revoke-result
yes
call_openR5calls_and_pledgescreateB0.1call-open-request-v2
call-open-result
yes
call_withdrawR14calls_and_pledgesupdateB0.1call-withdraw-request
call-withdraw-result
yes
charter_proposeR5chartercreateB0.1charter-propose-request-v2
charter-propose-result
yes
continuation_writeR29activitiescreateB0.1continuation-write-request
continuation-write-result
yes
continuity_root_updateR13participantsupdateB0.1continuity-root-update-request-v2
continuity-root-update-result
yes
delivery_submitR29calls_and_pledgescreateB0.1delivery-submit-request
delivery-submit-result
yes
delivery_withdrawR14calls_and_pledgesupdateB0.1delivery-withdraw-request
delivery-withdraw-result
no
endeavor_closeR14endeavorsupdateB0.1endeavor-close-request
endeavor-close-result
yes
endeavor_finalizeR9endeavorsupdateB0.1endeavor-finalize-request
endeavor-finalize-result
yes
endeavor_holdR14endeavorsupdateB0.1endeavor-hold-request
endeavor-hold-result
yes
endeavor_positionR7endeavorscreateB0.1endeavor-position-request
endeavor-position-result
yes
endeavor_proposeR5endeavorscreateB0.1endeavor-propose-request
endeavor-propose-result
yes
endeavor_releaseR14endeavorsupdateB0.1endeavor-release-request
endeavor-release-result
yes
episode_requestR29activitiescreateB0.1episode-request-request
episode-request-result
yes
mandate_deriveR15mandatescreateB0.1mandate-derive-request-v2
mandate-derive-result
yes
mandate_positionR16mandatescreateB0.1mandate-position-request
mandate-position-result
yes
mandate_prepareR15mandatescreateB0.1mandate-prepare-request-v2
mandate-prepare-result
yes
manifestation_disableR13participantsupdateB0.1manifestation-disable-request
manifestation-disable-result
no
manifestation_proposeR13participantscreateB0.1manifestation-propose-request
manifestation-propose-result
no
participant_proposeR5participantscreateB0.1participant-propose-request
participant-propose-result
no
participant_retireR12participantsupdateB0.1participant-retire-request
participant-retire-result
no
participation_ceaseR12participantsupdateB0.1participation-cease-request
participation-cease-result
yes
pledge_amendR5calls_and_pledgescreateB0.1pledge-amend-request-v2
pledge-amend-result
yes
pledge_finalizeR9calls_and_pledgesupdateB0.1pledge-finalize-request
pledge-finalize-result
yes
pledge_positionR7calls_and_pledgescreateB0.1pledge-position-request
pledge-position-result
yes
pledge_proposeR5calls_and_pledgescreateB0.1pledge-propose-request-v2
pledge-propose-result
yes
pledge_relinquishR14calls_and_pledgesupdateB0.1pledge-relinquish-request
pledge-relinquish-result
yes
pledge_resumeR14calls_and_pledgesupdateB0.1pledge-resume-request
pledge-resume-result
yes
review_recordR14calls_and_pledgescreateB0.1review-record-request
review-record-result
yes
wake_intent_submitR29activitiescreateB0.1wake-intent-submit-request
wake-intent-submit-result
yes
wake_intent_withdrawR29activitiesupdateB0.1wake-intent-withdraw-request
wake-intent-withdraw-result
yes

runtime — 14 rows

The execution seam. Episode claim/start/complete, checkpoints, permit consumption, usage reports, placement admission — reached with a byomd-minted workload token bound to one (episode, generation).

OperationBindingFamilyClassBundleRequest / result schemaServed
attention_notice_recordR30-derivedruntimecreateB0.5attention-notice-record-request
attention-notice-record-result
yes
checkpoint_commitR30runtimecreateB0.4checkpoint-commit-request
checkpoint-commit-result
yes
effect_outcome_admitR35runtimecreateB0.4effect-outcome-admit-request
effect-outcome-admit-result
yes
episode_claimR30runtimecreateB0.4episode-claim-request
episode-claim-result
yes
episode_completeR30runtimeupdateB0.4episode-complete-request
episode-complete-result
yes
episode_failR30runtimeupdateB0.4episode-fail-request
episode-fail-result
yes
episode_startR30runtimeupdateB0.4episode-start-request
episode-start-result
yes
episode_yieldR30runtimeupdateB0.4episode-yield-request
episode-yield-result
yes
execution_permit_consumeR34actsupdateB0.1execution-permit-consume-request
execution-permit-consume-result
yes
onboarding_compute_permit_consumeR32runtimeupdateB0.5onboarding-compute-permit-consume-request
onboarding-compute-permit-consume-result
yes
onboarding_episode_claimR31runtimecreateB0.5onboarding-episode-claim-request
onboarding-episode-claim-result
yes
onboarding_episode_completeR31runtimeupdateB0.5onboarding-episode-complete-request
onboarding-episode-complete-result
yes
placement_admitR33runtimecreateB0.4placement-admit-request
placement-admit-result
yes
usage_reportR30runtimecreateB0.4usage-report-request
usage-report-result
yes

projection — 11 rows

Reads only. Society and participant projections, the charter history, the event ledger and its payloads, snapshots, and the recovery checkpoint. No operation on this surface mutates anything.

OperationBindingFamilyClassBundleRequest / result schemaServed
activity_showR4activitiesreadB0.1activity-show-request
activity-show-result
yes
charter_historyR4charterreadB0.1charter-history-request
charter-history-result
yes
context_manifest_showR4knowledgereadB0.5context-manifest-show-request
context-manifest-show-result
yes
event_payloadR4events_and_recovery_corereadB0.1event-payload-request
event-payload-result
yes
events_readR4events_and_recovery_corereadB0.1events-read-request
events-read-result
yes
events_waitR4events_and_recovery_corereadB0.1events-wait-request
events-wait-result
yes
external_command_result_queryR42recoveryreadB0.3external-command-result-query-request
external-command-result-query-result
yes
participant_showR4participantsreadB0.1participant-show-request
participant-show-result
yes
recovery_checkpoint_showR4events_and_recovery_corereadB0.1recovery-checkpoint-show-request
recovery-checkpoint-show-result
yes
snapshot_getR4events_and_recovery_corereadB0.1snapshot-get-request
snapshot-get-result
yes
society_showR4societyreadB0.1society-show-request
society-show-result
yes

pre_auth — 3 rows

Version and capability negotiation, answerable before any authority is established. Not a socket of its own: these operations answer on every socket.

OperationBindingFamilyClassBundleRequest / result schemaServed
feature_infoR1negotiationreadB0.1feature-info-request
feature-info-result
yes
helloR1negotiationreadB0.1hello-request
hello-result
yes
protocol_infoR1negotiationreadB0.1protocol-info-request
protocol-info-result
yes

originating — 2 rows

The two recovery reads a caller aims at its own prior request — idempotency_result and cursor_recover. Not a socket of its own: they answer on the mutation-capable socket the original request used.

OperationBindingFamilyClassBundleRequest / result schemaServed
cursor_recoverR41events_and_recovery_corereadB0.1cursor-recover-request
cursor-recover-result
yes
idempotency_resultR41events_and_recovery_corereadB0.1idempotency-result-request
idempotency-result-result
yes

admin — 0 rows

Named in the closed surface enum and bound to no operation at all. There is no admin.sock, and deny-by-absence means an admin call is not unauthorized — it is unaddressable.

Deny by absence

No operation is bound to admin. It is a value in the closed surface enum with no registry row and no socket, so there is nothing to call and nothing to authorize.

Registry-bound, not implemented

10 of the 95 registered operations are not implemented by this daemon: act_intent_cancel, delivery_withdraw, manifestation_disable, manifestation_propose, participant_propose, participant_retire, participant_suspend, society_dissolve, society_hold, society_release. Each is bound in the registry and answers feature_unavailable; feature_info advertises exactly the implemented set, because a feature is advertised only when it is complete.

Transition machines

26 committed transition descriptors, 167 states and 312 transitions in total. A descriptor is the closed state machine for one record kind: a transition that is not listed is not merely disallowed, it is invalid. 5 of them are Kovee-owned executors, outside byom's one-descriptor-per-mutating-operation rule.

The model column names the TLA+ module that declares parity with the descriptor. 9 modules exist; a descriptor with no model is covered by the executable state walks and by the schema and registry gates, but not by TLC.

MachineStatesTransitionsOwnerModel
ActIntent1120byomActIntentPermit.tla
ActivityStream826byomEpisodeLease.tla
AuthorityMutationJournal59byomAuthorityJournal.tla
ByomAksonDispatchOutcomeReceiptHead23kovee (C2)— none
ByomEpisodeBinding34kovee (C2)— none
Call59byom— none
Candidate self-policy45byom— none
CharterRevision35byom— none
ContinuationHead12byom— none
ContinuityRoot35byom— none
Delivery/Review44byom— none
EndeavorFormationIntent/Slot937kovee (C2)— none
Endeavor814byom— none
Episode/EpisodeLease1720byomEpisodeLease.tla
GreenfieldEnablement47kovee (C2)GreenfieldEnablement.tla
Mandate79byomMandateChain.tla
Manifestation44byom— none
MembershipOffer/Standing1219byomMembershipOfferStanding.tla
OnboardingActivationOffer614byomMembershipOfferStanding.tla
Participant activation policy44byom— none
Participant assent policy44byom— none
Participant56byom— none
Pledge1443byomPledge.tla
Society57byom— none
ByomSubordinateReservation613kovee (C2)SubordinateReservation.tla
WakeIntent/ActivationAdmission/ResourceAllocation1319byomEpisodeLease.tla

Digest classes

Every digest field on the wire is a typed DigestRef{class, algorithm, key_ref?, value_hex}, a closed member set — never an unlabelled hash. A well-constructed digest of the wrong class is digest_class_mismatch even when the 32-byte value spaces coincide.

ClassAlgorithmkey_refWhat it is for
structural_publicsha-256forbiddenKnowingly non-sensitive, non-erasable protocol or schema bytes only. SHA-256 over type-tagged canonical bytes.
portable_publicsha-256forbiddenContent whose owner explicitly accepted a durable, publicly dictionary-testable identifier. SHA-256 over exact bytes. This is the class the A8 cross-boundary rule demands of any digest one protocol asks the other for.
disclosed_partysha-256forbiddenSHA-256 over bytes already disclosed to named recipients, always carrying the external-copy obligation.
ciphertext_publicsha-256forbiddenSHA-256 over encrypted blob bytes. Sealed blobs only — never a commitment to low-entropy plaintext.
local_erasure_safehmac-sha-256requiredOrdinary erasable local content and every authority subject. HMAC under a random per-object secret: destroying that secret destroys exactly that object's offline verification.
scope_erasure_safehmac-sha-256requiredShared-key index and chain constructions — the idempotency index, the privacy-access chain. HMAC under a per-scope key: destroying it erases verifiability for the whole scope, never one object.

Problem kinds

The failure envelope wraps an RFC 9457 problem object whose kind is this closed 29-value enum. type is exactly https://byom.dev/problems/ + kind; an unknown kind fails closed. title is free prose and carries no authority.

invalid, unsupported_version, feature_unavailable, forbidden_surface, forbidden, not_found, stale_revision, stale_binding, stale_assembly_epoch, stale_lease, idempotency_mismatch, position_ineligible, decision_incomplete, independence_conflict, authority_widening, mandate_held, admission_required, classification_unmapped, policy_conflict, policy_overflow, budget_exceeded, effect_ambiguous, authority_witness_unknown, endpoint_sealed, cursor_expired, unavailable, formation_requires_participation, external_command_not_terminalizable, internal.

Wire limits

The conformance-tested initial limits, advertised by protocol_info and enforced before schema validation.

LimitValueUnit
Request body262,144bytes, inclusive — 256 KiB
Response body1,048,576bytes, inclusive — 1 MiB
Container nesting depth64levels, inclusive
JSON values per document65,536nodes, inclusive
Identifier128bytes of visible ASCII
List items per mutation256items
Events per page512events