bor

package
v0.0.2-tenderly Latest Latest
Warning

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

 Go to latest Published: Mar 23, 2026 License: GPL-3.0, LGPL-3.0 Imports: 50 Imported by: 0

Documentation

Overview

Package bor is a generated GoMock package.

Package bor is a generated GoMock package.

Index

Constants

This section is empty.

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.

View Source 
var (
	// MaxCheckpointLength is the maximum number of blocks that can be requested for constructing a checkpoint root hash
	MaxCheckpointLength = uint64(math.Pow(2, 15))
)

Functions

func BorRLP 

func BorRLP(header *types.Header, c *params.BorConfig) []byte

BorRLP returns the rlp bytes which needs to be signed for the bor 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 CalcProducerDelay 

func CalcProducerDelay(number uint64, succession int, c *params.BorConfig) uint64

CalcProducerDelay is the block delay algorithm based on block time, period, producerDelay and turn-ness of a signer

func Difficulty 

func Difficulty(validatorSet *valset.ValidatorSet, signer common.Address) uint64

Difficulty returns the difficulty for a particular signer at the current snapshot number

func IsBlockEarly 

func IsBlockEarly(parent *types.Header, header *types.Header, number uint64, succession int, cfg *params.BorConfig) bool

IsBlockEarly returns true if the header time is earlier than expected (according to consensus rules). This can happen if the producer maliciously updates the header time.

func IsSprintStart 

func IsSprintStart(number, sprint uint64) bool

func SealHash 

func SealHash(header *types.Header, c *params.BorConfig) (hash common.Hash)

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

func Sign 

func Sign(signFn SignerFn, signer common.Address, header *types.Header, c *params.BorConfig) error

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) GetAuthor 

func (api *API) GetAuthor(blockNrOrHash *rpc.BlockNumberOrHash) (*common.Address, error)

GetAuthor retrieves the author a block.

func (*API) GetCurrentProposer 

func (api *API) GetCurrentProposer() (common.Address, error)

GetCurrentProposer gets the current proposer

func (*API) GetCurrentValidators 

func (api *API) GetCurrentValidators() ([]*valset.Validator, error)

GetCurrentValidators gets the current validators

func (*API) GetRootHash 

func (api *API) GetRootHash(start uint64, end uint64) (string, error)

GetRootHash returns the merkle root of the start-to-end blocks' headers

func (*API) GetSigners 

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

GetSigners retrieves the list of authorized signers at the specified block.

func (*API) GetSignersAtHash 

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

GetSignersAtHash retrieves the list of authorized signers at the specified block.

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) GetSnapshotProposer 

func (api *API) GetSnapshotProposer(blockNrOrHash *rpc.BlockNumberOrHash) (common.Address, error)

GetSnapshotProposer retrieves the in-turn signer at a given block.

func (*API) GetSnapshotProposerSequence 

func (api *API) GetSnapshotProposerSequence(blockNrOrHash *rpc.BlockNumberOrHash) (BlockSigners, error)

GetSnapshotProposerSequence retrieves the in-turn signers of all sprints in a span

type BlockSigners 

type BlockSigners struct {
	Signers []difficultiesKV
	Diff    int
	Author  common.Address
}

type BlockTooSoonError 

type BlockTooSoonError struct {
	Number     uint64
	Succession int
}

func (*BlockTooSoonError) Error 

func (e *BlockTooSoonError) Error() string

type Bor 

type Bor struct {
	GenesisContractsClient GenesisContract
	HeimdallClient         IHeimdallClient
	HeimdallWSClient       IHeimdallWSClient

	DevFakeAuthor bool
	// contains filtered or unexported fields
}

Bor is the matic-bor consensus engine

func New 

func New(
	chainConfig *params.ChainConfig,
	db ethdb.Database,
	ethAPI api.Caller,
	spanner Spanner,
	heimdallClient IHeimdallClient,
	heimdallWSClient IHeimdallWSClient,
	genesisContracts GenesisContract,
	devFakeAuthor bool,
	blockTime time.Duration,
) *Bor

New creates a Matic Bor consensus engine.

func (*Bor) APIs 

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

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

func (*Bor) Author 

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

