docs: ADR bundle 0001-0007 — engine and CoW architectural decisions#1
Open
brunota20 wants to merge 3 commits into
Open
docs: ADR bundle 0001-0007 — engine and CoW architectural decisions#1brunota20 wants to merge 3 commits into
brunota20 wants to merge 3 commits into
Conversation
yvesfracari
reviewed
Jun 3, 2026
There was a problem hiding this comment.
I think that here we have another decision to make. If we need to make historical index as well. Let's discuss this with mfw but it makes the project more complex without need
Collaborator
Author
There was a problem hiding this comment.
When sending this to mfw, I will comment that this last ADR is discussable
Updates the requirements on [wit-bindgen](https://github.com/bytecodealliance/wit-bindgen) to permit the latest version. - [Release notes](https://github.com/bytecodealliance/wit-bindgen/releases) - [Commits](bytecodealliance/wit-bindgen@v0.57.0...v0.58.0) --- updated-dependencies: - dependency-name: wit-bindgen dependency-version: 0.58.0 dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [actions/checkout](https://github.com/actions/checkout) from 6.0.2 to 6.0.3. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@de0fac2...df4cb1c) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: 6.0.3 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
This was referenced Jun 18, 2026
Replaces the original docs/adr-bundle commit chain with the current accurate version of the same file set. Each ADR + diagram now matches the design as shipped through M5: - ADR-0001 nexum.toml -> module.toml rename - ADR-0003 32-byte hash namespacing in redb local-store - ADR-0006 capability gating is link-time (boot validation against KNOWN_CAPABILITIES), not per-call dispatch - diagrams.md ASCII hyphens per rubric; vapor features (cargo-nexum CLI, nexum-sdk separate crate, :8080/health endpoint, [module.resources] per-module caps) marked as future direction (0.3+ target), with pointers to ADR-0009 for the host-trait seam that supersedes the macro design. Same file set as before (8 ADRs in docs/adr/, 9 diagrams in docs/diagrams/, the original CI workflow + .gitignore + modules/example/Cargo.toml deltas). This is a force-push that replaces the original PR #12 head; mfw78's prior review threads will need to be re-anchored against the updated text. AI Assistance: Claude Code (Opus 4.7) rebuilt the branch by copying file content from chore/docs-reconciliation-m2-m5 (M5-current + reconciliation applied) onto a fresh tree off the upstream main base. A human (Bruno) is accountable for the result.
e5579a3 to
439bd2f
Compare
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 mfw78 sign-off; landing them here makes the decisions reviewable independently from the implementing draft PRs innullislabs/shepherd(#8, #9, #10).ADRs are ordered for reading (foundations → CoW infra → CoW helpers → cross-cutting), not chronologically.
Scope
engine.tomlseparate from modulenexum.tomllocal-storevia length-prefixed keycowprotocoltobleu/cow-rsmaincow-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.Highlights worth mfw78's attention
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 ADR where Bleu deliberately deviates from the published design and needs explicit sign-off.cowprotocolprimitives. The EthFlow module is positioned as the Rust externalization of the ethflow indexer currently insidecowprotocol/services/crates/autopilot/src/database/onchain_order_events/ethflow_events.rs, in line with howwatch-towerandrefunderwere extracted.composable::poll_and_build_orderwith richPollOutcome,eth_flow::decode_placement,OrderPostErrorrich variants +retry_hint,OrderBookApi::with_base_url,wasm32feature-gate) land inbleu/cow-rsfirst and are consumed via the patched dependency in ADR-0004.Next
Once mfw78 reacts, 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 mfw78 already specified.