Documentation
¶
Index ¶
- func BuildBlock(params BuildBlockParams) *types.Block
- type BuildBlockParams
- type Config
- type Consensus
- type ConsensusParams
- type Factory
- type Metrics
- type NoProof
- func (n *NoProof) Close() error
- func (n *NoProof) Finalize(txn *state.Txn, block *types.Block) error
- func (n *NoProof) Prepare(header *types.Header) error
- func (n *NoProof) Seal(block *types.Block, ctx context.Context) (*types.Block, error)
- func (n *NoProof) VerifyHeader(parent, header *types.Header, uncle, seal bool) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildBlock ¶
func BuildBlock(params BuildBlockParams) *types.Block
BuildBlock is a utility function that builds a block, based on the passed in header, transactions and receipts
Types ¶
type BuildBlockParams ¶
type BuildBlockParams struct { Header *types.Header Txns []*types.Transaction Receipts []*types.Receipt }
BuildBlockParams are parameters passed into the BuildBlock helper method
type Config ¶
type Config struct { // Logger to be used by the backend Logger *log.Logger // Params are the params of the chain and the consensus Params *chain.Params // Config defines specific configuration parameters for the backend Config map[string]interface{} // Path is the directory path for the consensus protocol tos tore information Path string }
Config is the configuration for the consensus
type Consensus ¶
type Consensus interface { // VerifyHeader verifies the header is correct VerifyHeader(parent, header *types.Header) error // GetBlockCreator retrieves the block creator (or signer) given the block header GetBlockCreator(header *types.Header) (types.Address, error) // PreStateCommit a hook to be called before finalizing state transition on inserting block PreStateCommit(header *types.Header, txn *state.Transition) error // GetSyncProgression retrieves the current sync progression, if any GetSyncProgression() *progress.Progression // Initialize initializes the consensus (e.g. setup data) Initialize() error // Start starts the consensus and servers Start() error // Close closes the connection Close() error }
Consensus is the public interface for consensus mechanism Each consensus mechanism must implement this interface in order to be valid
type ConsensusParams ¶
type Factory ¶
type Factory func( *ConsensusParams, ) (Consensus, error)
Factory is the factory function to create a discovery backend
type Metrics ¶
type Metrics struct { // No.of validators Validators metrics.Gauge // No.of rounds Rounds metrics.Gauge // No.of transactions in the block NumTxs metrics.Gauge //Time between current block and the previous block in seconds BlockInterval metrics.Gauge }
Metrics represents the consensus metrics
func GetPrometheusMetrics ¶
GetPrometheusMetrics return the consensus metrics instance
type NoProof ¶
type NoProof struct { }
NoProof is a consensus algorithm that validates everything
func (*NoProof) Prepare ¶
Prepare initializes the consensus fields of a block header according to the rules of a particular engine. The changes are executed inline.