Documentation
¶
Index ¶
- type ConsensusContext
- type Context
- type ContextInitializable
- type EventDispatcher
- type EventDispatcherTracker
- func (evd *EventDispatcherTracker) Accept(ctx *ConsensusContext, containerID ids.ID, container []byte) error
- func (evd *EventDispatcherTracker) IsAccepted(containerID ids.ID) (int, bool)
- func (evd *EventDispatcherTracker) IsIssued(containerID ids.ID) (int, bool)
- func (evd *EventDispatcherTracker) IsRejected(containerID ids.ID) (int, bool)
- func (evd *EventDispatcherTracker) Issue(ctx *ConsensusContext, containerID ids.ID, container []byte) error
- func (evd *EventDispatcherTracker) Reject(ctx *ConsensusContext, containerID ids.ID, container []byte) error
- type SubnetLookup
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConsensusContext ¶ added in v1.7.0
type ConsensusContext struct {
*Context
Registerer prometheus.Registerer
DecisionDispatcher EventDispatcher
ConsensusDispatcher EventDispatcher
// contains filtered or unexported fields
}
func DefaultConsensusContextTest ¶ added in v1.7.0
func DefaultConsensusContextTest() *ConsensusContext
func (*ConsensusContext) Bootstrapped ¶ added in v1.7.0
func (ctx *ConsensusContext) Bootstrapped()
Bootstrapped marks this chain as done bootstrapping
func (*ConsensusContext) Executing ¶ added in v1.7.0
func (ctx *ConsensusContext) Executing(b bool)
Executing marks this chain as executing or not. Set to "true" if there's an ongoing transaction.
func (*ConsensusContext) IsBootstrapped ¶ added in v1.7.0
func (ctx *ConsensusContext) IsBootstrapped() bool
IsBootstrapped returns true iff this chain is done bootstrapping
func (*ConsensusContext) IsExecuting ¶ added in v1.7.0
func (ctx *ConsensusContext) IsExecuting() bool
IsExecuting returns true iff this chain is still executing transactions.
func (*ConsensusContext) IsValidatorOnly ¶ added in v1.7.0
func (ctx *ConsensusContext) IsValidatorOnly() bool
IsValidatorOnly returns true iff this chain is available only to validators
func (*ConsensusContext) SetValidatorOnly ¶ added in v1.7.0
func (ctx *ConsensusContext) SetValidatorOnly()
SetValidatorOnly marks this chain as available only to validators
type Context ¶
type Context struct {
NetworkID uint32
SubnetID ids.ID
ChainID ids.ID
NodeID ids.ShortID
XChainID ids.ID
AVAXAssetID ids.ID
Log logging.Logger
Lock sync.RWMutex
Keystore keystore.BlockchainKeystore
BCLookup ids.AliaserReader
SNLookup SubnetLookup
Metrics metrics.OptionalGatherer
// snowman++ attributes
ValidatorState validators.State // interface for P-Chain validators
StakingLeafSigner crypto.Signer // block signer
StakingCertLeaf *x509.Certificate // block certificate
}
Context is information about the current execution. [NetworkID] is the ID of the network this context exists within. [ChainID] is the ID of the chain this context exists within. [NodeID] is the ID of this node
func DefaultContextTest ¶
func DefaultContextTest() *Context
type ContextInitializable ¶ added in v1.4.12
type ContextInitializable interface {
// InitCtx initializes an object provided a *Context object
InitCtx(ctx *Context)
}
ContextInitializable represents an object that can be initialized given a *Context object
type EventDispatcher ¶ added in v1.0.1
type EventDispatcher interface {
Issue(ctx *ConsensusContext, containerID ids.ID, container []byte) error
// If the returned error is non-nil, the chain associated with [ctx] should shut
// down and not commit [container] or any other container to its database as accepted.
// Accept must be called before [containerID] is committed to the VM as accepted.
Accept(ctx *ConsensusContext, containerID ids.ID, container []byte) error
Reject(ctx *ConsensusContext, containerID ids.ID, container []byte) error
}
type EventDispatcherTracker ¶ added in v1.7.0
type EventDispatcherTracker struct {
// contains filtered or unexported fields
}
EventDispatcherTracker tracks the dispatched events by its ID and counts. Useful for testing.
func NewEventDispatcherTracker ¶ added in v1.7.0
func NewEventDispatcherTracker() *EventDispatcherTracker
func (*EventDispatcherTracker) Accept ¶ added in v1.7.0
func (evd *EventDispatcherTracker) Accept(ctx *ConsensusContext, containerID ids.ID, container []byte) error
func (*EventDispatcherTracker) IsAccepted ¶ added in v1.7.0
func (evd *EventDispatcherTracker) IsAccepted(containerID ids.ID) (int, bool)
func (*EventDispatcherTracker) IsIssued ¶ added in v1.7.0
func (evd *EventDispatcherTracker) IsIssued(containerID ids.ID) (int, bool)
func (*EventDispatcherTracker) IsRejected ¶ added in v1.7.0
func (evd *EventDispatcherTracker) IsRejected(containerID ids.ID) (int, bool)
func (*EventDispatcherTracker) Issue ¶ added in v1.7.0
func (evd *EventDispatcherTracker) Issue(ctx *ConsensusContext, containerID ids.ID, container []byte) error
func (*EventDispatcherTracker) Reject ¶ added in v1.7.0
func (evd *EventDispatcherTracker) Reject(ctx *ConsensusContext, containerID ids.ID, container []byte) error
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
consensus
|
|
|
engine
|
|
|
avalanche/state
Package state manages the meta-data required by consensus for an avalanche dag.
|
Package state manages the meta-data required by consensus for an avalanche dag. |
|
networking
|
|
Click to show internal directories.
Click to hide internal directories.