From 749e3eb3a1e798cb9e996c8f2fcd21899e1ba628 Mon Sep 17 00:00:00 2001 From: alphak3y <84204260+alphak3y@users.noreply.github.com> Date: Thu, 22 Aug 2024 19:33:18 -0600 Subject: [PATCH] Update README.md --- README.md | 80 +++++++++++++++++++++++++++---------------------------- 1 file changed, 40 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 0d5b7872124a..aafb21e37e3e 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ -## Go Ethereum +## Go Story -Golang execution layer implementation of the Ethereum protocol. +Golang execution layer implementation of the Story protocol. [![API Reference]( -https://pkg.go.dev/badge/github.com/ethereum/go-ethereum -)](https://pkg.go.dev/github.com/ethereum/go-ethereum?tab=doc) -[![Go Report Card](https://goreportcard.com/badge/github.com/ethereum/go-ethereum)](https://goreportcard.com/report/github.com/ethereum/go-ethereum) -[![Travis](https://app.travis-ci.com/ethereum/go-ethereum.svg?branch=master)](https://app.travis-ci.com/github/ethereum/go-ethereum) +https://pkg.go.dev/badge/github.com/story/go-story +)](https://pkg.go.dev/github.com/story/go-story?tab=doc) +[![Go Report Card](https://goreportcard.com/badge/github.com/story/go-story)](https://goreportcard.com/report/github.com/story/go-story) +[![Travis](https://app.travis-ci.com/story/go-story.svg?branch=master)](https://app.travis-ci.com/github/story/go-story) [![Discord](https://img.shields.io/badge/discord-join%20chat-blue.svg)](https://discord.gg/nthXNEv) Automated builds are available for stable releases and the unstable master branch. Binary -archives are published at https://geth.ethereum.org/downloads/. +archives are published at https://geth.story.org/downloads/. ## Building the source -For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/getting-started/installing-geth). +For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.story.org/docs/getting-started/installing-geth). Building `geth` requires both a Go (version 1.21 or later) and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run @@ -31,23 +31,23 @@ make all ## Executables -The go-ethereum project comes with several wrappers/executables found in the `cmd` +The go-story project comes with several wrappers/executables found in the `cmd` directory. | Command | Description | | :--------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`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/fundamentals/command-line-options) for command line options. | +| **`geth`** | Our main Story CLI client. It is the entry point into the Story 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 Story network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `geth --help` and the [CLI page](https://geth.story.org/docs/fundamentals/command-line-options) for command line options. | | `clef` | Stand-alone signing tool, which can be used as a backend signer for `geth`. | | `devp2p` | Utilities to interact with nodes on the networking layer, without running a full blockchain. | -| `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/developers/dapp-developer/native-bindings) page for details. | -| `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. | -| `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`). | -| `rlpdump` | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://ethereum.org/en/developers/docs/data-structures-and-encoding/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`). | +| `abigen` | Source code generator to convert Story contract definitions into easy-to-use, compile-time type-safe Go packages. It operates on plain [Story 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.story.org/docs/developers/dapp-developer/native-bindings) page for details. | +| `bootnode` | Stripped down version of our Story 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. | +| `evm` | Developer utility version of the EVM (Story 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`). | +| `rlpdump` | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://story.org/en/developers/docs/data-structures-and-encoding/rlp)) dumps (data encoding used by the Story protocol both network as well as consensus wise) to user-friendlier hierarchical representation (e.g. `rlpdump --hex CE0183FFFFFFC4C304050583616263`). | ## Running `geth` Going through all the possible command line flags is out of scope here (please consult our -[CLI Wiki page](https://geth.ethereum.org/docs/fundamentals/command-line-options)), +[CLI Wiki page](https://geth.story.org/docs/fundamentals/command-line-options)), but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own `geth` instance. @@ -67,9 +67,9 @@ Recommended: * High-performance SSD with at least 1TB of free space * 25+ MBit/sec download Internet service -### Full node on the main Ethereum network +### Full node on the main Story network -By far the most common scenario is people wanting to simply interact with the Ethereum +By far the most common scenario is people wanting to simply interact with the Story network: create accounts; transfer funds; deploy and interact with contracts. For this particular use case, the user doesn't care about years-old historical data, so we can sync quickly to the current state of the network. To do so: @@ -81,17 +81,17 @@ $ geth console This command will: * Start `geth` in snap sync mode (default, can be changed with the `--syncmode` flag), causing it to download more data in exchange for avoiding processing the entire history - of the Ethereum network, which is very CPU intensive. - * Start the built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interacting-with-geth/javascript-console), + of the Story network, which is very CPU intensive. + * Start the built-in interactive [JavaScript console](https://geth.story.org/docs/interacting-with-geth/javascript-console), (via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://github.com/ChainSafe/web3.js/blob/0.20.7/DOCUMENTATION.md) (note: the `web3` version bundled within `geth` is very old, and not up to date with official docs), - as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc). + as well as `geth`'s own [management APIs](https://geth.story.org/docs/interacting-with-geth/rpc). This tool is optional and if you leave it out you can always attach it to an already running `geth` instance with `geth attach`. ### A Full node on the Görli test network -Transitioning towards developers, if you'd like to play around with creating Ethereum +Transitioning towards developers, if you'd like to play around with creating Story contracts, you almost certainly would like to do that without any real money involved until you get the hang of the entire system. In other words, instead of attaching to the main network, you want to join the **test** network with your node, which is fully equivalent to @@ -106,11 +106,11 @@ useful on the testnet too. Specifying the `--goerli` flag, however, will reconfigure your `geth` instance a bit: - * Instead of connecting to the main Ethereum network, the client will connect to the Görli + * Instead of connecting to the main Story network, the client will connect to the Görli test network, which uses different P2P bootnodes, different network IDs and genesis states. - * Instead of using the default data directory (`~/.ethereum` on Linux for example), `geth` - will nest itself one level deeper into a `goerli` subfolder (`~/.ethereum/goerli` on + * Instead of using the default data directory (`~/.story` on Linux for example), `geth` + will nest itself one level deeper into a `goerli` subfolder (`~/.story/goerli` on Linux). Note, on OSX and Linux this also means that attaching to a running testnet node requires the use of a custom endpoint since `geth attach` will try to attach to a production node endpoint by default, e.g., @@ -143,13 +143,13 @@ $ geth --your-favourite-flags dumpconfig #### Docker quick start -One of the quickest ways to get Ethereum up and running on your machine is by using +One of the quickest ways to get Story up and running on your machine is by using Docker: ```shell -docker run -d --name ethereum-node -v /Users/alice/ethereum:/root \ +docker run -d --name story-node -v /Users/alice/story:/root \ -p 8545:8545 -p 30303:30303 \ - ethereum/client-go + story/client-go ``` This will start `geth` in snap-sync mode with a DB memory allowance of 1GB, as the @@ -164,9 +164,9 @@ accessible from the outside. ### Programmatically interfacing `geth` nodes As a developer, sooner rather than later you'll want to start interacting with `geth` and the -Ethereum network via your own programs and not manually through the console. To aid -this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://ethereum.github.io/execution-apis/api-documentation/) -and [`geth` specific APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc)). +Story network via your own programs and not manually through the console. To aid +this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://story.github.io/execution-apis/api-documentation/) +and [`geth` specific APIs](https://geth.story.org/docs/interacting-with-geth/rpc)). These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based platforms, and named pipes on Windows). @@ -198,7 +198,7 @@ can reuse the same connection for multiple requests! **Note: Please understand the security implications of opening up an HTTP/WS based transport before doing so! Hackers on the internet are actively trying to subvert -Ethereum nodes with exposed APIs! Further, all browser tabs can access locally +Story nodes with exposed APIs! Further, all browser tabs can access locally running web servers, so malicious web pages could try to subvert locally available APIs!** @@ -274,7 +274,7 @@ $ bootnode --genkey=boot.key $ bootnode --nodekey=boot.key ``` -With the bootnode online, it will display an [`enode` URL](https://ethereum.org/en/developers/docs/networking-layer/network-addresses/#enode) +With the bootnode online, it will display an [`enode` URL](https://story.org/en/developers/docs/networking-layer/network-addresses/#enode) that other nodes can use to connect to it and exchange peer information. Make sure to replace the displayed IP address information (most probably `[::]`) with your externally accessible IP to get the actual `enode` URL. @@ -320,7 +320,7 @@ transactions are accepted at (`--miner.gasprice`). Thank you for considering helping out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes! -If you'd like to contribute to go-ethereum, please fork, fix, commit and send a pull request +If you'd like to contribute to go-story, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on [our Discord Server](https://discord.gg/invite/nthXNEv) to ensure those changes are in line with the general philosophy of the project and/or get @@ -337,22 +337,22 @@ Please make sure your contributions adhere to our coding guidelines: * Commit messages should be prefixed with the package(s) they modify. * E.g. "eth, rpc: make trace configs optional" -Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/geth-developer/dev-guide) +Please see the [Developers' Guide](https://geth.story.org/docs/developers/geth-developer/dev-guide) for more details on configuring your environment, managing project dependencies, and testing procedures. -### Contributing to geth.ethereum.org +### Contributing to geth.story.org -For contributions to the [go-ethereum website](https://geth.ethereum.org), please checkout and raise pull requests against the `website` branch. -For more detailed instructions please see the `website` branch [README](https://github.com/ethereum/go-ethereum/tree/website#readme) or the -[contributing](https://geth.ethereum.org/docs/developers/geth-developer/contributing) page of the website. +For contributions to the [go-story website](https://geth.story.org), please checkout and raise pull requests against the `website` branch. +For more detailed instructions please see the `website` branch [README](https://github.com/story/go-story/tree/website#readme) or the +[contributing](https://geth.story.org/docs/developers/geth-developer/contributing) page of the website. ## License -The go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the +The go-story library (i.e. all code outside of the `cmd` directory) is licensed under the [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), also included in our repository in the `COPYING.LESSER` file. -The go-ethereum binaries (i.e. all code inside of the `cmd` directory) are licensed under the +The go-story binaries (i.e. all code inside of the `cmd` directory) are licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also included in our repository in the `COPYING` file.