block

Documentation

Index

• Variables
• type CachedBlock
• type Executor
  • func NewExecutor(proposerAddress []byte, namespaceID string, chainID string, ...) (*Executor, error)
  • func (e *Executor) Commit(state *types.State, block *types.Block, resp *tmstate.ABCIResponses) (int64, error)
  • func (e *Executor) CreateBlock(height uint64, lastCommit *types.Commit, lastHeaderHash [32]byte, ...) *types.Block
  • func (e *Executor) ExecuteBlock(state types.State, block *types.Block) (*tmstate.ABCIResponses, error)
  • func (e *Executor) GetAppInfo() (*abci.ResponseInfo, error)
  • func (e *Executor) InitChain(genesis *tmtypes.GenesisDoc, validators []*tmtypes.Validator) (*abci.ResponseInitChain, error)
  • func (e *Executor) UpdateMempoolAfterInitChain(s *types.State)
  • func (e *Executor) UpdateStateAfterInitChain(s *types.State, res *abci.ResponseInitChain, validators []*tmtypes.Validator)
  • func (e *Executor) UpdateStateFromResponses(resp *tmstate.ABCIResponses, state types.State, block *types.Block) (types.State, error)
• type Manager
  • func NewManager(proposerKey crypto.PrivKey, conf config.BlockManagerConfig, ...) (*Manager, error)
  • func (m *Manager) CreateNextDABatch(startHeight uint64, endHeight uint64) (*types.Batch, error)
  • func (m *Manager) HandleSubmissionTrigger(ctx context.Context) error
  • func (m *Manager) ProcessNextDABatch(daMetaData *da.DASubmitMetaData) error
  • func (m *Manager) ProduceAndGossipBlock(ctx context.Context, allowEmpty bool) error
  • func (m *Manager) ProduceBlockLoop(ctx context.Context)
  • func (m *Manager) RetrieveLoop(ctx context.Context)
  • func (m *Manager) RunInitChain(ctx context.Context) error
  • func (m *Manager) Start(ctx context.Context, isAggregator bool) error
  • func (m *Manager) SubmitLoop(ctx context.Context)
  • func (m *Manager) SyncTargetLoop(ctx context.Context)
  • func (m *Manager) UpdateStateFromApp() error
  • func (m *Manager) UpdateSyncParams(endHeight uint64)
  • func (m *Manager) ValidateBatch(batch *types.Batch) error
• type PendingBatch

Variables

var (
	ErrNonRecoverable = errors.New("non recoverable")
	ErrRecoverable    = errors.New("recoverable")
	ErrWrongDA        = errors.New("wrong DA")
)

Types

type CachedBlock

type CachedBlock struct {
	Block  *types.Block
	Commit *types.Commit
}

type Executor

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

Executor creates and applies blocks and maintains state.

func NewExecutor

func NewExecutor(proposerAddress []byte, namespaceID string, chainID string, mempool mempool.Mempool, proxyApp proxy.AppConns, eventBus *tmtypes.EventBus, logger types.Logger) (*Executor, error)

NewExecutor creates new instance of BlockExecutor. Proposer address and namespace ID will be used in all newly created blocks.

func (*Executor) Commit

func (e *Executor) Commit(state *types.State, block *types.Block, resp *tmstate.ABCIResponses) (int64, error)

Commit commits the block

func (*Executor) CreateBlock

func (e *Executor) CreateBlock(height uint64, lastCommit *types.Commit, lastHeaderHash [32]byte, state types.State) *types.Block

CreateBlock reaps transactions from mempool and builds a block.

func (*Executor) ExecuteBlock

func (e *Executor) ExecuteBlock(state types.State, block *types.Block) (*tmstate.ABCIResponses, error)

ExecuteBlock executes the block and returns the ABCIResponses. Block should be valid (passed validation checks).

func (*Executor) GetAppInfo

func (e *Executor) GetAppInfo() (*abci.ResponseInfo, error)

GetAppInfo returns the latest AppInfo from the proxyApp.

func (*Executor) InitChain

func (e *Executor) InitChain(genesis *tmtypes.GenesisDoc, validators []*tmtypes.Validator) (*abci.ResponseInitChain, error)

InitChain calls InitChainSync using consensus connection to app.

