manash

Documentation

Overview

Package manash implements the manash proof-of-work consensus engine.

Index

• Variables
• func CalcDifficulty(config *params.ChainConfig, curVersion string, time uint64, ...) (*big.Int, error)
• func GetdifficultyListAndTargetList(difficultyList []*big.Int) minerDifficultyList
• func MakeCache(block uint64, dir string)
• func MakeDataset(block uint64, dir string)
• func SeedHash(block uint64) []byte
• type Config
• type Manash
  • func New(config Config) *Manash
  • func NewFakeDelayer(delay time.Duration) *Manash
  • func NewFakeFailer(fail uint64) *Manash
  • func NewFaker() *Manash
  • func NewFullFaker() *Manash
  • func NewShared() *Manash
  • func NewTester() *Manash
  • func (manash *Manash) APIs(chain consensus.ChainReader) []rpc.API
  • func (manash *Manash) Author(header *types.Header) (common.Address, error)
  • func (manash *Manash) CalcDifficulty(chain consensus.ChainReader, curVersion string, time uint64, ...) (*big.Int, error)
  • func (manash *Manash) Finalize(chain consensus.ChainReader, header *types.Header, state *state.StateDBManage, ...) (*types.Block, error)
  • func (manash *Manash) Hashrate() float64
  • func (manash *Manash) Prepare(chain consensus.ChainReader, header *types.Header) error
  • func (manash *Manash) Seal(chain consensus.ChainReader, header *types.Header, stop <-chan struct{}, ...) (*types.Header, error)
  • func (manash *Manash) SetThreads(threads int)
  • func (manash *Manash) Threads() int
  • func (manash *Manash) VerifyHeader(chain consensus.ChainReader, header *types.Header, seal bool) error
  • func (manash *Manash) VerifyHeaders(chain consensus.ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)
  • func (manash *Manash) VerifySeal(chain consensus.ChainReader, header *types.Header) error
  • func (manash *Manash) VerifySignatures(signature []common.Signature) (bool, error)
  • func (manash *Manash) VerifyUncles(chain consensus.ChainReader, block *types.Block) error
• type Mode

Variables

var (
	FrontierBlockReward  *big.Int = big.NewInt(5e+18) // Block reward in wei for successfully mining a block
	ByzantiumBlockReward *big.Int = big.NewInt(3e+18) // Block reward in wei for successfully mining a block upward from Byzantium

)

Manash proof-of-work protocol constants.

var ErrInvalidDumpMagic = errors.New("invalid dump magic")

Functions

func CalcDifficulty

func CalcDifficulty(config *params.ChainConfig, curVersion string, time uint64, parent *types.Header) (*big.Int, error)

CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty that a new block should have when created at time given the parent block's time and difficulty.

func GetdifficultyListAndTargetList

func GetdifficultyListAndTargetList(difficultyList []*big.Int) minerDifficultyList

func MakeCache

func MakeCache(block uint64, dir string)

MakeCache generates a new manash cache and optionally stores it to disk.

func MakeDataset

func MakeDataset(block uint64, dir string)

MakeDataset generates a new manash dataset and optionally stores it to disk.

func SeedHash

func SeedHash(block uint64) []byte

SeedHash is the seed to use for generating a verification cache and the mining dataset.

Types

type Config

type Config struct {
	CacheDir       string
	CachesInMem    int
	CachesOnDisk   int
	DatasetDir     string
	DatasetsInMem  int
	DatasetsOnDisk int
	PowMode        Mode
}

Config are the configuration parameters of the manash.

type Manash

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

Manash is a consensus engine based on proot-of-work implementing the manash algorithm.

func New

func New(config Config) *Manash

New creates a full sized manash PoW scheme.

func NewFakeDelayer

func NewFakeDelayer(delay time.Duration) *Manash

NewFakeDelayer creates a manash consensus engine with a fake PoW scheme that accepts all blocks as valid, but delays verifications by some time, though they still have to conform to the Matrix consensus rules.

func NewFakeFailer

func NewFakeFailer(fail uint64) *Manash

NewFakeFailer creates a manash consensus engine with a fake PoW scheme that accepts all blocks as valid apart from the single one specified, though they still have to conform to the Matrix consensus rules.

