tendermint: github.com/tendermint/tendermint/types Index | Files | Directories

package types

import "github.com/tendermint/tendermint/types"

Index

Package Files

block.go block_meta.go canonical.go encoding_helper.go event_bus.go events.go evidence.go genesis.go keys.go params.go part_set.go priv_validator.go proposal.go protobuf.go results.go signable.go signed_msg_type.go test_util.go tx.go validation.go validator.go validator_set.go vote.go vote_set.go wire.go

Constants

const (
    // MaxHeaderBytes is a maximum header size (including amino overhead).
    MaxHeaderBytes int64 = 653

    // MaxAminoOverheadForBlock - maximum amino overhead to encode a block (up to
    // MaxBlockSizeBytes in size) not including it's parts except Data.
    // This means it also excludes the overhead for individual transactions.
    // To compute individual transactions' overhead use types.ComputeAminoOverhead(tx types.Tx, fieldNum int).
    //
    // Uvarint length of MaxBlockSizeBytes: 4 bytes
    // 2 fields (2 embedded):               2 bytes
    // Uvarint length of Data.Txs:          4 bytes
    // Data.Txs field:                      1 byte
    MaxAminoOverheadForBlock int64 = 11
)
const (
    // Block level events for mass consumption by users.
    // These events are triggered from the state package,
    // after a block has been committed.
    // These are also used by the tx indexer for async indexing.
    // All of this data can be fetched through the rpc.
    EventNewBlock            = "NewBlock"
    EventNewBlockHeader      = "NewBlockHeader"
    EventTx                  = "Tx"
    EventValidatorSetUpdates = "ValidatorSetUpdates"

    // Internal consensus events.
    // These are used for testing the consensus state machine.
    // They can also be used to build real-time consensus visualizers.
    EventCompleteProposal = "CompleteProposal"
    EventLock             = "Lock"
    EventNewRound         = "NewRound"
    EventNewRoundStep     = "NewRoundStep"
    EventPolka            = "Polka"
    EventRelock           = "Relock"
    EventTimeoutPropose   = "TimeoutPropose"
    EventTimeoutWait      = "TimeoutWait"
    EventUnlock           = "Unlock"
    EventValidBlock       = "ValidBlock"
    EventVote             = "Vote"
)

Reserved event types (alphabetically sorted).

const (
    // EventTypeKey is a reserved key, used to specify event type in tags.
    EventTypeKey = "tm.event"
    // TxHashKey is a reserved key, used to specify transaction's hash.
    // see EventBus#PublishEventTx
    TxHashKey = "tx.hash"
    // TxHeightKey is a reserved key, used to specify transaction block's height.
    // see EventBus#PublishEventTx
    TxHeightKey = "tx.height"
)
const (
    // MaxBlockSizeBytes is the maximum permitted size of the blocks.
    MaxBlockSizeBytes = 104857600 // 100MB

    // BlockPartSizeBytes is the size of one block part.
    BlockPartSizeBytes = 65536 // 64kB
)
const (
    ABCIEvidenceTypeDuplicateVote = "duplicate/vote"
    ABCIEvidenceTypeMockGood      = "mock/good"
)
const (
    ABCIPubKeyTypeEd25519   = "ed25519"
    ABCIPubKeyTypeSecp256k1 = "secp256k1"
)
const (
    MaxTotalVotingPower      = int64(math.MaxInt64) / 8
    PriorityWindowSizeFactor = 2
)
const (
    // MaxChainIDLen is a maximum length of the chain ID.
    MaxChainIDLen = 50
)
const (
    // MaxEvidenceBytes is a maximum size of any evidence (including amino overhead).
    MaxEvidenceBytes int64 = 484
)
const (
    MaxEvidenceBytesDenominator = 10
)
const (
    // MaxVoteBytes is a maximum vote size (including amino overhead).
    MaxVoteBytes int64 = 223
)
const TimeFormat = time.RFC3339Nano

TimeFormat is used for generating the sigs

Variables

var (
    EventQueryCompleteProposal    = QueryForEvent(EventCompleteProposal)
    EventQueryLock                = QueryForEvent(EventLock)
    EventQueryNewBlock            = QueryForEvent(EventNewBlock)
    EventQueryNewBlockHeader      = QueryForEvent(EventNewBlockHeader)
    EventQueryNewRound            = QueryForEvent(EventNewRound)
    EventQueryNewRoundStep        = QueryForEvent(EventNewRoundStep)
    EventQueryPolka               = QueryForEvent(EventPolka)
    EventQueryRelock              = QueryForEvent(EventRelock)
    EventQueryTimeoutPropose      = QueryForEvent(EventTimeoutPropose)
    EventQueryTimeoutWait         = QueryForEvent(EventTimeoutWait)
    EventQueryTx                  = QueryForEvent(EventTx)
    EventQueryUnlock              = QueryForEvent(EventUnlock)
    EventQueryValidatorSetUpdates = QueryForEvent(EventValidatorSetUpdates)
    EventQueryValidBlock          = QueryForEvent(EventValidBlock)
    EventQueryVote                = QueryForEvent(EventVote)
)
var (
    ErrPartSetUnexpectedIndex = errors.New("Error part set unexpected index")
    ErrPartSetInvalidProof    = errors.New("Error part set invalid proof")
)
var (
    ErrInvalidBlockPartSignature = errors.New("Error invalid block part signature")
    ErrInvalidBlockPartHash      = errors.New("Error invalid block part hash")
)
var (
    ErrVoteUnexpectedStep            = errors.New("Unexpected step")
    ErrVoteInvalidValidatorIndex     = errors.New("Invalid validator index")
    ErrVoteInvalidValidatorAddress   = errors.New("Invalid validator address")
    ErrVoteInvalidSignature          = errors.New("Invalid signature")
    ErrVoteInvalidBlockHash          = errors.New("Invalid block hash")
    ErrVoteNonDeterministicSignature = errors.New("Non-deterministic signature")
    ErrVoteNil                       = errors.New("Nil vote")
)
var ABCIPubKeyTypesToAminoNames = map[string]string{
    ABCIPubKeyTypeEd25519:   ed25519.PubKeyAminoName,
    ABCIPubKeyTypeSecp256k1: secp256k1.PubKeyAminoName,
}

TODO: Make non-global by allowing for registration of more pubkey types

var ErroringMockPVErr = errors.New("erroringMockPV always returns an error")
var (
    // MaxSignatureSize is a maximum allowed signature size for the Proposal
    // and Vote.
    // XXX: secp256k1 does not have Size nor MaxSize defined.
    MaxSignatureSize = cmn.MaxInt(ed25519.SignatureSize, 64)
)
var PB2TM = pb2tm{}

PB2TM is used for converting protobuf ABCI to Tendermint ABCI. UNSTABLE

var (
    PeerStateKey = "ConsensusReactor.peerState"
)

UNSTABLE

var TM2PB = tm2pb{}

TM2PB is used for converting Tendermint ABCI to protobuf ABCI. UNSTABLE

func CanonicalTime Uses

func CanonicalTime(t time.Time) string

CanonicalTime can be used to stringify time in a canonical way.

func ComputeAminoOverhead Uses

func ComputeAminoOverhead(tx Tx, fieldNum int) int64

ComputeAminoOverhead calculates the overhead for amino encoding a transaction. The overhead consists of varint encoding the field number and the wire type (= length-delimited = 2), and another varint encoding the length of the transaction. The field number can be the field number of the particular transaction, or the field number of the parenting struct that contains the transactions []Tx as a field (this field number is repeated for each contained Tx). If some []Tx are encoded directly (without a parenting struct), the default fieldNum is also 1 (see BinFieldNum in amino.MarshalBinaryBare).

func EventQueryTxFor Uses

func EventQueryTxFor(tx Tx) tmpubsub.Query

func GetCodec Uses

func GetCodec() *amino.Codec

GetCodec returns a codec used by the package. For testing purposes only.

func IsErrTooMuchChange Uses

func IsErrTooMuchChange(err error) bool

func IsVoteTypeValid Uses

func IsVoteTypeValid(t SignedMsgType) bool

IsVoteTypeValid returns true if t is a valid vote type.

func MaxDataBytes Uses

func MaxDataBytes(maxBytes int64, valsCount, evidenceCount int) int64

MaxDataBytes returns the maximum size of block's data.

XXX: Panics on negative result.

func MaxDataBytesUnknownEvidence Uses

func MaxDataBytesUnknownEvidence(maxBytes int64, valsCount int) int64

MaxDataBytesUnknownEvidence returns the maximum size of block's data when evidence count is unknown. MaxEvidencePerBlock will be used for the size of evidence.

XXX: Panics on negative result.

