miner

Documentation

Overview

Package miner provides a basic miner for sunyata, suitable for testing and as a basis for more sophisticated implementations.

Index

• Variables
• type Miner
  • func New(cs consensus.State, addr sunyata.Address, tp *txpool.Pool, ng NonceGrinder) *Miner
  • func (m *Miner) MineBlock() sunyata.Block
  • func (m *Miner) ProcessChainApplyUpdate(cau *chain.ApplyUpdate, _ bool) error
  • func (m *Miner) ProcessChainRevertUpdate(cru *chain.RevertUpdate) error
  • func (m *Miner) Stats() (mined int, rate float64)
• type NonceGrinder

Variables

var CPU cpuGrinder

CPU grinds nonces with a single CPU thread.

Types

type Miner

type Miner struct {
	// contains filtered or unexported fields
}

A Miner mines blocks.

func New

func New(cs consensus.State, addr sunyata.Address, tp *txpool.Pool, ng NonceGrinder) *Miner

New returns a Miner initialized with the provided state.

func (*Miner) MineBlock

func (m *Miner) MineBlock() sunyata.Block

MineBlock mines a valid block, using transactions drawn from the txpool.

func (*Miner) ProcessChainApplyUpdate

func (m *Miner) ProcessChainApplyUpdate(cau *chain.ApplyUpdate, _ bool) error

ProcessChainApplyUpdate implements chain.Subscriber.

func (*Miner) ProcessChainRevertUpdate

func (m *Miner) ProcessChainRevertUpdate(cru *chain.RevertUpdate) error

ProcessChainRevertUpdate implements chain.Subscriber.

func (*Miner) Stats

func (m *Miner) Stats() (mined int, rate float64)

Stats reports various mining statistics.

type NonceGrinder

type NonceGrinder interface {
	GrindNonce(h *sunyata.BlockHeader, target sunyata.BlockID)
}

A NonceGrinder sets the value of h.Nonce such that h.ID().MeetsTarget(target) returns true.