miner

Documentation

Index

• func NewTestMiner(nextCh <-chan MineReq, addr address.Address) func(v1api.FullNode, gen.WinningPoStProver) *Miner
• type MineReq
• type Miner
  • func NewMiner(api v1api.FullNode, epp gen.WinningPoStProver, addr address.Address, ...) *Miner
  • func (m *Miner) Address() address.Address
  • func (m *Miner) GetBestMiningCandidate(ctx context.Context) (*MiningBase, error)
  • func (m *Miner) Start(_ context.Context) error
  • func (m *Miner) Stop(ctx context.Context) error
• type MiningBase

Functions

func NewTestMiner

func NewTestMiner(nextCh <-chan MineReq, addr address.Address) func(v1api.FullNode, gen.WinningPoStProver) *Miner

Types

type MineReq

type MineReq struct {
	InjectNulls abi.ChainEpoch
	Done        func(bool, abi.ChainEpoch, error)
}

type Miner

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

Miner encapsulates the mining processes of the system.

Refer to the godocs on mineOne and mine methods for more detail.

func NewMiner

func NewMiner(api v1api.FullNode, epp gen.WinningPoStProver, addr address.Address, sf *slashfilter.SlashFilter, j journal.Journal) *Miner

NewMiner instantiates a miner with a concrete WinningPoStProver and a miner address (which can be different from the worker's address).

func (*Miner) Address

func (m *Miner) Address() address.Address

Address returns the address of the miner.

func (*Miner) GetBestMiningCandidate

func (m *Miner) GetBestMiningCandidate(ctx context.Context) (*MiningBase, error)

GetBestMiningCandidate implements the fork choice rule from a miner's perspective, returning the best head to mine on. This includes the number of null rounds we think we should insert and the time at which we received said head.

func (*Miner) Start

func (m *Miner) Start(_ context.Context) error

Start starts the mining operation. It spawns a goroutine and returns immediately. Start is not idempotent.

func (*Miner) Stop

func (m *Miner) Stop(ctx context.Context) error

Stop stops the mining operation. It is not idempotent, and multiple adjacent calls to Stop will fail.

type MiningBase

type MiningBase struct {
	TipSet      *types.TipSet
	ComputeTime time.Time
	NullRounds  abi.ChainEpoch
}

MiningBase is the tipset on top of which we plan to construct our next block. Refer to godocs on GetBestMiningCandidate.