func MaxEvidencePerBlock Uses

func MaxEvidencePerBlock(blockMaxBytes int64) (int64, int64)

MaxEvidencePerBlock returns the maximum number of evidences allowed in the block and their maximum total size (limitted to 1/10th of the maximum block size). TODO: change to a constant, or to a fraction of the validator set size. See https://github.com/tendermint/tendermint/issues/2590

func NewErroringMockPV Uses

func NewErroringMockPV() *erroringMockPV

NewErroringMockPV returns a MockPV that fails on each signing request. Again, for testing only.

func QueryForEvent Uses

func QueryForEvent(eventType string) tmpubsub.Query

func RandValidator Uses

func RandValidator(randPower bool, minPower int64) (*Validator, PrivValidator)

RandValidator returns a randomized validator, useful for testing. UNSTABLE

func RandValidatorSet Uses

func RandValidatorSet(numValidators int, votingPower int64) (*ValidatorSet, []PrivValidator)

RandValidatorSet returns a randomized validator set, useful for testing. NOTE: PrivValidator are in order. UNSTABLE

func RegisterBlockAmino Uses

func RegisterBlockAmino(cdc *amino.Codec)

func RegisterEventDatas Uses

func RegisterEventDatas(cdc *amino.Codec)

func RegisterEvidences Uses

func RegisterEvidences(cdc *amino.Codec)

func RegisterMockEvidences Uses

func RegisterMockEvidences(cdc *amino.Codec)

func RegisterMockEvidencesGlobal Uses

func RegisterMockEvidencesGlobal()

For testing purposes only

func ValidateHash Uses

func ValidateHash(h []byte) error

ValidateHash returns an error if the hash is not empty, but its size != tmhash.Size.

func ValidateTime Uses

func ValidateTime(t time.Time) error

ValidateTime does a basic time validation ensuring time does not drift too much: +/- one year. TODO: reduce this to eg 1 day NOTE: DO NOT USE in ValidateBasic methods in this package. This function can only be used for real time validation, like on proposals and votes in the consensus. If consensus is stuck, and rounds increase for more than a day, having only a 1-day band here could break things... Can't use for validating blocks because we may be syncing years worth of history.

func ValidatorListString Uses

func ValidatorListString(vals []*Validator) string

ValidatorListString returns a prettified validator list for logging purposes.

type ABCIResult Uses

type ABCIResult struct {
    Code uint32       `json:"code"`
    Data cmn.HexBytes `json:"data"`
}

ABCIResult is the deterministic component of a ResponseDeliverTx. TODO: add tags and other fields https://github.com/tendermint/tendermint/issues/1007

func NewResultFromResponse Uses

func NewResultFromResponse(response *abci.ResponseDeliverTx) ABCIResult

NewResultFromResponse creates ABCIResult from ResponseDeliverTx.

func (ABCIResult) Bytes Uses

func (a ABCIResult) Bytes() []byte

Bytes returns the amino encoded ABCIResult

type ABCIResults Uses

type ABCIResults []ABCIResult

ABCIResults wraps the deliver tx results to return a proof

func NewResults Uses

func NewResults(responses []*abci.ResponseDeliverTx) ABCIResults

NewResults creates ABCIResults from the list of ResponseDeliverTx.

func (ABCIResults) Bytes Uses

func (a ABCIResults) Bytes() []byte

Bytes serializes the ABCIResponse using wire

func (ABCIResults) Hash Uses

func (a ABCIResults) Hash() []byte

Hash returns a merkle hash of all results

func (ABCIResults) ProveResult Uses

func (a ABCIResults) ProveResult(i int) merkle.SimpleProof

ProveResult returns a merkle proof of one result from the set

type Address Uses

type Address = crypto.Address

Address is hex bytes.

type Block Uses

type Block struct {
    Header     `json:"header"`
    Data       `json:"data"`
    Evidence   EvidenceData `json:"evidence"`
    LastCommit *Commit      `json:"last_commit"`
    // contains filtered or unexported fields
}

Block defines the atomic unit of a Tendermint blockchain.

func MakeBlock Uses

func MakeBlock(height int64, txs []Tx, lastCommit *Commit, evidence []Evidence) *Block

MakeBlock returns a new block with an empty header, except what can be computed from itself. It populates the same set of fields validated by ValidateBasic.

func (*Block) Hash Uses

func (b *Block) Hash() cmn.HexBytes

Hash computes and returns the block hash. If the block is incomplete, block hash is nil for safety.

func (*Block) HashesTo Uses

func (b *Block) HashesTo(hash []byte) bool

HashesTo is a convenience function that checks if a block hashes to the given argument. Returns false if the block is nil or the hash is empty.

func (*Block) MakePartSet Uses

func (b *Block) MakePartSet(partSize int) *PartSet

MakePartSet returns a PartSet containing parts of a serialized block. This is the form in which the block is gossipped to peers. CONTRACT: partSize is greater than zero.

func (*Block) Marshal Uses

func (b *Block) Marshal() ([]byte, error)

Marshal returns the amino encoding.

func (*Block) MarshalTo Uses

func (b *Block) MarshalTo(data []byte) (int, error)

MarshalTo calls Marshal and copies to the given buffer.

func (*Block) Size Uses

func (b *Block) Size() int

Size returns size of the block in bytes.

func (*Block) String Uses

func (b *Block) String() string

String returns a string representation of the block

func (*Block) StringIndented Uses

func (b *Block) StringIndented(indent string) string

StringIndented returns a string representation of the block

func (*Block) StringShort Uses

func (b *Block) StringShort() string

StringShort returns a shortened string representation of the block

func (*Block) Unmarshal Uses

func (b *Block) Unmarshal(bs []byte) error

Unmarshal deserializes from amino encoded form.

func (*Block) ValidateBasic Uses

func (b *Block) ValidateBasic() error

ValidateBasic performs basic validation that doesn't involve state data. It checks the internal consistency of the block. Further validation is done using state#ValidateBlock.

type BlockEventPublisher Uses

type BlockEventPublisher interface {
    PublishEventNewBlock(block EventDataNewBlock) error
    PublishEventNewBlockHeader(header EventDataNewBlockHeader) error
    PublishEventTx(EventDataTx) error
    PublishEventValidatorSetUpdates(EventDataValidatorSetUpdates) error
}

BlockEventPublisher publishes all block related events

type BlockID Uses

type BlockID struct {
    Hash        cmn.HexBytes  `json:"hash"`
    PartsHeader PartSetHeader `json:"parts"`
}

BlockID defines the unique ID of a block as its Hash and its PartSetHeader

func (BlockID) Equals Uses

func (blockID BlockID) Equals(other BlockID) bool

Equals returns true if the BlockID matches the given BlockID

func (BlockID) IsComplete Uses

func (blockID BlockID) IsComplete() bool

IsComplete returns true if this is a valid BlockID of a non-nil block.

func (BlockID) IsZero Uses

func (blockID BlockID) IsZero() bool

IsZero returns true if this is the BlockID of a nil block.

func (BlockID) Key Uses

func (blockID BlockID) Key() string

Key returns a machine-readable string representation of the BlockID

func (BlockID) String Uses

func (blockID BlockID) String() string

String returns a human readable string representation of the BlockID

func (BlockID) ValidateBasic Uses

func (blockID BlockID) ValidateBasic() error

ValidateBasic performs basic validation.

type BlockMeta Uses

type BlockMeta struct {
    BlockID BlockID `json:"block_id"` // the block hash and partsethash
    Header  Header  `json:"header"`   // The block's Header
}

BlockMeta contains meta information about a block - namely, it's ID and Header.

func NewBlockMeta Uses

func NewBlockMeta(block *Block, blockParts *PartSet) *BlockMeta

NewBlockMeta returns a new BlockMeta from the block and its blockParts.

func (*BlockMeta) Marshal Uses

func (bm *BlockMeta) Marshal() ([]byte, error)

Marshal returns the amino encoding.

func (*BlockMeta) MarshalTo Uses

func (bm *BlockMeta) MarshalTo(data []byte) (int, error)

MarshalTo calls Marshal and copies to the given buffer.

func (*BlockMeta) Size Uses

func (bm *BlockMeta) Size() int

Size returns the size of the amino encoding, in bytes.

func (*BlockMeta) Unmarshal Uses

func (bm *BlockMeta) Unmarshal(bs []byte) error

Unmarshal deserializes from amino encoded form.

type BlockSizeParams Uses

type BlockSizeParams struct {
    MaxBytes int64 `json:"max_bytes"`
    MaxGas   int64 `json:"max_gas"`
}

BlockSizeParams define limits on the block size.

func DefaultBlockSizeParams Uses

