Documentation
¶
Overview ¶
Package consensus contains Neo consensus node implementation.
It uses external dBFT library for the core algorithm and basically joins this library with Neo node internals implemented in NeoGo.
Index ¶
- Constants
- type Config
- type Payload
- func (p *Payload) DecodeBinary(r *io.BinReader)
- func (p *Payload) EncodeBinary(w *io.BinWriter)
- func (p Payload) GetChangeView() payload.ChangeView
- func (p Payload) GetCommit() payload.Commit
- func (p Payload) GetPrepareRequest() payload.PrepareRequest
- func (p Payload) GetPrepareResponse() payload.PrepareResponse
- func (p Payload) GetRecoveryMessage() payload.RecoveryMessage
- func (p Payload) GetRecoveryRequest() payload.RecoveryRequest
- func (p *Payload) Hash() util.Uint256
- func (p Payload) Height() uint32
- func (p Payload) Payload() interface{}
- func (p *Payload) SetHeight(h uint32)
- func (p *Payload) SetPayload(pl interface{})
- func (p *Payload) SetType(t payload.MessageType)
- func (p *Payload) SetValidatorIndex(i uint16)
- func (p *Payload) SetViewNumber(view byte)
- func (p *Payload) Sign(key *privateKey) error
- func (p Payload) Type() payload.MessageType
- func (p Payload) ValidatorIndex() uint16
- func (p Payload) ViewNumber() byte
- type Service
Constants ¶
const Category = "dBFT"
Category is message category for extensible payloads.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct { // Logger is a logger instance. Logger *zap.Logger // Broadcast is a callback which is called to notify server // about new consensus payload to sent. Broadcast func(p *npayload.Extensible) // Chain is a core.Blockchainer instance. Chain blockchainer.Blockchainer // ProtocolConfiguration contains protocol settings. ProtocolConfiguration config.ProtocolConfiguration // RequestTx is a callback to which will be called // when a node lacks transactions present in a block. RequestTx func(h ...util.Uint256) // TimePerBlock minimal time that should pass before next block is accepted. TimePerBlock time.Duration // Wallet is a local-node wallet configuration. Wallet *config.Wallet }
Config is a configuration for consensus services.
type Payload ¶
type Payload struct { npayload.Extensible // contains filtered or unexported fields }
Payload is a type for consensus-related messages.
func NewPayload ¶ added in v0.90.0
NewPayload creates new consensus payload for the provided network.
func (*Payload) DecodeBinary ¶
DecodeBinary implements io.Serializable interface.
func (*Payload) EncodeBinary ¶
EncodeBinary implements io.Serializable interface.
func (Payload) GetChangeView ¶
func (p Payload) GetChangeView() payload.ChangeView
GetChangeView implements payload.ConsensusPayload interface.
func (Payload) GetPrepareRequest ¶
func (p Payload) GetPrepareRequest() payload.PrepareRequest
GetPrepareRequest implements payload.ConsensusPayload interface.
func (Payload) GetPrepareResponse ¶
func (p Payload) GetPrepareResponse() payload.PrepareResponse
GetPrepareResponse implements payload.ConsensusPayload interface.
func (Payload) GetRecoveryMessage ¶
func (p Payload) GetRecoveryMessage() payload.RecoveryMessage
GetRecoveryMessage implements payload.ConsensusPayload interface.
func (Payload) GetRecoveryRequest ¶
func (p Payload) GetRecoveryRequest() payload.RecoveryRequest
GetRecoveryRequest implements payload.ConsensusPayload interface.
func (Payload) Payload ¶
func (p Payload) Payload() interface{}
Payload implements payload.ConsensusPayload interface.
func (*Payload) SetPayload ¶
func (p *Payload) SetPayload(pl interface{})
SetPayload implements payload.ConsensusPayload interface.
func (*Payload) SetType ¶
func (p *Payload) SetType(t payload.MessageType)
SetType implements payload.ConsensusPayload interface.
func (*Payload) SetValidatorIndex ¶
SetValidatorIndex implements payload.ConsensusPayload interface.
func (*Payload) SetViewNumber ¶
SetViewNumber implements payload.ConsensusPayload interface.
func (*Payload) Sign ¶
Sign signs payload using the private key. It also sets corresponding verification and invocation scripts.
func (Payload) Type ¶
func (p Payload) Type() payload.MessageType
Type implements payload.ConsensusPayload interface.
func (Payload) ValidatorIndex ¶
ValidatorIndex implements payload.ConsensusPayload interface.
func (Payload) ViewNumber ¶
ViewNumber implements payload.ConsensusPayload interface.
type Service ¶
type Service interface { // Start initializes dBFT and starts event loop for consensus service. // It must be called only when sufficient amount of peers are connected. Start() // Shutdown stops dBFT event loop. Shutdown() // OnPayload is a callback to notify Service about new received payload. OnPayload(p *npayload.Extensible) // OnTransaction is a callback to notify Service about new received transaction. OnTransaction(tx *transaction.Transaction) }
Service represents consensus instance.
func NewService ¶
NewService returns new consensus.Service instance.