mesh

Documentation

Overview

Package mesh defines the main store point for all the persisted mesh objects such as ATXs, ballots and blocks.

Index

• Variables
• type Executor
  • func NewExecutor(db sql.Executor, atxsdata *atxsdata.Data, vm vmState, cs conservativeState, ...) *Executor
  • func (e *Executor) Execute(ctx context.Context, lid types.LayerID, block *types.Block) error
  • func (e *Executor) ExecuteOptimistic(ctx context.Context, lid types.LayerID, tickHeight uint64, ...) (*types.Block, error)
  • func (e *Executor) Revert(ctx context.Context, revertTo types.LayerID) error
• type MalfeasanceHandler
  • func NewMalfeasanceHandler(db sql.Executor, edVerifier *signing.EdVerifier, opt ...MalfeasanceOpt) *MalfeasanceHandler
  • func (mh *MalfeasanceHandler) ReportInvalidProof(numInvalidProofs *prometheus.CounterVec)
  • func (mh *MalfeasanceHandler) ReportProof(numProofs *prometheus.CounterVec)
  • func (mh *MalfeasanceHandler) Validate(ctx context.Context, data wire.ProofData) (types.NodeID, error)
• type MalfeasanceOpt
  • func WithMalfeasanceLogger(logger *zap.Logger) MalfeasanceOpt
• type Mesh
  • func NewMesh(db *sql.Database, atxsdata *atxsdata.Data, c layerClock, trtl system.Tortoise, ...) (*Mesh, error)
  • func (msh *Mesh) AddBallot(ctx context.Context, ballot *types.Ballot) (*wire.MalfeasanceProof, error)
  • func (msh *Mesh) AddBlockWithTXs(ctx context.Context, block *types.Block) error
  • func (msh *Mesh) AddTXsFromProposal(ctx context.Context, layerID types.LayerID, proposalID types.ProposalID, ...) error
  • func (msh *Mesh) GetLayer(lid types.LayerID) (*types.Layer, error)
  • func (msh *Mesh) GetLayerVerified(lid types.LayerID) (*types.Block, error)
  • func (msh *Mesh) GetRewardsByCoinbase(coinbase types.Address) ([]*types.Reward, error)
  • func (msh *Mesh) GetRewardsBySmesherId(smesherID types.NodeID) ([]*types.Reward, error)
  • func (msh *Mesh) LastVerified() types.LayerID
  • func (msh *Mesh) LatestLayer() types.LayerID
  • func (msh *Mesh) LatestLayerInState() types.LayerID
  • func (msh *Mesh) MeshHash(lid types.LayerID) (types.Hash32, error)
  • func (msh *Mesh) MissingBlocks() <-chan []types.BlockID
  • func (msh *Mesh) ProcessLayer(ctx context.Context, lid types.LayerID) error
  • func (msh *Mesh) ProcessLayerPerHareOutput(ctx context.Context, layerID types.LayerID, blockID types.BlockID, ...) error
  • func (msh *Mesh) ProcessedLayer() types.LayerID
  • func (msh *Mesh) SetZeroBlockLayer(ctx context.Context, lid types.LayerID)
• type MissingBlocksError
  • func (e *MissingBlocksError) Error() string

Variables

var (
	ErrLayerNotInOrder = errors.New("layers not applied in order")
	ErrLayerApplied    = errors.New("layer already applied")
)

Types

type Executor

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

func NewExecutor

func NewExecutor(db sql.Executor, atxsdata *atxsdata.Data, vm vmState, cs conservativeState, lg log.Log) *Executor

func (*Executor) Execute

func (e *Executor) Execute(ctx context.Context, lid types.LayerID, block *types.Block) error

Execute transactions in the specified block and update the conservative cache.

func (*Executor) ExecuteOptimistic

func (e *Executor) ExecuteOptimistic(
	ctx context.Context,
	lid types.LayerID,
	tickHeight uint64,
	rewards []types.AnyReward,
	tids []types.TransactionID,
) (*types.Block, error)

ExecuteOptimistic executes the specified transactions and returns a block that contains only successfully executed transactions.

func (*Executor) Revert

func (e *Executor) Revert(ctx context.Context, revertTo types.LayerID) error

Revert reverts the VM state and conservative cache to the given layer.

type MalfeasanceHandler

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

func NewMalfeasanceHandler

func NewMalfeasanceHandler(
	db sql.Executor,
	edVerifier *signing.EdVerifier,
	opt ...MalfeasanceOpt,
) *MalfeasanceHandler

func (*MalfeasanceHandler) ReportInvalidProof

