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

Commit

Permalink
added searcher cli readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iowar committed Oct 22, 2023
1 parent 24ba41d commit b366c7b
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions examples/searcher_cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Searcher CLI
Searcher CLI is a command-line tool used to interact with a gRPC searcher server.

## Usage
Searcher CLI can be used with the following commands:

### 1. Send Bid
Used to send a bid.

```bash
searcher-cli send-bid --txhash <transaction_hash> --amount <bid_amount> --block <block_number>
```
* `--txhash`: Transaction hash.
* `--amount`: Bid amount.
* `--block`: Block number.

### 2. Check Status
Used to check the status of the gRPC searcher server.

```bash
searcher-cli status
```

### 3. Send Random Bid
Used to send a random bid.

```bash
searcher-cli send-rand-bid
```

## Configuration
Configuration options can be set using the config.yml file. An example configuration file is as follows:

```yaml
server_address: "localhost:13524"
log_fmt: "text"
log_level: "info"
```
* `server_address`: The address and port of the gRPC searcher server.
* `log_fmt`: Log format (text or json).
* `log_level`: Log level (debug, info, warn, error).

You can modify these settings to suit your specific environment and preferences.

0 comments on commit b366c7b

Please sign in to comment.