Skip to content

Commit

Permalink
docs: clarify points in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Evan-Kim2028 committed Jan 6, 2025
1 parent 2fea175 commit e6344e8
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
## About
This repository provides a user friendly CLI interface for making preconfirmation bids from mev-commit for ETH transfers or blob transactions. Additionally a bidder can spin up the docker container and run directly with the example [bidder node docker](https://github.com/primev/bidder_node_docker)
This repository provides a user friendly CLI interface for making preconfirmation bids from mev-commit for ETH transfers or blob transactions and aims to support different types of transactions such as bridging in the future. Additionally a bidder can spin up the docker container and run directly with the example [bidder node docker](https://github.com/primev/bidder_node_docker)

Transactions are sent directly to the builder as transaction payloads. Currently a fixed priority fee is used alongside a preconf bid amount.

If you’re an advanced user, you can still skip the interactive mode by specifying all configurations via environment variables, .env files, or command-line flags.


## Requirements
- funded holesky address
- funded L1 address (default is Holesky)
- funded mev-commit address
- mev-commit p2p bidder node (v0.8)
- a good websocket endpoint (a publicly available one is set as default, but cannot handle high throughput)
- mev-commit p2p bidder node
- a good websocket endpoint (a publicly available one is set as default for Holesky, but cannot handle high throughput)

## Installation
```
Expand All @@ -31,25 +31,26 @@ SERVER_ADDRESS="localhost:13524" # address of the server (Default loc
OFFSET=1 # of blocks in the future to ask for the preconf bid (Default 1 for next block)
NUM_BLOB=0 # blob count of 0 will just send eth transfers (Default 0)
BID_AMOUNT=0.001 # preconf bid amount (Default 0.001 ETH)
PRIORITY_FEE=1 # priority fee in wei (Default 1 gwei)
PRIORITY_FEE=1 # priority fee in wei (Default 1 wei)
BID_AMOUNT_STD_DEV_PERCENTAGE=100 # amount of variation in the preconf bid amount (in %) (Default 100%)
DEFAULT_TIMEOUT=15 # default context timeout for the program (Default 15 seconds)
APP_NAME=preconf_bidder # application name for logging purposes (Default name preconf_bidder)
VERSION=0.8.0 # mev-commit version for logging purposes (Default version v0.8.0)
```
## How to run
Ensure that the mev-commit bidder node is running in the background. A quickstart can be found [here](https://docs.primev.xyz/get-started/quickstart), which will get the latest mev-commit version and start running it with an auto generated private key.
## Ensure Bidder Node is Running
Ensure that the mev-commit bidder node is running in the background and the autodeposit function deposited ETH into the bidder window. A quickstart can be found [here](https://docs.primev.xyz/get-started/quickstart), which will get the latest mev-commit version and start running it with an auto generated private key.

## CLI
First build the CLI `go build -o biddercli .`

Then run the CLI `./biddercli`. Flags can be passed to quickstart the process and override default variables, otherwise follow the prompts to get started.

## Docker
Build the docker with `sudo docker-compose up --build`. Best run with the unofficial [dockerized bidder node example](https://github.com/primev/bidder_node_docker)
Build the docker with `sudo docker-compose up --build`. Best run with the [dockerized bidder node example](https://github.com/primev/bidder_node_docker)

## Linting
Run linting with `golangci-lint run ./...` inside the repository folder

## Testing
Run `go test -v ./...` in the main folder directory to run all the tests.

## CLI
First build the CLI `go build -o biddercli .`

Then run the CLI `./biddercli`. Flags can be passed to quickstart the process and override default variables, otherwise follow the prompts to get started.

0 comments on commit e6344e8

Please sign in to comment.