func (mh *MalfeasanceHandler) ReportInvalidProof(numInvalidProofs *prometheus.CounterVec)

func (*MalfeasanceHandler) ReportProof

func (mh *MalfeasanceHandler) ReportProof(numProofs *prometheus.CounterVec)

func (*MalfeasanceHandler) Validate

func (mh *MalfeasanceHandler) Validate(ctx context.Context, data wire.ProofData) (types.NodeID, error)

type MalfeasanceOpt

type MalfeasanceOpt func(*MalfeasanceHandler)

func WithMalfeasanceLogger

func WithMalfeasanceLogger(logger *zap.Logger) MalfeasanceOpt

type Mesh

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

Mesh is the logic layer above our mesh.DB database.

func NewMesh

func NewMesh(
	db *sql.Database,
	atxsdata *atxsdata.Data,
	c layerClock,
	trtl system.Tortoise,
	exec *Executor,
	state conservativeState,
	logger log.Log,
) (*Mesh, error)

NewMesh creates a new instant of a mesh.

func (*Mesh) AddBallot

func (msh *Mesh) AddBallot(
	ctx context.Context,
	ballot *types.Ballot,
) (*wire.MalfeasanceProof, error)

AddBallot to the mesh.

func (*Mesh) AddBlockWithTXs

func (msh *Mesh) AddBlockWithTXs(ctx context.Context, block *types.Block) error

AddBlockWithTXs adds the block and its TXs in into the database.

func (*Mesh) AddTXsFromProposal

func (msh *Mesh) AddTXsFromProposal(
	ctx context.Context,
	layerID types.LayerID,
	proposalID types.ProposalID,
	txIDs []types.TransactionID,
) error

AddTXsFromProposal adds the TXs in a Proposal into the database.

func (*Mesh) GetLayer

func (msh *Mesh) GetLayer(lid types.LayerID) (*types.Layer, error)

GetLayer returns GetLayer i from the database.

func (*Mesh) GetLayerVerified

func (msh *Mesh) GetLayerVerified(lid types.LayerID) (*types.Block, error)

GetLayerVerified returns the verified, canonical block for a layer (or none for an empty layer).

func (*Mesh) GetRewardsByCoinbase

func (msh *Mesh) GetRewardsByCoinbase(coinbase types.Address) ([]*types.Reward, error)

GetRewardsByCoinbase retrieves account's rewards by the coinbase address.

func (*Mesh) GetRewardsBySmesherId

func (msh *Mesh) GetRewardsBySmesherId(smesherID types.NodeID) ([]*types.Reward, error)

GetRewardsBySmesherId retrieves account's rewards by the smesher ID.

func (*Mesh) LastVerified

func (msh *Mesh) LastVerified() types.LayerID

LastVerified returns the latest layer verified by tortoise.

func (*Mesh) LatestLayer

func (msh *Mesh) LatestLayer() types.LayerID

LatestLayer - returns the latest layer we saw from the network.

func (*Mesh) LatestLayerInState

func (msh *Mesh) LatestLayerInState() types.LayerID

LatestLayerInState returns the latest layer we applied to state.

func (*Mesh) MeshHash

func (msh *Mesh) MeshHash(lid types.LayerID) (types.Hash32, error)

MeshHash returns the aggregated mesh hash at the specified layer.

func (*Mesh) MissingBlocks

func (msh *Mesh) MissingBlocks() <-chan []types.BlockID

MissingBlocks returns single consumer channel. Consumer by contract is responsible for downloading missing blocks.

func (*Mesh) ProcessLayer

func (msh *Mesh) ProcessLayer(ctx context.Context, lid types.LayerID) error

ProcessLayer reads latest consensus results and ensures that vm state is consistent with results. It is safe to call after optimistically executing the block.

func (*Mesh) ProcessLayerPerHareOutput

func (msh *Mesh) ProcessLayerPerHareOutput(
	ctx context.Context,
	layerID types.LayerID,
	blockID types.BlockID,
	executed bool,
) error

ProcessLayerPerHareOutput receives hare output once it finishes running for a given layer.

func (*Mesh) ProcessedLayer

func (msh *Mesh) ProcessedLayer() types.LayerID

ProcessedLayer returns the last processed layer ID.

func (*Mesh) SetZeroBlockLayer

func (msh *Mesh) SetZeroBlockLayer(ctx context.Context, lid types.LayerID)

SetZeroBlockLayer advances the latest layer in the network with a layer that has no data.

type MissingBlocksError

type MissingBlocksError struct {
	Blocks []types.BlockID
}

func (*MissingBlocksError) Error

func (e *MissingBlocksError) Error() string