func DefaultBlockSizeParams() BlockSizeParams

DefaultBlockSizeParams returns a default BlockSizeParams.

type CanonicalBlockID Uses

type CanonicalBlockID struct {
    Hash        cmn.HexBytes
    PartsHeader CanonicalPartSetHeader
}

func CanonicalizeBlockID Uses

func CanonicalizeBlockID(blockID BlockID) CanonicalBlockID

type CanonicalPartSetHeader Uses

type CanonicalPartSetHeader struct {
    Hash  cmn.HexBytes
    Total int
}

func CanonicalizePartSetHeader Uses

func CanonicalizePartSetHeader(psh PartSetHeader) CanonicalPartSetHeader

type CanonicalProposal Uses

type CanonicalProposal struct {
    Type      SignedMsgType // type alias for byte
    Height    int64         `binary:"fixed64"`
    Round     int64         `binary:"fixed64"`
    POLRound  int64         `binary:"fixed64"`
    BlockID   CanonicalBlockID
    Timestamp time.Time
    ChainID   string
}

func CanonicalizeProposal Uses

func CanonicalizeProposal(chainID string, proposal *Proposal) CanonicalProposal

type CanonicalVote Uses

type CanonicalVote struct {
    Type      SignedMsgType // type alias for byte
    Height    int64         `binary:"fixed64"`
    Round     int64         `binary:"fixed64"`
    BlockID   CanonicalBlockID
    Timestamp time.Time
    ChainID   string
}

func CanonicalizeVote Uses

func CanonicalizeVote(chainID string, vote *Vote) CanonicalVote

type Commit Uses

type Commit struct {
    // NOTE: The Precommits are in order of address to preserve the bonded ValidatorSet order.
    // Any peer with a block can gossip precommits by index with a peer without recalculating the
    // active ValidatorSet.
    BlockID    BlockID      `json:"block_id"`
    Precommits []*CommitSig `json:"precommits"`
    // contains filtered or unexported fields
}

Commit contains the evidence that a block was committed by a set of validators. NOTE: Commit is empty for height 1, but never nil.

func MakeCommit Uses

func MakeCommit(blockID BlockID, height int64, round int,
    voteSet *VoteSet,
    validators []PrivValidator) (*Commit, error)

func NewCommit Uses

func NewCommit(blockID BlockID, precommits []*CommitSig) *Commit

NewCommit returns a new Commit with the given blockID and precommits. TODO: memoize ValidatorSet in constructor so votes can be easily reconstructed from CommitSig after #1648.

func (*Commit) BitArray Uses

func (commit *Commit) BitArray() *cmn.BitArray

BitArray returns a BitArray of which validators voted in this commit

func (*Commit) GetByIndex Uses

func (commit *Commit) GetByIndex(index int) *Vote

GetByIndex returns the vote corresponding to a given validator index. Panics if `index >= commit.Size()`. Implements VoteSetReader.

func (*Commit) Hash Uses

func (commit *Commit) Hash() cmn.HexBytes

Hash returns the hash of the commit

func (*Commit) Height Uses

func (commit *Commit) Height() int64

Height returns the height of the commit

func (*Commit) IsCommit Uses

func (commit *Commit) IsCommit() bool

IsCommit returns true if there is at least one vote.

func (*Commit) Round Uses

func (commit *Commit) Round() int

Round returns the round of the commit

func (*Commit) Size Uses

func (commit *Commit) Size() int

Size returns the number of votes in the commit

func (*Commit) StringIndented Uses

func (commit *Commit) StringIndented(indent string) string

StringIndented returns a string representation of the commit

func (*Commit) ToVote Uses

func (commit *Commit) ToVote(cs *CommitSig) *Vote

ToVote converts a CommitSig to a Vote. If the CommitSig is nil, the Vote will be nil.

func (*Commit) Type Uses

func (commit *Commit) Type() byte

Type returns the vote type of the commit, which is always VoteTypePrecommit

func (*Commit) ValidateBasic Uses

func (commit *Commit) ValidateBasic() error

ValidateBasic performs basic validation that doesn't involve state data. Does not actually check the cryptographic signatures.

func (*Commit) VoteSignBytes Uses

func (commit *Commit) VoteSignBytes(chainID string, cs *CommitSig) []byte

VoteSignBytes constructs the SignBytes for the given CommitSig. The only unique part of the SignBytes is the Timestamp - all other fields signed over are otherwise the same for all validators.

type CommitSig Uses

type CommitSig Vote

CommitSig is a vote included in a Commit. For now, it is identical to a vote, but in the future it will contain fewer fields to eliminate the redundancy in commits. See https://github.com/tendermint/tendermint/issues/1648.

func (*CommitSig) String Uses

func (cs *CommitSig) String() string

String returns the underlying Vote.String()

type ConsensusParams Uses

type ConsensusParams struct {
    BlockSize BlockSizeParams `json:"block_size"`
    Evidence  EvidenceParams  `json:"evidence"`
    Validator ValidatorParams `json:"validator"`
}

ConsensusParams contains consensus critical parameters that determine the validity of blocks.

func DefaultConsensusParams Uses

func DefaultConsensusParams() *ConsensusParams

DefaultConsensusParams returns a default ConsensusParams.

func (*ConsensusParams) Equals Uses

func (params *ConsensusParams) Equals(params2 *ConsensusParams) bool

func (*ConsensusParams) Hash Uses

func (params *ConsensusParams) Hash() []byte

Hash returns a hash of a subset of the parameters to store in the block header. Only the Block.MaxBytes and Block.MaxGas are included in the hash. This allows the ConsensusParams to evolve more without breaking the block protocol. No need for a Merkle tree here, just a small struct to hash.

func (ConsensusParams) Update Uses

func (params ConsensusParams) Update(params2 *abci.ConsensusParams) ConsensusParams

Update returns a copy of the params with updates from the non-zero fields of p2. NOTE: note: must not modify the original

func (*ConsensusParams) Validate Uses

func (params *ConsensusParams) Validate() error

Validate validates the ConsensusParams to ensure all values are within their allowed limits, and returns an error if they are not.

type Data Uses

type Data struct {

    // Txs that will be applied by state @ block.Height+1.
    // NOTE: not all txs here are valid.  We're just agreeing on the order first.
    // This means that block.AppHash does not include these txs.
    Txs Txs `json:"txs"`
    // contains filtered or unexported fields
}

Data contains the set of transactions included in the block

func (*Data) Hash Uses

func (data *Data) Hash() cmn.HexBytes

Hash returns the hash of the data

func (*Data) StringIndented Uses

func (data *Data) StringIndented(indent string) string

StringIndented returns a string representation of the transactions

type DuplicateVoteEvidence Uses

type DuplicateVoteEvidence struct {
    PubKey crypto.PubKey
    VoteA  *Vote
    VoteB  *Vote
}

DuplicateVoteEvidence contains evidence a validator signed two conflicting votes.

func (*DuplicateVoteEvidence) Address Uses

func (dve *DuplicateVoteEvidence) Address() []byte

Address returns the address of the validator.

func (*DuplicateVoteEvidence) Bytes Uses

func (dve *DuplicateVoteEvidence) Bytes() []byte

Hash returns the hash of the evidence.

func (*DuplicateVoteEvidence) Equal Uses

func (dve *DuplicateVoteEvidence) Equal(ev Evidence) bool

Equal checks if two pieces of evidence are equal.

func (*DuplicateVoteEvidence) Hash Uses

func (dve *DuplicateVoteEvidence) Hash() []byte

Hash returns the hash of the evidence.

func (*DuplicateVoteEvidence) Height Uses

func (dve *DuplicateVoteEvidence) Height() int64

Height returns the height this evidence refers to.

func (*DuplicateVoteEvidence) String Uses

func (dve *DuplicateVoteEvidence) String() string

String returns a string representation of the evidence.

func (*DuplicateVoteEvidence) ValidateBasic Uses

func (dve *DuplicateVoteEvidence) ValidateBasic() error

ValidateBasic performs basic validation.

func (*DuplicateVoteEvidence) Verify Uses

func (dve *DuplicateVoteEvidence) Verify(chainID string, pubKey crypto.PubKey) error

Verify returns an error if the two votes aren't conflicting. To be conflicting, they must be from the same validator, for the same H/R/S, but for different blocks.

type ErrEvidenceInvalid Uses

type ErrEvidenceInvalid struct {
    Evidence   Evidence
    ErrorValue error
}

ErrEvidenceInvalid wraps a piece of evidence and the error denoting how or why it is invalid.

func NewErrEvidenceInvalid Uses

func NewErrEvidenceInvalid(ev Evidence, err error) *ErrEvidenceInvalid

