runtime: implement cow-api, chain, local-store host backends#8
Draft
brunota20 wants to merge 2 commits into
Draft
runtime: implement cow-api, chain, local-store host backends#8brunota20 wants to merge 2 commits into
brunota20 wants to merge 2 commits into
Conversation
Adds the dependencies the 0.2 host backends need: - cowprotocol (1.0.0-alpha) for the cow-api submission path (OrderBookApi, OrderCreation, OrderUid, Chain). - alloy-provider / -rpc-client / -transport-ws / -primitives (1.5) for the chain JSON-RPC dispatch. The reqwest feature on alloy-provider engages connect_http; the pubsub/ws features back eth_subscribe-class methods. - redb (2) for local-store. Same crate cowprotocol's own watch-tower picked, so the dep tree does not bifurcate when both are used in the same workspace. - reqwest (0.12, rustls-tls) — direct, so the import survives any future cowprotocol feature rearrangement. - tracing + tracing-subscriber (env-filter + fmt) — replaces the 0.1 eprintln! debug log so the engine can drop into a structured log pipeline without re-instrumenting every host call. - thiserror (2) — typed error enums in each backend. - tempfile + wiremock as dev-deps for the host backend tests. Adds engine.example.toml documenting the [engine] state_dir + per- chain RPC URLs the chain backend reads at boot; data/ is now ignored so a local run does not leave the redb file in tree.
Replaces the 0.2 Unsupported stubs with working backends. Each
capability lives in its own host submodule so the trait impls in
main.rs stay thin (dispatch + project the backend's typed error
onto HostError).
cow_api::submit_order
- Parses the guest's bytes as JSON cowprotocol::OrderCreation.
- Dispatches via cowprotocol::OrderBookApi::post_order.
- Returns the assigned OrderUid as a 0x-prefixed hex string.
cow_api::request
- REST passthrough. The base URL is whichever URL the pool's
OrderBookApi client carries — so OrderBookApi::new_with_base_url
overrides (staging, wiremock) flow through transparently.
- Method/path validated host-side; orderbook 4xx/5xx bodies are
surfaced verbatim so the guest can decode {errorType,description}.
chain::request
- Raw JSON-RPC dispatch over an alloy DynProvider opened from
engine.toml at boot. WebSocket URLs engage pubsub (eth_subscribe);
HTTP URLs use the HTTP transport. Params are passed as
serde_json::RawValue so alloy does not re-encode.
- request-batch falls back to per-call dispatch (same shape as the
earlier stub but now backed by real RPC).
local_store
- redb file under engine_config.engine.state_dir.
- Single shared table. Per-module namespacing is enforced
host-side via [len:u8][module_name][raw_key] prefix on every
key. list_keys strips the prefix before returning to the guest.
logging
- Routes through tracing::event! tagged with module=<namespace>.
- Engine boot installs an EnvFilter-based subscriber; RUST_LOG
overrides the engine.toml log_level.
identity / remote-store / messaging / http stay at Unsupported per
the 0.2 roadmap (keystore / Swarm / Waku land in 0.3).
Tests (14, all green):
- cow_orderbook: pool default chains, unknown-chain typing, REST
GET passthrough, relative-path resolution, unknown-method
rejection, submit_order round-trip — last three under wiremock
so the full HTTP path is exercised without hitting api.cow.fi.
- provider_pool: empty pool surfaces UnknownChain.
- local_store: roundtrip, namespace isolation, delete, list_keys
prefix-stripping, empty-namespace rejection.
End-to-end against modules/example: example.wasm loads under the
new wiring, logs init + on_event through the tracing pipeline.
This was referenced Jun 1, 2026
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.
Draft, opening for early visibility — happy to revise scope or split further.
Context: Bleu has been working on the same M2 deliverables (TWAP + EthFlow + cow-api host) in a parallel repo (
bleu/shepherd) on a raw-FFI ABI that predated this repo. Once we saw the Nexum/Component-Model architecture here, the right move was to port the CoW Protocol logic onto your contract rather than continue two parallel runtimes. This PR is that port — only the pieces that fit the WIT contract you've already shipped; the raw-FFI side stays in our repo as a reference implementation.What this lands
Replaces the 0.2
Unsupportedstubs forcow-api,chain, andlocal-storewith working backends. Each capability lives in its own host submodule (crates/nexum-engine/src/host/{cow_orderbook,provider_pool,local_store_redb}.rs) so the trait impls inmain.rsstay thin and the backends are unit-testable without a wasmtime store.cow_api
request(chain_id, method, path, body)OrderBookApiclient carries, soOrderBookApi::new_with_base_urloverrides (staging / wiremock) flow through. Orderbook 4xx/5xx bodies surface verbatim so guests can decode{errorType, description}.submit_order(chain_id, order_data)cowprotocol::OrderCreation, dispatches viaOrderBookApi::post_order, returns the assignedOrderUidas0x-prefixed hex.chain
request(chain_id, method, params)DynProvideropened fromengine.toml.ws:///wss://engage pubsub (needed foreth_subscribe);http:///https://use the HTTP transport. Params pass through asserde_json::RawValueso alloy does not re-encode.request_batchlocal-store
get/set/delete/list_keysagainst a redb file underengine_config.engine.state_dir. Single shared table; per-module namespacing is enforced host-side via[len:u8][module_name][raw_key]prefix on every key.list_keysstrips the prefix before returning to the guest. Two modules using the same key string see disjoint data.logging
Routes through
tracing::event!tagged withmodule=<namespace>. Engine boot installs anEnvFilter-based subscriber;RUST_LOGoverrides theengine.tomllog_level. The 0.1-styleeprintln!lines are gone — fmt subscriber renders the same info plus structured fields.Out of scope (deliberate)
identity,remote-store,messaging,httpstay atUnsupported. Each has the 0.3 roadmap (keystore / Swarm / Waku) cited inline inmain.rs.Engine config
New optional
engine.toml(sibling of the binary, or third positional arg):Missing file ⇒ defaults (no chain endpoints;
chain::requestandcow_api::submit_orderreturnUnsupporteduntil configured).engine.example.tomlships in tree.Tests
14 unit tests, all green:
cow_orderbook: pool default-chains, unknown-chain typing, REST GET passthrough, relative-path resolution, unknown-method rejection,submit_orderround-trip — last three underwiremockso the full HTTP path is exercised without hittingapi.cow.fi.provider_pool: empty pool surfacesUnknownChain.local_store: roundtrip, namespace isolation, delete,list_keysprefix-stripping, empty-namespace rejection.End-to-end against
modules/example:example.wasmloads under the new wiring, logsinit+on_eventthrough the tracing pipeline. `just run` works unchanged.```
cargo fmt --all --check # clean
RUSTFLAGS=-D warnings cargo clippy --workspace --all-targets --all-features # clean
cargo test -p nexum-engine --bins # 14 passed
```
Threat-model notes
cow-rs.cow_api::requestreturns the response body verbatim; we do not parse or validate beyond whatcowprotocol::OrderBookApialready does.submit_orderre-parses the guest's JSON viaserde_json::from_slice::<OrderCreation>and reuses cowprotocol'sOrderCreation::from_signed_order_datavalidation (from != ZERO, app-data digest check) before posting. A malicious guest cannot bypass that path because the host calls cowprotocol, not its own re-encoder.engine.toml.Open questions for the maintainer
engine.tomlshape. I put it sibling to the binary with[engine] state_dir+[chains.<id>] rpc_url. Open to moving knobs into env vars, splitting it differently, or merging withnexum.tomlif you prefer one config surface. Yelled at the missing-config path with atracing::warn!rather than failing boot.OrderBookPool::with_default_chainshard-codes the five chains cowprotocol exposes viaChain::try_from. If you'd rather it consultengine.toml.[cow_api]for URL overrides per chain (mirroring the chain RPC table), happy to add it — theOrderBookApi::new_with_base_urlplumbing is already there.Coupling to
cowprotocol. This PR pullscowprotocoldirectly intonexum-engine. If the long-term design is "engine stays nexum-only, cow extensions live behind a feature flag", I can gate everycow-apicode path behind--features cowso a pure-Nexum build does not see the cowprotocol tree.local_storequota / transactional rollback. docs/04 mentions "per-event all-or-nothing" semantics and per-module storage quotas. This PR ships neither — every host call commits its own redb txn. Both fit naturally on top (we have a working quota counter in our other repo); want to do them in a follow-up?Bleu happy to iterate on any of the above before this leaves draft.