types

package
v1.1.3-rc02 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 3, 2024 License: Apache-2.0 Imports: 18 Imported by: 38

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidSignature   = errors.New("invalid signature")
	ErrNoStateFound       = errors.New("no state found")
	ErrSkippedEmptyBlock  = errors.New("skipped empty block")
	ErrInvalidBlockHeight = errors.New("invalid block height")
)
View Source 
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.

View Source 
var RollappBlockSizeBytesGauge = promauto.NewGauge(prometheus.GaugeOpts{
	Name: "rollapp_block_size_bytes",
	Help: "Rollapp ",
})
View Source 
var RollappBlockSizeTxsGauge = promauto.NewGauge(prometheus.GaugeOpts{
	Name: "rollapp_block_size_txs",
	Help: "Rollapp ",
})
View Source 
var RollappHeightGauge = promauto.NewGauge(prometheus.GaugeOpts{
	Name: "rollapp_height",
	Help: "The height of the local rollapp",
})
View Source 
var RollappHubHeightGauge = promauto.NewGauge(prometheus.GaugeOpts{
	Name: "rollapp_hub_height",
	Help: "The latest height of the Rollapp that has been synced to the hub.",
})

Functions

func ToABCIBlock added in v1.1.0 

func ToABCIBlock(block *Block) (*tmtypes.Block, error)

ToABCIBlock converts Dymint block into block format defined by ABCI. Returned block should pass `ValidateBasic`.

func ToABCIBlockDataTxs added in v1.1.0 

func ToABCIBlockDataTxs(data *Data) []tmtypes.Tx

ToABCIBlockDataTxs converts Dymint block-data into block-data format defined by ABCI.

func ToABCIBlockMeta added in v1.1.0 

func ToABCIBlockMeta(block *Block) (*tmtypes.BlockMeta, error)

ToABCIBlockMeta converts Dymint block into BlockMeta format defined by ABCI

func ToABCICommit added in v1.1.0 

func ToABCICommit(commit *Commit, header *Header) *tmtypes.Commit

ToABCICommit converts Dymint commit into commit format defined by ABCI. This function only converts fields that are available in Dymint commit. Other fields (especially ValidatorAddress and Timestamp of Signature) has to be filled by caller.

func ToABCIHeader added in v1.1.0 

func ToABCIHeader(header *Header) tmtypes.Header

ToABCIHeader converts Dymint header to Header format defined in ABCI. Caller should fill all the fields that are not available in Dymint header (like ChainID).

func ToABCIHeaderPB added in v1.1.0 

func ToABCIHeaderPB(header *Header) types.Header

ToABCIHeaderPB converts Dymint header to Header format defined in ABCI. Caller should fill all the fields that are not available in Dymint header (like ChainID).

func ValidateProposedTransition added in v1.1.0 

func ValidateProposedTransition(state State, block *Block, commit *Commit, proposer *Sequencer) error

Types

type Batch 

type Batch struct {
	StartHeight uint64
	EndHeight   uint64
	Blocks      []*Block
	Commits     []*Commit
}

Batch defines a struct for block aggregation for support of batching. TODO: maybe change to BlockBatch

func (*Batch) FromProto 

func (b *Batch) FromProto(other *pb.Batch) error

FromProto fills Batch with data from its protobuf representation.

func (*Batch) MarshalBinary 

func (b *Batch) MarshalBinary() ([]byte, error)

MarshalBinary encodes Batch into binary form and returns it.

func (*Batch) ToProto 

func (b *Batch) ToProto() *pb.Batch

ToProto converts Batch into protobuf representation and returns it.

func (*Batch) UnmarshalBinary 

func (b *Batch) UnmarshalBinary(data []byte) error

UnmarshalBinary decodes binary form of Batch into object.

type Block 

type Block struct {
	Header     Header
	Data       Data
	LastCommit Commit
}

Block defines the structure of Dymint block.

func (*Block) FromProto 

func (b *Block) FromProto(other *pb.Block) error

FromProto fills Block with data from its protobuf representation.

func (*Block) Hash 

func (b *Block) Hash() [32]byte

Hash returns ABCI-compatible hash of a block.

func (*Block) MarshalBinary 

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

MarshalBinary encodes Block into binary form and returns it.

func (*Block) ToProto 

func (b *Block) ToProto() *pb.Block

ToProto converts Block into protobuf representation and returns it.

func (*Block) UnmarshalBinary 

func (b *Block) UnmarshalBinary(data []byte) error

UnmarshalBinary decodes binary form of Block into object.

func (*Block) ValidateBasic 

func (b *Block) ValidateBasic() error

ValidateBasic performs basic validation of a block.

func (*Block) ValidateWithState added in v1.1.0 

func (b *Block) ValidateWithState(state State) error

type Commit 

type Commit struct {
	Height     uint64
	HeaderHash [32]byte
	// TODO(omritoptix): Change from []Signature to Signature as it should be one signature per block
	Signatures  []Signature
	TMSignature tmtypes.CommitSig
}