NewErrEvidenceInvalid returns a new EvidenceInvalid with the given err.

func (*ErrEvidenceInvalid) Error Uses

func (err *ErrEvidenceInvalid) Error() string

Error returns a string representation of the error.

type ErrEvidenceOverflow Uses

type ErrEvidenceOverflow struct {
    MaxNum int64
    GotNum int64
}

ErrEvidenceOverflow is for when there is too much evidence in a block.

func NewErrEvidenceOverflow Uses

func NewErrEvidenceOverflow(max, got int64) *ErrEvidenceOverflow

NewErrEvidenceOverflow returns a new ErrEvidenceOverflow where got > max.

func (*ErrEvidenceOverflow) Error Uses

func (err *ErrEvidenceOverflow) Error() string

Error returns a string representation of the error.

type ErrVoteConflictingVotes Uses

type ErrVoteConflictingVotes struct {
    *DuplicateVoteEvidence
}

func NewConflictingVoteError Uses

func NewConflictingVoteError(val *Validator, voteA, voteB *Vote) *ErrVoteConflictingVotes

func (*ErrVoteConflictingVotes) Error Uses

func (err *ErrVoteConflictingVotes) Error() string

type EventBus Uses

type EventBus struct {
    cmn.BaseService
    // contains filtered or unexported fields
}

EventBus is a common bus for all events going through the system. All calls are proxied to underlying pubsub server. All events must be published using EventBus to ensure correct data types.

func NewEventBus Uses

func NewEventBus() *EventBus

NewEventBus returns a new event bus.

func NewEventBusWithBufferCapacity Uses

func NewEventBusWithBufferCapacity(cap int) *EventBus

NewEventBusWithBufferCapacity returns a new event bus with the given buffer capacity.

func (*EventBus) OnStart Uses

func (b *EventBus) OnStart() error

func (*EventBus) OnStop Uses

func (b *EventBus) OnStop()

func (*EventBus) Publish Uses

func (b *EventBus) Publish(eventType string, eventData TMEventData) error

func (*EventBus) PublishEventCompleteProposal Uses

func (b *EventBus) PublishEventCompleteProposal(data EventDataCompleteProposal) error

func (*EventBus) PublishEventLock Uses

func (b *EventBus) PublishEventLock(data EventDataRoundState) error

func (*EventBus) PublishEventNewBlock Uses

func (b *EventBus) PublishEventNewBlock(data EventDataNewBlock) error

func (*EventBus) PublishEventNewBlockHeader Uses

func (b *EventBus) PublishEventNewBlockHeader(data EventDataNewBlockHeader) error

func (*EventBus) PublishEventNewRound Uses

func (b *EventBus) PublishEventNewRound(data EventDataNewRound) error

func (*EventBus) PublishEventNewRoundStep Uses

func (b *EventBus) PublishEventNewRoundStep(data EventDataRoundState) error

func (*EventBus) PublishEventPolka Uses

func (b *EventBus) PublishEventPolka(data EventDataRoundState) error

func (*EventBus) PublishEventRelock Uses

func (b *EventBus) PublishEventRelock(data EventDataRoundState) error

func (*EventBus) PublishEventTimeoutPropose Uses

func (b *EventBus) PublishEventTimeoutPropose(data EventDataRoundState) error

func (*EventBus) PublishEventTimeoutWait Uses

func (b *EventBus) PublishEventTimeoutWait(data EventDataRoundState) error

func (*EventBus) PublishEventTx Uses

func (b *EventBus) PublishEventTx(data EventDataTx) error

PublishEventTx publishes tx event with tags from Result. Note it will add predefined tags (EventTypeKey, TxHashKey). Existing tags with the same names will be overwritten.

func (*EventBus) PublishEventUnlock Uses

func (b *EventBus) PublishEventUnlock(data EventDataRoundState) error

func (*EventBus) PublishEventValidBlock Uses

func (b *EventBus) PublishEventValidBlock(data EventDataRoundState) error

func (*EventBus) PublishEventValidatorSetUpdates Uses

func (b *EventBus) PublishEventValidatorSetUpdates(data EventDataValidatorSetUpdates) error

func (*EventBus) PublishEventVote Uses

func (b *EventBus) PublishEventVote(data EventDataVote) error

func (*EventBus) SetLogger Uses

func (b *EventBus) SetLogger(l log.Logger)

func (*EventBus) Subscribe Uses

func (b *EventBus) Subscribe(ctx context.Context, subscriber string, query tmpubsub.Query, out chan<- interface{}) error

func (*EventBus) Unsubscribe Uses

func (b *EventBus) Unsubscribe(ctx context.Context, subscriber string, query tmpubsub.Query) error

func (*EventBus) UnsubscribeAll Uses

func (b *EventBus) UnsubscribeAll(ctx context.Context, subscriber string) error

type EventBusSubscriber Uses

type EventBusSubscriber interface {
    Subscribe(ctx context.Context, subscriber string, query tmpubsub.Query, out chan<- interface{}) error
    Unsubscribe(ctx context.Context, subscriber string, query tmpubsub.Query) error
    UnsubscribeAll(ctx context.Context, subscriber string) error
}

type EventDataCompleteProposal Uses

type EventDataCompleteProposal struct {
    Height int64  `json:"height"`
    Round  int    `json:"round"`
    Step   string `json:"step"`

    BlockID BlockID `json:"block_id"`
}

type EventDataNewBlock Uses

type EventDataNewBlock struct {
    Block *Block `json:"block"`

    ResultBeginBlock abci.ResponseBeginBlock `json:"result_begin_block"`
    ResultEndBlock   abci.ResponseEndBlock   `json:"result_end_block"`
}

type EventDataNewBlockHeader Uses

type EventDataNewBlockHeader struct {
    Header Header `json:"header"`

    ResultBeginBlock abci.ResponseBeginBlock `json:"result_begin_block"`
    ResultEndBlock   abci.ResponseEndBlock   `json:"result_end_block"`
}

light weight event for benchmarking

type EventDataNewRound Uses

type EventDataNewRound struct {
    Height int64  `json:"height"`
    Round  int    `json:"round"`
    Step   string `json:"step"`

    Proposer ValidatorInfo `json:"proposer"`
}

type EventDataRoundState Uses

type EventDataRoundState struct {
    Height int64  `json:"height"`
    Round  int    `json:"round"`
    Step   string `json:"step"`

    // private, not exposed to websockets
    RoundState interface{} `json:"-"`
}

NOTE: This goes into the replay WAL

type EventDataString Uses

type EventDataString string

type EventDataTx Uses

type EventDataTx struct {
    TxResult
}

All txs fire EventDataTx

type EventDataValidatorSetUpdates Uses

type EventDataValidatorSetUpdates struct {
    ValidatorUpdates []*Validator `json:"validator_updates"`
}

type EventDataVote Uses

type EventDataVote struct {
    Vote *Vote
}

type Evidence Uses

type Evidence interface {
    Height() int64                                     // height of the equivocation
    Address() []byte                                   // address of the equivocating validator
    Bytes() []byte                                     // bytes which compromise the evidence
    Hash() []byte                                      // hash of the evidence
    Verify(chainID string, pubKey crypto.PubKey) error // verify the evidence
    Equal(Evidence) bool                               // check equality of evidence

    ValidateBasic() error
    String() string
}

Evidence represents any provable malicious activity by a validator

type EvidenceData Uses

type EvidenceData struct {
    Evidence EvidenceList `json:"evidence"`
    // contains filtered or unexported fields
}

EvidenceData contains any evidence of malicious wrong-doing by validators

func (*EvidenceData) Hash Uses

func (data *EvidenceData) Hash() cmn.HexBytes

Hash returns the hash of the data.

func (*EvidenceData) StringIndented Uses

func (data *EvidenceData) StringIndented(indent string) string

StringIndented returns a string representation of the evidence.

type EvidenceList Uses

type EvidenceList []Evidence

EvidenceList is a list of Evidence. Evidences is not a word.

func (EvidenceList) Has Uses

func (evl EvidenceList) Has(evidence Evidence) bool

Has returns true if the evidence is in the EvidenceList.

func (EvidenceList) Hash Uses

func (evl EvidenceList) Hash() []byte

Hash returns the simple merkle root hash of the EvidenceList.

func (EvidenceList) String Uses

func (evl EvidenceList) String() string

type EvidenceParams Uses

type EvidenceParams struct {
    MaxAge int64 `json:"max_age"` // only accept new evidence more recent than this
}

EvidenceParams determine how we handle evidence of malfeasance

func DefaultEvidenceParams Uses

func DefaultEvidenceParams() EvidenceParams

DefaultEvidenceParams Params returns a default EvidenceParams.

