Miner

Entity	Version
Source	`1.12.14-unstable/generated-at:2023-09-04T08:02:34-06:00`
OpenRPC	`1.2.6`

miner_setEtherbase¶

SetEtherbase sets the etherbase of the miner.

Params (1)¶

Parameters must be given by position.

1: etherbase common.Address

Required: ✓ Yes

Schema

- description: `Hex representation of a Keccak 256 hash POINTER`
- pattern: `^0x[a-fA-F\d]{64}$`
- title: `keccak`
- type: string

Raw

{
    "description": "Hex representation of a Keccak 256 hash POINTER",
    "pattern": "^0x[a-fA-F\\d]{64}$",
    "title": "keccak",
    "type": [
        "string"
    ]
}

Result¶

bool

Required: ✓ Yes

Client Method Invocation Examples¶

Shell HTTP

curl -X POST -H "Content-Type: application/json" http://localhost:8545 --data '{"jsonrpc": "2.0", "id": 42, "method": "miner_setEtherbase", "params": [<etherbase>]}'

Shell WebSocket

wscat -c ws://localhost:8546 -x '{"jsonrpc": "2.0", "id": 1, "method": "miner_setEtherbase", "params": [<etherbase>]}'

Javascript Console

miner.setEtherbase(etherbase);

Source code

func (api *MinerAPI) SetEtherbase(etherbase common.Address) bool {
    api.e.SetEtherbase(etherbase)
    return true
}// SetEtherbase sets the etherbase of the miner.

View on GitHub →

miner_setExtra¶

SetExtra sets the extra data string that is included when this miner mines a block.

Params (1)¶

Parameters must be given by position.

1: extra string

Required: ✓ Yes

Result¶

bool

Required: ✓ Yes

Client Method Invocation Examples¶

Shell HTTP

curl -X POST -H "Content-Type: application/json" http://localhost:8545 --data '{"jsonrpc": "2.0", "id": 42, "method": "miner_setExtra", "params": [<extra>]}'

Shell WebSocket

wscat -c ws://localhost:8546 -x '{"jsonrpc": "2.0", "id": 1, "method": "miner_setExtra", "params": [<extra>]}'

Javascript Console

miner.setExtra(extra);

Source code

func (api *MinerAPI) SetExtra(extra string) (bool, error) {
    if err := api.e.Miner().SetExtra([ // SetExtra sets the extra data string that is included when this miner mines a block.
    ]byte(extra)); err != nil {
        return false, err
    }
    return true, nil
}

View on GitHub →

miner_setGasLimit¶

SetGasLimit sets the gaslimit to target towards during mining.

Params (1)¶

Parameters must be given by position.

1: gasLimit hexutil.Uint64

Required: ✓ Yes

Schema

- description: `Hex representation of a uint64`
- pattern: `^0x([a-fA-F\d])+$`
- title: `uint64`
- type: string

Raw

{
    "description": "Hex representation of a uint64",
    "pattern": "^0x([a-fA-F\\d])+$",
    "title": "uint64",
    "type": [
        "string"
    ]
}

Result¶

bool

Required: ✓ Yes

Client Method Invocation Examples¶

Shell HTTP

curl -X POST -H "Content-Type: application/json" http://localhost:8545 --data '{"jsonrpc": "2.0", "id": 42, "method": "miner_setGasLimit", "params": [<gasLimit>]}'

Shell WebSocket

wscat -c ws://localhost:8546 -x '{"jsonrpc": "2.0", "id": 1, "method": "miner_setGasLimit", "params": [<gasLimit>]}'

Javascript Console

miner.setGasLimit(gasLimit);

Source code

func (api *MinerAPI) SetGasLimit(gasLimit hexutil.Uint64) bool {
    api.e.Miner().SetGasCeil(uint64(gasLimit))
    return true
}// SetGasLimit sets the gaslimit to target towards during mining.

View on GitHub →

miner_setGasPrice¶

SetGasPrice sets the minimum accepted gas price for the miner.

Params (1)¶

Parameters must be given by position.

1: gasPrice hexutil.Big

Required: ✓ Yes

Schema

- description: `Hex representation of the integer`
- pattern: `^0x[a-fA-F0-9]+$`
- title: `integer`
- type: string

Raw

{
    "description": "Hex representation of the integer",
    "pattern": "^0x[a-fA-F0-9]+$",
    "title": "integer",
    "type": [
        "string"
    ]
}

Result¶

bool

Required: ✓ Yes

Client Method Invocation Examples¶

Shell HTTP

