events Agent Guide

September 4, 2026 ยท View on GitHub

Scope: this guide applies to src/crates/contracts/events.

openbitfun-events owns platform-neutral event contracts and the emitter interface. It describes events; it does not own event delivery or product decisions.

Guardrails

  • Keep event payloads serializable, stable, and platform-neutral.
  • Do not depend on app crates, Tauri, transport adapters, concrete services, or UI command logic.
  • Preserve event names, payload fields, priority semantics, and ordering assumptions when refactoring.
  • Use shared DTOs from openbitfun-core-types when event payloads need stable identifiers or portable facts.
  • Delivery, persistence, throttling, subscription routing, and remote sync behavior belong in transport, services, or app adapters.

Verification

cargo check -p openbitfun-events
node scripts/check-core-boundaries.mjs

For documentation-only changes, run git diff --check.