sync

Documentation

Index

• Constants
• Variables
• func NewMetaForkDetector(rounder consensus.Rounder) (*metaForkDetector, error)
• func NewShardForkDetector(rounder consensus.Rounder) (*shardForkDetector, error)
• type ErrSignedBlock
  • func (err ErrSignedBlock) Error() string
• type MetaBootstrap
  • func NewMetaBootstrap(poolsHolder dataRetriever.MetaPoolsHolder, store dataRetriever.StorageService, ...) (*MetaBootstrap, error)
  • func (boot MetaBootstrap) AddSyncStateListener(syncStateListener func(isSyncing bool))
  • func (boot *MetaBootstrap) IsInterfaceNil() bool
  • func (boot MetaBootstrap) SetStatusHandler(handler core.AppStatusHandler) error
  • func (boot MetaBootstrap) ShouldSync() bool
  • func (boot *MetaBootstrap) StartSync()
  • func (boot *MetaBootstrap) StopSync()
  • func (boot *MetaBootstrap) SyncBlock() error
• type ShardBootstrap
  • func NewShardBootstrap(poolsHolder dataRetriever.PoolsHolder, store dataRetriever.StorageService, ...) (*ShardBootstrap, error)
  • func (boot ShardBootstrap) AddSyncStateListener(syncStateListener func(isSyncing bool))
  • func (boot *ShardBootstrap) IsInterfaceNil() bool
  • func (boot ShardBootstrap) SetStatusHandler(handler core.AppStatusHandler) error
  • func (boot ShardBootstrap) ShouldSync() bool
  • func (boot *ShardBootstrap) StartSync()
  • func (boot *ShardBootstrap) StopSync()
  • func (boot *ShardBootstrap) SyncBlock() error

Constants

const MinForkRound = uint64(0)

Variables

var ErrBlockIsNotSigned = errors.New("block is not signed")

ErrBlockIsNotSigned signals that the block is not signed

var ErrHigherNonceInBlock = errors.New("higher nonce in block")

ErrHigherNonceInBlock signals that the nonce in block is higher than what could exist in the current round

var ErrHigherRoundInBlock = errors.New("higher round in block")

ErrHigherRoundInBlock signals that the round index in block is higher than the current round of chronology

var ErrInvalidShardId = errors.New("invalid shard id")

ErrInvalidShardId signals that an invalid shard id has been provided

var ErrLowerNonceInBlock = errors.New("lower nonce in block")

ErrLowerNonceInBlock signals that the nonce in block is lower than the last check point nonce

var ErrLowerRoundInBlock = errors.New("lower round in block")

ErrLowerRoundInBlock signals that the round index in block is lower than the checkpoint round

var ErrNilHash = errors.New("nil hash")

ErrNilHash signals that a nil hash has been provided

var ErrNilHeader = errors.New("nil header")

ErrNilHeader signals that a nil header has been provided

var ErrRandomSeedNotValid = errors.New("random seed is not valid")

ErrRandomSeedNotValid signals that the random seed is not valid

var ErrRollBackBehindFinalHeader = errors.New("roll back behind final header is not permitted")

ErrRollBackBehindFinalHeader signals that a roll back behind final header has been attempted

Functions

func NewMetaForkDetector

func NewMetaForkDetector(rounder consensus.Rounder) (*metaForkDetector, error)

NewMetaForkDetector method creates a new metaForkDetector object

func NewShardForkDetector

func NewShardForkDetector(rounder consensus.Rounder) (*shardForkDetector, error)

NewShardForkDetector method creates a new shardForkDetector object

Types

type ErrSignedBlock

type ErrSignedBlock struct {
	CurrentNonce uint64
}

ErrSignedBlock signals that a block is signed

func (ErrSignedBlock) Error

func (err ErrSignedBlock) Error() string

type MetaBootstrap

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

MetaBootstrap implements the bootstrap mechanism

func NewMetaBootstrap

func NewMetaBootstrap(
	poolsHolder dataRetriever.MetaPoolsHolder,
	store dataRetriever.StorageService,
	blkc data.ChainHandler,
	rounder consensus.Rounder,
	blkExecutor process.BlockProcessor,
	waitTime time.Duration,
	hasher hashing.Hasher,
	marshalizer marshal.Marshalizer,
	forkDetector process.ForkDetector,
	resolversFinder dataRetriever.ResolversFinder,
	shardCoordinator sharding.Coordinator,
	accounts state.AccountsAdapter,
	bootstrapRoundIndex uint64,
) (*MetaBootstrap, error)

