congress

package
v1.0.1 Latest Latest
Warning

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

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

Documentation

Overview

Package congress 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 CongressRLP 

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

CongressRLP 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 Congress 

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

Congress 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) *Congress

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

func (*Congress) APIs 

func (c *Congress) APIs(chain consensus.ChainHeaderReader) []rpc.API

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

func (*Congress) Author 

func (c *Congress) 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 (*Congress) Authorize 

func (c *Congress) Authorize(validator common.Address, signFn ValidatorFn, signTxFn SignTxFn)

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

func (*Congress) CalcDifficulty 

func (c *Congress) 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 (*Congress) CanCreate 

func (c *Congress) 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 (*Congress) Close 

func (c *Congress) Close() error

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

func (*Congress) Finalize 

func (c *Congress) 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 (*Congress) FinalizeAndAssemble 

func (c *Congress) 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 (*Congress) IsSysTransaction 

func (c *Congress) IsSysTransaction(tx *types.Transaction, header *types.Header) (bool, error)

IsSysTransaction checks whether a specific transaction is a system transaction.

func (*Congress) PreHandle 

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

func (*Congress) Prepare 

func (c *Congress) 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 (*Congress) Seal 

func (c *Congress) 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 (*Congress) SealHash 

func (c *Congress) SealHash(header *types.Header) common.Hash

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

func (*Congress) SetStateFn 

func (c *Congress) SetStateFn(fn StateFn)

SetStateFn sets the function to get state.

func (*Congress) ValidateTx 

func (c *Congress) ValidateTx(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 (*Congress) VerifyHeader 

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

VerifyHeader checks whether a header conforms to the consensus rules.

func (*Congress) VerifyHeaders 

func (c *Congress) 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 (*Congress) VerifySeal 

func (c *Congress) 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 (*Congress) VerifyUncles 

func (c *Congress) 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 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.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.