Skip to content

some fixes in the code and the comments #249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: portal
Choose a base branch
from
Open

some fixes in the code and the comments #249

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ make shisui-image
After building `shisui`, you can start the client by running

```shell
# supported options are list below
# supported options are listed below
./build/bin/shisui
```

Expand All @@ -43,7 +43,7 @@ Alternatively, you can run the docker image by running
```shell
docker run -d -p 8545:8545 -p 9009:9009/udp -e SHISUI_NAT=stun ghcr.io/optimism-java/shisui:latest

# if you know your exiIp, replace by -e SHISUI_NAT=extip:${your ip}
# if you know your extIp, replace by -e SHISUI_NAT=extip:${your ip}
```

You can use the script below to check if the node has started correctly.
Expand Down Expand Up @@ -75,15 +75,15 @@ curl -X POST http://127.0.0.1:8545 \
* `stun` uses stun server to find extip
* `--udp.addr` protocol UDP server listening port(default: `9009`)
* `--loglevel` loglevel of portal network, `1` to `5`, from `error` to `trace`(default: `1`)
* `--private.key` private key of p2p node, hex format without `0x` prifix
* `--private.key` private key of p2p node, hex format without `0x` prefix
* `--bootnodes` bootnode of p2p network with ENR format, use `none` to config empty bootnodes
* `--networks` portal sub networks: history, beacon, state

all the options above can be set with envs.

the env is prefixed with `SHISUI` and change the `.` to `_`.

eg `--rpc.add` can be replaced with env `SHISUI_RPC_ADDR`
eg `--rpc.addr` can be replaced with env `SHISUI_RPC_ADDR`

### Hardware Requirements

Expand Down