mev-commit

Is P2P software that creates a network of execution providers and bidders. Bidders can broadcast bids to providers and receive commitments from them. A high throughput POA EVM chain settles the bids at the end of a block slot.

Documentation

For detailed documentation, visit the mev-commit docs.

Main Components

• mev-commit client
• mev-commit-oracle
• mev-commit-bridge
• mev-commit-geth
• contracts

Getting Started

The mev-commit repository is a mono-repository that also use submodules for external dependencies. To clone the repository and its submodules, run the following command:

git clone --recurse-submodules <[email protected]:primev/mev-commit.git|https://github.com/primev/mev-commit.git>

If you have already cloned the repository and need to update the submodules, run the following command:

git submodule update --init --recursive

Development

When working with submodules, you can use the git submodule command to list available submodules. To make changes to a submodule, navigate to the submodule directory using the cd command. Before making any changes, ensure that the submodule is up-to-date. For example, to navigate to the external/geth submodule, run the following command:

cd external/geth
git submodule update --init --recursive

Make the necessary changes to the submodule and commit (and push) them. To make the changes available in the main repository, you need to push the changes to the submodule. After making changes to the submodule, navigate back to the main repository and commit the changes. For example, to commit and push changes made to the external/geth submodule, run the following commands inside the submodule directory:

git add -p
git commit -m "<your-commit-message>"
git push

Go back to the main repository and commit (and push) the changes made to the submodule:

git add external/geth
git commit -m "<your-commit-message>"
git push

Go Modules

Since this repository uses Go Workspaces to manage Go modules, when making changes to a Go module and its dependencies, ensure that the changes are reflected everywhere by running the following command:

go list -f '{{.Dir}}' -m | xargs -L1 go mod tidy -C
go work sync

See the go.work file for all the Go modules used in this repository.