Documentation
¶
Overview ¶
Package wshash implements the wshash proof-of-work consensus engine.
Index ¶
- Variables
- func AccumulateRewards(config *params.ChainConfig, state *state.StateDB, header *types.Header, ...)
- func CalcDifficulty(config *params.ChainConfig, time uint64, parent *types.Header) *big.Int
- func MakeCache(block uint64, dir string)
- func MakeDataset(block uint64, dir string)
- func SeedHash(block uint64) []byte
- type Wshash
- func (wshash *Wshash) APIs(chain consensus.ChainReader) []rpc.API
- func (wshash *Wshash) Author(header *types.Header) (common.Address, error)
- func (wshash *Wshash) Finalize(chain consensus.ChainReader, header *types.Header, state *state.StateDB, ...) (*types.Block, error)
- func (wshash *Wshash) Hashrate() float64
- func (wshash *Wshash) Prepare(chain consensus.ChainReader, header *types.Header) error
- func (wshash *Wshash) Seal(chain consensus.ChainReader, block *types.Block, stop <-chan struct{}) (*types.Block, error)
- func (wshash *Wshash) SetThreads(threads int)
- func (wshash *Wshash) Threads() int
- func (wshash *Wshash) VerifyHeader(chain consensus.ChainReader, header *types.Header, seal bool) error
- func (wshash *Wshash) VerifyHeaders(chain consensus.ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)
- func (wshash *Wshash) VerifySeal(chain consensus.ChainReader, header *types.Header) error
- func (wshash *Wshash) VerifyUncles(chain consensus.ChainReader, block *types.Block) error
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidDumpMagic = errors.New("invalid dump magic")
Functions ¶
func AccumulateRewards ¶
func AccumulateRewards(config *params.ChainConfig, state *state.StateDB, header *types.Header, uncles []*types.Header)
AccumulateRewards credits the coinbase of the given block with the mining reward. The total reward consists of the static block reward and rewards for included uncles. The coinbase of each uncle block is also rewarded. TODO (karalabe): Move the chain maker into this package and make this private!
func CalcDifficulty ¶
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. TODO (karalabe): Move the chain maker into this package and make this private!
func MakeDataset ¶
MakeDataset generates a new wshash dataset and optionally stores it to disk.
Types ¶
type Wshash ¶
type Wshash struct {
// contains filtered or unexported fields
}
Wshash is a consensus engine based on proot-of-work implementing the wshash algorithm.
func New ¶
func New(cachedir string, cachesinmem, cachesondisk int, dagdir string, dagsinmem, dagsondisk int) *Wshash
New creates a full sized wshash PoW scheme.
func NewFakeDelayer ¶
NewFakeDelayer creates a wshash 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 Wiseplat consensus rules.
func NewFakeFailer ¶
NewFakeFailer creates a wshash 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 Wiseplat consensus rules.
func NewFaker ¶
func NewFaker() *Wshash
NewFaker creates a wshash consensus engine with a fake PoW scheme that accepts all blocks' seal as valid, though they still have to conform to the Wiseplat consensus rules.
func NewFullFaker ¶
func NewFullFaker() *Wshash
NewFullFaker creates an wshash consensus engine with a full fake scheme that accepts all blocks as valid, without checking any consensus rules whatsoever.
func NewShared ¶
func NewShared() *Wshash
NewShared creates a full sized wshash PoW shared between all requesters running in the same process.
func NewTester ¶
func NewTester() *Wshash
NewTester creates a small sized wshash PoW scheme useful only for testing purposes.
func (*Wshash) APIs ¶
func (wshash *Wshash) APIs(chain consensus.ChainReader) []rpc.API
APIs implements consensus.Engine, returning the user facing RPC APIs. Currently that is empty.
func (*Wshash) Author ¶
Author implements consensus.Engine, returning the header's coinbase as the proof-of-work verified author of the block.
func (*Wshash) Finalize ¶
func (wshash *Wshash) Finalize(chain consensus.ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, uncles []*types.Header, receipts []*types.Receipt) (*types.Block, error)
Finalize implements consensus.Engine, accumulating the block and uncle rewards, setting the final state and assembling the block.
func (*Wshash) Hashrate ¶
Hashrate implements PoW, returning the measured rate of the search invocations per second over the last minute.
func (*Wshash) Prepare ¶
Prepare implements consensus.Engine, initializing the difficulty field of a header to conform to the wshash protocol. The changes are done inline.
func (*Wshash) Seal ¶
func (wshash *Wshash) Seal(chain consensus.ChainReader, block *types.Block, stop <-chan struct{}) (*types.Block, error)
Seal implements consensus.Engine, attempting to find a nonce that satisfies the block's difficulty requirements.
func (*Wshash) SetThreads ¶
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 (*Wshash) Threads ¶
Threads returns the number of mining threads currently enabled. This doesn't necessarily mean that mining is running!
func (*Wshash) VerifyHeader ¶
func (wshash *Wshash) VerifyHeader(chain consensus.ChainReader, header *types.Header, seal bool) error
VerifyHeader checks whether a header conforms to the consensus rules of the stock Wiseplat wshash engine.
func (*Wshash) VerifyHeaders ¶
func (wshash *Wshash) 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 (*Wshash) VerifySeal ¶
VerifySeal implements consensus.Engine, checking whether the given block satisfies the PoW difficulty requirements.
func (*Wshash) VerifyUncles ¶
VerifyUncles verifies that the given block's uncles conform to the consensus rules of the stock Wiseplat wshash engine.
Source Files