dpos

package
v0.1.0-alpha Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 6, 2021 License: GPL-3.0 Imports: 33 Imported by: 0

Documentation

Overview

Package dpos implements the proof-of-stake-authority consensus engine.

Index

Constants

View Source
const (
	DirectionFrom blacklistDirection = iota
	DirectionTo
	DirectionBoth
)

Variables

View Source
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

func DposRLP

func DposRLP(header *types.Header) []byte

DposRLP returns the rlp bytes which needs to be signed for the proof-of-stake-authority sealing. The RLP to sign consists of the entire header apart from the 65 byte signature contained at the end of the extra data.

Note, the method requires the extra data to be at least 65 bytes, otherwise it panics. This is done to avoid accidentally using both forms (signature present or not), which could be abused to produce different hashes for the same header.

func SealHash

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

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

Types

type API

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

API is a user facing RPC API to allow controlling the validator and voting mechanisms of the proof-of-authority scheme.

func (*API) GetSnapshot

func (api *API) GetSnapshot(number *rpc.BlockNumber) (*Snapshot, error)

GetSnapshot retrieves the state snapshot at a given block.

func (*API) GetSnapshotAtHash

func (api *API) GetSnapshotAtHash(hash common.Hash) (*Snapshot, error)

GetSnapshotAtHash retrieves the state snapshot at a given block.

func (*API) GetValidators

func (api *API) GetValidators(number *rpc.BlockNumber) ([]common.Address, error)

GetValidators retrieves the list of authorized validators at the specified block.

func (*API) GetValidatorsAtHash

func (api *API) GetValidatorsAtHash(hash common.Hash) ([]common.Address, error)

GetValidatorsAtHash retrieves the list of authorized validators at the specified block.

func (*API) Status

func (api *API) Status() (*status, error)

Status returns the status of the last N blocks, - the number of active validators, - the number of validators, - the percentage of in-turn blocks

type Dpos

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

Dpos is the proof-of-stake-authority consensus engine proposed to support the Ethereum testnet following the Ropsten attacks.

func New

func New(chainConfig *params.ChainConfig, db ethdb.Database) *Dpos

New creates a Dpos proof-of-stake-authority consensus engine with the initial validators set to the ones provided by the user.

func (*Dpos) APIs

func (d *Dpos) APIs(chain consensus.ChainHeaderReader) []rpc.API

APIs implements consensus.Engine, returning the user facing RPC API to allow controlling the validator voting.

func (*Dpos) ApplySysTx

func (d *Dpos) ApplySysTx(evm *vm.EVM, state *state.StateDB, txIndex int, sender common.Address, tx *types.Transaction) (ret []byte, vmerr error, err error)

ApplySysTx applies a system-transaction using a given evm, the main purpose of this method is for tracing a system-transaction.

func (*Dpos) Author

func (d *Dpos) Author(header *types.Header) (common.Address, error)

Author implements consensus.Engine, returning the Ethereum address recovered from the signature in the header's extra-data section.

func (*Dpos) Authorize

func (d *Dpos) Authorize(validator common.Address, signFn ValidatorFn, signTxFn SignTxFn)

Authorize injects a private key into the consensus engine to mint new blocks with.

func (*Dpos) CalcDifficulty

func (d *Dpos) CalcDifficulty(chain consensus.ChainHeaderReader, time uint64, parent *types.Header) *big.Int

CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty that a new block should have: * DIFF_NOTURN(2) if BLOCK_NUMBER % validator_COUNT != validator_INDEX * DIFF_INTURN(1) if BLOCK_NUMBER % validator_COUNT == validator_INDEX

func (*Dpos) CanCreate

func (d *Dpos) CanCreate(state consensus.StateReader, addr common.Address, height *big.Int) bool

CanCreate determines where a given address can create a new contract.

This will queries the system Developers contract, by DIRECTLY to get the target slot value of the contract, it means that it's strongly relative to the layout of the Developers contract's state variables

func (*Dpos) Close

func (d *Dpos) Close() error

Close implements consensus.Engine. It's a noop for dpos as there are no background threads.

func (*Dpos) CreateEvmExtraValidator

func (d *Dpos) CreateEvmExtraValidator(header *types.Header, parentState *state.StateDB) types.EvmExtraValidator

func (*Dpos) Finalize

