types

package
v1.0.0-beta.2 Latest Latest
Warning

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

 Go to latest Published: Jul 24, 2025 License: Apache-2.0 Imports: 21 Imported by: 7

Documentation

Index

Constants

View Source 
const DefaultSigningKeyType = "ed25519"

DefaultSigningKeyType is the key type used by the sequencer signing key

Variables

View Source 
var (
	// ErrNoProposerAddress is returned when the proposer address is not set.
	ErrNoProposerAddress = errors.New("no proposer address")

	// ErrProposerVerificationFailed is returned when the proposer verification fails.
	ErrProposerVerificationFailed = errors.New("proposer verification failed")
)
View Source 
var (
	// ErrLastHeaderHashMismatch is returned when the last header hash doesn't match.
	ErrLastHeaderHashMismatch = errors.New("last header hash mismatch")

	// ErrLastCommitHashMismatch is returned when the last commit hash doesn't match.
	ErrLastCommitHashMismatch = errors.New("last commit hash mismatch")
)
View Source 
var (
	// ErrAggregatorSetHashMismatch is returned when the aggregator set hash
	// in the signed header doesn't match the hash of the validator set.
	ErrAggregatorSetHashMismatch = errors.New("aggregator set hash in signed header and hash of validator set do not match")

	// ErrSignatureVerificationFailed is returned when the signature
	// verification fails
	ErrSignatureVerificationFailed = errors.New("signature verification failed")

	// ErrProposerAddressMismatch is returned when the proposer address in the signed header does not match the proposer address in the validator set
	ErrProposerAddressMismatch = errors.New("proposer address in SignedHeader does not match the proposer address in the validator set")

	// ErrSignatureEmpty is returned when signature is empty
	ErrSignatureEmpty = errors.New("signature is empty")
)
View Source 
var HeaderContextKey = headerContextKey{}

HeaderContextKey is used to store the header in the context. This is useful if the execution client needs to access the header during transaction execution.

View Source 
var InitStateVersion = Version{
	Block: 11,
	App:   0,
}

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

func DefaultSignaturePayloadProvider 

func DefaultSignaturePayloadProvider(header *Header) ([]byte, error)

DefaultSignaturePayloadProvider is the default implementation of SignaturePayloadProvider.

func GenerateRandomBlockCustom added in v0.13.0 

func GenerateRandomBlockCustom(config *BlockConfig, chainID string) (*SignedHeader, *Data, crypto.PrivKey)

GenerateRandomBlockCustom returns a block with random data and the given height, transactions, privateKey and proposer address.

func GenerateRandomBlockCustomWithAppHash 

func GenerateRandomBlockCustomWithAppHash(config *BlockConfig, chainID string, appHash []byte) (*SignedHeader, *Data, crypto.PrivKey)

GenerateRandomBlockCustomWithAppHash returns a block with random data and the given height, transactions, privateKey, proposer address, and custom appHash.

func GetGenesisWithPrivkey added in v0.11.8 

func GetGenesisWithPrivkey(chainID string) (genesis.Genesis, crypto.PrivKey, crypto.PubKey)

GetGenesisWithPrivkey returns a genesis state and a private key

func GetRandomBlock added in v0.10.7 

func GetRandomBlock(height uint64, nTxs int, chainID string) (*SignedHeader, *Data)

GetRandomBlock creates a block with a given height and number of transactions, intended for testing. It's tailored for simplicity, primarily used in test setups where additional outputs are not needed.

func GetRandomBytes added in v0.9.0 

func GetRandomBytes(n uint) []byte

GetRandomBytes returns a byte slice of random bytes of length n. It uses crypto/rand for cryptographically secure random number generation.

func KeyAddress 

func KeyAddress(pubKey crypto.PubKey) []byte

func RetrieveWithHelpers 

func RetrieveWithHelpers(
	ctx context.Context,
	da coreda.DA,
	logger logging.EventLogger,
	dataLayerHeight uint64,
	namespace []byte,
) coreda.ResultRetrieve

RetrieveWithHelpers performs blob retrieval using the underlying DA layer, handling error mapping to produce a ResultRetrieve. It mimics the logic previously found in da.DAClient.Retrieve.

func SubmitWithHelpers 

