ethereumjs-monorepo

@ethereumjs/ethash

---

@ethereumjs/ethash / Miner

Class: Miner

Defined in: index.ts:47

Constructors

Constructor

new Miner(mineObject, ethash): Miner

Defined in: index.ts:64

Create a Miner object

Parameters

mineObject

The object to mine on, either a BlockHeader or a Block object

BlockHeader

Block

ethash

Ethash

Ethash object to use for mining

Returns

Miner

Properties

solution?

optional solution: Solution

Defined in: index.ts:52

Methods

iterate()

iterate(iterations): Promise<undefined | Solution>

Defined in: index.ts:114

Iterate iterations times over nonces to find a valid PoW. Caches solution if one is found

Parameters

iterations

number = 0

Number of iterations to iterate over. If -1 is passed, the loop runs until a solution is found

Returns

Promise<undefined | Solution>

• undefined if no solution was found, or otherwise a Solution object

---

mine()

mine(iterations): Promise<undefined | BlockHeader | Block>

Defined in: index.ts:91

Iterate iterations time over nonces, returns a BlockHeader or Block if a solution is found, undefined otherwise

Parameters

iterations

number = 0

Number of iterations to iterate over. If -1 is passed, the loop runs until a solution is found

Returns

Promise<undefined | BlockHeader | Block>

• undefined if no solution was found within the iterations, or a BlockHeader or Block with valid PoW based upon what was passed in the constructor

---

stop()

stop(): void

Defined in: index.ts:81

Stop the miner on the next iteration

Returns

void