geth-dev-assistant

KO | EN

gitlite — search

#hacktoberfest #golang #android #machine-learning #deep-learning #linux #docker #macos #nodejs #vue #pytorch #ios #mcp #open-source

geth-dev-assistant

(★ 11)

Quickly configure and launch a geth --dev ephemeral POA network.

geth-dev-assistant Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# geth-dev-assistant

Quickly configure and launch a geth `--dev` ephemeral POA network.
Helpful when using geth in CI.

![Screen Shot 2019-05-18 at 12 06 40 AM](https://user-images.githubusercontent.com/7332026/57965995-0fe36600-7901-11e9-94eb-83a49b171bcb.png)

+ Pulls a specified geth docker image from Docker Hub
+ Launches a docker geth instance as a background process
+ Waits until geth is ready to receive calls over http / websockets
+ (Optionally) creates, unlocks and funds some password generated accounts
+ (Optionally) mines blocks with no-op txs until a gas limit target is reached.

Geth `--dev` seeds with a single funded account and has a relatively low default block gas limit
(~ 10 mil). If the client's mining period is set to 0, it needs to be spun with transactions
before a higher gas limit target is reached.

### Install
```shell
npm install --save-dev geth-dev-assistant
```

### Run
```shell
npx geth-dev-assistant [options]
```

### Usage Example
```shell
npx geth-dev-assistant \
    --tag 'latest' \
    --accounts 5 \
    --balance 50 \
    --gasLimit 12000000

# Run tests
npx mocha

# Clean-up
docker stop geth-client
```

### Options

| Option   | Description                                 | Type   | Default                 |
| -------- | ------------------------------------------- | ------ | ----------------------  |
| accounts | number of accounts to create / unlock       | number | 0 (use default acct)    |
| password | for geth accounts                           | string | "left-hand-of-darkness" |
| balance  | new account starting balances (in ETH)      | number | 100                     |
| gasLimit | block gas limit target to mine towards      | number | (varies by geth version)|
| launch   | pull and launch a geth docker instance      | bool   | true                    |
| repo     | root docker repo (useful for forks)         | string | 'ethereum/client-go'    |
| tag      | geth version / docker tag to fetch          | string | 'stable'                |
| offline  | do not pull image from docker hub           | bool   | false                   |
| sleep    | max seconds to wait for geth to spin up     | number | 10                      |
| period   | automining interval                         | number | 0 (insta-mine)          |
| port     | http port to connect to client with         | number | 8545                    |
| help     | show help                                   | bool   | false                   |

### Other resources
+ A POA network setup using genesis.json [at 0xProject](https://github.com/0xProject/0x-monorepo/blob/development/packages/devnet/genesis.json).
+ [ethnode](https://github.com/vrde/ethnode) a zero config tool to run a local Ethereum dev node (geth & parity!)
+ Geth client options [wiki](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options)

geth-dev-assistant

geth-dev-assistant Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

geth-dev-assistant

geth-dev-assistant Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README