func SubmitWithHelpers(
	ctx context.Context,
	da coreda.DA,
	logger logging.EventLogger,
	data [][]byte,
	gasPrice float64,
	options []byte,
) coreda.ResultSubmit

SubmitWithHelpers performs blob submission using the underlying DA layer, handling error mapping to produce a ResultSubmit. It assumes blob size filtering is handled within the DA implementation's Submit. It mimics the logic previously found in da.DAClient.Submit.

func Validate added in v0.14.0 

func Validate(header *SignedHeader, data *Data) error

Validate performs validation of data with respect to its header

Types

type BaseHeader 

type BaseHeader struct {
	// Height represents the block height (aka block number) of a given header
	Height uint64
	// Time contains Unix nanotime of a block
	Time uint64
	// The Chain ID
	ChainID string
}

BaseHeader contains the most basic data of a header

type BlockConfig added in v0.13.0 

type BlockConfig struct {
	Height       uint64
	NTxs         int
	PrivKey      crypto.PrivKey // Input and Output option
	ProposerAddr []byte         // Input option
}

BlockConfig carries all necessary state for block generation

type Data 

type Data struct {
	*Metadata
	Txs Txs
}

Data defines Rollkit block data.

func (*Data) ChainID added in v0.14.0 

func (d *Data) ChainID() string

ChainID returns chain ID of the block.

func (*Data) DACommitment 

func (d *Data) DACommitment() Hash

DACommitment returns the DA commitment of the Data excluding the Metadata

func (*Data) FromProto added in v0.10.2 

func (d *Data) FromProto(other *pb.Data) error

FromProto fills the Data with data from its protobuf representation

func (*Data) Hash added in v0.10.5 

func (d *Data) Hash() Hash

Hash returns hash of the Data

func (*Data) Height added in v0.14.0 

func (d *Data) Height() uint64

Height returns height of the block.

func (*Data) IsZero added in v0.14.0 

func (d *Data) IsZero() bool

IsZero returns true if the block is nil.

func (*Data) LastHeader added in v0.14.0 

func (d *Data) LastHeader() Hash

LastHeader returns last header hash of the block.

func (*Data) MarshalBinary 

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

MarshalBinary encodes Data into binary form and returns it.

func (*Data) New added in v0.14.0 

func (d *Data) New() *Data

New returns a new Block.

func (*Data) Size added in v0.14.0 

func (d *Data) Size() int

Size returns size of the block in bytes.

func (*Data) Time added in v0.14.0 

func (d *Data) Time() time.Time

Time returns time of the block.

func (*Data) ToProto 

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

ToProto converts Data into protobuf representation and returns it.

func (*Data) UnmarshalBinary added in v0.10.2 

func (d *Data) UnmarshalBinary(data []byte) error

UnmarshalBinary decodes binary form of Data into object.

func (*Data) Validate added in v0.14.0 

func (d *Data) Validate() error

Validate performs basic validation of a block. this is used to implement the header interface for go header

func (*Data) Verify added in v0.14.0 

func (d *Data) Verify(untrustedData *Data) error

Verify Verifies a new, untrusted block against a trusted block.

type Hash 

type Hash = header.Hash

Hash is a 32-byte array which is used to represent a hash result.

func DefaultValidatorHasherProvider 

func DefaultValidatorHasherProvider(
	_ []byte,
	_ crypto.PubKey,
) (Hash, error)

DefaultValidatorHasherProvider is the default implementation of ValidatorHasherProvider. It returns an empty Hash, as rollkit does not use validator hashes itself. 

