Skip to content

docs: move the JIT system guide to the solver crate #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kayibal wants to merge 1 commit into
base: main
Choose a base branch
from
+687 −407
Open

docs: move the JIT system guide to the solver crate #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,10 @@ Opting in costs the user nothing in calldata: the ABI is identical, so only the
address changes, and on Base the L1 data fee is unchanged. The whole cost is L2 execution gas,
about $0.0003 to $0.0005 per swap at August 2026 prices.

**[contracts/README.md](contracts/README.md)** is the detailed document: the mechanism, the
compression format, break-even economics with live prices, the trust model, and how to run the
tests. Start there.
**[crates/fynd-jit-solver/README.md](crates/fynd-jit-solver/README.md)** is the detailed
document: the mechanism, the solve loop, what authorizes an emission, the compression format,
break-even economics with live prices, the trust model, and how to run the tests. Start there.
**[contracts/README.md](contracts/README.md)** covers the three contracts on their own.

## Intent backrunning

Expand All @@ -52,15 +53,13 @@ and the smoke test.
| path | what it is |
| --- | --- |
| [`contracts/`](contracts) | Foundry project: `FyndJITRouter`, `RouteDictionary`, `RouteDecompressor`, and the `BackrunResolver` the intent mode settles through |
| [`crates/fynd-jit-solver`](crates/fynd-jit-solver) | The JIT solver: open book, improved-route quoting, the profitability gate, and the `storeBatch` it emits |
| [`crates/route-compressor`](crates/route-compressor) | Rust mirror of the on-chain compression format, plus the builder's calldata encoders |
| [`crates/intent-backrunner`](crates/intent-backrunner) | The Fusion intent engine |
| [`crates/builder-types`](crates/builder-types) | The types that cross the builder boundary: `BuildEvent` in, `BackrunCandidate` out |
| [`crates/solver-core`](crates/solver-core) | What both solvers share: the tycho quote client, build-iteration tracking, pending-state replay, and the fee conventions |
| [`crates/builder-types`](crates/builder-types) | The types that cross the builder boundary: `BuildEvent` in, `JitFrontrun` and `BackrunCandidate` out |
| [`crates/uniswap-v2-core`](crates/uniswap-v2-core), [`v3`](crates/uniswap-v3-core), [`v4`](crates/uniswap-v4-core) | Log-driven pending-state indexers for those three protocols |

The JIT solver itself, `crates/fynd-jit-solver`, is under review in
[PR #19](https://github.com/propeller-heads/builder-integration/pull/19) and is not yet on the
main line.

## Deployments

`FyndJITRouter` is not deployed yet. On Base it will front the live TychoRouterV3 at
Expand All @@ -71,8 +70,9 @@ main line.

```sh
cd contracts && forge test # 107 tests, ~2 min from a clean build
cargo test --workspace # 102 tests
cargo test --workspace # 256 tests, 3 ignored
```

Both READMEs document the fork suites, the cross-language fixtures, and the environment
variables they need.
`cargo test --workspace` rewrites `contracts/test/fixtures/route_selector/*.json`, so check
`git status` afterwards. The crate READMEs document the fork suites, the cross-language
fixtures, and the environment variables they need.
Loading