From 3ff20825fa2ee5020c2a55c33db2801274609efc Mon Sep 17 00:00:00 2001 From: Christopher Franko Date: Sat, 8 Oct 2016 10:46:57 -0400 Subject: [PATCH] merge cleanup 2 --- .travis.yml | 2 +- README.md | 34 +++++++++++++++++----------------- circle.yml | 2 +- cmd/geth/dao_test.go | 2 +- cmd/geth/genesis_test.go | 2 +- cmd/utils/flags.go | 2 +- console/console.go | 6 +++--- 7 files changed, 25 insertions(+), 25 deletions(-) diff --git a/.travis.yml b/.travis.yml index 12bfdc8026..15912309a8 100644 --- a/.travis.yml +++ b/.travis.yml @@ -27,7 +27,7 @@ matrix: - debhelper - dput script: - - go run build/ci.go debsrc -signer "Felix Lange (Geth CI Testing Key) " -upload ppa:lp-fjl/geth-ci-testing + - go run build/ci.go debsrc -signer "Felix Lange ( CI Testing Key) " -upload ppa:lp-fjl/geth-ci-testing install: - go get golang.org/x/tools/cmd/cover diff --git a/README.md b/README.md index 288a4c9d68..1829c8173c 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ Go Expanse comes with several wrappers/executables found in Going through all the possible command line flags is out of scope here (please consult our [CLI Wiki page](https://github.com/expanse-project/go-expanse/wiki/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. +own instance. ### Full node on the main Ethereum network @@ -78,10 +78,10 @@ This command will: * Bump the memory allowance of the database to 512MB (`--cache=512`), which can help significantly in sync times especially for HDD users. This flag is optional and you can set it as high or as low as you'd like, though we'd recommend the 512MB - 2GB range. - * Start up Geth's built-in interactive [JavaScript console](https://github.com/expanse-project/go-expanse/wiki/JavaScript-Console), + * Start up 's built-in interactive [JavaScript console](https://github.com/expanse-project/go-expanse/wiki/JavaScript-Console), (via the trailing `console` subcommand) through which you can invoke all official [`web3` methods](https://github.com/ethereum/wiki/wiki/JavaScript-API) - as well as Geth's own [management APIs](https://github.com/expanse-project/go-expanse/wiki/Management-APIs). - This too is optional and if you leave it out you can always attach to an already running Geth instance + as well as 's own [management APIs](https://github.com/expanse-project/go-expanse/wiki/Management-APIs). + This too is optional and if you leave it out you can always attach to an already running instance with `geth --attach`. ### Full node on the Ethereum test network @@ -99,28 +99,28 @@ The `--fast`, `--cache` flags and `console` subcommand have the exact same meani are equially useful on the testnet too. Please see above for their explanations if you've skipped to here. -Specifying the `--testnet` flag however will reconfigure your Geth instance a bit: +Specifying the `--testnet` flag however will reconfigure your instance a bit: - * Instead of using the default data directory (`~/.ethereum` on Linux for example), Geth will nest + * Instead of using the default data directory (`~/.ethereum` on Linux for example), will nest itself one level deeper into a `testnet` subfolder (`~/.ethereum/testnet` on Linux). * Instead of connecting the main Ethereum network, the client will connect to the test network, which uses different P2P bootnodes, different network IDs and genesis states. *Note: Although there are some internal protective measures to prevent transactions from crossing over between the main network and test network (different starting nonces), you should make sure to -always use separate accounts for play-money and real-money. Unless you manually move accounts, Geth +always use separate accounts for play-money and real-money. Unless you manually move accounts, will by default correctly separate the two networks and will not make any accounts available between them.* -### Programatically interfacing Geth nodes +### Programatically interfacing 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 +As a developer, sooner rather than later you'll want to start interacting with and the Ethereum +network via your own programs and not manually through the console. To aid this, has built in support for a JSON-RPC based APIs ([standard APIs](https://github.com/ethereum/wiki/wiki/JSON-RPC) and -[Geth specific APIs](https://github.com/expanse-project/go-expanse/wiki/Management-APIs)). These can be +[ specific APIs](https://github.com/expanse-project/go-expanse/wiki/Management-APIs)). These can be exposed via HTTP, WebSockets and IPC (unix sockets on unix based platroms, and named pipes on Windows). -The IPC interface is enabled by default and exposes all the APIs supported by Geth, whereas the HTTP +The IPC interface is enabled by default and exposes all the APIs supported by , whereas the HTTP and WS interfaces need to manually be enabled and only expose a subset of APIs due to security reasons. These can be turned on/off and configured as you'd expect. @@ -141,7 +141,7 @@ HTTP based JSON-RPC API options: * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it) You'll need to use your own programming environments' capabilities (libraries, tools, etc) to connect -via HTTP, WS or IPC to a Geth node configured with the above flags and you'll need to speak [JSON-RPC](http://www.jsonrpc.org/specification) +via HTTP, WS or IPC to a node configured with the above flags and you'll need to speak [JSON-RPC](http://www.jsonrpc.org/specification) on all transports. You can reuse the same connection for multiple requests! **Note: Please understand the security implications of opening up an HTTP/WS based transport before @@ -185,7 +185,7 @@ configs: } ``` -With the genesis state defined in the above JSON file, you'll need to initialize **every** Geth node +With the genesis state defined in the above JSON file, you'll need to initialize **every** node with it prior to starting it up to ensure all blockchain parameters are correctly set: ``` @@ -208,12 +208,12 @@ that other nodes can use to connect to it and exchange peer information. Make su displayed IP address information (most probably `[::]`) with your externally accessible IP to get the actual `enode` URL. -*Note: You could also use a full fledged Geth node as a bootnode, but it's the less recommended way.* +*Note: You could also use a full fledged node as a bootnode, but it's the less recommended way.* #### Starting up your member nodes With the bootnode operational and externally reachable (you can try `telnet ` to ensure -it's indeed reachable), start every subsequent Geth node pointed to the bootnode for peer discovery +it's indeed reachable), start every subsequent node pointed to the bootnode for peer discovery via the `--bootnodes` flag. It will probably also be desirable to keep the data directory of your private network separated, so do also specify a custom `--datadir` flag. @@ -233,7 +233,7 @@ repository. In a private network setting however, a single CPU miner instance is more than enough for practical purposes as it can produce a stable stream of blocks at the correct intervals without needing heavy -resources (consider running on a single thread, no need for multiple ones either). To start a Geth +resources (consider running on a single thread, no need for multiple ones either). To start a instance for mining, run it with all your usual flags, extended by: ``` diff --git a/circle.yml b/circle.yml index 39ff5d83c6..32356976de 100644 --- a/circle.yml +++ b/circle.yml @@ -23,7 +23,7 @@ dependencies: test: override: - # Build Geth and move into a known folder + # Build and move into a known folder - make geth - cp ./build/bin/geth $HOME/geth diff --git a/cmd/geth/dao_test.go b/cmd/geth/dao_test.go index 6f21560f9a..a9c1d50ff6 100644 --- a/cmd/geth/dao_test.go +++ b/cmd/geth/dao_test.go @@ -172,7 +172,7 @@ func testDAOForkBlockNewChain(t *testing.T, testnet bool, genesis string, votes datadir := tmpdir(t) defer os.RemoveAll(datadir) - // Start a Geth instance with the requested flags set and immediately terminate + // Start a instance with the requested flags set and immediately terminate if genesis != "" { json := filepath.Join(datadir, "genesis.json") if err := ioutil.WriteFile(json, []byte(genesis), 0600); err != nil { diff --git a/cmd/geth/genesis_test.go b/cmd/geth/genesis_test.go index 4f8b1642ef..f50e79702d 100644 --- a/cmd/geth/genesis_test.go +++ b/cmd/geth/genesis_test.go @@ -84,7 +84,7 @@ var customGenesisTests = []struct { }, } -// Tests that initializing Geth with a custom genesis block and chain definitions +// Tests that initializing with a custom genesis block and chain definitions // work properly. func TestCustomGenesis(t *testing.T) { for i, tt := range customGenesisTests { diff --git a/cmd/utils/flags.go b/cmd/utils/flags.go index d221d1829d..829faa2495 100644 --- a/cmd/utils/flags.go +++ b/cmd/utils/flags.go @@ -822,7 +822,7 @@ func MustMakeChainConfigFromDb(ctx *cli.Context, db ethdb.Database) *core.ChainC if !config.DAOForkSupport { choice = "OPPOSE" } - current := fmt.Sprintf("Geth is currently configured to %s the DAO hard-fork!", choice) + current := fmt.Sprintf(" is currently configured to %s the DAO hard-fork!", choice) howtoswap := fmt.Sprintf("You can change your choice prior to block #%v with --support-dao-fork or --oppose-dao-fork.", config.DAOForkBlock) howtosync := fmt.Sprintf("After the hard-fork block #%v passed, changing chains requires a resync from scratch!", config.DAOForkBlock) separator := strings.Repeat("-", len(howtoswap)) diff --git a/console/console.go b/console/console.go index d032b3a5b8..0efb68807a 100644 --- a/console/console.go +++ b/console/console.go @@ -241,11 +241,11 @@ func (c *Console) AutoCompleteInput(line string, pos int) (string, []string, str return line[:start], c.jsre.CompleteKeywords(line[start:pos]), line[pos:] } -// Welcome show summary of current Geth instance and some metadata about the +// Welcome show summary of current instance and some metadata about the // console's available modules. func (c *Console) Welcome() { - // Print some generic Geth metadata - fmt.Fprintf(c.printer, "Welcome to the Geth JavaScript console!\n\n") + // Print some generic metadata + fmt.Fprintf(c.printer, "Welcome to the JavaScript console!\n\n") c.jsre.Run(` console.log("instance: " + web3.version.node); console.log("coinbase: " + eth.coinbase);