Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Commit

Permalink
Fix merge conflict issue in readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
ckartik committed Oct 12, 2023
1 parent 22d685e commit c56269e
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,19 +72,6 @@ OPTIONS:
}
}
```

## PreConfirmations from Builders
To recieve preConfirmations from builders, the builder-mev-node needs to have a running service that connects to the RPC endpoints and connects to the following functions:
```protobuf
// ReceiveBids is called by the builder to receive bids from the mev-commit node.
// The mev-commit node will stream bids to the builder.
rpc ReceiveBids(EmptyMessage) returns (stream Bid) {}
// SendProcessedBids is called by the builder to send processed bids to the mev-commit node.
// The builder will stream processed bids to the mev-commit node.
rpc SendProcessedBids(stream BidResponse) returns (EmptyMessage) {}
```

## Sending bids as a Searcher
To send bids, you can use an gRPC api that is availible to searcher nodes.
Upon running this service, searcher nodes will have access to the following:
Expand Down Expand Up @@ -114,6 +101,17 @@ By default, the docker setup exposes port `13524`, which is the standard port on
## Commitments from Builders
To recieve commitments from builders, the builder-mev-node needs to have a running service that connects to the RPC endpoints and connects to the following functions:

```protobuf
// ReceiveBids is called by the builder to receive bids from the mev-commit node.
// The mev-commit node will stream bids to the builder.
rpc ReceiveBids(EmptyMessage) returns (stream Bid) {}
// SendProcessedBids is called by the builder to send processed bids to the mev-commit node.
// The builder will stream processed bids to the mev-commit node.
rpc SendProcessedBids(stream BidResponse) returns (EmptyMessage) {}
```


## Building Docker Image

To simplify the deployment process, you may utilize Docker to create an isolated environment to run mev-commit.
Expand All @@ -134,4 +132,4 @@ To simplify the deployment process, you may utilize Docker to create an isolated

```
docker-compose down
```
```

0 comments on commit c56269e

Please sign in to comment.