collection

Documentation

Index

• type Builder
  • func NewBuilder(db *badger.DB, mainHeaders storage.Headers, clusterHeaders storage.Headers, ...) *Builder
  • func (b *Builder) BuildOn(parentID flow.Identifier, setter func(*flow.Header) error) (*flow.Header, error)
• type Opt
  • func WithExpiryBuffer(buf uint) Opt
  • func WithMaxCollectionSize(size uint) Opt

Types

type Builder

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

Builder is the builder for collection block payloads. Upon providing a payload hash, it also memorizes the payload contents.

NOTE: Builder is NOT safe for use with multiple goroutines. Since the HotStuff event loop is the only consumer of this interface and is single threaded, this is OK.

func NewBuilder

func NewBuilder(
	db *badger.DB,
	mainHeaders storage.Headers,
	clusterHeaders storage.Headers,
	payloads storage.ClusterPayloads,
	transactions mempool.Transactions,
	tracer module.Tracer,
	opts ...Opt,
) *Builder

func (*Builder) BuildOn

func (b *Builder) BuildOn(parentID flow.Identifier, setter func(*flow.Header) error) (*flow.Header, error)

BuildOn creates a new block built on the given parent. It produces a payload that is valid with respect to the un-finalized chain it extends.

type Opt

type Opt func(*Builder)

func WithExpiryBuffer

func WithExpiryBuffer(buf uint) Opt

func WithMaxCollectionSize

func WithMaxCollectionSize(size uint) Opt