new Miner(options)
A bitcoin miner (supports mining witness blocks).
Parameters:
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Properties
|
Properties:
| Name | Type | Description |
|---|---|---|
running |
Boolean | |
loaded |
Boolean |
- Source:
Fires:
- Miner#event:block
- Miner#event:status
Methods
(static) rcmp(a, b) → {Number}
"Reverse" comparison so we don't have to waste time reversing the block hash.
Parameters:
| Name | Type | Description |
|---|---|---|
a |
Buffer | |
b |
Buffer |
- Source:
Returns:
- Type
- Number
close(callback)
Close the miner.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function |
- Source:
createBlock(versionnullable, callback)
Create a block "attempt".
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
version |
Number |
<nullable> |
Custom block version. |
callback |
function | Returns [Error, MinerBlock]. |
- Source:
mineBlock(versionnullable, callback)
Mine a single block.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
version |
Number |
<nullable> |
Custom block version. |
callback |
function | Returns [Error, [Block]]. |
- Source:
open(callback)
Open the miner, wait for the chain and mempool to load.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function |
- Source:
start(versionnullable)
Start mining.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
version |
Number |
<nullable> |
Custom block version. |
- Source:
stop()
Stop mining.
- Source: