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

Commit

Permalink
Adds more documentation refactoring.
Browse files Browse the repository at this point in the history
  • Loading branch information
ckartik committed Oct 15, 2023
1 parent 6fb906b commit d43b34f
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 19 deletions.
22 changes: 3 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,24 +102,6 @@ By default, the docker setup exposes port `13524`, which is the standard port on
}
```


## Commitments from Builders
To gather commitments from builders, the builder mev-node must maintain an active service that interfaces with the [GRPC API](https://github.com/primevprotocol/mev-commit/blob/main/rpc/builderapi/v1/builderapi.proto) and interacts with 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) {}
```

By Default this service is disabled, and must be enabled by setting the BuilderAPIEmabled flag in the config file to true.

The file is located at [./config/builder.yaml](./config/builder.yml) and the variable is set to `expose_builder_api: false` by default.

## Building Docker Image

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

## APIs for Searcher & Builder
[Link to Documentation on Searcher and Builder API](./pkg/rpc/README.md)

- This includes:
- the payload for the searcher API
- The required setup for builders to process bids into commitments in their personal infra.
19 changes: 19 additions & 0 deletions pkg/rpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,22 @@ The response to the searcher API is a stream of commitments, an example response
"pre_confirmation_signature": "4838b53968be8a4cd4bceee9a8299885546b7d184cfe6390dcb8afd37fec3c1b08f0ce03935afce5b11b9f425434a4b22d01cb4d4dd5f4e5894c699302dbb3ad01"
}
```


## Commitments from Builders | Builder API
To gather commitments from builders, the builder mev-node must maintain an active service that interfaces with the [GRPC API](https://github.com/primevprotocol/mev-commit/blob/main/rpc/builderapi/v1/builderapi.proto) and interacts with 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) {}
```

**By default this service is disabled**, and must be enabled by setting the BuilderAPIEmabled flag in the config file to true.

The file is located at [./config/builder.yaml](../../config/builder.yml) form the top level of the project and the variable is set to `expose_builder_api: false` by default.

0 comments on commit d43b34f

Please sign in to comment.