func (c *Bor) Authorize(currentSigner common.Address, signFn SignerFn)

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

func (*Bor) CalcDifficulty 

func (c *Bor) CalcDifficulty(chain consensus.ChainHeaderReader, _ 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 (*Bor) Close 

func (c *Bor) Close() error

Close implements consensus.Engine.

func (*Bor) CommitStates 

func (c *Bor) CommitStates(
	state vm.StateDB,
	header *types.Header,
	chain statefull.ChainContext,
) ([]*types.StateSyncData, error)

CommitStates commit states

func (*Bor) FetchAndCommitSpan 

func (c *Bor) FetchAndCommitSpan(
	ctx context.Context,
	newSpanID uint64,
	state vm.StateDB,
	header *types.Header,
	chain core.ChainContext,
) error

func (*Bor) Finalize 

func (c *Bor) Finalize(chain consensus.ChainHeaderReader, header *types.Header, wrappedState vm.StateDB, body *types.Body, receipts []*types.Receipt) []*types.Receipt

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

func (*Bor) FinalizeAndAssemble 

func (c *Bor) FinalizeAndAssemble(chain consensus.ChainHeaderReader, header *types.Header, state *state.StateDB, body *types.Body, receipts []*types.Receipt) (*types.Block, []*types.Receipt, time.Duration, error)

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

func (*Bor) GetCurrentValidators 

func (c *Bor) GetCurrentValidators(ctx context.Context, headerHash common.Hash, blockNumber uint64) ([]*valset.Validator, error)

func (*Bor) GetSpanner 

func (c *Bor) GetSpanner() Spanner

func (*Bor) Prepare 

func (c *Bor) Prepare(chain consensus.ChainHeaderReader, header *types.Header, waitOnPrepare bool) error

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

func (*Bor) PurgeCache 

func (c *Bor) PurgeCache()

PurgeCache clears all cached snapshots and span data. This is useful in tests when the mock heimdall client is changed and old cached data needs to be invalidated.

func (*Bor) Seal 

func (c *Bor) Seal(chain consensus.ChainHeaderReader, block *types.Block, witness *stateless.Witness, results chan<- *consensus.NewSealedBlockEvent, stop <-chan struct{}) error

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

func (*Bor) SealHash 

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

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

func (*Bor) SetHeimdallClient 

func (c *Bor) SetHeimdallClient(h IHeimdallClient)

func (*Bor) SetSpanner 

func (c *Bor) SetSpanner(spanner Spanner)

func (*Bor) VerifyHeader 

func (c *Bor) VerifyHeader(chain consensus.ChainHeaderReader, header *types.Header) error

VerifyHeader checks whether a header conforms to the consensus rules.

func (*Bor) VerifyHeaders 

func (c *Bor) VerifyHeaders(chain consensus.ChainHeaderReader, headers []*types.Header) (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 (*Bor) VerifySeal 

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

func (c *Bor) VerifyUncles(_ 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 GenesisContract 

type GenesisContract interface {
	CommitState(event *clerk.EventRecordWithTime, state vm.StateDB, header *types.Header, chCtx statefull.ChainContext) (uint64, error)
	LastStateId(state *state.StateDB, number uint64, hash common.Hash) (*big.Int, error)
}

type IHeimdallClient 

type IHeimdallClient interface {
	StateSyncEvents(ctx context.Context, fromID uint64, to int64) ([]*clerk.EventRecordWithTime, error)
	GetSpan(ctx context.Context, spanID uint64) (*types.Span, error)
	GetLatestSpan(ctx context.Context) (*types.Span, error)
	FetchCheckpoint(ctx context.Context, number int64) (*checkpoint.Checkpoint, error)
	FetchCheckpointCount(ctx context.Context) (int64, error)
	FetchMilestone(ctx context.Context) (*milestone.Milestone, error)
	FetchMilestoneCount(ctx context.Context) (int64, error)
	FetchStatus(ctx context.Context) (*ctypes.SyncInfo, error)
	Close()
}

type IHeimdallWSClient 

type IHeimdallWSClient interface {
	SubscribeMilestoneEvents(ctx context.Context) <-chan *milestone.Milestone
	Unsubscribe(ctx context.Context) error
	Close() error
}

type InvalidStateReceivedError 

type InvalidStateReceivedError struct {
	Number      uint64
	LastStateID uint64
	To          *time.Time
	Event       *clerk.EventRecordWithTime
}

func (*InvalidStateReceivedError) Error 

func (e *InvalidStateReceivedError) Error() string

type MaxCheckpointLengthExceededError 

type MaxCheckpointLengthExceededError struct {
	Start uint64
	End   uint64
}

func (*MaxCheckpointLengthExceededError) Error 

func (e *MaxCheckpointLengthExceededError) Error() string

type MismatchingValidatorsError 

type MismatchingValidatorsError struct {
	Number             uint64
	ValidatorSetSnap   []byte
	ValidatorSetHeader []byte
}

MismatchingValidatorsError is returned if a last block in sprint contains a list of validators different from the one that local node calculated

func (*MismatchingValidatorsError) Error 

func (e *MismatchingValidatorsError) Error() string

type MockGenesisContract 

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

MockGenesisContract is a mock of GenesisContract interface.

func NewMockGenesisContract 

func NewMockGenesisContract(ctrl *gomock.Controller) *MockGenesisContract

NewMockGenesisContract creates a new mock instance.

func (*MockGenesisContract) CommitState 

func (m *MockGenesisContract) CommitState(arg0 *clerk.EventRecordWithTime, arg1 vm.StateDB, arg2 *types.Header, arg3 statefull.ChainContext) (uint64, error)

CommitState mocks base method.

func (*MockGenesisContract) EXPECT 

func (m *MockGenesisContract) EXPECT() *MockGenesisContractMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockGenesisContract) LastStateId 

func (m *MockGenesisContract) LastStateId(arg0 *state.StateDB, arg1 uint64, arg2 common.Hash) (*big.Int, error)

LastStateId mocks base method.

type MockGenesisContractMockRecorder 

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

MockGenesisContractMockRecorder is the mock recorder for MockGenesisContract.

func (*MockGenesisContractMockRecorder) CommitState 

func (mr *MockGenesisContractMockRecorder) CommitState(arg0, arg1, arg2, arg3 interface{}) *gomock.Call

CommitState indicates an expected call of CommitState.

func (*MockGenesisContractMockRecorder) LastStateId 

func (mr *MockGenesisContractMockRecorder) LastStateId(arg0, arg1, arg2 interface{}) *gomock.Call

LastStateId indicates an expected call of LastStateId.

type MockSpanner 

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

MockSpanner is a mock of Spanner interface.

func NewMockSpanner 

func NewMockSpanner(ctrl *gomock.Controller) *MockSpanner

NewMockSpanner creates a new mock instance.

func (*MockSpanner) CommitSpan 

func (m *MockSpanner) CommitSpan(arg0 context.Context, arg1 types.Span, arg2, arg3 []types0.MinimalVal, arg4 vm.StateDB, arg5 *types1.Header, arg6 core.ChainContext) error

CommitSpan mocks base method.

func (*MockSpanner) EXPECT 

func (m *MockSpanner) EXPECT() *MockSpannerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockSpanner) GetCurrentSpan 

func (m *MockSpanner) GetCurrentSpan(arg0 context.Context, arg1 common.Hash, arg2 *state.StateDB) (*types.Span, error)

GetCurrentSpan mocks base method.

func (*MockSpanner) GetCurrentValidatorsByBlockNrOrHash 

func (m *MockSpanner) GetCurrentValidatorsByBlockNrOrHash(arg0 context.Context, arg1 rpc.BlockNumberOrHash, arg2 uint64) ([]*valset.Validator, error)

GetCurrentValidatorsByBlockNrOrHash mocks base method.

func (*MockSpanner) GetCurrentValidatorsByHash 

func (m *MockSpanner) GetCurrentValidatorsByHash(arg0 context.Context, arg1 common.Hash, arg2 uint64) ([]*valset.Validator, error)

GetCurrentValidatorsByHash mocks base method.

type MockSpannerMockRecorder 

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

MockSpannerMockRecorder is the mock recorder for MockSpanner.

func (*MockSpannerMockRecorder) CommitSpan 

func (mr *MockSpannerMockRecorder) CommitSpan(arg0, arg1, arg2, arg3, arg4, arg5, arg6 interface{}) *gomock.Call

CommitSpan indicates an expected call of CommitSpan.

func (*MockSpannerMockRecorder) GetCurrentSpan 

func (mr *MockSpannerMockRecorder) GetCurrentSpan(arg0, arg1, arg2 interface{}) *gomock.Call

GetCurrentSpan indicates an expected call of GetCurrentSpan.

func (*MockSpannerMockRecorder) GetCurrentValidatorsByBlockNrOrHash 

func (mr *MockSpannerMockRecorder) GetCurrentValidatorsByBlockNrOrHash(arg0, arg1, arg2 interface{}) *gomock.Call

GetCurrentValidatorsByBlockNrOrHash indicates an expected call of GetCurrentValidatorsByBlockNrOrHash.

func (*MockSpannerMockRecorder) GetCurrentValidatorsByHash 

func (mr *MockSpannerMockRecorder) GetCurrentValidatorsByHash(arg0, arg1, arg2 interface{}) *gomock.Call

GetCurrentValidatorsByHash indicates an expected call of GetCurrentValidatorsByHash.

type SignerFn 

type SignerFn func(accounts.Account, string, []byte) ([]byte, error)

SignerFn is a signer callback function to request a header to be signed by a backing account.

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
	ValidatorSet *valset.ValidatorSet      `json:"validatorSet"` // Validator set 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.

func (*Snapshot) GetSignerSuccessionNumber 

func (s *Snapshot) GetSignerSuccessionNumber(signer common.Address) (int, error)

GetSignerSuccessionNumber returns the relative position of signer in terms of the in-turn proposer

type SpanStore 

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

SpanStore acts as a simple middleware to cache span data populated from heimdall. It is used in multiple places of bor consensus for verification.

func NewSpanStore 

func NewSpanStore(heimdallClient IHeimdallClient, spanner Spanner, chainId string) *SpanStore

func (*SpanStore) Close 

func (s *SpanStore) Close()

Close cancels the background routine and cleans up resources

func (*SpanStore) PurgeCache 

func (s *SpanStore) PurgeCache()

PurgeCache clears all cached spans and resets state. This is useful in tests when the mock heimdall client is changed and old cached data needs to be invalidated.

type Spanner 

type Spanner interface {
	GetCurrentSpan(ctx context.Context, headerHash common.Hash, state *state.StateDB) (*borTypes.Span, error)
	GetCurrentValidatorsByHash(ctx context.Context, headerHash common.Hash, blockNumber uint64) ([]*valset.Validator, error)
	GetCurrentValidatorsByBlockNrOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash, blockNumber uint64) ([]*valset.Validator, error)
	CommitSpan(ctx context.Context, minimalSpan borTypes.Span, validators, producers []stakeTypes.MinimalVal, state vm.StateDB, header *types.Header, chainContext core.ChainContext) error
}

type UnauthorizedProposerError 

type UnauthorizedProposerError struct {
	Number   uint64
	Proposer []byte
}

UnauthorizedProposerError is returned if a header is [being] signed by an unauthorized entity.

func (*UnauthorizedProposerError) Error 

func (e *UnauthorizedProposerError) Error() string

type UnauthorizedSignerError 

type UnauthorizedSignerError struct {
	Number         uint64
	Signer         []byte
	AllowedSigners []*valset.Validator
}

UnauthorizedSignerError is returned if a header is [being] signed by an unauthorized entity.

func (*UnauthorizedSignerError) Error 

func (e *UnauthorizedSignerError) Error() string

type WrongDifficultyError 

type WrongDifficultyError struct {
	Number   uint64
	Expected uint64
	Actual   uint64
	Signer   []byte
}

WrongDifficultyError is returned if the difficulty of a block doesn't match the turn of the signer.

func (*WrongDifficultyError) Error 

func (e *WrongDifficultyError) Error() string

Source Files

View all Source files

Directories

Path Synopsis
Package api is a generated GoMock package.
 Package api is a generated GoMock package.
Package api is a generated GoMock package.
 Package api is a generated GoMock package.
checkpoint
milestone
span

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.