NewMetaBootstrap creates a new Bootstrap object

func (MetaBootstrap) AddSyncStateListener

func (boot MetaBootstrap) AddSyncStateListener(syncStateListener func(isSyncing bool))

AddSyncStateListener adds a syncStateListener that get notified each time the sync status of the node changes

func (*MetaBootstrap) IsInterfaceNil

func (boot *MetaBootstrap) IsInterfaceNil() bool

IsInterfaceNil returns true if there is no value under the interface

func (MetaBootstrap) SetStatusHandler

func (boot MetaBootstrap) SetStatusHandler(handler core.AppStatusHandler) error

SetStatusHandler will set the instance of the AppStatusHandler

func (MetaBootstrap) ShouldSync

func (boot MetaBootstrap) ShouldSync() bool

ShouldSync method returns the synch state of the node. If it returns 'true', this means that the node is not synchronized yet and it has to continue the bootstrapping mechanism, otherwise the node is already synched and it can participate to the consensus, if it is in the jobDone group of this rounder

func (*MetaBootstrap) StartSync

func (boot *MetaBootstrap) StartSync()

StartSync method will start SyncBlocks as a go routine

func (*MetaBootstrap) StopSync

func (boot *MetaBootstrap) StopSync()

StopSync method will stop SyncBlocks

func (*MetaBootstrap) SyncBlock

func (boot *MetaBootstrap) SyncBlock() error

SyncBlock method actually does the synchronization. It requests the next block header from the pool and if it is not found there it will be requested from the network. After the header is received, it requests the block body in the same way(pool and than, if it is not found in the pool, from network). If either header and body are received the ProcessAndCommit method will be called. This method will execute the block and its transactions. Finally if everything works, the block will be committed in the blockchain, and all this mechanism will be reiterated for the next block.

type ShardBootstrap

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

ShardBootstrap implements the bootstrap mechanism

func NewShardBootstrap

func NewShardBootstrap(
	poolsHolder dataRetriever.PoolsHolder,
	store dataRetriever.StorageService,
	blkc data.ChainHandler,
	rounder consensus.Rounder,
	blkExecutor process.BlockProcessor,
	waitTime time.Duration,
	hasher hashing.Hasher,
	marshalizer marshal.Marshalizer,
	forkDetector process.ForkDetector,
	resolversFinder dataRetriever.ResolversFinder,
	shardCoordinator sharding.Coordinator,
	accounts state.AccountsAdapter,
	bootstrapRoundIndex uint64,
) (*ShardBootstrap, error)

NewShardBootstrap creates a new Bootstrap object

func (ShardBootstrap) AddSyncStateListener

func (boot ShardBootstrap) AddSyncStateListener(syncStateListener func(isSyncing bool))

AddSyncStateListener adds a syncStateListener that get notified each time the sync status of the node changes

func (*ShardBootstrap) IsInterfaceNil

func (boot *ShardBootstrap) IsInterfaceNil() bool

IsInterfaceNil returns true if there is no value under the interface

func (ShardBootstrap) SetStatusHandler

func (boot ShardBootstrap) SetStatusHandler(handler core.AppStatusHandler) error

SetStatusHandler will set the instance of the AppStatusHandler

func (ShardBootstrap) ShouldSync

func (boot ShardBootstrap) ShouldSync() bool

ShouldSync method returns the synch state of the node. If it returns 'true', this means that the node is not synchronized yet and it has to continue the bootstrapping mechanism, otherwise the node is already synched and it can participate to the consensus, if it is in the jobDone group of this rounder

func (*ShardBootstrap) StartSync

func (boot *ShardBootstrap) StartSync()

StartSync method will start SyncBlocks as a go routine

func (*ShardBootstrap) StopSync

func (boot *ShardBootstrap) StopSync()

StopSync method will stop SyncBlocks

func (*ShardBootstrap) SyncBlock

func (boot *ShardBootstrap) SyncBlock() error

SyncBlock method actually does the synchronization. It requests the next block header from the pool and if it is not found there it will be requested from the network. After the header is received, it requests the block body in the same way(pool and than, if it is not found in the pool, from network). If either header and body are received the ProcessAndCommit method will be called. This method will execute the block and its transactions. Finally if everything works, the block will be committed in the blockchain, and all this mechanism will be reiterated for the next block.