Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var InitStateVersion = tmstate.Version{ Consensus: tmversion.Consensus{ Block: version.BlockProtocol, App: 0, }, Software: version.TMCoreSemVer, }
InitStateVersion sets the Consensus.Block and Software versions, but leaves the Consensus.App version blank. The Consensus.App version will be set during the Handshake, once we hear from the app what protocol version it is running.
Functions ¶
This section is empty.
Types ¶
type Block ¶
Block defines the structure of Optimint block.
func (*Block) MarshalBinary ¶
MarshalBinary encodes Block into binary form and returns it.
func (*Block) UnmarshalBinary ¶
UnmarshalBinary decodes binary form of Block into object.
func (*Block) ValidateBasic ¶
ValidateBasic performs basic validation of a block.
type Commit ¶
type Commit struct {
Height uint64
HeaderHash [32]byte
Signatures []Signature // most of the time this is a single signature
}
Commit cointains evidence of block creation.
func (*Commit) MarshalBinary ¶
MarshalBinary encodes Commit into binary form and returns it.
func (*Commit) UnmarshalBinary ¶
UnmarshalBinary decodes binary form of Commit into object.
func (*Commit) ValidateBasic ¶
ValidateBasic performs basic validation of a commit.
type Data ¶
type Data struct {
Txs Txs
IntermediateStateRoots IntermediateStateRoots
Evidence EvidenceData
}
Data defines Optimint block data.
func (*Data) MarshalBinary ¶
MarshalBinary encodes Data into binary form and returns it.
func (*Data) ValidateBasic ¶
ValidateBasic performs basic validation of block data. Actually it's a placeholder, because nothing is checked.
type Evidence ¶
type Evidence interface {
ABCI() []abci.Evidence // forms individual evidence to be sent to the application
Bytes() []byte // bytes which comprise the evidence
Hash() []byte // hash of the evidence
Height() int64 // height of the infraction
String() string // string format of the evidence
Time() time.Time // time of the infraction
ValidateBasic() error // basic consistency check
}
Evidence represents any provable malicious activity by a validator. Verification logic for each evidence is part of the evidence module.
type EvidenceData ¶
type EvidenceData struct {
Evidence []Evidence
}
EvidenceData defines how evidence is stored in block.
type Header ¶
type Header struct {
// Block and App version
Version Version
// NamespaceID identifies this chain e.g. when connected to other rollups via IBC.
// TODO(ismail): figure out if we want to use namespace.ID here instead (downside is that it isn't fixed size)
// at least extract the used constants (32, 8) as package variables though.
NamespaceID [8]byte
Height uint64
Time uint64 // time in tai64 format
// prev block info
LastHeaderHash [32]byte
// hashes of block data
LastCommitHash [32]byte // commit from aggregator(s) from the last block
DataHash [32]byte // Block.Data root aka Transactions
ConsensusHash [32]byte // consensus params for current block
AppHash [32]byte // state after applying txs from the current block
// Root hash of all results from the txs from the previous block.
// This is ABCI specific but smart-contract chains require some way of committing
// to transaction receipts/results.
LastResultsHash [32]byte
// Note that the address can be derived from the pubkey which can be derived
// from the signature when using secp256k.
// We keep this in case users choose another signature format where the
// pubkey can't be recovered by the signature (e.g. ed25519).
ProposerAddress []byte // original proposer of the block
// Hash of block aggregator set, at a time of block creation
AggregatorsHash [32]byte
}
Header defines the structure of Optimint block header.
func (*Header) MarshalBinary ¶
MarshalBinary encodes Header into binary form and returns it.
func (*Header) UnmarshalBinary ¶
UnmarshalBinary decodes binary form of Header into object.
func (*Header) ValidateBasic ¶
ValidateBasic performs basic validation of a header.
type IntermediateStateRoots ¶
type IntermediateStateRoots struct {
RawRootsList [][]byte
}
IntermediateStateRoots describes the state between transactions. They are required for fraud proofs.
type State ¶ added in v0.3.2
type State struct {
Version tmstate.Version
// immutable
ChainID string
InitialHeight int64 // should be 1, not 0, when starting from height 1
// LastBlockHeight=0 at genesis (ie. block(H=0) does not exist)
LastBlockHeight int64
LastBlockID types.BlockID
LastBlockTime time.Time
// DAHeight identifies DA block containing the latest applied Optimint block.
DAHeight uint64
// In the MVP implementation, there will be only one Validator
NextValidators *types.ValidatorSet
Validators *types.ValidatorSet
LastValidators *types.ValidatorSet
LastHeightValidatorsChanged int64
// Consensus parameters used for validating blocks.
// Changes returned by EndBlock and updated after Commit.
ConsensusParams tmproto.ConsensusParams
LastHeightConsensusParamsChanged int64
// Merkle root of the results from executing prev block
LastResultsHash [32]byte
// the latest AppHash we've received from calling abci.Commit()
AppHash [32]byte
}
State contains information about current state of the blockchain.
func NewFromGenesisDoc ¶ added in v0.3.2
func NewFromGenesisDoc(genDoc *types.GenesisDoc) (State, error)
NewFromGenesisDoc reads blockchain State from genesis.
type TxProof ¶
type TxProof struct {
RootHash tmbytes.HexBytes `json:"root_hash"`
Data Tx `json:"data"`
Proof merkle.Proof `json:"proof"`
}
TxProof represents a Merkle proof of the presence of a transaction in the Merkle tree.
Source Files
Directories