curl -X POST -H "Content-Type: application/json" http://localhost:8545 --data '{"jsonrpc": "2.0", "id": 42, "method": "miner_setGasPrice", "params": [<gasPrice>]}'

Shell WebSocket

wscat -c ws://localhost:8546 -x '{"jsonrpc": "2.0", "id": 1, "method": "miner_setGasPrice", "params": [<gasPrice>]}'

Javascript Console

miner.setGasPrice(gasPrice);

Source code

func (api *MinerAPI) SetGasPrice(gasPrice hexutil.Big) bool {
    api.e.lock.Lock()
    api.e.gasPrice = (*big.Int)(&gasPrice)
    api.e.lock.Unlock()
    api.e.txPool.SetGasTip((*big.Int)(&gasPrice))
    return true
}// SetGasPrice sets the minimum accepted gas price for the miner.

View on GitHub →

miner_setRecommitInterval¶

SetRecommitInterval updates the interval for miner sealing work recommitting.

Params (1)¶

Parameters must be given by position.

1: interval int

Required: ✓ Yes

Schema

- description: `Hex representation of the integer`
- pattern: `^0x[a-fA-F0-9]+$`
- title: `integer`
- type: string

Raw

{
    "description": "Hex representation of the integer",
    "pattern": "^0x[a-fA-F0-9]+$",
    "title": "integer",
    "type": [
        "string"
    ]
}

Result¶

None

Client Method Invocation Examples¶

Shell HTTP

curl -X POST -H "Content-Type: application/json" http://localhost:8545 --data '{"jsonrpc": "2.0", "id": 42, "method": "miner_setRecommitInterval", "params": [<interval>]}'

Shell WebSocket

wscat -c ws://localhost:8546 -x '{"jsonrpc": "2.0", "id": 1, "method": "miner_setRecommitInterval", "params": [<interval>]}'

Javascript Console

miner.setRecommitInterval(interval);

Source code

func (api *MinerAPI) SetRecommitInterval(interval int) {
    api.e.Miner().SetRecommitInterval(time.Duration(interval) * time.Millisecond)
}// SetRecommitInterval updates the interval for miner sealing work recommitting.

View on GitHub →

miner_start¶

Start starts the miner with the given number of threads. If threads is nil, the number of workers started is equal to the number of logical CPUs that are usable by this process. If mining is already running, this method adjust the number of threads allowed to use and updates the minimum price required by the transaction pool.

Params (1)¶

Parameters must be given by position.

1: threads *int

Required: ✓ Yes

Schema

- description: `Hex representation of the integer`
- pattern: `^0x[a-fA-F0-9]+$`
- title: `integer`
- type: string

Raw

{
    "description": "Hex representation of the integer",
    "pattern": "^0x[a-fA-F0-9]+$",
    "title": "integer",
    "type": [
        "string"
    ]
}

Result¶

None

Client Method Invocation Examples¶

Shell HTTP

curl -X POST -H "Content-Type: application/json" http://localhost:8545 --data '{"jsonrpc": "2.0", "id": 42, "method": "miner_start", "params": [<threads>]}'

Shell WebSocket

wscat -c ws://localhost:8546 -x '{"jsonrpc": "2.0", "id": 1, "method": "miner_start", "params": [<threads>]}'

Javascript Console

miner.start(threads);

Source code

func (api *MinerAPI) Start(threads *int) error {
    if threads == nil {
        return api.e.StartMining(runtime.NumCPU())
    }
    return api.e.StartMining(*threads)
}// Start starts the miner with the given number of threads. If threads is nil,
// the number of workers started is equal to the number of logical CPUs that are
// usable by this process. If mining is already running, this method adjust the
// number of threads allowed to use and updates the minimum price required by the
// transaction pool.

View on GitHub →

miner_stop¶

Stop terminates the miner, both at the consensus engine level as well as at the block creation level.

Params (0)¶

None

Result¶

None

Client Method Invocation Examples¶

Shell HTTP

curl -X POST -H "Content-Type: application/json" http://localhost:8545 --data '{"jsonrpc": "2.0", "id": 42, "method": "miner_stop", "params": []}'

Shell WebSocket

wscat -c ws://localhost:8546 -x '{"jsonrpc": "2.0", "id": 1, "method": "miner_stop", "params": []}'

Javascript Console

miner.stop();

Source code

func (api *MinerAPI) Stop() {
    api.e.StopMining()
}// Stop terminates the miner, both at the consensus engine level as well as at
// the block creation level.

View on GitHub →

Last update: 2025-01-20