mesh

Documentation

Overview

Package mesh defines the main store point for all the block-mesh objects such as blocks, transactions and global state

Index

• Variables
• func GenesisBlock() *types.Block
• func GenesisLayer() *types.Layer
• type AtxDB
• type AtxDbMock
  • func NewAtxDbMock() *AtxDbMock
  • func (t *AtxDbMock) AddAtx(id types.ATXID, atx *types.ActivationTx)
  • func (t *AtxDbMock) GetAtxHeader(id types.ATXID) (*types.ActivationTxHeader, error)
  • func (t *AtxDbMock) GetFullAtx(id types.ATXID) (*types.ActivationTx, error)
  • func (t *AtxDbMock) ProcessAtxs(atxs []*types.ActivationTx) error
  • func (AtxDbMock) SyntacticallyValidateAtx(*types.ActivationTx) error
• type Config
  • func DefaultMeshConfig() Config
• type DB
  • func NewMemMeshDB(log log.Log) *DB
  • func NewPersistentMeshDB(path string, blockCacheSize int, log log.Log) (*DB, error)
  • func (m *DB) AddBlock(bl *types.Block) error
  • func (m *DB) AddZeroBlockLayer(index types.LayerID) error
  • func (m *DB) BlocksByValidity(blocks []*types.Block) (validBlocks, invalidBlocks []*types.Block)
  • func (m *DB) Close()
  • func (m *DB) ContextualValidity(id types.BlockID) (bool, error)
  • func (m *DB) ContextuallyValidBlock(layer types.LayerID) (map[types.BlockID]struct{}, error)
  • func (m *DB) ForBlockInView(view map[types.BlockID]struct{}, layer types.LayerID, ...) error
  • func (m *DB) GetBlock(id types.BlockID) (*types.Block, error)
  • func (m *DB) GetProjection(addr types.Address, prevNonce, prevBalance uint64) (nonce, balance uint64, err error)
  • func (m *DB) GetRewards(account types.Address) (rewards []types.Reward, err error)
  • func (m *DB) GetTransaction(id types.TransactionID) (*types.Transaction, error)
  • func (m *DB) GetTransactions(transactions []types.TransactionID) ([]*types.Transaction, map[types.TransactionID]struct{})
  • func (m *DB) GetTransactionsByDestination(l types.LayerID, account types.Address) (txs []types.TransactionID)
  • func (m *DB) GetTransactionsByOrigin(l types.LayerID, account types.Address) (txs []types.TransactionID)
  • func (m *DB) LayerBlockIds(index types.LayerID) ([]types.BlockID, error)
  • func (m *DB) LayerBlocks(index types.LayerID) ([]*types.Block, error)
  • func (m *DB) Persist(key []byte, v interface{}) error
  • func (m *DB) PersistentData() bool
  • func (m *DB) Retrieve(key []byte, v interface{}) (interface{}, error)
  • func (m *DB) SaveContextualValidity(id types.BlockID, valid bool) error
  • func (m *DB) WriteTransaction(l types.LayerID, t *types.Transaction) error
• type Mesh
  • func NewMesh(db *DB, atxDb AtxDB, rewardConfig Config, mesh tortoise, ...) *Mesh
  • func NewRecoveredMesh(db *DB, atxDb AtxDB, rewardConfig Config, mesh tortoise, ...) *Mesh
  • func (msh *Mesh) AddBlock(blk *types.Block) error
  • func (msh *Mesh) AddBlockWithTxs(blk *types.Block) error
  • func (msh *Mesh) CacheWarmUp(layerSize int)
  • func (msh *Mesh) GetATXs(atxIds []types.ATXID) (map[types.ATXID]*types.ActivationTx, []types.ATXID)
  • func (msh *Mesh) GetLayer(i types.LayerID) (*types.Layer, error)
  • func (msh *Mesh) GetOrphanBlocksBefore(l types.LayerID) ([]types.BlockID, error)
  • func (msh *Mesh) GetProcessedLayer(i types.LayerID) (*types.Layer, error)
  • func (msh *Mesh) HandleValidatedLayer(validatedLayer types.LayerID, layer []types.BlockID)
  • func (msh *Mesh) LatestLayer() types.LayerID
  • func (msh *Mesh) LatestLayerInState() types.LayerID
  • func (msh *Mesh) SetLatestLayer(idx types.LayerID)
  • func (msh *Mesh) SetZeroBlockLayer(lyr types.LayerID) error
  • func (msh *Mesh) StoreTransactionsFromPool(blk *types.Block) error
• type Validator

Variables

var ErrAlreadyExist = errors.New("block already exist in database")

ErrAlreadyExist error returned when adding an existing value to the database

var TORTOISE = []byte("tortoise")

TORTOISE key for tortoise persistence in database

var VERIFIED = []byte("verified")

VERIFIED refers to layers we pushed into the state

Functions