type GenesisDoc Uses

type GenesisDoc struct {
    GenesisTime     time.Time          `json:"genesis_time"`
    ChainID         string             `json:"chain_id"`
    ConsensusParams *ConsensusParams   `json:"consensus_params,omitempty"`
    Validators      []GenesisValidator `json:"validators,omitempty"`
    AppHash         cmn.HexBytes       `json:"app_hash"`
    AppState        json.RawMessage    `json:"app_state,omitempty"`
}

GenesisDoc defines the initial conditions for a tendermint blockchain, in particular its validator set.

func GenesisDocFromFile Uses

func GenesisDocFromFile(genDocFile string) (*GenesisDoc, error)

GenesisDocFromFile reads JSON data from a file and unmarshalls it into a GenesisDoc.

func GenesisDocFromJSON Uses

func GenesisDocFromJSON(jsonBlob []byte) (*GenesisDoc, error)

GenesisDocFromJSON unmarshalls JSON data into a GenesisDoc.

func (*GenesisDoc) SaveAs Uses

func (genDoc *GenesisDoc) SaveAs(file string) error

SaveAs is a utility method for saving GenensisDoc as a JSON file.

func (*GenesisDoc) ValidateAndComplete Uses

func (genDoc *GenesisDoc) ValidateAndComplete() error

ValidateAndComplete checks that all necessary fields are present and fills in defaults for optional fields left empty

func (*GenesisDoc) ValidatorHash Uses

func (genDoc *GenesisDoc) ValidatorHash() []byte

ValidatorHash returns the hash of the validator set contained in the GenesisDoc

type GenesisValidator Uses

type GenesisValidator struct {
    Address Address       `json:"address"`
    PubKey  crypto.PubKey `json:"pub_key"`
    Power   int64         `json:"power"`
    Name    string        `json:"name"`
}

GenesisValidator is an initial validator.

type HashedParams Uses

type HashedParams struct {
    BlockMaxBytes int64
    BlockMaxGas   int64
}

HashedParams is a subset of ConsensusParams. It is amino encoded and hashed into the Header.ConsensusHash.

type Header struct {
    // basic block info
    Version  version.Consensus `json:"version"`
    ChainID  string            `json:"chain_id"`
    Height   int64             `json:"height"`
    Time     time.Time         `json:"time"`
    NumTxs   int64             `json:"num_txs"`
    TotalTxs int64             `json:"total_txs"`

    // prev block info
    LastBlockID BlockID `json:"last_block_id"`

    // hashes of block data
    LastCommitHash cmn.HexBytes `json:"last_commit_hash"` // commit from validators from the last block
    DataHash       cmn.HexBytes `json:"data_hash"`        // transactions

    // hashes from the app output from the prev block
    ValidatorsHash     cmn.HexBytes `json:"validators_hash"`      // validators for the current block
    NextValidatorsHash cmn.HexBytes `json:"next_validators_hash"` // validators for the next block
    ConsensusHash      cmn.HexBytes `json:"consensus_hash"`       // consensus params for current block
    AppHash            cmn.HexBytes `json:"app_hash"`             // state after txs from the previous block
    LastResultsHash    cmn.HexBytes `json:"last_results_hash"`    // root hash of all results from the txs from the previous block

    // consensus info
    EvidenceHash    cmn.HexBytes `json:"evidence_hash"`    // evidence included in the block
    ProposerAddress Address      `json:"proposer_address"` // original proposer of the block
}

Header defines the structure of a Tendermint block header. NOTE: changes to the Header should be duplicated in: - header.Hash() - abci.Header - /docs/spec/blockchain/blockchain.md

func (*Header) Hash Uses

func (h *Header) Hash() cmn.HexBytes

Hash returns the hash of the header. It computes a Merkle tree from the header fields ordered as they appear in the Header. Returns nil if ValidatorHash is missing, since a Header is not valid unless there is a ValidatorsHash (corresponding to the validator set).

func (*Header) Populate Uses

func (h *Header) Populate(
    version version.Consensus, chainID string,
    timestamp time.Time, lastBlockID BlockID, totalTxs int64,
    valHash, nextValHash []byte,
    consensusHash, appHash, lastResultsHash []byte,
    proposerAddress Address,
)

Populate the Header with state-derived data. Call this after MakeBlock to complete the Header.

func (*Header) StringIndented Uses

func (h *Header) StringIndented(indent string) string

StringIndented returns a string representation of the header

type MockBadEvidence Uses

type MockBadEvidence struct {
    MockGoodEvidence
}

UNSTABLE

func (MockBadEvidence) Equal Uses

func (e MockBadEvidence) Equal(ev Evidence) bool

func (MockBadEvidence) String Uses

func (e MockBadEvidence) String() string

func (MockBadEvidence) ValidateBasic Uses

func (e MockBadEvidence) ValidateBasic() error

func (MockBadEvidence) Verify Uses

func (e MockBadEvidence) Verify(chainID string, pubKey crypto.PubKey) error

type MockGoodEvidence Uses

type MockGoodEvidence struct {
    Height_  int64
    Address_ []byte
}

UNSTABLE

func NewMockGoodEvidence Uses

func NewMockGoodEvidence(height int64, idx int, address []byte) MockGoodEvidence

UNSTABLE

func (MockGoodEvidence) Address Uses

func (e MockGoodEvidence) Address() []byte

func (MockGoodEvidence) Bytes Uses

func (e MockGoodEvidence) Bytes() []byte

func (MockGoodEvidence) Equal Uses

func (e MockGoodEvidence) Equal(ev Evidence) bool

func (MockGoodEvidence) Hash Uses

func (e MockGoodEvidence) Hash() []byte

func (MockGoodEvidence) Height Uses

func (e MockGoodEvidence) Height() int64

func (MockGoodEvidence) String Uses

func (e MockGoodEvidence) String() string

func (MockGoodEvidence) ValidateBasic Uses

func (e MockGoodEvidence) ValidateBasic() error

func (MockGoodEvidence) Verify Uses

func (e MockGoodEvidence) Verify(chainID string, pubKey crypto.PubKey) error

type MockPV Uses

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

MockPV implements PrivValidator without any safety or persistence. Only use it for testing.

func NewMockPV Uses

func NewMockPV() *MockPV

func NewMockPVWithParams Uses

func NewMockPVWithParams(privKey crypto.PrivKey, breakProposalSigning, breakVoteSigning bool) *MockPV

NewMockPVWithParams allows one to create a MockPV instance, but with finer grained control over the operation of the mock validator. This is useful for mocking test failures.

func (*MockPV) DisableChecks Uses

func (pv *MockPV) DisableChecks()

XXX: Implement.

func (*MockPV) GetPubKey Uses

func (pv *MockPV) GetPubKey() crypto.PubKey

Implements PrivValidator.

func (*MockPV) SignProposal Uses

func (pv *MockPV) SignProposal(chainID string, proposal *Proposal) error

Implements PrivValidator.

func (*MockPV) SignVote Uses

func (pv *MockPV) SignVote(chainID string, vote *Vote) error

Implements PrivValidator.

func (*MockPV) String Uses

func (pv *MockPV) String() string

String returns a string representation of the MockPV.

type MockRandomGoodEvidence Uses

type MockRandomGoodEvidence struct {
    MockGoodEvidence
    // contains filtered or unexported fields
}

UNSTABLE

func NewMockRandomGoodEvidence Uses

func NewMockRandomGoodEvidence(height int64, address []byte, randBytes []byte) MockRandomGoodEvidence

UNSTABLE

func (MockRandomGoodEvidence) Hash Uses

func (e MockRandomGoodEvidence) Hash() []byte

type NopEventBus Uses

type NopEventBus struct{}

-----------------------------------------------------------------------------

func (NopEventBus) PublishEventCompleteProposal Uses

func (NopEventBus) PublishEventCompleteProposal(data EventDataRoundState) error

func (NopEventBus) PublishEventLock Uses

func (NopEventBus) PublishEventLock(data EventDataRoundState) error

func (NopEventBus) PublishEventNewBlock Uses

func (NopEventBus) PublishEventNewBlock(data EventDataNewBlock) error

func (NopEventBus) PublishEventNewBlockHeader Uses

func (NopEventBus) PublishEventNewBlockHeader(data EventDataNewBlockHeader) error

func (NopEventBus) PublishEventNewRound Uses

func (NopEventBus) PublishEventNewRound(data EventDataRoundState) error

func (NopEventBus) PublishEventNewRoundStep Uses

func (NopEventBus) PublishEventNewRoundStep(data EventDataRoundState) error

func (NopEventBus) PublishEventPolka Uses

func (NopEventBus) PublishEventPolka(data EventDataRoundState) error

