go-ethereum/README.md
Chen Kai 71bc26db8c feat:update readme
Signed-off-by: Chen Kai <281165273grape@gmail.com>
2024-03-15 21:08:16 +08:00

1.6 KiB

Shisui

AppVeyor Build Discord

Shisui is an Ethereum portal client written in Go language based go-ethereum and erigon. The name is inspired by Uchiha Shisui from the anime Naruto, who is renowned as "Shisui of the Body Flicker".

Note: Shisui is still under heavy development and is not yet ready for production use.

Building the source

For prerequisites and detailed build instructions please read the Installation Instructions.

Building shisui requires both a Go (version 1.19 or later) and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run

make shisui

Also, you can build the docker image by running

make shisui-image

Running shisui

After building shisui, you can start the client by running

./build/bin/shisui

Alternatively, you can run the docker image by running

docker run -d -p 8545:8545 -p 9009:9009/udp ghcr.io/optimism-java/shisui:latest

Hardware Requirements

Minimum:

  • CPU with 2+ cores
  • 4GB RAM
  • 1TB free storage space to sync the Mainnet
  • 8 MBit/sec download Internet service

Recommended:

  • Fast CPU with 4+ cores
  • 16GB+ RAM
  • High-performance SSD with at least 1TB of free space
  • 25+ MBit/sec download Internet service