{"id":23408522,"url":"https://github.com/zen-eth/shisui","last_synced_at":"2025-08-31T16:35:22.131Z","repository":{"id":269016876,"uuid":"906119208","full_name":"zen-eth/shisui","owner":"zen-eth","description":"Ethereum Portal Network Client written in Go","archived":false,"fork":false,"pushed_at":"2025-02-11T14:43:24.000Z","size":8496,"stargazers_count":3,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-11T15:37:26.085Z","etag":null,"topics":["eth","ethereum","go","golang","lightclient","portal-network"],"latest_commit_sha":null,"homepage":"https://www.ethportal.net/clients/shisui","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zen-eth.png","metadata":{"files":{"readme":"README.md","changelog":"history/accumulator.go","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-20T07:52:31.000Z","updated_at":"2025-02-09T13:53:41.000Z","dependencies_parsed_at":"2025-01-10T09:51:17.163Z","dependency_job_id":"08508945-5490-480f-b646-619c2110acfc","html_url":"https://github.com/zen-eth/shisui","commit_stats":null,"previous_names":["zen-eth/shisui"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zen-eth%2Fshisui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zen-eth%2Fshisui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zen-eth%2Fshisui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zen-eth%2Fshisui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zen-eth","download_url":"https://codeload.github.com/zen-eth/shisui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238902629,"owners_count":19549776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eth","ethereum","go","golang","lightclient","portal-network"],"created_at":"2024-12-22T15:15:15.573Z","updated_at":"2025-08-31T16:35:22.125Z","avatar_url":"https://github.com/zen-eth.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shisui\n[![CI](https://github.com/zen-eth/shisui/actions/workflows/ci.yml/badge.svg)](https://github.com/zen-eth/shisui/actions/workflows/ci.yml)\n[![Discord](https://img.shields.io/badge/discord-join%20chat-blue.svg)](https://discord.gg/HBAgaHCBuY)\n\nShisui is an [Ethereum portal client](https://github.com/ethereum/portal-network-specs) written in Go language based\non [go-ethereum](https://github.com/ethereum/go-ethereum).\nThe name is inspired by Uchiha Shisui from the anime Naruto, who is renowned as \"Shisui of the Body Flicker\".\n\n\u003e **Note:** Shisui is still **under heavy development** and is not yet ready for production use.\n\n## Building the source\n\nFor prerequisites and detailed build instructions please read\nthe [Installation Instructions](https://geth.ethereum.org/docs/getting-started/installing-geth).\n\nBuilding `shisui` requires both a Go (version 1.24 or later) and a C compiler. You can install\nthem using your favourite package manager. Once the dependencies are installed, run\n\n```shell\nmake shisui\n```\n\nAlso, you can build the docker image by running\n\n```shell\nmake shisui-image\n```\n\n## Running `shisui`\n\nAfter building `shisui`, you can start the client by running\n\n```shell\n# supported options are list below\n./build/bin/shisui\n```\n\nAlternatively, you can run the docker image by running\n\n```shell\ndocker run -d -p 8545:8545 -p 9009:9009/udp -e SHISUI_NAT=stun ghcr.io/zen-eth/shisui:latest\n\n# if you know your exiIp, replace by -e SHISUI_NAT=extip:${your ip}\n```\n\nYou can use the script below to check if the node has started correctly.\n\n```shell\ncurl -X POST http://127.0.0.1:8545 \\\n     -H \"Content-Type: application/json\" \\\n     -d '{\n           \"jsonrpc\": \"2.0\",\n           \"method\": \"discv5_nodeInfo\",\n           \"params\": [],\n           \"id\": 0\n         }'\n```\n\n### supported options\n\n* `--rpc.addr` HTTP-RPC server listening addr\n* `--rpc.port` HTTP-RPC server listening port(default: `8545`)\n* `--data.dir` data dir of where the data file located(default: `./`)\n* `--data.capacity` the capacity of the data stored, the unit is MB(default: `10GB`)\n* `--nat` p2p address(default `none`)\n    * `none`, find local address\n    * `any` uses the first auto-detected mechanism\n    * `extip:77.12.33.4` will assume the local machine is reachable on the given IP\n    * `upnp`               uses the Universal Plug and Play protocol\n    * `pmp`                uses NAT-PMP with an auto-detected gateway address\n    * `pmp:192.168.0.1`    uses NAT-PMP with the given gateway address\n    * `stun`    uses stun server to find extip\n* `--udp.addr` protocol UDP server listening port(default: `9009`)\n* `--loglevel` loglevel of portal network, `1` to `5`, from `error` to `trace`(default: `1`)\n* `--private.key` private key of p2p node, hex format without `0x` prifix\n* `--bootnodes` bootnode of p2p network with ENR format, use `none` to config empty bootnodes\n* `--networks` portal sub networks: history, beacon, state\n* `--discv5.gnet` enable gnet(windows does not support) as udp connection in discv5, default is false\n\nall the options above can be set with envs.\n\nthe env is prefixed with `SHISUI` and change the `.` to `_`.\n\neg `--rpc.add` can be replaced with env `SHISUI_RPC_ADDR`\n\n### Hardware Requirements\n\nMinimum:\n\n* CPU with 2+ cores\n* 4GB RAM\n* 1TB free storage space to sync the Mainnet\n* 8 MBit/sec download Internet service\n\nRecommended:\n\n* Fast CPU with 4+ cores\n* 16GB+ RAM\n* High-performance SSD with at least 1TB of free space\n* 25+ MBit/sec download Internet service\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzen-eth%2Fshisui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzen-eth%2Fshisui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzen-eth%2Fshisui/lists"}