func (NopEventBus) PublishEventRelock Uses

func (NopEventBus) PublishEventRelock(data EventDataRoundState) error

func (NopEventBus) PublishEventTimeoutPropose Uses

func (NopEventBus) PublishEventTimeoutPropose(data EventDataRoundState) error

func (NopEventBus) PublishEventTimeoutWait Uses

func (NopEventBus) PublishEventTimeoutWait(data EventDataRoundState) error

func (NopEventBus) PublishEventTx Uses

func (NopEventBus) PublishEventTx(data EventDataTx) error

func (NopEventBus) PublishEventUnlock Uses

func (NopEventBus) PublishEventUnlock(data EventDataRoundState) error

func (NopEventBus) PublishEventValidatorSetUpdates Uses

func (NopEventBus) PublishEventValidatorSetUpdates(data EventDataValidatorSetUpdates) error

func (NopEventBus) PublishEventVote Uses

func (NopEventBus) PublishEventVote(data EventDataVote) error

func (NopEventBus) Subscribe Uses

func (NopEventBus) Subscribe(ctx context.Context, subscriber string, query tmpubsub.Query, out chan<- interface{}) error

func (NopEventBus) Unsubscribe Uses

func (NopEventBus) Unsubscribe(ctx context.Context, subscriber string, query tmpubsub.Query) error

func (NopEventBus) UnsubscribeAll Uses

func (NopEventBus) UnsubscribeAll(ctx context.Context, subscriber string) error

type P2PID Uses

type P2PID string

UNSTABLE XXX: duplicate of p2p.ID to avoid dependence between packages. Perhaps we can have a minimal types package containing this (and other things?) that both `types` and `p2p` import ?

type Part Uses

type Part struct {
    Index int                `json:"index"`
    Bytes cmn.HexBytes       `json:"bytes"`
    Proof merkle.SimpleProof `json:"proof"`
}

func (*Part) String Uses

func (part *Part) String() string

func (*Part) StringIndented Uses

func (part *Part) StringIndented(indent string) string

func (*Part) ValidateBasic Uses

func (part *Part) ValidateBasic() error

ValidateBasic performs basic validation.

type PartSet Uses

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

func NewPartSetFromData Uses

func NewPartSetFromData(data []byte, partSize int) *PartSet

Returns an immutable, full PartSet from the data bytes. The data bytes are split into "partSize" chunks, and merkle tree computed.

func NewPartSetFromHeader Uses

func NewPartSetFromHeader(header PartSetHeader) *PartSet

Returns an empty PartSet ready to be populated.

func (*PartSet) AddPart Uses

func (ps *PartSet) AddPart(part *Part) (bool, error)

func (*PartSet) BitArray Uses

func (ps *PartSet) BitArray() *cmn.BitArray

func (*PartSet) Count Uses

func (ps *PartSet) Count() int

func (*PartSet) GetPart Uses

func (ps *PartSet) GetPart(index int) *Part

func (*PartSet) GetReader Uses

func (ps *PartSet) GetReader() io.Reader

func (*PartSet) HasHeader Uses

func (ps *PartSet) HasHeader(header PartSetHeader) bool

func (*PartSet) Hash Uses

func (ps *PartSet) Hash() []byte

func (*PartSet) HashesTo Uses

func (ps *PartSet) HashesTo(hash []byte) bool

func (*PartSet) Header Uses

func (ps *PartSet) Header() PartSetHeader

func (*PartSet) IsComplete Uses

func (ps *PartSet) IsComplete() bool

func (*PartSet) MarshalJSON Uses

func (ps *PartSet) MarshalJSON() ([]byte, error)

func (*PartSet) StringShort Uses

func (ps *PartSet) StringShort() string

func (*PartSet) Total Uses

func (ps *PartSet) Total() int

type PartSetHeader Uses

type PartSetHeader struct {
    Total int          `json:"total"`
    Hash  cmn.HexBytes `json:"hash"`
}

func (PartSetHeader) Equals Uses

func (psh PartSetHeader) Equals(other PartSetHeader) bool

func (PartSetHeader) IsZero Uses

func (psh PartSetHeader) IsZero() bool

func (PartSetHeader) String Uses

func (psh PartSetHeader) String() string

func (PartSetHeader) ValidateBasic Uses

func (psh PartSetHeader) ValidateBasic() error

ValidateBasic performs basic validation.

type PartSetReader Uses

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

func NewPartSetReader Uses

func NewPartSetReader(parts []*Part) *PartSetReader

func (*PartSetReader) Read Uses

func (psr *PartSetReader) Read(p []byte) (n int, err error)

type PrivValidator Uses

type PrivValidator interface {
    GetPubKey() crypto.PubKey

    SignVote(chainID string, vote *Vote) error
    SignProposal(chainID string, proposal *Proposal) error
}

PrivValidator defines the functionality of a local Tendermint validator that signs votes and proposals, and never double signs.

type PrivValidatorsByAddress Uses

type PrivValidatorsByAddress []PrivValidator

func (PrivValidatorsByAddress) Len Uses

func (pvs PrivValidatorsByAddress) Len() int

func (PrivValidatorsByAddress) Less Uses

func (pvs PrivValidatorsByAddress) Less(i, j int) bool

func (PrivValidatorsByAddress) Swap Uses

func (pvs PrivValidatorsByAddress) Swap(i, j int)

type Proposal Uses

type Proposal struct {
    Type      SignedMsgType
    Height    int64     `json:"height"`
    Round     int       `json:"round"`
    POLRound  int       `json:"pol_round"` // -1 if null.
    BlockID   BlockID   `json:"block_id"`
    Timestamp time.Time `json:"timestamp"`
    Signature []byte    `json:"signature"`
}

Proposal defines a block proposal for the consensus. It refers to the block by BlockID field. It must be signed by the correct proposer for the given Height/Round to be considered valid. It may depend on votes from a previous round, a so-called Proof-of-Lock (POL) round, as noted in the POLRound. If POLRound >= 0, then BlockID corresponds to the block that is locked in POLRound.

func NewProposal Uses

func NewProposal(height int64, round int, polRound int, blockID BlockID) *Proposal

NewProposal returns a new Proposal. If there is no POLRound, polRound should be -1.

func (*Proposal) SignBytes Uses

func (p *Proposal) SignBytes(chainID string) []byte

SignBytes returns the Proposal bytes for signing

func (*Proposal) String Uses

func (p *Proposal) String() string

String returns a string representation of the Proposal.

func (*Proposal) ValidateBasic Uses

func (p *Proposal) ValidateBasic() error

ValidateBasic performs basic validation.

type Signable Uses

type Signable interface {
    SignBytes(chainID string) []byte
}

Signable is an interface for all signable things. It typically removes signatures before serializing. SignBytes returns the bytes to be signed NOTE: chainIDs are part of the SignBytes but not necessarily the object themselves. NOTE: Expected to panic if there is an error marshalling.

type SignedHeader Uses

type SignedHeader struct {
    *Header `json:"header"`
    Commit  *Commit `json:"commit"`
}

SignedHeader is a header along with the commits that prove it. It is the basis of the lite client.

func (SignedHeader) String Uses

func (sh SignedHeader) String() string

func (SignedHeader) StringIndented Uses

func (sh SignedHeader) StringIndented(indent string) string

StringIndented returns a string representation of the SignedHeader.

func (SignedHeader) ValidateBasic Uses

func (sh SignedHeader) ValidateBasic(chainID string) error

ValidateBasic does basic consistency checks and makes sure the header and commit are consistent.

NOTE: This does not actually check the cryptographic signatures. Make sure to use a Verifier to validate the signatures actually provide a significantly strong proof for this header's validity.

type SignedMsgType Uses

type SignedMsgType byte

SignedMsgType is a type of signed message in the consensus.

const (
    // Votes
    PrevoteType   SignedMsgType = 0x01
    PrecommitType SignedMsgType = 0x02

    // Proposals
    ProposalType SignedMsgType = 0x20
)

type TMEventData Uses

type TMEventData interface {
}

TMEventData implements events.EventData.

type Tx Uses

type Tx []byte

Tx is an arbitrary byte array. NOTE: Tx has no types at this level, so when wire encoded it's just length-prefixed. Might we want types here ?

func (Tx) Hash Uses

func (tx Tx) Hash() []byte

Hash computes the TMHASH hash of the wire encoded transaction.

func (Tx) String Uses

func (tx Tx) String() string

String returns the hex-encoded transaction as a string.

type TxEventPublisher Uses

type TxEventPublisher interface {
    PublishEventTx(EventDataTx) error
}

type TxProof Uses

