README
☀️ SUAVE Protocol Specifications
This repository hosts the current SUAVE specifications.
Discussions about design rationale and proposed changes can be brought up and discussed on the Flashbots forum. Solidified, agreed-upon changes to the spec can be made through pull requests.
⚠️ The SUAVE protocol is still in a state where the code is the most up-to-date protocol spec. The goal of these notes is to gradually evolve into an implementation agnostic specification. ⚠️
About Suave
SUAVE - Single Unifying Auction for Value Expression - is a platform for building MEV applications such as OFAs and block builders in a decentralized and private way.
Read more about SUAVE:
- https://writings.flashbots.net/the-future-of-mev-is-suave
- https://writings.flashbots.net/mevm-suave-centauri-and-beyond
Specs
Specifications for the SUAVE protocol are currently organized by testnet during early protocol development. Several testnets might be developed in parallel.
In-development Specifications
| Testnet | Phase | ChainID | Specs |
|---|---|---|---|
| Rigil | Big Bang | 16813125 | • SUAVE chain • MEVM • Confidential Data Store • Precompiles • Bridge |
| Sirrah | Proto-Collision |
Roadmap
Contributing
You are welcome to open PRs and issues. We invite you to discuss your ideas in the Flashbots Forum for greater visibility and to avoid doing work that is unlikely to be widely accepted and merged into the core specs.
For creating tables of contents, we use the "Markdown All in One" VS code extension. This extension comes with a lot of keyboard shortcuts, which may override the ones you are already using. You can disable keyboard shortcuts for this extension by going to "Settings -> Keyboard Shortcuts" (cmd+K cmd+S) and searching for markdown.ext (see #22 for more details).
However, we don't need the ToCs and some other content (like this paragraph) rendered in the documentation frontend. Therefore, please add the <div class="hideInDocs"></div> to any content that should not appear in the FE.
Made with ☀️ by the ⚡🤖 collective.