Commit cointains evidence of block creation.

func (*Commit) FromProto 

func (c *Commit) FromProto(other *pb.Commit) error

FromProto fills Commit with data from its protobuf representation.

func (*Commit) MarshalBinary 

func (c *Commit) MarshalBinary() ([]byte, error)

MarshalBinary encodes Commit into binary form and returns it.

func (*Commit) ToProto 

func (c *Commit) ToProto() *pb.Commit

ToProto converts Commit into protobuf representation and returns it.

func (*Commit) UnmarshalBinary 

func (c *Commit) UnmarshalBinary(data []byte) error

UnmarshalBinary decodes binary form of Commit into object.

func (*Commit) Validate 

func (c *Commit) Validate(proposer *Sequencer, abciHeaderBytes []byte) error

Validate performs full validation of a commit.

func (*Commit) ValidateBasic 

func (c *Commit) ValidateBasic() error

ValidateBasic performs basic validation of a commit.

func (*Commit) ValidateWithHeader added in v1.1.0 

func (c *Commit) ValidateWithHeader(proposer *Sequencer, header *Header) error

type Data 

type Data struct {
	Txs                    Txs
	IntermediateStateRoots IntermediateStateRoots
	Evidence               EvidenceData
}

Data defines Dymint block data.

func (*Data) MarshalBinary 

func (d *Data) MarshalBinary() ([]byte, error)

MarshalBinary encodes Data into binary form and returns it.

func (*Data) ToProto 

func (d *Data) ToProto() *pb.Data

ToProto converts Data into protobuf representation and returns it.

func (*Data) ValidateBasic 

func (d *Data) ValidateBasic() error

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 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

	// The Chain ID
	ChainID string
}

Header defines the structure of Dymint block header.

func (*Header) FromProto 

func (h *Header) FromProto(other *pb.Header) error

FromProto fills Header with data from its protobuf representation.

func (*Header) Hash 

func (h *Header) Hash() [32]byte

Hash returns ABCI-compatible hash of a header.

func (*Header) MarshalBinary 

func (h *Header) MarshalBinary() ([]byte, error)

MarshalBinary encodes Header into binary form and returns it.

func (*Header) ToProto 

func (h *Header) ToProto() *pb.Header

ToProto converts Header into protobuf representation and returns it.

func (*Header) UnmarshalBinary 

func (h *Header) UnmarshalBinary(data []byte) error

UnmarshalBinary decodes binary form of Header into object.

func (*Header) ValidateBasic 

func (h *Header) ValidateBasic() error

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 Logger added in v1.1.0 

type Logger interface {
	Debug(msg string, keyvals ...interface{})
	Info(msg string, keyvals ...interface{})
	Error(msg string, keyvals ...interface{})
}

Logger interface is compatible with Tendermint logger

type Sequencer 

type Sequencer struct {
	// PublicKey is the public key of the sequencer
	PublicKey crypto.PubKey
	// Status is status of the sequencer
	Status SequencerStatus
}

Sequencer represents a sequencer of the rollapp

type SequencerStatus 

type SequencerStatus int32

SequencerStatus defines the operating status of a sequencer 

const (
	// Proposer defines a sequencer that is currently the proposer
	Proposer SequencerStatus = iota
	// Inactive defines a sequencer that is currently inactive
	Inactive
)

type Signature 

type Signature []byte

Signature represents signature of block creator.

type State 

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

	// 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

	// LastStore height is the last height we've saved to the store.
	LastStoreHeight uint64

	// BaseHeight is the height of the first block we have in store after pruning.
	BaseHeight uint64

	// the latest AppHash we've received from calling abci.Commit()
	AppHash [32]byte
}

State contains information about current state of the blockchain.

func NewFromGenesisDoc 

func NewFromGenesisDoc(genDoc *types.GenesisDoc) (State, error)

NewFromGenesisDoc reads blockchain State from genesis.

func (*State) FromProto 

func (s *State) FromProto(other *pb.State) error

FromProto fills State with data from its protobuf representation.

func (*State) IsGenesis added in v1.1.0 

func (s *State) IsGenesis() bool

func (*State) ToProto 

func (s *State) ToProto() (*pb.State, error)

ToProto converts State into protobuf representation and returns it.

type Tx 

type Tx []byte

Tx represents transaction.

func (Tx) Hash 

func (tx Tx) Hash() []byte

Hash computes the TMHASH hash of the wire encoded transaction.

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.

type Txs 

type Txs []Tx

Txs represents a slice of transactions.

func (Txs) Proof 

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 Version 

type Version struct {
	Block uint64
	App   uint64
}

Version captures the consensus rules for processing a block in the blockchain, including all blockchain data structures and the rules of the application's state transition machine. This is equivalent to the tmversion.Consensus type in Tendermint.

Source Files

View all Source files

Directories

Path Synopsis
pb
dalc
dymint

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.