cryptore

Documentation

Overview

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

Index

• Variables
• func CalcDifficulty(config *params.ChainConfig, time uint64, parent *types.Header) *big.Int
• func SeedHash(block uint64) []byte
• type API
  • func (api *API) GetHashrate() uint64
  • func (api *API) GetWork() ([4]string, error)
  • func (api *API) SubmitHashRate(rate hexutil.Uint64, id common.Hash) bool
  • func (api *API) SubmitWork(nonce types.BlockNonce, hash common.Hash) bool
• type Config
• type Cryptore
  • func New(config Config, notify []string, noverify bool) *Cryptore
  • func NewFakeDelayer(delay time.Duration) *Cryptore
  • func NewFakeFailer(fail uint64) *Cryptore
  • func NewFaker() *Cryptore
  • func NewFullFaker() *Cryptore
  • func NewShared() *Cryptore
  • func NewTester(notify []string, noverify bool) *Cryptore
  • func (cryptore *Cryptore) APIs(chain consensus.ChainReader) []rpc.API
  • func (cryptore *Cryptore) Author(header *types.Header) (common.Address, error)
  • func (cryptore *Cryptore) CalcDifficulty(chain consensus.ChainReader, time uint64, parent *types.Header) *big.Int
  • func (cryptore *Cryptore) Close() error
  • func (cryptore *Cryptore) Finalize(chain consensus.ChainReader, header *types.Header, state *state.StateDB, ...)
  • func (cryptore *Cryptore) FinalizeAndAssemble(chain consensus.ChainReader, header *types.Header, state *state.StateDB, ...) (*types.Block, error)
  • func (cryptore *Cryptore) Hashrate() float64
  • func (cryptore *Cryptore) Prepare(chain consensus.ChainReader, header *types.Header) error
  • func (cryptore *Cryptore) Seal(chain consensus.ChainReader, block *types.Block, results chan<- *types.Block, ...) error
  • func (cryptore *Cryptore) SealHash(header *types.Header) (hash common.Hash)
  • func (cryptore *Cryptore) SetThreads(threads int)
  • func (cryptore *Cryptore) Threads() int
  • func (cryptore *Cryptore) VerifyHeader(chain consensus.ChainReader, header *types.Header, seal bool) error
  • func (cryptore *Cryptore) VerifyHeaders(chain consensus.ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)
  • func (cryptore *Cryptore) VerifySeal(chain consensus.ChainReader, header *types.Header) error
  • func (cryptore *Cryptore) VerifyUncles(chain consensus.ChainReader, block *types.Block) error
• type Mode

Variables

var (
	BlockReward = big.NewInt(5e+18) // Block reward in ore for successfully mining a block

)

Cryptore proof-of-work protocol constants.

Functions

func CalcDifficulty

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

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 SeedHash

func SeedHash(block uint64) []byte

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

Types

type API

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

API exposes cryptore related methods for the RPC interface.

func (*API) GetHashrate

func (api *API) GetHashrate() uint64

GetHashrate returns the current hashrate for local CPU miner and remote miner.

func (*API) GetWork

func (api *API) GetWork() ([4]string, error)

GetWork returns a work package for external miner.

The work package consists of 3 strings:

result[0] - 32 bytes hex encoded current block header pow-hash
result[2] - 32 bytes hex encoded boundary condition ("target"), 2^256/difficulty
result[3] - hex encoded block number

func (*API) SubmitHashRate

func (api *API) SubmitHashRate(rate hexutil.Uint64, id common.Hash) bool

SubmitHashrate can be used for remote miners to submit their hash rate. This enables the node to report the combined hash rate of all miners which submit work through this node.

It accepts the miner hash rate and an identifier which must be unique between nodes.

func (*API) SubmitWork

func (api *API) SubmitWork(nonce types.BlockNonce, hash common.Hash) bool

SubmitWork can be used by external miner to submit their POW solution. It returns an indication if the work was accepted. Note either an invalid solution, a stale work a non-existent work will return false.

type Config

type Config struct {
	PowMode Mode

	Log log.Logger `toml:"-"`
}

Config are the configuration parameters of the cryptore.

type Cryptore

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

Cryptore is a consensus engine based on proof-of-work implementing the cryptore algorithm.

func New

func New(config Config, notify []string, noverify bool) *Cryptore

New creates a full sized cryptore PoW scheme and starts a background thread for remote mining, also optionally notifying a batch of remote services of new work packages.

func NewFakeDelayer

func NewFakeDelayer(delay time.Duration) *Cryptore

NewFakeDelayer creates a cryptore 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 Core consensus rules.

func NewFakeFailer

func NewFakeFailer(fail uint64) *Cryptore

NewFakeFailer creates a cryptore 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 Core consensus rules.

func NewFaker

func NewFaker() *Cryptore

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

func NewFullFaker

func NewFullFaker() *Cryptore

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

func NewShared

func NewShared() *Cryptore

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

func NewTester

func NewTester(notify []string, noverify bool) *Cryptore

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

func (*Cryptore) APIs

func (cryptore *Cryptore) APIs(chain consensus.ChainReader) []rpc.API

APIs implements consensus.Engine, returning the user facing RPC APIs.

func (*Cryptore) Author

func (cryptore *Cryptore) 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 (*Cryptore) CalcDifficulty

func (cryptore *Cryptore) CalcDifficulty(chain consensus.ChainReader, time uint64, parent *types.Header) *big.Int

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 (*Cryptore) Close

func (cryptore *Cryptore) Close() error

Close closes the exit channel to notify all backend threads exiting.

func (*Cryptore) Finalize

func (cryptore *Cryptore) Finalize(chain consensus.ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, uncles []*types.Header)

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

func (*Cryptore) FinalizeAndAssemble

func (cryptore *Cryptore) FinalizeAndAssemble(chain consensus.ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, uncles []*types.Header, receipts []*types.Receipt) (*types.Block, error)

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

func (*Cryptore) Hashrate

func (cryptore *Cryptore) Hashrate() float64

Hashrate implements PoW, returning the measured rate of the search invocations per second over the last minute. Note the returned hashrate includes local hashrate, but also includes the total hashrate of all remote miner.

func (*Cryptore) Prepare

func (cryptore *Cryptore) Prepare(chain consensus.ChainReader, header *types.Header) error

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

func (*Cryptore) Seal

func (cryptore *Cryptore) Seal(chain consensus.ChainReader, block *types.Block, results chan<- *types.Block, stop <-chan struct{}) error

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

func (*Cryptore) SealHash

func (cryptore *Cryptore) SealHash(header *types.Header) (hash common.Hash)

SealHash returns the hash of a block prior to it being sealed.

func (*Cryptore) SetThreads

func (cryptore *Cryptore) 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 (*Cryptore) Threads

func (cryptore *Cryptore) Threads() int

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

func (*Cryptore) VerifyHeader

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

VerifyHeader checks whether a header conforms to the consensus rules of the stock Core cryptore engine.

func (*Cryptore) VerifyHeaders

func (cryptore *Cryptore) 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 (*Cryptore) VerifySeal

func (cryptore *Cryptore) VerifySeal(chain consensus.ChainReader, header *types.Header) error

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

func (*Cryptore) VerifyUncles

func (cryptore *Cryptore) VerifyUncles(chain consensus.ChainReader, block *types.Block) error

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

type Mode

type Mode uint

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

const (
	ModeNormal Mode = iota
	ModeShared
	ModeTest
	ModeFake
	ModeFullFake
)