func (*Executor) UpdateMempoolAfterInitChain

func (e *Executor) UpdateMempoolAfterInitChain(s *types.State)

func (*Executor) UpdateStateAfterInitChain

func (e *Executor) UpdateStateAfterInitChain(s *types.State, res *abci.ResponseInitChain, validators []*tmtypes.Validator)

func (*Executor) UpdateStateFromResponses

func (e *Executor) UpdateStateFromResponses(resp *tmstate.ABCIResponses, state types.State, block *types.Block) (types.State, error)

UpdateStateFromResponses updates state based on the ABCIResponses.

type Manager

type Manager struct {
	// Configuration
	Conf        config.BlockManagerConfig
	Genesis     *tmtypes.GenesisDoc
	ProposerKey crypto.PrivKey

	// Store and execution
	Store     store.Store
	LastState types.State
	Executor  *Executor

	// Clients and servers
	Pubsub *pubsub.Server

	DAClient da.DataAvailabilityLayerClient
	SLClient settlement.LayerI

	// Data retrieval
	Retriever da.BatchRetriever

	SyncTargetDiode diodes.Diode
	SyncTarget      atomic.Uint64
	// contains filtered or unexported fields
}

Manager is responsible for aggregating transactions into blocks.

func NewManager

func NewManager(
	proposerKey crypto.PrivKey,
	conf config.BlockManagerConfig,
	genesis *tmtypes.GenesisDoc,
	store store.Store,
	mempool mempool.Mempool,
	proxyApp proxy.AppConns,
	dalc da.DataAvailabilityLayerClient,
	settlementClient settlement.LayerI,
	eventBus *tmtypes.EventBus,
	pubsub *pubsub.Server,
	p2pClient *p2p.Client,
	logger types.Logger,
) (*Manager, error)

NewManager creates new block Manager.

func (*Manager) CreateNextDABatch

func (m *Manager) CreateNextDABatch(startHeight uint64, endHeight uint64) (*types.Batch, error)

func (*Manager) HandleSubmissionTrigger

func (m *Manager) HandleSubmissionTrigger(ctx context.Context) error

HandleSubmissionTrigger processes the submission trigger event. It checks if there are new blocks produced since the last submission. If there are, it attempts to submit a batch of blocks. It then attempts to produce an empty block to ensure IBC messages pass through during the batch submission process due to proofs requires for ibc messages only exist on the next block. Finally, it submits the next batch of blocks and updates the sync target to the height of the last block in the submitted batch.

func (*Manager) ProcessNextDABatch

func (m *Manager) ProcessNextDABatch(daMetaData *da.DASubmitMetaData) error

func (*Manager) ProduceAndGossipBlock

func (m *Manager) ProduceAndGossipBlock(ctx context.Context, allowEmpty bool) error

func (*Manager) ProduceBlockLoop

func (m *Manager) ProduceBlockLoop(ctx context.Context)

ProduceBlockLoop is calling publishBlock in a loop as long as we're synced.

func (*Manager) RetrieveLoop

func (m *Manager) RetrieveLoop(ctx context.Context)

RetrieveLoop listens for new sync messages written to a ring buffer and in turn runs syncUntilTarget on the latest message in the ring buffer.

func (*Manager) RunInitChain

func (m *Manager) RunInitChain(ctx context.Context) error

func (*Manager) Start

func (m *Manager) Start(ctx context.Context, isAggregator bool) error

Start starts the block manager.

func (*Manager) SubmitLoop

func (m *Manager) SubmitLoop(ctx context.Context)

func (*Manager) SyncTargetLoop

func (m *Manager) SyncTargetLoop(ctx context.Context)

SyncTargetLoop is responsible for getting real time updates about batches submission. for non aggregator: updating the sync target which will be used by retrieveLoop to sync until this target.

func (*Manager) UpdateStateFromApp

func (m *Manager) UpdateStateFromApp() error

UpdateStateFromApp is responsible for aligning the state of the store from the abci app

func (*Manager) UpdateSyncParams

func (m *Manager) UpdateSyncParams(endHeight uint64)

UpdateSyncParams updates the sync target and state index if necessary

func (*Manager) ValidateBatch

func (m *Manager) ValidateBatch(batch *types.Batch) error

type PendingBatch

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