Skip to content

Commit

Permalink
Mining docs (#1628)
Browse files Browse the repository at this point in the history
  • Loading branch information
AskAlexSharov committed Mar 30, 2021
1 parent 86ccfd0 commit 4a176e4
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 848 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Turbo-Geth is a fork of [Go-Ethereum](https://github.com/ethereum/go-ethereum) w
- [Usage](#usage)
+ [Getting Started](#getting-started)
+ [Testnets](#testnets)
+ [Mining](#mining)
+ [Windows](#windows)
+ [GoDoc](https://godoc.org/github.com/ledgerwatch/turbo-geth)
- [Key features](#key-features)
Expand Down Expand Up @@ -67,6 +68,24 @@ If you would like to give turbo-geth a try, but do not have spare 2Tb on your dr

Please note the `--datadir` option that allows you to store turbo-geth files in a non-default location, in this example, in `goerli` subdirectory of the current directory.

### Mining

Support only remote-miners.

* To enable, add `--mine --miner.etherbase=...` or `--mine --miner.miner.sigkey=...` flags.
* Other supported options: `--miner.extradata`, `--miner.notify`, `--miner.gaslimit`, `--miner.gasprice`
, `--miner.gastarget`
* RPCDaemon supports methods: eth_coinbase , eth_hashrate, eth_mining, eth_getWork, eth_submitWork, eth_submitHashrate
* RPCDaemon supports websocket methods: newPendingTransaction
* TODO:
+ we don't broadcast mined blocks to p2p-network yet, [but it's easy to accomplish](https://github.com/ledgerwatch/turbo-geth/blob/9b8cdc0f2289a7cef78218a15043de5bdff4465e/eth/downloader/downloader.go#L673)
+ eth_newPendingTransactionFilter
+ eth_newBlockFilter
+ eth_newFilter
+ websocket Logs

<code> 🔬 Detailed mining explanation is [here](/docs/mining.md).</code>

### Windows

Windows users may run turbo-geth in 3 possible ways:
Expand Down
Loading

0 comments on commit 4a176e4

Please sign in to comment.