types

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

type HeightVoteSetOption func(*HeightVoteSet)

type PeerRoundState struct {
	Height int64         `json:"height"` // Height peer is at
	Round  int32         `json:"round"`  // Round peer is at, -1 if unknown.
	Step   RoundStepType `json:"step"`   // Step peer is at

	// Estimated start of round 0 at this height
	StartTime time.Time `json:"start_time"`

	// True if peer has proposal for this round
	Proposal                   bool                `json:"proposal"`
	ProposalBlockPartSetHeader types.PartSetHeader `json:"proposal_block_part_set_header"`
	ProposalBlockParts         *bits.BitArray      `json:"proposal_block_parts"`
	// Proposal's POL round. -1 if none.
	ProposalPOLRound int32 `json:"proposal_pol_round"`

	// nil until ProposalPOLMessage received.
	ProposalPOL     *bits.BitArray `json:"proposal_pol"`
	Prevotes        *bits.BitArray `json:"prevotes"`          // All votes peer has for this round
	Precommits      *bits.BitArray `json:"precommits"`        // All precommits peer has for this round
	LastCommitRound int32          `json:"last_commit_round"` // Round of commit for last height. -1 if none.

	HasCommit bool `json:"has_commit"`

	// Round that we have commit for. Not necessarily unique. -1 if none.
	CatchupCommitRound int32 `json:"catchup_commit_round"`

	// All commit precommits peer has for this height & CatchupCommitRound
	CatchupCommit *bits.BitArray `json:"catchup_commit"`
}

type ProposalCreator interface {
	Create(ctx context.Context, height int64, round int32, rs *RoundState) error
}

type ProposalSetter interface {
	Set(ctx context.Context, proposal *types.Proposal, receivedAt time.Time, rs *RoundState) error
}

type Proposaler interface {
	ProposalCreator
	ProposalSetter
}

type RoundState struct {
	Height    int64         `json:"height"` // Height we are working on
	Round     int32         `json:"round"`
	Step      RoundStepType `json:"step"`
	StartTime time.Time     `json:"start_time"`

	// Subjective time when +2/3 precommits for Block at Round were found
	CommitTime          time.Time           `json:"commit_time"`
	Validators          *types.ValidatorSet `json:"validators"`
	ProposerSelector    selectproposer.ProposerSelector
	Proposal            *types.Proposal `json:"proposal"`
	ProposalReceiveTime time.Time       `json:"proposal_receive_time"`
	ProposalBlock       *types.Block    `json:"proposal_block"`
	ProposalBlockParts  *types.PartSet  `json:"proposal_block_parts"`
	LockedRound         int32           `json:"locked_round"`
	LockedBlock         *types.Block    `json:"locked_block"`
	LockedBlockParts    *types.PartSet  `json:"locked_block_parts"`
	Commit              *types.Commit   `json:"commit"`

	// Last known round with POL for non-nil valid block.
	ValidRound         int32        `json:"valid_round"`
	ValidBlock         *types.Block `json:"valid_block"`      // Last known block of POL mentioned above.
	ValidBlockRecvTime time.Time    `json:"valid_block_time"` // Receive time of last known block of POL mentioned above.

	// Last known block parts of POL mentioned above.
	ValidBlockParts           *types.PartSet      `json:"valid_block_parts"`
	Votes                     *HeightVoteSet      `json:"votes"`
	CommitRound               int32               `json:"commit_round"`
	LastCommit                *types.Commit       `json:"last_commit"`
	LastValidators            *types.ValidatorSet `json:"last_validators"`
	TriggeredTimeoutPrecommit bool                `json:"triggered_timeout_precommit"`

	sm.CurrentRoundState `json:"uncommitted_state"`
}

type RoundStateSimple struct {
	HeightRoundStep   string              `json:"height/round/step"`
	StartTime         time.Time           `json:"start_time"`
	ProposalBlockHash bytes.HexBytes      `json:"proposal_block_hash"`
	LockedBlockHash   bytes.HexBytes      `json:"locked_block_hash"`
	ValidBlockHash    bytes.HexBytes      `json:"valid_block_hash"`
	Votes             json.RawMessage     `json:"height_vote_set"`
	Proposer          types.ValidatorInfo `json:"proposer"`
}

type RoundStepType uint8 // These must be numeric, ordered.

type RoundVoteSet struct {
	Prevotes   *types.VoteSet
	Precommits *types.VoteSet
	Commit     *types.Commit
}