This repository has been archived by the owner on Jun 20, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|