type Header struct {
	BaseHeader
	// Block and App version
	Version Version

	// prev block info
	LastHeaderHash Hash

	// hashes of block data
	LastCommitHash Hash // commit from aggregator(s) from the last block
	DataHash       Hash // Block.Data root aka Transactions
	ConsensusHash  Hash // consensus params for current block
	AppHash        Hash // 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 Hash

	// compatibility with tendermint light client
	ValidatorHash Hash

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

Header defines the structure of Rollkit block header.

func GetRandomHeader added in v0.10.7 

func GetRandomHeader(chainID string, appHash []byte) Header

GetRandomHeader returns a header with random fields and current time

func GetRandomNextHeader added in v0.10.7 

func GetRandomNextHeader(header Header, chainID string) Header

GetRandomNextHeader returns a header with random data and height of +1 from the provided Header

func HeaderFromContext 

func HeaderFromContext(ctx context.Context) (Header, bool)

func (*Header) ChainID 

func (h *Header) ChainID() string

ChainID returns chain ID of the 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() Hash

Hash returns hash of the header

func (*Header) Height 

func (h *Header) Height() uint64

Height returns height of the header.

func (*Header) IsZero 

func (h *Header) IsZero() bool

IsZero returns true if the header is nil.

func (*Header) LastHeader 

func (h *Header) LastHeader() Hash

LastHeader returns last header hash of the header.

func (*Header) MarshalBinary 

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

MarshalBinary encodes Header into binary form and returns it.

func (*Header) New 

func (h *Header) New() *Header

New creates a new Header.

func (*Header) Time 

func (h *Header) Time() time.Time

Time returns timestamp as unix time with nanosecond precision

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

func (h *Header) Validate() error

Validate performs basic validation of a header.

func (*Header) ValidateBasic 

func (h *Header) ValidateBasic() error

ValidateBasic performs basic validation of a header.

func (*Header) Verify added in v0.7.2 

func (h *Header) Verify(untrstH *Header) error

Verify verifies the header.

type HeaderConfig added in v0.13.0 

type HeaderConfig struct {
	Height   uint64
	DataHash header.Hash
	AppHash  header.Hash
	Signer   signer.Signer
}

HeaderConfig carries all necessary state for header generation

type Metadata added in v0.14.0 

type Metadata struct {
	ChainID      string
	Height       uint64
	Time         uint64
	LastDataHash Hash
}

Metadata defines metadata for Data struct to help with p2p gossiping.

func (*Metadata) FromProto added in v0.14.0 

func (m *Metadata) FromProto(other *pb.Metadata) error

FromProto fills Metadata with data from its protobuf representation.

func (*Metadata) MarshalBinary added in v0.14.0 

func (m *Metadata) MarshalBinary() ([]byte, error)

MarshalBinary encodes Metadata into binary form and returns it.

func (*Metadata) ToProto added in v0.14.0 

func (m *Metadata) ToProto() *pb.Metadata

ToProto converts Metadata into protobuf representation and returns it.

func (*Metadata) UnmarshalBinary added in v0.14.0 

func (m *Metadata) UnmarshalBinary(metadata []byte) error

UnmarshalBinary decodes binary form of Metadata into object.

type Signature 

type Signature []byte

Signature represents signature of block creator.

func GetSignature added in v0.13.6 

func GetSignature(header Header, signer signer.Signer) (Signature, error)

GetSignature returns a signature from the given private key over the given header

func (*Signature) ValidateBasic added in v0.13.6 

func (signature *Signature) ValidateBasic() error

ValidateBasic performs basic validation of a signature.

type SignaturePayloadProvider 

type SignaturePayloadProvider func(header *Header) ([]byte, error)

SignaturePayloadProvider defines the function type for providing a signature payload.

type SignedData 

type SignedData struct {
	Data
	Signature Signature
	Signer    Signer
}

SignedData combines Data and its signature.

func (*SignedData) FromProto 

func (sd *SignedData) FromProto(other *pb.SignedData) error

FromProto fills SignedData with data from protobuf representation.

func (*SignedData) MarshalBinary 

func (sd *SignedData) MarshalBinary() ([]byte, error)

MarshalBinary encodes SignedData into binary form and returns it.

func (*SignedData) ToProto 

func (sd *SignedData) ToProto() (*pb.SignedData, error)

ToProto converts SignedData into protobuf representation and returns it.

func (*SignedData) UnmarshalBinary 

func (sd *SignedData) UnmarshalBinary(data []byte) error

UnmarshalBinary decodes binary form of SignedData into object.

type SignedHeader 

type SignedHeader struct {
	Header
	// Note: This is backwards compatible as ABCI exported types are not affected.
	Signature Signature
	Signer    Signer
	// contains filtered or unexported fields
}

SignedHeader combines Header and its signature.

Used mostly for gossiping.

func GetFirstSignedHeader added in v0.11.8 

func GetFirstSignedHeader(signer signer.Signer, chainID string) (*SignedHeader, error)

GetFirstSignedHeader creates a 1st signed header for a chain, given a valset and signing key.

func GetRandomNextSignedHeader added in v0.10.7 

func GetRandomNextSignedHeader(signedHeader *SignedHeader, signer signer.Signer, chainID string) (*SignedHeader, error)

GetRandomNextSignedHeader returns a signed header with random data and height of +1 from the provided signed header

func GetRandomSignedHeader added in v0.9.0 

func GetRandomSignedHeader(chainID string) (*SignedHeader, crypto.PrivKey, error)

GetRandomSignedHeader generates a signed header with random data and returns it.

func GetRandomSignedHeaderCustom added in v0.13.0 

func GetRandomSignedHeaderCustom(config *HeaderConfig, chainID string) (*SignedHeader, error)

GetRandomSignedHeaderCustom creates a signed header based on the provided HeaderConfig.

func (*SignedHeader) FromProto 

func (sh *SignedHeader) FromProto(other *pb.SignedHeader) error

FromProto fills SignedHeader with data from protobuf representation. The contained Signer can only be used to verify signatures, not to sign messages.

func (*SignedHeader) IsZero added in v0.7.0 

func (sh *SignedHeader) IsZero() bool

IsZero returns true if the SignedHeader is nil

func (*SignedHeader) MarshalBinary 

func (sh *SignedHeader) MarshalBinary() ([]byte, error)

MarshalBinary encodes SignedHeader into binary form and returns it.

func (*SignedHeader) New added in v0.7.0 

func (sh *SignedHeader) New() *SignedHeader

New creates a new SignedHeader.

func (*SignedHeader) SetCustomVerifier 

func (sh *SignedHeader) SetCustomVerifier(provider SignaturePayloadProvider)

SetCustomVerifier sets a custom signature provider for the SignedHeader. If set, ValidateBasic will use this function to verify the signature.

func (*SignedHeader) ToProto 

func (sh *SignedHeader) ToProto() (*pb.SignedHeader, error)

ToProto converts SignedHeader into protobuf representation and returns it.

func (*SignedHeader) UnmarshalBinary 

func (sh *SignedHeader) UnmarshalBinary(data []byte) error

UnmarshalBinary decodes binary form of SignedHeader into object.

func (*SignedHeader) ValidateBasic 

func (sh *SignedHeader) ValidateBasic() error

ValidateBasic performs basic validation of a signed header.

func (*SignedHeader) Verify added in v0.7.2 

func (sh *SignedHeader) Verify(untrstH *SignedHeader) error

Verify verifies the signed header.

type Signer 

type Signer struct {
	PubKey  crypto.PubKey
	Address []byte
}

Signer is a type that can verify messages.

func NewSigner 

func NewSigner(pubKey crypto.PubKey) (Signer, error)

NewSigner creates a new signer from a public key.

func (*Signer) Verify 

func (s *Signer) Verify(vote []byte, signature []byte) (bool, error)

Verify verifies a vote with a signature.

type State 

type State struct {
	Version Version

	// immutable
	ChainID       string
	InitialHeight uint64

	// LastBlockHeight=0 at genesis (ie. block(H=0) does not exist)
	LastBlockHeight uint64
	LastBlockTime   time.Time

	// DAHeight identifies DA block containing the latest applied Rollkit block.
	DAHeight uint64

	// Merkle root of the results from executing prev block
	LastResultsHash Hash

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

State contains information about current state of the blockchain.

func NewFromGenesisDoc 

func NewFromGenesisDoc(genDoc genesis.Genesis) (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) NextState 

func (s *State) NextState(header Header, stateRoot []byte) (State, error)

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 GetRandomTx added in v0.9.0 

func GetRandomTx() Tx

GetRandomTx returns a tx with random data

type Txs 

type Txs []Tx

Txs represents a slice of transactions.

type ValidatorHasherProvider 

type ValidatorHasherProvider func(
	proposerAddress []byte,
	pubKey crypto.PubKey,
) (Hash, error)

ValidatorHasherProvider defines the function type for hashing a validator's public key and address.

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
rollkit/v1
rollkit/v1/v1connect

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.