Skip to content

[review-mirror] M1: ADR bundle 0001-0008 (upstream nullislabs/shepherd#12) - #83

Closed
brunota20 wants to merge 3 commits into
mirror-base/epicsfrom
docs/adr-bundle
Closed

[review-mirror] M1: ADR bundle 0001-0008 (upstream nullislabs/shepherd#12)#83
brunota20 wants to merge 3 commits into
mirror-base/epicsfrom
docs/adr-bundle

Conversation

@brunota20

Copy link
Copy Markdown

Internal review mirror of upstream nullislabs#12 (M1 architectural decision records).

Scope

The eight numbered ADRs capturing the engine + CoW design decisions:

  • ADR-0001: module.toml separate from engine.toml
  • ADR-0002: ProviderPool, transport by URL scheme, fatal-on-connection-error at boot
  • ADR-0003: LocalStore namespacing under a single redb file
  • ADR-0004: [patch.crates-io] cowprotocol to bleu/cow-rs
  • ADR-0005: OrderBookPool cached OrderBookApi per chain, built upfront
  • ADR-0006: high-level twap/ethflow host helpers
  • ADR-0007: upstream protocol logic to cow-rs (no CoW logic in engine)
  • ADR-0008: factory subscriptions via SubscriptionTemplate

Plus the matching diagrams under docs/diagrams/.

This branch was rebuilt to the M5-current docs state per the doc reconciliation pass (no vapor, capability gating aligned to shipped link-time enforcement).

How to use this PR

dependabot Bot and others added 3 commits June 14, 2026 03:59
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>
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.
@brunota20

Copy link
Copy Markdown
Author

Replaced by unified M1 epic mirror.

@brunota20 brunota20 closed this Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant