docs: ADR bundle (0001-0008) — engine and CoW architectural decisions#12
Open
brunota20 wants to merge 4 commits into
Open
docs: ADR bundle (0001-0008) — engine and CoW architectural decisions#12brunota20 wants to merge 4 commits into
brunota20 wants to merge 4 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Captures the eight architectural decisions Bleu has made (engine-side) or proposed (CoW host helpers, upstream policy, forward-looking factory pattern) across the M1 → M2 work. All eight carry status
proposedpending upstream sign-off; landing them here makes the decisions reviewable independently from the implementing draft PRs (#8, #9, #10).These ADRs went through internal Bleu review in bleu/nullis-shepherd#1 before opening here.
ADRs are ordered for reading (foundations → CoW infra → CoW helpers → cross-cutting), not chronologically.
Scope
engine.tomlseparate from modulenexum.tomllocal-storevia length-prefixed keycowprotocolto the head of upstream PR #5cow-apihost backend via cachedOrderBookApiper chainshepherd:cow@0.2.0cow-rsfirst, adopt in engine secondAlso adds
data/(enginestate_dirdefault) andskills-lock.json(local skill lockfile) to.gitignoreso the engine's runtime state does not pollute the working tree.Format
ADRs follow the
grill-with-docsformat: short title, 1-2 paragraph Context, Decision, Considered options (rejected alternatives worth remembering), and Consequences. Frontmatter carriesstatus: proposedand animplemented-in: <PR>pointer where applicable.Points to weigh on review
docs/04-state-store.md— the linked doc specifies one redb file per module; we propose a single shared file with a[len:u8][module][key]prefix. Rationale in the ADR. This is the one place Bleu deliberately deviates from the published design and needs explicit sign-off.cowprotocolprimitives. EthFlow is positioned as the Rust externalization of the ethflow indexer currently insidecowprotocol/services/crates/autopilot/src/database/onchain_order_events/ethflow_events.rs.composable::poll_and_build_orderwith richPollOutcome,eth_flow::decode_placement,OrderPostErrorrich variants +retry_hint,OrderBookApi::with_base_url,wasm32feature-gate) land as additional commits oncowdao-grants/cow-rsPR #5 and are consumed via the patched dependency in ADR-0004.Next
Once feedback comes in, statuses flip to
accepted(orsuperseded) in a follow-up commit. The most likely point of pushback is ADR-0003 (single redb file vs per-module file); the rest of the surface is either gap-filling or implementation choice over interfaces the upstream spec already defines.