docs: add CLAUDE.md with commands, architecture, and conventions#554
Open
louise-poole wants to merge 1 commit intomainfrom
Open
docs: add CLAUDE.md with commands, architecture, and conventions#554louise-poole wants to merge 1 commit intomainfrom
louise-poole wants to merge 1 commit intomainfrom
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
dianacarvalho1
approved these changes
Mar 11, 2026
zizou0x
reviewed
Mar 11, 2026
Comment on lines
+30
to
+39
| ### Key Modules (`src/`) | ||
| - **`protocol/`**: Core traits and models (`ProtocolComponent`, `Update`) | ||
| - **`evm/simulation.rs`**: `SimulationEngine` — runs EVM transactions via `revm` | ||
| - **`evm/engine_db/`**: Database backends (in-memory, RPC-backed) | ||
| - **`evm/stream.rs`**: Tycho feed integration — decodes live state into protocol instances | ||
| - **`evm/protocol/`**: Protocol implementations | ||
| - **Native**: Pure Rust math (`uniswap_v2`, `uniswap_v3`, `uniswap_v4`, `ekubo`, `cowamm`, `fluid`, etc.) | ||
| - **VM** (`vm/`): Generic Solidity adapter executed in `revm` for protocols without native impls | ||
| - Shared: `cpmm.rs`, `clmm.rs`, `safe_math.rs`, `u256_num.rs` | ||
| - **`rfq/`**: RFQ client for off-chain market makers (Bebop, Hashflow) |
Contributor
There was a problem hiding this comment.
Happy to start like this but I think it's not optimal, we should probably do like Turbine did; trim it to the strict minimum and point to other files (e.g they used ./claude.CODEBASE.md` for the modules descriptions
Contributor
Author
There was a problem hiding this comment.
Do you know if they felt it had much of an impact on their Claude sessions? This felt very compact already.
Contributor
There was a problem hiding this comment.
Yes I think it helped a lot to keep the context small
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
3 participants
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.
No description provided.