{"id":20747359,"url":"https://github.com/ether1project/ethoprotocol","last_synced_at":"2025-04-28T11:50:44.789Z","repository":{"id":45470112,"uuid":"126745452","full_name":"Ether1Project/Ethoprotocol","owner":"Ether1Project","description":"Official Go implementation of The Etho Protocol","archived":false,"fork":false,"pushed_at":"2023-03-07T00:22:23.000Z","size":143338,"stargazers_count":41,"open_issues_count":20,"forks_count":33,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-30T09:22:38.073Z","etag":null,"topics":["ethereum-clone","ethereum-network","geth-instance","geth-node","ipc","json-rpc","mining","rpc"],"latest_commit_sha":null,"homepage":"https://ethoprotocol.com","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ether1Project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null}},"created_at":"2018-03-25T22:23:25.000Z","updated_at":"2024-09-23T12:43:07.000Z","dependencies_parsed_at":"2024-04-11T13:41:20.261Z","dependency_job_id":"61818281-e0c7-4620-9c1e-e0429641bf0a","html_url":"https://github.com/Ether1Project/Ethoprotocol","commit_stats":null,"previous_names":["ether1project/ethoprotocol"],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ether1Project%2FEthoprotocol","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ether1Project%2FEthoprotocol/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ether1Project%2FEthoprotocol/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ether1Project%2FEthoprotocol/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ether1Project","download_url":"https://codeload.github.com/Ether1Project/Ethoprotocol/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251310975,"owners_count":21568999,"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":["ethereum-clone","ethereum-network","geth-instance","geth-node","ipc","json-rpc","mining","rpc"],"created_at":"2024-11-17T08:12:48.807Z","updated_at":"2025-04-28T11:50:44.735Z","avatar_url":"https://github.com/Ether1Project.png","language":"Go","readme":"## Go Etho (Formerly Go Ether-1)\n\nOfficial Golang implementation of The Etho Protocol.\n\n[![API Reference](\nhttps://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/68747470733a2f2f676f646f632e6f72672f6769746875622e636f6d2f676f6c616e672f6764646f3f7374617475732e737667\n)](https://godoc.org/github.com/ethereum/go-ethereum)\n[![Go Report Card](https://goreportcard.com/badge/github.com/Ether1Project/Ether1)](https://goreportcard.com/report/github.com/Ether1Project/Ether1)\n[![Discord](https://img.shields.io/badge/discord-join%20chat-blue.svg)](https://discord.gg/MFn9Tmz)\n[![CircleCI](https://circleci.com/gh/Ether1Project/Ether1.svg?style=svg)](https://circleci.com/gh/Ether1Project/Ether1)\n\n\n## Building the source\n\nFor prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/install-and-build/installing-geth).\n\nBuilding `geth` requires both a Go (version 1.14 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 geth\n```\n\nor, to build the full suite of utilities:\n\n```shell\nmake all\n```\n\n## Executables\n\nThe Etho Protocol project comes with several wrappers/executables found in the `cmd`\ndirectory.\n\n|    Command    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |\n| :-----------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|  **`geth`**   | Our main Ethereum CLI client. It is the entry point into the Ethereum network (main-, test- or private net), capable of running as a full node (default), archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as a gateway into the Ethereum network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `geth --help` and the [CLI page](https://geth.ethereum.org/docs/interface/command-line-options) for command line options.          |\n|   `clef`    | Stand-alone signing tool, which can be used as a backend signer for `geth`.  |\n|   `devp2p`    | Utilities to interact with nodes on the networking layer, without running a full blockchain. |\n|   `abigen`    | Source code generator to convert Ethereum contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain [Ethereum contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html) with expanded functionality if the contract bytecode is also available. However, it also accepts Solidity source files, making development much more streamlined. Please see our [Native DApps](https://geth.ethereum.org/docs/dapp/native-bindings) page for details. |\n|  `bootnode`   | Stripped down version of our Ethereum client implementation that only takes part in the network node discovery protocol, but does not run any of the higher level application protocols. It can be used as a lightweight bootstrap node to aid in finding peers in private networks.                                                                                                                                                                                                                                                                 |\n|     `evm`     | Developer utility version of the EVM (Ethereum Virtual Machine) that is capable of running bytecode snippets within a configurable environment and execution mode. Its purpose is to allow isolated, fine-grained debugging of EVM opcodes (e.g. `evm --code 60ff60ff --debug run`).                                                                                                                                                                                                                                                                     |\n|   `rlpdump`   | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://eth.wiki/en/fundamentals/rlp)) dumps (data encoding used by the Ethereum protocol both network as well as consensus wise) to user-friendlier hierarchical representation (e.g. `rlpdump --hex CE0183FFFFFFC4C304050583616263`).                                                                                                                                                                                                                                 |\n|   `puppeth`   | a CLI wizard that aids in creating a new Ethereum network.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n\n## Running `geth`\n\nGoing through all the possible command line flags is out of scope here (please consult our\n[CLI Wiki page](https://geth.ethereum.org/docs/interface/command-line-options)),\nbut we've enumerated a few common parameter combos to get you up to speed quickly\non how you can run your own `geth` instance.\n\n### Full node on the main Etho Protocol network\n\nBy far the most common scenario is people wanting to simply interact with The Etho Protocol\nnetwork: create accounts; transfer funds; deploy and interact with contracts. For this\nparticular use-case the user doesn't care about years-old historical data, so we can\nfast-sync quickly to the current state of the network. To do so:\n\n```shell\n$ geth console\n```\n\nThis command will:\n * Start `geth` in snap sync mode (default, can be changed with the `--syncmode` flag),\n   causing it to download more data in exchange for avoiding processing the entire history\n   of the Ethereum network, which is very CPU intensive.\n * Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console),\n   (via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://web3js.readthedocs.io/en/) \n   (note: the `web3` version bundled within `geth` is very old, and not up to date with official docs),\n   as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/rpc/server).\n   This tool is optional and if you leave it out you can always attach to an already running\n   `geth` instance with `geth attach`.\n\n#### Docker quick start\n\nOne of the quickest ways to get The Etho Protocol up and running on your machine is by using\nDocker:\n\n```shell\ndocker run -d --name ethereum-node -v /Users/alice/ethereum:/root \\\n           -p 8545:8545 -p 30303:30303 \\\n           ethereum/client-go\n```\n\nThis will start `geth` in fast-sync mode with a DB memory allowance of 1GB just as the\nabove command does.  It will also create a persistent volume in your home directory for\nsaving your blockchain as well as map the default ports. There is also an `alpine` tag\navailable for a slim version of the image.\n\nDo not forget `--http.addr 0.0.0.0`, if you want to access RPC from other containers\nand/or hosts. By default, `geth` binds to the local interface and RPC endpoints is not\naccessible from the outside.\n\n### Programmatically interfacing `geth` nodes\n\n\nAs a developer, sooner rather than later you'll want to start interacting with `geth` and the\nEthereum network via your own programs and not manually through the console. To aid\nthis, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://eth.wiki/json-rpc/API)\nand [`geth` specific APIs](https://geth.ethereum.org/docs/rpc/server)).\n\nThese can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based\nplatforms, and named pipes on Windows).\n\nThe IPC interface is enabled by default and exposes all the APIs supported by `geth`,\nwhereas the HTTP and WS interfaces need to manually be enabled and only expose a\nsubset of APIs due to security reasons. These can be turned on/off and configured as\nyou'd expect.\n\nHTTP based JSON-RPC API options:\n\n  * `--http` Enable the HTTP-RPC server\n  * `--http.addr` HTTP-RPC server listening interface (default: `localhost`)\n  * `--http.port` HTTP-RPC server listening port (default: `8545`)\n  * `--http.api` API's offered over the HTTP-RPC interface (default: `eth,net,web3`)\n  * `--http.corsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced)\n  * `--ws` Enable the WS-RPC server\n  * `--ws.addr` WS-RPC server listening interface (default: `localhost`)\n  * `--ws.port` WS-RPC server listening port (default: `8546`)\n  * `--ws.api` API's offered over the WS-RPC interface (default: `eth,net,web3`)\n  * `--ws.origins` Origins from which to accept websockets requests\n  * `--ipcdisable` Disable the IPC-RPC server\n  * `--ipcapi` API's offered over the IPC-RPC interface (default: `admin,debug,eth,miner,net,personal,shh,txpool,web3`)\n  * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it)\n\nYou'll need to use your own programming environments' capabilities (libraries, tools, etc) to\nconnect via HTTP, WS or IPC to a `geth` node configured with the above flags and you'll\nneed to speak [JSON-RPC](https://www.jsonrpc.org/specification) on all transports. You\ncan reuse the same connection for multiple requests!\n\n**Note: Please understand the security implications of opening up an HTTP/WS based\ntransport before doing so! Hackers on the internet are actively trying to subvert\nEtho Protocol nodes with exposed APIs! Further, all browser tabs can access locally\nrunning web servers, so malicious web pages could try to subvert locally available\nAPIs!**\n\n### Operating a private network\n\nMaintaining your own private network is more involved as a lot of configurations taken for\ngranted in the official networks need to be manually set up.\n\n#### Defining the private genesis state\n\nFirst, you'll need to create the genesis state of your networks, which all nodes need to be\naware of and agree upon. This consists of a small JSON file (e.g. call it `genesis.json`):\n\n```json\n{\n  \"config\": {\n    \"chainId\": \u003carbitrary positive integer\u003e,\n    \"homesteadBlock\": 0,\n    \"eip150Block\": 0,\n    \"eip155Block\": 0,\n    \"eip158Block\": 0,\n    \"byzantiumBlock\": 0,\n    \"constantinopleBlock\": 0,\n    \"petersburgBlock\": 0,\n    \"istanbulBlock\": 0,\n    \"berlinBlock\": 0\n  },\n  \"alloc\": {},\n  \"coinbase\": \"0x0000000000000000000000000000000000000000\",\n  \"difficulty\": \"0x20000\",\n  \"extraData\": \"\",\n  \"gasLimit\": \"0x2fefd8\",\n  \"nonce\": \"0x0000000000000042\",\n  \"mixhash\": \"0x0000000000000000000000000000000000000000000000000000000000000000\",\n  \"parentHash\": \"0x0000000000000000000000000000000000000000000000000000000000000000\",\n  \"timestamp\": \"0x00\"\n}\n```\n\nThe above fields should be fine for most purposes, although we'd recommend changing\nthe `nonce` to some random value so you prevent unknown remote nodes from being able\nto connect to you. If you'd like to pre-fund some accounts for easier testing, create\nthe accounts and populate the `alloc` field with their addresses.\n\n```json\n\"alloc\": {\n  \"0x0000000000000000000000000000000000000001\": {\n    \"balance\": \"111111111\"\n  },\n  \"0x0000000000000000000000000000000000000002\": {\n    \"balance\": \"222222222\"\n  }\n}\n```\n\nWith the genesis state defined in the above JSON file, you'll need to initialize **every**\n`geth` node with it prior to starting it up to ensure all blockchain parameters are correctly\nset:\n\n```shell\n$ geth init path/to/genesis.json\n```\n\n#### Creating the rendezvous point\n\nWith all nodes that you want to run initialized to the desired genesis state, you'll need to\nstart a bootstrap node that others can use to find each other in your network and/or over\nthe internet. The clean way is to configure and run a dedicated bootnode:\n\n```shell\n$ bootnode --genkey=boot.key\n$ bootnode --nodekey=boot.key\n```\n\nWith the bootnode online, it will display an [`enode` URL](https://eth.wiki/en/fundamentals/enode-url-format)\nthat other nodes can use to connect to it and exchange peer information. Make sure to\nreplace the displayed IP address information (most probably `[::]`) with your externally\naccessible IP to get the actual `enode` URL.\n\n*Note: You could also use a full-fledged `geth` node as a bootnode, but it's the less\nrecommended way.*\n\n#### Starting up your member nodes\n\nWith the bootnode operational and externally reachable (you can try\n`telnet \u003cip\u003e \u003cport\u003e` to ensure it's indeed reachable), start every subsequent `geth`\nnode pointed to the bootnode for peer discovery via the `--bootnodes` flag. It will\nprobably also be desirable to keep the data directory of your private network separated, so\ndo also specify a custom `--datadir` flag.\n\n```shell\n$ geth --datadir=path/to/custom/data/folder --bootnodes=\u003cbootnode-enode-url-from-above\u003e\n```\n\n*Note: Since your network will be completely cut off from the main and test networks, you'll\nalso need to configure a miner to process transactions and create new blocks for you.*\n\n#### Running a private miner\n\nMining on the public Etho Protocol network is a complex task as it's only feasible using GPUs,\nrequiring an OpenCL or CUDA enabled `ethminer` instance. For information on such a\nsetup, please consult the [EtherMining subreddit](https://www.reddit.com/r/EtherMining/)\nand the [ethminer](https://github.com/ethereum-mining/ethminer) repository.\n\nIn a private network setting, however a single CPU miner instance is more than enough for\npractical purposes as it can produce a stable stream of blocks at the correct intervals\nwithout needing heavy resources (consider running on a single thread, no need for multiple\nones either). To start a `geth` instance for mining, run it with all your usual flags, extended\nby:\n\n```shell\n$ geth \u003cusual-flags\u003e --mine --miner.threads=1 --miner.etherbase=0x0000000000000000000000000000000000000000\n```\n\nWhich will start mining blocks and transactions on a single CPU thread, crediting all\nproceedings to the account specified by `--miner.etherbase`. You can further tune the mining\nby changing the default gas limit blocks converge to (`--miner.targetgaslimit`) and the price\ntransactions are accepted at (`--miner.gasprice`).\n\n\n## Etho Protocol Decentralized Data Storage Nodes (Collateralized Nodes)\n\nInitializing, configuring and running an Etho node with decentralized storage capabilities (ethoFS) enabled is a three step process.\n\nAll three node types are available to initialize, config and run via the CLI utilizing the --ethofs flag to designate node type. Explore the [Etho Protocol Node Dashboard ](https://nodes.ethoprotocol.com) for details and requirements for deploying each ethofs enabled node type. A good place for more information is also our [Etho Protocol documentation ](https://docs.ethoprotocol.com)\n\n#### Node Types:\n\nService Node (sn)\nMasternode (mn)\nGateway Node (gn)\n\n#### Node Initialization, Configuration and Run Commands:\n\nStep 1: Run ethoFS Initialization\n\n```shell\n$ geth --ethofs=mn --ethofsInit console\n```\n\nStep 2: Run ethoFS Configuration\n\n```shell\n$ geth --ethofs=mn --ethofsConfig console\n```\n\nStep 3: Start ethoFS Enabled Node\n\n```shell\n$ geth --ethofs=mn console\n```\n\n## Contribution\n\nThank you for considering to help out with the source code! We welcome contributions\nfrom anyone on the internet, and are grateful for even the smallest of fixes!\n\nIf you'd like to contribute to The Etho Protocol, please fork, fix, commit and send a pull request\nfor the maintainers to review and merge into the main code base.\n\nPlease make sure your contributions adhere to our coding guidelines:\n\n * Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting)\n   guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).\n * Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary)\n   guidelines.\n * Pull requests need to be based on and opened against the `master` branch.\n * Commit messages should be prefixed with the package(s) they modify.\n   * E.g. \"eth, rpc: make trace configs optional\"\n\nPlease see the [Developers' Guide](https://geth.ethereum.org/docs/developers/devguide)\nfor more details on configuring your environment, managing project dependencies, and\ntesting procedures.\n\n## License\n\nThe go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the\n[GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html),\nalso included in our repository in the `COPYING.LESSER` file.\n\nThe go-ethereum binaries (i.e. all code inside of the `cmd` directory) is licensed under the\n[GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also\nincluded in our repository in the `COPYING` file.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fether1project%2Fethoprotocol","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fether1project%2Fethoprotocol","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fether1project%2Fethoprotocol/lists"}