func GenesisBlock

func GenesisBlock() *types.Block

GenesisBlock is a is the first static block that xists at the beginning of each network. it exist one layer before actual blocks could be created

func GenesisLayer

func GenesisLayer() *types.Layer

GenesisLayer generates layer 0 should be removed after the genesis flow is implemented

Types

type AtxDB

type AtxDB interface {
	ProcessAtxs(atxs []*types.ActivationTx) error
	GetAtxHeader(id types.ATXID) (*types.ActivationTxHeader, error)
	GetFullAtx(id types.ATXID) (*types.ActivationTx, error)
	SyntacticallyValidateAtx(atx *types.ActivationTx) error
}

AtxDB holds logic for working with atxs

type AtxDbMock

type AtxDbMock struct {
	ProcCnt int
	// contains filtered or unexported fields
}

AtxDbMock is a mock of an activation DB

func NewAtxDbMock

func NewAtxDbMock() *AtxDbMock

NewAtxDbMock returns a new AtxDbMock

func (*AtxDbMock) AddAtx

func (t *AtxDbMock) AddAtx(id types.ATXID, atx *types.ActivationTx)

AddAtx stores an ATX for later retrieval

func (*AtxDbMock) GetAtxHeader

func (t *AtxDbMock) GetAtxHeader(id types.ATXID) (*types.ActivationTxHeader, error)

GetAtxHeader returns a new ActivationTxHeader

func (*AtxDbMock) GetFullAtx

func (t *AtxDbMock) GetFullAtx(id types.ATXID) (*types.ActivationTx, error)

GetFullAtx returns a full ATX

func (*AtxDbMock) ProcessAtxs

func (t *AtxDbMock) ProcessAtxs(atxs []*types.ActivationTx) error

ProcessAtxs counts how many ATXs were processed

func (AtxDbMock) SyntacticallyValidateAtx

func (AtxDbMock) SyntacticallyValidateAtx(*types.ActivationTx) error

SyntacticallyValidateAtx always returns no error

type Config

type Config struct {
	BaseReward *big.Int `mapstructure:"base-reward"`
}

Config defines the configuration options for Spacemesh rewards.

func DefaultMeshConfig

func DefaultMeshConfig() Config

DefaultMeshConfig returns the default Config.

type DB

type DB struct {
	log.Log
	// contains filtered or unexported fields
}

DB represents a mesh database instance

func NewMemMeshDB

func NewMemMeshDB(log log.Log) *DB

NewMemMeshDB is a mock used for testing

func NewPersistentMeshDB

func NewPersistentMeshDB(path string, blockCacheSize int, log log.Log) (*DB, error)

NewPersistentMeshDB creates an instance of a mesh database

func (*DB) AddBlock

func (m *DB) AddBlock(bl *types.Block) error

AddBlock adds a block to the database

func (*DB) AddZeroBlockLayer

func (m *DB) AddZeroBlockLayer(index types.LayerID) error

AddZeroBlockLayer tags lyr as a layer without blocks

func (*DB) BlocksByValidity

func (m *DB) BlocksByValidity(blocks []*types.Block) (validBlocks, invalidBlocks []*types.Block)

BlocksByValidity classifies a slice of blocks by validity

func (*DB) Close

func (m *DB) Close()

Close closes all resources

func (*DB) ContextualValidity

func (m *DB) ContextualValidity(id types.BlockID) (bool, error)

ContextualValidity retrieves opinion on block from the database

func (*DB) ContextuallyValidBlock

func (m *DB) ContextuallyValidBlock(layer types.LayerID) (map[types.BlockID]struct{}, error)

ContextuallyValidBlock - returns the contextually valid blocks for the provided layer

func (*DB) ForBlockInView

func (m *DB) ForBlockInView(view map[types.BlockID]struct{}, layer types.LayerID, blockHandler func(block *types.Block) (bool, error)) error

ForBlockInView traverses all blocks in a view and uses blockHandler func on each block The block handler func should return two values - a bool indicating whether or not we should stop traversing after the current block (happy flow) and an error indicating that an error occurred while handling the block, the traversing will stop in that case as well (error flow)

func (*DB) GetBlock

func (m *DB) GetBlock(id types.BlockID) (*types.Block, error)

GetBlock gets a block from the database by id

func (*DB) GetProjection

func (m *DB) GetProjection(addr types.Address, prevNonce, prevBalance uint64) (nonce, balance uint64, err error)

GetProjection returns projection of address

func (*DB) GetRewards

func (m *DB) GetRewards(account types.Address) (rewards []types.Reward, err error)

GetRewards retrieves account's rewards by address

func (*DB) GetTransaction

func (m *DB) GetTransaction(id types.TransactionID) (*types.Transaction, error)

GetTransaction retrieves a tx by its id

func (*DB) GetTransactions

func (m *DB) GetTransactions(transactions []types.TransactionID) ([]*types.Transaction, map[types.TransactionID]struct{})