type TxProof struct {
    RootHash cmn.HexBytes
    Data     Tx
    Proof    merkle.SimpleProof
}

TxProof represents a Merkle proof of the presence of a transaction in the Merkle tree.

func (TxProof) Leaf Uses

func (tp TxProof) Leaf() []byte

Leaf returns the hash(tx), which is the leaf in the merkle tree which this proof refers to.

func (TxProof) Validate Uses

func (tp TxProof) Validate(dataHash []byte) error

Validate verifies the proof. It returns nil if the RootHash matches the dataHash argument, and if the proof is internally consistent. Otherwise, it returns a sensible error.

type TxResult Uses

type TxResult struct {
    Height int64                  `json:"height"`
    Index  uint32                 `json:"index"`
    Tx     Tx                     `json:"tx"`
    Result abci.ResponseDeliverTx `json:"result"`
}

TxResult contains results of executing the transaction.

One usage is indexing transaction results.

type Txs Uses

type Txs []Tx

Txs is a slice of Tx.

func (Txs) Hash Uses

func (txs Txs) Hash() []byte

Hash returns the Merkle root hash of the transaction hashes. i.e. the leaves of the tree are the hashes of the txs.

func (Txs) Index Uses

func (txs Txs) Index(tx Tx) int

Index returns the index of this transaction in the list, or -1 if not found

func (Txs) IndexByHash Uses

func (txs Txs) IndexByHash(hash []byte) int

IndexByHash returns the index of this transaction hash in the list, or -1 if not found

func (Txs) Proof Uses

func (txs Txs) Proof(i int) TxProof

Proof returns a simple merkle proof for this node. Panics if i < 0 or i >= len(txs) TODO: optimize this!

type Validator Uses

type Validator struct {
    Address     Address       `json:"address"`
    PubKey      crypto.PubKey `json:"pub_key"`
    VotingPower int64         `json:"voting_power"`

    ProposerPriority int64 `json:"proposer_priority"`
}

Volatile state for each Validator NOTE: The ProposerPriority is not included in Validator.Hash(); make sure to update that method if changes are made here

func NewValidator Uses

func NewValidator(pubKey crypto.PubKey, votingPower int64) *Validator

func (*Validator) Bytes Uses

func (v *Validator) Bytes() []byte

Bytes computes the unique encoding of a validator with a given voting power. These are the bytes that gets hashed in consensus. It excludes address as its redundant with the pubkey. This also excludes ProposerPriority which changes every round.

func (*Validator) CompareProposerPriority Uses

func (v *Validator) CompareProposerPriority(other *Validator) *Validator

Returns the one with higher ProposerPriority.

func (*Validator) Copy Uses

func (v *Validator) Copy() *Validator

Creates a new copy of the validator so we can mutate ProposerPriority. Panics if the validator is nil.

func (*Validator) String Uses

func (v *Validator) String() string

type ValidatorInfo Uses

type ValidatorInfo struct {
    Address Address `json:"address"`
    Index   int     `json:"index"`
}

type ValidatorParams Uses

type ValidatorParams struct {
    PubKeyTypes []string `json:"pub_key_types"`
}

ValidatorParams restrict the public key types validators can use. NOTE: uses ABCI pubkey naming, not Amino names.

func DefaultValidatorParams Uses

func DefaultValidatorParams() ValidatorParams

DefaultValidatorParams returns a default ValidatorParams, which allows only ed25519 pubkeys.

func (*ValidatorParams) IsValidPubkeyType Uses

func (params *ValidatorParams) IsValidPubkeyType(pubkeyType string) bool

type ValidatorSet Uses

type ValidatorSet struct {
    // NOTE: persisted via reflect, must be exported.
    Validators []*Validator `json:"validators"`
    Proposer   *Validator   `json:"proposer"`
    // contains filtered or unexported fields
}

ValidatorSet represent a set of *Validator at a given height. The validators can be fetched by address or index. The index is in order of .Address, so the indices are fixed for all rounds of a given blockchain height. On the other hand, the .ProposerPriority of each validator and the designated .GetProposer() of a set changes every round, upon calling .IncrementProposerPriority(). NOTE: Not goroutine-safe. NOTE: All get/set to validators should copy the value for safety.

func NewValidatorSet Uses

func NewValidatorSet(valz []*Validator) *ValidatorSet

NewValidatorSet initializes a ValidatorSet by copying over the values from `valz`, a list of Validators. If valz is nil or empty, the new ValidatorSet will have an empty list of Validators. The addresses of validators in `valz` must be unique otherwise the function panics.

func (*ValidatorSet) Copy Uses

func (vals *ValidatorSet) Copy() *ValidatorSet

Copy each validator into a new ValidatorSet

func (*ValidatorSet) CopyIncrementProposerPriority Uses

func (vals *ValidatorSet) CopyIncrementProposerPriority(times int) *ValidatorSet

Increment ProposerPriority and update the proposer on a copy, and return it.

func (*ValidatorSet) GetByAddress Uses

func (vals *ValidatorSet) GetByAddress(address []byte) (index int, val *Validator)

GetByAddress returns an index of the validator with address and validator itself if found. Otherwise, -1 and nil are returned.

func (*ValidatorSet) GetByIndex Uses

func (vals *ValidatorSet) GetByIndex(index int) (address []byte, val *Validator)

GetByIndex returns the validator's address and validator itself by index. It returns nil values if index is less than 0 or greater or equal to len(ValidatorSet.Validators).

func (*ValidatorSet) GetProposer Uses

func (vals *ValidatorSet) GetProposer() (proposer *Validator)

GetProposer returns the current proposer. If the validator set is empty, nil is returned.

func (*ValidatorSet) HasAddress Uses

func (vals *ValidatorSet) HasAddress(address []byte) bool

HasAddress returns true if address given is in the validator set, false - otherwise.

func (*ValidatorSet) Hash Uses

func (vals *ValidatorSet) Hash() []byte

Hash returns the Merkle root hash build using validators (as leaves) in the set.

func (*ValidatorSet) IncrementProposerPriority Uses

func (vals *ValidatorSet) IncrementProposerPriority(times int)

IncrementProposerPriority increments ProposerPriority of each validator and updates the proposer. Panics if validator set is empty. `times` must be positive.

func (*ValidatorSet) IsNilOrEmpty Uses

func (vals *ValidatorSet) IsNilOrEmpty() bool

Nil or empty validator sets are invalid.

func (*ValidatorSet) Iterate Uses

func (vals *ValidatorSet) Iterate(fn func(index int, val *Validator) bool)

Iterate will run the given function over the set.

func (*ValidatorSet) Remove Uses

func (vals *ValidatorSet) Remove(address []byte) (val *Validator, removed bool)

Remove deletes the validator with address. It returns the validator removed and true. If returns nil and false if validator is not present in the set.

func (*ValidatorSet) RescalePriorities Uses

func (vals *ValidatorSet) RescalePriorities(diffMax int64)

func (*ValidatorSet) Size Uses

func (vals *ValidatorSet) Size() int

Size returns the length of the validator set.

func (*ValidatorSet) String Uses

func (vals *ValidatorSet) String() string

func (*ValidatorSet) StringIndented Uses

func (vals *ValidatorSet) StringIndented(indent string) string

String

func (*ValidatorSet) TotalVotingPower Uses

func (vals *ValidatorSet) TotalVotingPower() int64

TotalVotingPower returns the sum of the voting powers of all validators.

func (*ValidatorSet) UpdateWithChangeSet Uses

func (vals *ValidatorSet) UpdateWithChangeSet(changes []*Validator) error

UpdateWithChangeSet attempts to update the validator set with 'changes' It performs the following steps: - validates the changes making sure there are no duplicates and splits them in updates and deletes - verifies that applying the changes will not result in errors - computes the total voting power BEFORE removals to ensure that in the next steps the relative priorities

across old and newly added validators is fair

- computes the priorities of new validators against the final set - applies the updates against the validator set - applies the removals against the validator set - performs scaling and centering of priority values If error is detected during verification steps it is returned and the validator set is not changed.

func (*ValidatorSet) VerifyCommit Uses

func (vals *ValidatorSet) VerifyCommit(chainID string, blockID BlockID, height int64, commit *Commit) error

Verify that +2/3 of the set had signed the given signBytes.

func (*ValidatorSet) VerifyFutureCommit Uses

func (vals *ValidatorSet) VerifyFutureCommit(newSet *ValidatorSet, chainID string,
    blockID BlockID, height int64, commit *Commit) error

VerifyFutureCommit will check to see if the set would be valid with a different validator set.

vals is the old validator set that we know. Over 2/3 of the power in old signed this block.