func NewFaker

func NewFaker() *Manash

NewFaker creates a manash consensus engine with a fake PoW scheme that accepts all blocks' seal as valid, though they still have to conform to the Matrix consensus rules.

func NewFullFaker

func NewFullFaker() *Manash

NewFullFaker creates an manash consensus engine with a full fake scheme that accepts all blocks as valid, without checking any consensus rules whatsoever.

func NewShared

func NewShared() *Manash

NewShared creates a full sized manash PoW shared between all requesters running in the same process.

func NewTester

func NewTester() *Manash

NewTester creates a small sized manash PoW scheme useful only for testing purposes.

func (*Manash) APIs

func (manash *Manash) APIs(chain consensus.ChainReader) []rpc.API

APIs implements consensus.Engine, returning the user facing RPC APIs. Currently that is empty.

func (*Manash) Author

func (manash *Manash) Author(header *types.Header) (common.Address, error)

Author implements consensus.Engine, returning the header's coinbase as the proof-of-work verified author of the block.

func (*Manash) CalcDifficulty

func (manash *Manash) CalcDifficulty(chain consensus.ChainReader, curVersion string, time uint64, parent *types.Header) (*big.Int, error)

CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty that a new block should have when created at time given the parent block's time and difficulty.

func (*Manash) Finalize

func (manash *Manash) Finalize(chain consensus.ChainReader, header *types.Header, state *state.StateDBManage, uncles []*types.Header, currencyBlock []types.CurrencyBlock) (*types.Block, error)

Finalize implements consensus.Engine, accumulating the block and uncle rewards, setting the final state and assembling the block.

func (*Manash) Hashrate

func (manash *Manash) Hashrate() float64

Hashrate implements PoW, returning the measured rate of the search invocations per second over the last minute.

func (*Manash) Prepare

func (manash *Manash) Prepare(chain consensus.ChainReader, header *types.Header) error

Prepare implements consensus.Engine, initializing the difficulty field of a header to conform to the manash protocol. The changes are done inline.

func (*Manash) Seal

func (manash *Manash) Seal(chain consensus.ChainReader, header *types.Header, stop <-chan struct{}, isBroadcastNode bool) (*types.Header, error)

Seal implements consensus.Engine, attempting to find a nonce that satisfies the block's difficulty requirements.

func (*Manash) SetThreads

func (manash *Manash) SetThreads(threads int)

SetThreads updates the number of mining threads currently enabled. Calling this method does not start mining, only sets the thread count. If zero is specified, the miner will use all cores of the machine. Setting a thread count below zero is allowed and will cause the miner to idle, without any work being done.

func (*Manash) Threads

func (manash *Manash) Threads() int

Threads returns the number of mining threads currently enabled. This doesn't necessarily mean that mining is running!

func (*Manash) VerifyHeader

func (manash *Manash) VerifyHeader(chain consensus.ChainReader, header *types.Header, seal bool) error

VerifyHeader checks whether a header conforms to the consensus rules of the stock Matrix manash engine.

func (*Manash) VerifyHeaders

func (manash *Manash) VerifyHeaders(chain consensus.ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)

VerifyHeaders is similar to VerifyHeader, but verifies a batch of headers concurrently. The method returns a quit channel to abort the operations and a results channel to retrieve the async verifications.

func (*Manash) VerifySeal

func (manash *Manash) VerifySeal(chain consensus.ChainReader, header *types.Header) error

VerifySeal implements consensus.Engine, checking whether the given block satisfies the PoW difficulty requirements.

func (*Manash) VerifySignatures

func (manash *Manash) VerifySignatures(signature []common.Signature) (bool, error)

VerifyHeader checks whether a header conforms to the consensus rules of the stock Matrix manash engine.

func (*Manash) VerifyUncles

func (manash *Manash) VerifyUncles(chain consensus.ChainReader, block *types.Block) error

VerifyUncles verifies that the given block's uncles conform to the consensus rules of the stock Matrix manash engine.

type Mode

type Mode uint

Mode defines the type and amount of PoW verification an manash engine makes.

const (
	ModeNormal Mode = iota
	ModeShared
	ModeTest
	ModeFake
	ModeFullFake
)