Documentation
¶
Index ¶
- Variables
- type API
- func (api *API) GetSigners(number *rpc.BlockNumber) ([]common.Address, error)
- func (api *API) GetSignersAtHash(hash common.Hash) ([]common.Address, error)
- func (api *API) GetSnapshot(number *rpc.BlockNumber) (*DposSnapshot, error)
- func (api *API) GetSnapshotAtHash(hash common.Hash) (*DposSnapshot, error)
- type Dpos
- func (c *Dpos) APIs(chain consensus.ChainReader) []rpc.API
- func (c *Dpos) Author(header *types.Header) (common.Address, error)
- func (c *Dpos) Authorize(signer common.Address, signFn SignerFn)
- func (c *Dpos) CalcDifficulty(chain consensus.ChainReader, time uint64, parent *types.Header) *big.Int
- func (c *Dpos) CalcDifficultyInternal(snap *DposSnapshot, chain consensus.ChainReader, time uint64, ...) *big.Int
- func (c *Dpos) CalcNonce(snap *DposSnapshot, chain consensus.ChainReader, time uint64, ...) uint64
- func (c *Dpos) Finalize(chain consensus.ChainReader, header *types.Header, state *state.StateDB, ...) (*types.Block, error)
- func (c *Dpos) Prepare(chain consensus.ChainReader, header *types.Header) error
- func (c *Dpos) Seal(chain consensus.ChainReader, block *types.Block, stop <-chan struct{}) (*types.Block, error)
- func (c *Dpos) VerifyHeader(chain consensus.ChainReader, header *types.Header, seal bool) error
- func (c *Dpos) VerifyHeaders(chain consensus.ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)
- func (c *Dpos) VerifySeal(chain consensus.ChainReader, header *types.Header) error
- func (c *Dpos) VerifyUncles(chain consensus.ChainReader, block *types.Block) error
- type DposSnapshot
- type SignerFn
Constants ¶
This section is empty.
Variables ¶
var ( // ErrInvalidTimestamp is returned if the timestamp of a block is lower than // the previous block's timestamp + the minimum block period. ErrInvalidTimestamp = errors.New("invalid timestamp") )
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.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
// contains filtered or unexported fields
}
API is a user facing RPC API to allow controlling the signer and voting mechanisms of the proof-of-authority scheme.
func (*API) GetSigners ¶
GetSigners retrieves the list of authorized signers at the specified block.
func (*API) GetSignersAtHash ¶
GetSignersAtHash retrieves the state snapshot at a given block.
func (*API) GetSnapshot ¶
func (api *API) GetSnapshot(number *rpc.BlockNumber) (*DposSnapshot, error)
GetSnapshot retrieves the state snapshot at a given block.
func (*API) GetSnapshotAtHash ¶
func (api *API) GetSnapshotAtHash(hash common.Hash) (*DposSnapshot, error)
GetSnapshotAtHash retrieves the state snapshot at a given block.
type Dpos ¶
type Dpos struct {
// contains filtered or unexported fields
}
Dpos is the proof-of-authority consensus engine proposed to support the WorldOpenNetwork testnet following the Ropsten attacks.
func New ¶
func New(config *params.DposConfig, db wondb.Database) *Dpos
New creates a Dpos proof-of-authority consensus engine with the initial signers set to the ones provided by the user.
func (*Dpos) APIs ¶
func (c *Dpos) APIs(chain consensus.ChainReader) []rpc.API
APIs implements consensus.Engine, returning the user facing RPC API to allow controlling the signer voting.
func (*Dpos) Author ¶
Author implements consensus.Engine, returning the WorldOpenNetwork address recovered from the signature in the header's extra-data section.
func (*Dpos) Authorize ¶
Authorize injects a private key into the consensus engine to mint new blocks with.
func (*Dpos) CalcDifficulty ¶
func (c *Dpos) 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 based on the previous blocks in the chain and the current signer.
func (*Dpos) CalcDifficultyInternal ¶
func (c *Dpos) CalcDifficultyInternal(snap *DposSnapshot, 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 based on the previous blocks in the chain and the current signer.
func (*Dpos) CalcNonce ¶
func (c *Dpos) CalcNonce(snap *DposSnapshot, chain consensus.ChainReader, time uint64, parent *types.Header) uint64
func (*Dpos) Finalize ¶
func (c *Dpos) 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, ensuring no uncles are set, nor block rewards given, and returns the final block.
func (*Dpos) Prepare ¶
Prepare implements consensus.Engine, preparing all the consensus fields of the header for running the transactions on top.
func (*Dpos) Seal ¶
func (c *Dpos) Seal(chain consensus.ChainReader, block *types.Block, stop <-chan struct{}) (*types.Block, error)
Seal implements consensus.Engine, attempting to create a sealed block using the local signing credentials.
func (*Dpos) VerifyHeader ¶
VerifyHeader checks whether a header conforms to the consensus rules.
func (*Dpos) VerifyHeaders ¶
func (c *Dpos) VerifyHeaders(chain consensus.ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)
VerifyHeaders is similar to VerifyHeader, but verifies a batch of headers. The method returns a quit channel to abort the operations and a results channel to retrieve the async verifications (the order is that of the input slice).
func (*Dpos) VerifySeal ¶
VerifySeal implements consensus.Engine, checking whether the signature contained in the header satisfies the consensus protocol requirements.
func (*Dpos) VerifyUncles ¶
VerifyUncles implements consensus.Engine, always returning an error for any uncles as this consensus mechanism doesn't permit uncles.
type DposSnapshot ¶
type DposSnapshot struct {
Number uint64 `json:"number"` // Block number where the snapshot was created
Hash common.Hash `json:"hash"` // Block hash where the snapshot was created
Signers map[common.Address]struct{} `json:"signers"` // Set of authorized signers at this moment
Recents map[uint64]common.Address `json:"recents"` // Set of recent signers for spam protections
// contains filtered or unexported fields
}
Snapshot is the state of the authorization voting at a given point in time.
Source Files