README
¶
A brief introduction to TrueChain 2.0 Consensus
Documentation
¶
Overview ¶
Package minerva implements the TrueChain consensus engine.
Index ¶
- Variables
- func GetBlockReward(num uint64) *big.Int
- func LogPrint(info string, addr common.Address, amount *big.Int)
- type Config
- type ConstSqrt
- type Minerva
- func (m *Minerva) APIs(chain consensus.ChainReader) []rpc.API
- func (m *Minerva) Author(header *types.Header) (common.Address, error)
- func (m *Minerva) Finalize(chain consensus.ChainReader, header *types.Header, state *state.StateDB, ...) (*types.Block, *types.ChainReward, error)
- func (m *Minerva) FinalizeCommittee(block *types.Block) error
- func (m *Minerva) GetElection() consensus.CommitteeElection
- func (m *Minerva) Prepare(chain consensus.ChainReader, header *types.Header) error
- func (m *Minerva) SetElection(e consensus.CommitteeElection)
- func (m *Minerva) SetThreads(threads int)
- func (m *Minerva) Threads() int
- func (m *Minerva) VerifyHeader(chain consensus.ChainReader, header *types.Header) error
- func (m *Minerva) VerifyHeaders(chain consensus.ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)
- func (m *Minerva) VerifySigns(fastnumber *big.Int, fastHash common.Hash, signs []*types.PbftSign) error
- func (m *Minerva) VerifySwitchInfo(fastnumber *big.Int, info []*types.CommitteeMember) error
- type Mode
Constants ¶
This section is empty.
Variables ¶
var ( //ErrRewardedBlock is returned if a block to import is already rewarded. ErrRewardedBlock = errors.New("block already rewarded") ErrRewardEnd = errors.New("Reward end") )
Various error messages to mark blocks invalid. These should be private to prevent engine specific errors from being referenced in the remainder of the codebase, inherently breaking if the engine is swapped out. Please put common error types into the consensus package.
var ( Big1e16 = big.NewInt(1e16) // 0.01 unit //BaseBig ... BaseBig = big.NewInt(1e18) //NetworkFragmentsNuber The number of main network fragments is currently fixed at 1 NetworkFragmentsNuber = 1 NewRewardBegin = 53550 RewardEndSnailHeight = 1000000 )
var ErrInvalidDumpMagic = errors.New("invalid dump magic")
ErrInvalidDumpMagic errorinfo
Functions ¶
func GetBlockReward ¶
GetBlockReward Reward for block allocation
Types ¶
type Config ¶
type Config struct {
PowMode Mode
}
Config are the configuration parameters of the minerva.
type Minerva ¶
type Minerva struct {
// contains filtered or unexported fields
}
Minerva consensus
func NewFakeDelayer ¶
NewFakeDelayer creates a minerva 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 Ethereum consensus rules.
func NewFakeFailer ¶
NewFakeFailer creates a minerva 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 Ethereum consensus rules.
func NewFaker ¶
func NewFaker() *Minerva
NewFaker creates a minerva consensus engine with a fake PoW scheme that accepts all blocks' seal as valid, though they still have to conform to the Ethereum consensus rules.
func NewFullFaker ¶
func NewFullFaker() *Minerva
NewFullFaker creates an minerva consensus engine with a full fake scheme that accepts all blocks as valid, without checking any consensus rules whatsoever.
func NewShared ¶
func NewShared() *Minerva
NewShared creates a full sized minerva shared between all requesters running in the same process.
func NewTester ¶
func NewTester() *Minerva
NewTester creates a small sized minerva scheme useful only for testing purposes.
func (*Minerva) Author ¶
Author implements consensus.Engine, returning the header's coinbase as the proof-of-work verified author of the block.
func (*Minerva) Finalize ¶
func (m *Minerva) Finalize(chain consensus.ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, receipts []*types.Receipt, feeAmount *big.Int) (*types.Block, *types.ChainReward, error)
Finalize implements consensus.Engine, accumulating the block fruit and uncle rewards, setting the final state and assembling the block.
func (*Minerva) FinalizeCommittee ¶
FinalizeCommittee upddate current committee state
func (*Minerva) GetElection ¶
func (m *Minerva) GetElection() consensus.CommitteeElection
GetElection return election
func (*Minerva) Prepare ¶
Prepare implements consensus.Engine, initializing the difficulty field of a header to conform to the minerva protocol. The changes are done inline.
func (*Minerva) SetElection ¶
func (m *Minerva) SetElection(e consensus.CommitteeElection)
SetElection Append interface CommitteeElection after instantiation
func (*Minerva) 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 (*Minerva) Threads ¶
Threads returns the number of mining threads currently enabled. This doesn't necessarily mean that mining is running!
func (*Minerva) VerifyHeader ¶
VerifyHeader checks whether a header conforms to the consensus rules of the stock TrueChain m engine.
func (*Minerva) VerifyHeaders ¶
func (m *Minerva) 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 (*Minerva) VerifySigns ¶
func (m *Minerva) VerifySigns(fastnumber *big.Int, fastHash common.Hash, signs []*types.PbftSign) error
VerifySigns check the sings included in fast block or fruit
func (*Minerva) VerifySwitchInfo ¶
VerifySwitchInfo verify the switch info of Committee
Source Files