https://github.com/flashbots/suapp-examples
SUAVE Application Examples
https://github.com/flashbots/suapp-examples
Last synced: 4 months ago
JSON representation
SUAVE Application Examples
- Host: GitHub
- URL: https://github.com/flashbots/suapp-examples
- Owner: flashbots
- License: mit
- Created: 2023-11-03T12:03:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-04T09:29:50.000Z (over 1 year ago)
- Last Synced: 2025-04-02T06:07:06.438Z (about 1 year ago)
- Language: Go
- Homepage: https://github.com/flashbots/suave-geth/
- Size: 454 KB
- Stars: 57
- Watchers: 18
- Forks: 20
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SUAVE Suapp Examples
This repository contains several [examples and useful references](/examples/) for building Suapps!
---
See also:
- [suave-geth source](https://github.com/flashbots/suave-geth)
- [Flashbots Collective: SUAVE Forum](https://collective.flashbots.net/c/suave/27)
Writings:
- [The Future of MEV is SUAVE](https://writings.flashbots.net/the-future-of-mev-is-suave)
- [The MEVM, SUAVE Centauri, and Beyond](https://writings.flashbots.net/mevm-suave-centauri-and-beyond)
---
## Getting Started
```bash
# Clone this repository
git clone https://github.com/flashbots/suapp-examples.git
```
---
## Compile the examples
Install [Foundry](https://getfoundry.sh/):
```bash
curl -L https://foundry.paradigm.xyz | bash
foundryup
```
Install dependencies:
```bash
forge install
```
Compile:
```bash
forge build
```
---
## Start the local devnet
### TL;DR
1. Install prerequisites:
- [Docker](https://docs.docker.com/engine/install/)
- [Kurtosis](https://docs.kurtosis.com/install/)
2. Run
```bash
# Launch kurtosis devnet + sidecar docker-compose with SUAVE
make devnet-up
# Point SUAVE examples to the devnet
export BUILDER_URL=http://el-4-geth-builder-lighthouse:8545
export L1_PRIVKEY=bcdf20249abf0ed6d944c0288fad489e33f66b3960d9e6229c1cd214ed3bbe31
# Run
go run examples/app-ofa-private/main.go
# Tear-down
make devnet-down
```
>
> **Notes:**
>
> 1. If you are Mac OS user, you might want to consider using
> [OrbStack](https://orbstack.dev/) instead of Docker Desktop.
>
> 2. Some of the tests (`app-ofa-private`, for example) will need Eth
> devnet to progress beyond dencun fork. Wait out ~5m after the
> start before running them (roughly slot 128).
>
### Details
Above setup will (among other things) deploy:
- SUAVE devnet RPC on `http://127.0.0.1:8545`
- Eth devnet RPC on `http://127.0.0.1:8555`
- SUAVE explorer on `http://127.0.0.1:8080`
- Eth explorer on `http://127.0.0.1:18080`
- MEV Boost Relay Overview on `http://127.0.0.1:9060`
All Eth components are provisioned by `ethereum-package` from kurtosis.
Please check `https://github.com/kurtosis-tech/ethereum-package` for more info.
---
## Run the examples
Check out the [`/examples/`](/examples/) folder for several example Suapps and `main.go` files to deploy and run them!
---
Happy hacking 🛠️