func (d *Dpos) Finalize(chain consensus.ChainHeaderReader, header *types.Header, state *state.StateDB, txs *[]*types.Transaction, uncles []*types.Header, receipts *[]*types.Receipt, systemTxs []*types.Transaction) error

Finalize implements consensus.Engine, ensuring no uncles are set, nor block rewards given.

func (*Dpos) FinalizeAndAssemble

func (d *Dpos) FinalizeAndAssemble(chain consensus.ChainHeaderReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, uncles []*types.Header, receipts []*types.Receipt) (b *types.Block, rs []*types.Receipt, err error)

FinalizeAndAssemble implements consensus.Engine, ensuring no uncles are set, nor block rewards given, and returns the final block.

func (*Dpos) IsSysTransaction

func (d *Dpos) IsSysTransaction(sender common.Address, tx *types.Transaction, header *types.Header) (bool, error)

IsSysTransaction checks whether a specific transaction is a system transaction.

func (*Dpos) PreHandle

func (d *Dpos) PreHandle(chain consensus.ChainHeaderReader, header *types.Header, state *state.StateDB) error

func (*Dpos) Prepare

func (d *Dpos) Prepare(chain consensus.ChainHeaderReader, header *types.Header) error

Prepare implements consensus.Engine, preparing all the consensus fields of the header for running the transactions on top.

func (*Dpos) Seal

func (d *Dpos) Seal(chain consensus.ChainHeaderReader, block *types.Block, results chan<- *types.Block, stop <-chan struct{}) error

Seal implements consensus.Engine, attempting to create a sealed block using the local signing credentials.

func (*Dpos) SealHash

func (d *Dpos) SealHash(header *types.Header) common.Hash

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

func (*Dpos) SetChain

func (d *Dpos) SetChain(chain consensus.ChainHeaderReader)

func (*Dpos) SetStateFn

func (d *Dpos) SetStateFn(fn StateFn)

SetStateFn sets the function to get state.

func (*Dpos) ValidateTx

func (d *Dpos) ValidateTx(sender common.Address, tx *types.Transaction, header *types.Header, parentState *state.StateDB) error

ValidateTx do a consensus-related validation on the given transaction at the given header and state. the parentState must be the state of the header's parent block.

func (*Dpos) VerifyHeader

func (d *Dpos) VerifyHeader(chain consensus.ChainHeaderReader, header *types.Header, seal bool) error

VerifyHeader checks whether a header conforms to the consensus rules.

func (*Dpos) VerifyHeaders

func (d *Dpos) VerifyHeaders(chain consensus.ChainHeaderReader, 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

func (d *Dpos) VerifySeal(chain consensus.ChainHeaderReader, header *types.Header) error

VerifySeal implements consensus.Engine, checking whether the signature contained in the header satisfies the consensus protocol requirements.

func (*Dpos) VerifyUncles

func (d *Dpos) VerifyUncles(chain consensus.ChainReader, block *types.Block) error

VerifyUncles implements consensus.Engine, always returning an error for any uncles as this consensus mechanism doesn't permit uncles.

type EventCheckRule

type EventCheckRule struct {
	EventSig common.Hash
	Checks   map[int]common.AddressCheckType
}

type Proposal

type Proposal struct {
	Id     *big.Int
	Action *big.Int
	From   common.Address
	To     common.Address
	Value  *big.Int
	Data   []byte
}

Proposal is the system governance proposal info.

type SignTxFn

type SignTxFn func(account accounts.Account, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)

type Snapshot

type Snapshot struct {
	Number     uint64                      `json:"number"`     // Block number where the snapshot was created
	Hash       common.Hash                 `json:"hash"`       // Block hash where the snapshot was created
	Validators map[common.Address]struct{} `json:"validators"` // Set of authorized validators at this moment
	Recents    map[uint64]common.Address   `json:"recents"`    // Set of recent validators for spam protections
	// contains filtered or unexported fields
}

Snapshot is the state of the authorization voting at a given point in time.

type StateFn

type StateFn func(hash common.Hash) (*state.StateDB, error)

StateFn gets state by the state root hash.

type ValidatorFn

type ValidatorFn func(validator accounts.Account, mimeType string, message []byte) ([]byte, error)

ValidatorFn hashes and signs the data to be signed by a backing account.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL