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

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kant777 authored Oct 16, 2023
1 parent 1a64640 commit f2e97b3
Showing 1 changed file with 4 additions and 26 deletions.
30 changes: 4 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ log_level: debug
# Bootnodes used for bootstrapping the network.
bootnodes:
- /ip4/35.91.118.20/tcp/13522/p2p/16Uiu2HAmAG5z3E8p7o19tEcLdGvYrJYdD1NabRDc6jmizDva5BL3

# The default is set to false for development reasons. Change it to true if you wish to accept bids on your builder instance
expose_builder_api: false
```
- After the config file is ready, run `mev-commit start` with the config option.
Expand Down Expand Up @@ -76,31 +79,6 @@ OPTIONS:
]
}
}
```
## Sending bids as a Searcher
To send bids, you can use an [gRPC api](https://github.com/primevprotocol/mev-commit/blob/main/rpc/searcherapi/v1/searcherapi.proto) that is availible to searcher nodes.
Upon running this service, searcher nodes will have access to the following:
```protobuf
service Searcher {
rpc SendBid(Bid) returns (stream Commitment) {}
}
message Bid {
string tx_hash = 1;
int64 amount = 2;
int64 block_number = 3;
};
```

By default, the docker setup exposes port `13524`, which is the standard port on which the searcher api is running. By hitting `SendBid` with the bid structure in the following format:
```
{
"tx_hash": "<tx-hash>",
"amount": <number>,
"block_number": <block-number>
}
```
## Building Docker Image
Expand Down Expand Up @@ -128,4 +106,4 @@ To simplify the deployment process, you may utilize Docker to create an isolated
[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.
- The required setup for builders to process bids into commitments in their personal infra.

0 comments on commit f2e97b3

Please sign in to comment.