Official Go implementation of the Ethereum protocol
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
go-ethereum/docs/interacting-with-geth/rpc/ns-miner.md

85 lines
3.8 KiB

---
title: miner Namespace
description: Documentation for the JSON-RPC API "miner" namespace
---
The `miner` API is **now deprecated** because mining was switched off at the transition to proof-of-stake. It existed to provide remote control the node's mining operation and set various mining specific settings. It is provided here for historical interest!
2 years ago
## miner_getHashrate {#miner-hashrate}
Get hashrate in H/s (Hash operations per second).
| Client | Method invocation |
| :------ | ----------------------------------------------- |
| Console | `miner.getHashrate()` |
| RPC | `{"method": "miner_getHashrate", "params": []}` |
2 years ago
## miner_setExtra {#miner-setextra}
Sets the extra data a miner can include when miner blocks. This is capped at 32 bytes.
| Client | Method invocation |
| :------ | -------------------------------------------------- |
| Go | `miner.setExtra(extra string) (bool, error)` |
| Console | `miner.setExtra(string)` |
| RPC | `{"method": "miner_setExtra", "params": [string]}` |
2 years ago
## miner_setGasPrice {#miner-setgasprice}
Sets the minimal accepted gas price when mining transactions. Any transactions that are below this limit are excluded from the mining process.
| Client | Method invocation |
| :------ | ----------------------------------------------------- |
| Go | `miner.setGasPrice(number *rpc.HexNumber) bool` |
| Console | `miner.setGasPrice(number)` |
| RPC | `{"method": "miner_setGasPrice", "params": [number]}` |
2 years ago
## miner_setRecommitInterval {#miner-setrecommitinterval}
Updates the interval for recomitting the miner sealing work.
| Client | Method invocation |
| :------ | ------------------------------------------------------------- |
| Console | `miner.setRecommitInterval(interval int)` |
| RPC | `{"method": "miner_setRecommitInterval", "params": [number]}` |
2 years ago
## miner_start {#miner-start}
Start the CPU mining process with the given number of threads and generate a new DAG if need be.
| Client | Method invocation |
| :------ | --------------------------------------------------- |
| Go | `miner.Start(threads *rpc.HexNumber) (bool, error)` |
| Console | `miner.start(number)` |
| RPC | `{"method": "miner_start", "params": [number]}` |
2 years ago
## miner_stop {#miner-stop}
Stop the CPU mining operation.
| Client | Method invocation |
| :------ | ---------------------------------------- |
| Go | `miner.Stop() bool` |
| Console | `miner.stop()` |
| RPC | `{"method": "miner_stop", "params": []}` |
2 years ago
## miner_setEtherbase {#miner-setetherbase}
Sets the etherbase, where mining rewards will go.
| Client | Method invocation |
| :------ | ------------------------------------------------------- |
| Go | `miner.SetEtherbase(common.Address) bool` |
| Console | `miner.setEtherbase(address)` |
| RPC | `{"method": "miner_setEtherbase", "params": [address]}` |
2 years ago
## miner_setGasLimit {#miner-setgaslimit}
Sets the gas limit the miner will target when mining. Note: on networks where EIP-1559 is activated, this should be set to twice the gas target (i.e. the effective gas used on average per block) to be.
| Client | Method invocation |
| :------ | ----------------------------------------------------- |
| Go | `miner.SetGasLimit(number *rpc.HexNumber) bool` |
| Console | `miner.SetGasLimit(number)` |
| RPC | `{"method": "miner_setGasLimit", "params": [number]}` |