consensus

Documentation

Index

• func MaxNodesFaulty(n int) int
• func MinNodesFair(n int) int
• func MinNodesInQuorum(n int) int
• func New(chainCore chain.ChainCore, mempool mempool_pkg.Mempool, ...) chain.Consensus
• type BatchProposal
  • func BatchProposalFromBytes(data []byte) (*BatchProposal, error)
  • func BatchProposalFromMarshalUtil(mu *marshalutil.MarshalUtil) (*BatchProposal, error)
  • func (b *BatchProposal) Bytes() []byte
  • func (b *BatchProposal) EnsureTimestampConsistent(requests []isc.Request, stateTimestamp time.Time) error
• type ConsensusTimers
  • func NewConsensusTimers() ConsensusTimers

Functions

func MaxNodesFaulty

func MaxNodesFaulty(n int) int

MaxNodesFaulty calculates maximal number of nodes that can be assumed faulty F given a total number of nodes N.

func MinNodesFair

func MinNodesFair(n int) int

MinNodesFair returns a minimal number of nodes, that would include at least 1 fair node. It's F+1.

func MinNodesInQuorum

func MinNodesInQuorum(n int) int

MinNodesInQuorum returns a minimal number T of nodes required for a quorum. If N=3F+1 then T=2F+1, but if if N is arbitrary, then T=N-F.

func New

func New(
	chainCore chain.ChainCore,
	mempool mempool_pkg.Mempool,
	committee chain.Committee,
	peerGroup peering.GroupProvider,
	pullMissingRequestsFromCommittee bool,
	consensusMetrics metrics.ConsensusMetrics,
	dssNode dss_node.DSSNode,
	consensusJournal journal.ConsensusJournal,
	wal chain.WAL,
	publishTx func(chainID *isc.ChainID, tx *iotago.Transaction) error,
	timersOpt ...ConsensusTimers,
) chain.Consensus

Types

type BatchProposal

type BatchProposal struct {
	ValidatorIndex          uint16
	StateOutputID           *iotago.UTXOInput
	RequestIDs              []isc.RequestID
	RequestHashes           [][32]byte
	TimeData                time.Time
	ConsensusManaPledge     identity.ID
	AccessManaPledge        identity.ID
	FeeDestination          isc.AgentID
	SigShareOfStateOutputID tbls.SigShare
	DSSNonceIndexProposal   util.BitVector
}

func BatchProposalFromBytes

func BatchProposalFromBytes(data []byte) (*BatchProposal, error)

func BatchProposalFromMarshalUtil

func BatchProposalFromMarshalUtil(mu *marshalutil.MarshalUtil) (*BatchProposal, error)

func (*BatchProposal) Bytes

func (b *BatchProposal) Bytes() []byte

func (*BatchProposal) EnsureTimestampConsistent

func (b *BatchProposal) EnsureTimestampConsistent(requests []isc.Request, stateTimestamp time.Time) error

EnsureTimestampConsistent adjusts a batch timestamp, if it is not consistent with the requests in the BatchProposal and the previous transaction. The timestamp is consistent, if it is not bellow the timestamps of all the on-ledger requests and the previous transaction in the chain. This implement the "fixing" part described in IscBatchTimestamp.tla.

type ConsensusTimers

type ConsensusTimers struct {
	VMRunRetryToWaitForReadyRequests time.Duration
	BroadcastSignedResultRetry       time.Duration
	PostTxSequenceStep               time.Duration
	PullInclusionStateRetry          time.Duration
	ProposeBatchRetry                time.Duration
	ProposeBatchDelayForNewState     time.Duration
}

func NewConsensusTimers

func NewConsensusTimers() ConsensusTimers