Documentation ¶
Index ¶
- Variables
- type API
- type Backend
- func (sb *Backend) APIs(chain consensus.ChainReader) []rpc.API
- func (sb *Backend) Address() common.Address
- func (sb *Backend) AskSync(valSet validator.Set)
- func (sb *Backend) Author(header *types.Header) (common.Address, error)
- func (sb *Backend) Broadcast(ctx context.Context, valSet validator.Set, payload []byte) error
- func (sb *Backend) CalcDifficulty(chain consensus.ChainReader, time uint64, parent *types.Header) *big.Int
- func (sb *Backend) CheckSignature(data []byte, address common.Address, sig []byte) error
- func (sb *Backend) Close() error
- func (sb *Backend) Commit(proposal types.Block, seals [][]byte) error
- func (sb *Backend) Finalize(chain consensus.ChainReader, header *types.Header, state *state.StateDB, ...)
- func (sb *Backend) FinalizeAndAssemble(chain consensus.ChainReader, header *types.Header, statedb *state.StateDB, ...) (*types.Block, error)
- func (sb *Backend) GetContractABI() string
- func (sb *Backend) GetContractAddress() common.Address
- func (sb *Backend) GetPrivateKey() *ecdsa.PrivateKey
- func (sb *Backend) GetProposer(number uint64) common.Address
- func (sb *Backend) Gossip(ctx context.Context, valSet validator.Set, payload []byte)
- func (sb *Backend) HandleMsg(addr common.Address, msg p2p.Msg) (bool, error)
- func (sb *Backend) HandleUnhandledMsgs(ctx context.Context)
- func (sb *Backend) HasBadProposal(hash common.Hash) bool
- func (sb *Backend) LastCommittedProposal() (*types.Block, common.Address)
- func (sb *Backend) NewChainHead() error
- func (sb *Backend) Post(ev interface{})
- func (sb *Backend) Prepare(chain consensus.ChainReader, header *types.Header) error
- func (sb *Backend) Protocol() (protocolName string, extraMsgCodes uint64)
- func (sb *Backend) ResetPeerCache(address common.Address)
- func (sb *Backend) Seal(chain consensus.ChainReader, block *types.Block, results chan<- *types.Block, ...) error
- func (sb *Backend) SealHash(header *types.Header) common.Hash
- func (sb *Backend) SetBroadcaster(broadcaster consensus.Broadcaster)
- func (sb *Backend) SetPrivateKey(key *ecdsa.PrivateKey)
- func (sb *Backend) SetProposedBlockHash(hash common.Hash)
- func (sb *Backend) Sign(data []byte) ([]byte, error)
- func (sb *Backend) Start(ctx context.Context, chain consensus.ChainReader, ...) error
- func (sb *Backend) Subscribe(types ...interface{}) *event.TypeMuxSubscription
- func (sb *Backend) SyncPeer(address common.Address, messages []*tendermintCore.Message)
- func (sb *Backend) Validators(number uint64) validator.Set
- func (sb *Backend) VerifyHeader(chain consensus.ChainReader, header *types.Header, seal bool) error
- func (sb *Backend) VerifyHeaders(chain consensus.ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)
- func (sb *Backend) VerifyProposal(proposal types.Block) (time.Duration, error)
- func (sb *Backend) VerifySeal(chain consensus.ChainReader, header *types.Header) error
- func (sb *Backend) VerifyUncles(chain consensus.ChainReader, block *types.Block) error
- func (sb *Backend) WhiteList() []string
- type UnhandledMsg
Constants ¶
This section is empty.
Variables ¶
var ( // current validator set. ErrUnauthorizedAddress = errors.New("unauthorized address") // ErrStoppedEngine is returned if the engine is stopped ErrStoppedEngine = errors.New("stopped engine") )
var ErrStartedEngine = errors.New("started engine")
ErrStartedEngine is returned if the engine is already started
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
// contains filtered or unexported fields
}
API is a user facing RPC API to dump BFT state
func (*API) GetContractABI ¶ added in v0.2.1
Get Autonity contract ABI
func (*API) GetContractAddress ¶ added in v0.2.1
Get Autonity contract address
func (*API) GetValidators ¶
GetValidators retrieves the list of authorized validators at the specified block.
func (*API) GetValidatorsAtHash ¶
GetValidatorsAtHash retrieves the state snapshot at a given block.
type Backend ¶
type Backend struct {
// contains filtered or unexported fields
}
func New ¶
func New(config *tendermintConfig.Config, privateKey *ecdsa.PrivateKey, db ethdb.Database, chainConfig *params.ChainConfig, vmConfig *vm.Config) *Backend
New creates an Ethereum Backend for BFT core engine.
func (*Backend) APIs ¶
func (sb *Backend) APIs(chain consensus.ChainReader) []rpc.API
APIs returns the RPC APIs this consensus engine provides.
func (*Backend) Author ¶
Author retrieves the Ethereum address of the account that minted the given block, which may be different from the header's coinbase if a consensus engine is based on signatures.
func (*Backend) CalcDifficulty ¶
func (sb *Backend) 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 blockchain and the current signer.
func (*Backend) CheckSignature ¶
CheckSignature implements tendermint.Backend.CheckSignature
func (*Backend) Finalize ¶
func (sb *Backend) Finalize(chain consensus.ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, uncles []*types.Header)
Finalize runs any post-transaction state modifications (e.g. block rewards) and assembles the final block.
Note, the block header and state database might be updated to reflect any consensus rules that happen at finalization (e.g. block rewards).
func (*Backend) FinalizeAndAssemble ¶ added in v0.2.1
func (*Backend) GetContractABI ¶ added in v0.3.0
func (*Backend) GetContractAddress ¶ added in v0.3.0
func (*Backend) GetPrivateKey ¶ added in v0.2.1
func (sb *Backend) GetPrivateKey() *ecdsa.PrivateKey
func (*Backend) GetProposer ¶
GetProposer implements tendermint.Backend.GetProposer
func (*Backend) HandleUnhandledMsgs ¶ added in v0.3.0
func (*Backend) LastCommittedProposal ¶
func (*Backend) NewChainHead ¶
func (*Backend) Prepare ¶
Prepare initializes the consensus fields of a block header according to the rules of a particular engine. The changes are executed inline.
func (*Backend) ResetPeerCache ¶ added in v0.2.1
func (*Backend) Seal ¶
func (sb *Backend) Seal(chain consensus.ChainReader, block *types.Block, results chan<- *types.Block, stop <-chan struct{}) error
Seal generates a new block for the given input block with the local miner's seal place on top.
func (*Backend) SetBroadcaster ¶
func (sb *Backend) SetBroadcaster(broadcaster consensus.Broadcaster)
SetBroadcaster implements consensus.Handler.SetBroadcaster
func (*Backend) SetPrivateKey ¶ added in v0.2.1
func (sb *Backend) SetPrivateKey(key *ecdsa.PrivateKey)
func (*Backend) SetProposedBlockHash ¶
func (*Backend) Start ¶
func (sb *Backend) Start(ctx context.Context, chain consensus.ChainReader, currentBlock func() *types.Block, hasBadBlock func(hash common.Hash) bool) error
Start implements consensus.tendermint.Start
func (*Backend) Subscribe ¶ added in v0.2.1
func (sb *Backend) Subscribe(types ...interface{}) *event.TypeMuxSubscription
func (*Backend) SyncPeer ¶ added in v0.2.1
func (sb *Backend) SyncPeer(address common.Address, messages []*tendermintCore.Message)
Synchronize new connected peer with current height state
func (*Backend) VerifyHeader ¶
VerifyHeader checks whether a header conforms to the consensus rules of a given engine. Verifying the seal may be done optionally here, or explicitly via the VerifySeal method.
func (*Backend) VerifyHeaders ¶
func (sb *Backend) 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 (the order is that of the input slice).
func (*Backend) VerifyProposal ¶
VerifyProposal implements tendermint.Backend.VerifyProposal
func (*Backend) VerifySeal ¶
VerifySeal checks whether the crypto seal on a header is valid according to the consensus rules of the given engine.
func (*Backend) VerifyUncles ¶
VerifyUncles verifies that the given block's uncles conform to the consensus rules of a given engine.
type UnhandledMsg ¶ added in v0.3.0
type UnhandledMsg struct {
// contains filtered or unexported fields
}