In Tendermint, 1/3 of the voting power can halt or fork the chain, but 1/3 can't make arbitrary state transitions. You still need > 2/3 Byzantine to make arbitrary state transitions.

To preserve this property in the light client, we also require > 2/3 of the old vals to sign the future commit at H, that way we preserve the property that if they weren't being truthful about the validator set at H (block hash -> vals hash) or about the app state (block hash -> app hash) we can slash > 2/3. Otherwise, the lite client isn't providing the same security guarantees.

Even if we added a slashing condition that if you sign a block header with the wrong validator set, then we would only need > 1/3 of signatures from the old vals on the new commit, it wouldn't be sufficient because the new vals can be arbitrary and commit some arbitrary app hash.

newSet is the validator set that signed this block. Only votes from new are sufficient for 2/3 majority in the new set as well, for it to be a valid commit.

NOTE: This doesn't check whether the commit is a future commit, because the current height isn't part of the ValidatorSet. Caller must check that the commit height is greater than the height for this validator set.

type ValidatorsByAddress Uses

type ValidatorsByAddress []*Validator

Sort validators by address

func (ValidatorsByAddress) Len Uses

func (valz ValidatorsByAddress) Len() int

func (ValidatorsByAddress) Less Uses

func (valz ValidatorsByAddress) Less(i, j int) bool

func (ValidatorsByAddress) Swap Uses

func (valz ValidatorsByAddress) Swap(i, j int)

type Vote Uses

type Vote struct {
    Type             SignedMsgType `json:"type"`
    Height           int64         `json:"height"`
    Round            int           `json:"round"`
    BlockID          BlockID       `json:"block_id"` // zero if vote is nil.
    Timestamp        time.Time     `json:"timestamp"`
    ValidatorAddress Address       `json:"validator_address"`
    ValidatorIndex   int           `json:"validator_index"`
    Signature        []byte        `json:"signature"`
}

Vote represents a prevote, precommit, or commit vote from validators for consensus.

func (*Vote) CommitSig Uses

func (vote *Vote) CommitSig() *CommitSig

CommitSig converts the Vote to a CommitSig. If the Vote is nil, the CommitSig will be nil.

func (*Vote) Copy Uses

func (vote *Vote) Copy() *Vote

func (*Vote) SignBytes Uses

func (vote *Vote) SignBytes(chainID string) []byte

func (*Vote) String Uses

func (vote *Vote) String() string

func (*Vote) ValidateBasic Uses

func (vote *Vote) ValidateBasic() error

ValidateBasic performs basic validation.

func (*Vote) Verify Uses

func (vote *Vote) Verify(chainID string, pubKey crypto.PubKey) error

type VoteSet Uses

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

VoteSet helps collect signatures from validators at each height+round for a predefined vote type.

We need VoteSet to be able to keep track of conflicting votes when validators double-sign. Yet, we can't keep track of *all* the votes seen, as that could be a DoS attack vector.

There are two storage areas for votes. 1. voteSet.votes 2. voteSet.votesByBlock

`.votes` is the "canonical" list of votes. It always has at least one vote, if a vote from a validator had been seen at all. Usually it keeps track of the first vote seen, but when a 2/3 majority is found, votes for that get priority and are copied over from `.votesByBlock`.

`.votesByBlock` keeps track of a list of votes for a particular block. There are two ways a &blockVotes{} gets created in `.votesByBlock`. 1. the first vote seen by a validator was for the particular block. 2. a peer claims to have seen 2/3 majority for the particular block.

Since the first vote from a validator will always get added in `.votesByBlock` , all votes in `.votes` will have a corresponding entry in `.votesByBlock`.

When a &blockVotes{} in `.votesByBlock` reaches a 2/3 majority quorum, its votes are copied into `.votes`.

All this is memory bounded because conflicting votes only get added if a peer told us to track that block, each peer only gets to tell us 1 such block, and, there's only a limited number of peers.

NOTE: Assumes that the sum total of voting power does not exceed MaxUInt64.

func NewVoteSet Uses

func NewVoteSet(chainID string, height int64, round int, type_ SignedMsgType, valSet *ValidatorSet) *VoteSet

Constructs a new VoteSet struct used to accumulate votes for given height/round.

func (*VoteSet) AddVote Uses

func (voteSet *VoteSet) AddVote(vote *Vote) (added bool, err error)

Returns added=true if vote is valid and new. Otherwise returns err=ErrVote[

UnexpectedStep | InvalidIndex | InvalidAddress |
InvalidSignature | InvalidBlockHash | ConflictingVotes ]

Duplicate votes return added=false, err=nil. Conflicting votes return added=*, err=ErrVoteConflictingVotes. NOTE: vote should not be mutated after adding. NOTE: VoteSet must not be nil NOTE: Vote must not be nil

func (*VoteSet) BitArray Uses

func (voteSet *VoteSet) BitArray() *cmn.BitArray

func (*VoteSet) BitArrayByBlockID Uses

func (voteSet *VoteSet) BitArrayByBlockID(blockID BlockID) *cmn.BitArray

func (*VoteSet) BitArrayString Uses

func (voteSet *VoteSet) BitArrayString() string

Return the bit-array of votes including the fraction of power that has voted like: "BA{29:xx__x__x_x___x__x_______xxx__} 856/1304 = 0.66"

func (*VoteSet) ChainID Uses

func (voteSet *VoteSet) ChainID() string

func (*VoteSet) GetByAddress Uses

func (voteSet *VoteSet) GetByAddress(address []byte) *Vote

func (*VoteSet) GetByIndex Uses

func (voteSet *VoteSet) GetByIndex(valIndex int) *Vote

NOTE: if validator has conflicting votes, returns "canonical" vote

func (*VoteSet) HasAll Uses

func (voteSet *VoteSet) HasAll() bool

func (*VoteSet) HasTwoThirdsAny Uses

func (voteSet *VoteSet) HasTwoThirdsAny() bool

func (*VoteSet) HasTwoThirdsMajority Uses

func (voteSet *VoteSet) HasTwoThirdsMajority() bool

func (*VoteSet) Height Uses

func (voteSet *VoteSet) Height() int64

func (*VoteSet) IsCommit Uses

func (voteSet *VoteSet) IsCommit() bool

func (*VoteSet) MakeCommit Uses

func (voteSet *VoteSet) MakeCommit() *Commit

func (*VoteSet) MarshalJSON Uses

func (voteSet *VoteSet) MarshalJSON() ([]byte, error)

Marshal the VoteSet to JSON. Same as String(), just in JSON, and without the height/round/type_ (since its already included in the votes).

func (*VoteSet) Round Uses

func (voteSet *VoteSet) Round() int

func (*VoteSet) SetPeerMaj23 Uses

func (voteSet *VoteSet) SetPeerMaj23(peerID P2PID, blockID BlockID) error

If a peer claims that it has 2/3 majority for given blockKey, call this. NOTE: if there are too many peers, or too much peer churn, this can cause memory issues. TODO: implement ability to remove peers too NOTE: VoteSet must not be nil

func (*VoteSet) Size Uses

func (voteSet *VoteSet) Size() int

func (*VoteSet) String Uses

func (voteSet *VoteSet) String() string

func (*VoteSet) StringIndented Uses

func (voteSet *VoteSet) StringIndented(indent string) string

func (*VoteSet) StringShort Uses

func (voteSet *VoteSet) StringShort() string

func (*VoteSet) TwoThirdsMajority Uses

func (voteSet *VoteSet) TwoThirdsMajority() (blockID BlockID, ok bool)

If there was a +2/3 majority for blockID, return blockID and true. Else, return the empty BlockID{} and false.

func (*VoteSet) Type Uses

func (voteSet *VoteSet) Type() byte

func (*VoteSet) VoteStrings Uses

func (voteSet *VoteSet) VoteStrings() []string

Returns a list of votes compressed to more readable strings.

type VoteSetJSON Uses

type VoteSetJSON struct {
    Votes         []string          `json:"votes"`
    VotesBitArray string            `json:"votes_bit_array"`
    PeerMaj23s    map[P2PID]BlockID `json:"peer_maj_23s"`
}

More human readable JSON of the vote set NOTE: insufficient for unmarshalling from (compressed votes) TODO: make the peerMaj23s nicer to read (eg just the block hash)

type VoteSetReader Uses

type VoteSetReader interface {
    Height() int64
    Round() int
    Type() byte
    Size() int
    BitArray() *cmn.BitArray
    GetByIndex(int) *Vote
    IsCommit() bool
}

Common interface between *consensus.VoteSet and types.Commit

Directories

PathSynopsis
proto3
time

Package types imports 29 packages (graph) and is imported by 146 packages. Updated 2019-02-20. Refresh now. Tools for package owners.