GetTransactions retrieves a list of txs by their id's

func (*DB) GetTransactionsByDestination

func (m *DB) GetTransactionsByDestination(l types.LayerID, account types.Address) (txs []types.TransactionID)

GetTransactionsByDestination retrieves txs by destination and layer

func (*DB) GetTransactionsByOrigin

func (m *DB) GetTransactionsByOrigin(l types.LayerID, account types.Address) (txs []types.TransactionID)

GetTransactionsByOrigin retrieves txs by origin and layer

func (*DB) LayerBlockIds

func (m *DB) LayerBlockIds(index types.LayerID) ([]types.BlockID, error)

LayerBlockIds retrieves all block ids from a layer by layer index

func (*DB) LayerBlocks

func (m *DB) LayerBlocks(index types.LayerID) ([]*types.Block, error)

LayerBlocks retrieves all blocks from a layer by layer index

func (*DB) Persist

func (m *DB) Persist(key []byte, v interface{}) error

Persist persists an item v into the database using key as its id

func (*DB) PersistentData

func (m *DB) PersistentData() bool

PersistentData checks to see if db is empty

func (*DB) Retrieve

func (m *DB) Retrieve(key []byte, v interface{}) (interface{}, error)

Retrieve retrieves item by key into v

func (*DB) SaveContextualValidity

func (m *DB) SaveContextualValidity(id types.BlockID, valid bool) error

SaveContextualValidity persists opinion on block to the database

func (*DB) WriteTransaction

func (m *DB) WriteTransaction(l types.LayerID, t *types.Transaction) error

WriteTransaction writes a single transaction to the db

type Mesh

type Mesh struct {
	log.Log
	*DB
	AtxDB

	Validator
	// contains filtered or unexported fields
}

Mesh is the logic layer above our mesh.DB database

func NewMesh

func NewMesh(db *DB, atxDb AtxDB, rewardConfig Config, mesh tortoise, txInvalidator txMemPool, pr txProcessor, logger log.Log) *Mesh

NewMesh creates a new instant of a mesh

func NewRecoveredMesh

func NewRecoveredMesh(db *DB, atxDb AtxDB, rewardConfig Config, mesh tortoise, txInvalidator txMemPool, pr txProcessor, logger log.Log) *Mesh

NewRecoveredMesh creates new instance of mesh with recovered mesh data fom database

func (*Mesh) AddBlock

func (msh *Mesh) AddBlock(blk *types.Block) error

AddBlock adds a block to the database ignoring the block txs/atxs ***USED ONLY FOR TESTS***

func (*Mesh) AddBlockWithTxs

func (msh *Mesh) AddBlockWithTxs(blk *types.Block) error

AddBlockWithTxs adds a block to the database blk - the block to add txs - block txs that we dont have in our tx database yet

func (*Mesh) CacheWarmUp

func (msh *Mesh) CacheWarmUp(layerSize int)

CacheWarmUp warms up cache with latest blocks

func (*Mesh) GetATXs

func (msh *Mesh) GetATXs(atxIds []types.ATXID) (map[types.ATXID]*types.ActivationTx, []types.ATXID)

GetATXs uses GetFullAtx to return a list of atxs corresponding to atxIds requested

func (*Mesh) GetLayer

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

GetLayer returns Layer i from the database

func (*Mesh) GetOrphanBlocksBefore

func (msh *Mesh) GetOrphanBlocksBefore(l types.LayerID) ([]types.BlockID, error)

GetOrphanBlocksBefore returns all known orphan blocks with layerID < l

func (*Mesh) GetProcessedLayer

func (msh *Mesh) GetProcessedLayer(i types.LayerID) (*types.Layer, error)

GetProcessedLayer returns a layer only if it has already been processed

func (*Mesh) HandleValidatedLayer

func (msh *Mesh) HandleValidatedLayer(validatedLayer types.LayerID, layer []types.BlockID)

HandleValidatedLayer handles layer valid blocks as decided by hare

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

func (msh *Mesh) SetLatestLayer(idx types.LayerID)

SetLatestLayer sets the latest layer we saw from the network

func (*Mesh) SetZeroBlockLayer

func (msh *Mesh) SetZeroBlockLayer(lyr types.LayerID) error

SetZeroBlockLayer tags lyr as a layer without blocks

func (*Mesh) StoreTransactionsFromPool

func (msh *Mesh) StoreTransactionsFromPool(blk *types.Block) error

StoreTransactionsFromPool takes declared txs from provided block blk and writes them to DB. it then invalidates the transactions from txpool

type Validator

type Validator interface {
	ValidateLayer(layer *types.Layer)
	HandleLateBlock(bl *types.Block)
	ProcessedLayer() types.LayerID
	SetProcessedLayer(lyr types.LayerID)
}

Validator interface to be used in tests to mock validation flow