legacysync

Documentation

Index

• Constants
• Variables
• func CompareBlockByHash(a *types.Block, b *types.Block) int
• func CompareSyncPeerConfigByblockHashes(a *SyncPeerConfig, b *SyncPeerConfig) int
• func GetHowManyMaxConsensus(blocks []*types.Block) (int, int)
• func GetSyncingPort(nodePort string) string
• func RlpDecodeBlockOrBlockWithSig(payload []byte) (*types.Block, error)
• type BlockWithSig
• type StateSync
  • func CreateStateSync(bc *core.BlockChain, ip string, port string, peerHash [20]byte, ...) *StateSync
  • func (ss *StateSync) AddLastMileBlock(block *types.Block)
  • func (ss *StateSync) AddNewBlock(peerHash []byte, block *types.Block)
  • func (ss *StateSync) CreateSyncConfig(peers []p2p.Peer, isBeacon bool) error
  • func (ss *StateSync) GetActivePeerNumber() int
  • func (ss *StateSync) GetMaxPeerHeight() uint64
  • func (ss *StateSync) GetSyncStatus() SyncCheckResult
  • func (ss *StateSync) GetSyncStatusDoubleChecked() SyncCheckResult
  • func (ss *StateSync) IsSameBlockchainHeight(bc *core.BlockChain) (uint64, bool)
  • func (ss *StateSync) ProcessStateSync(startHash []byte, size uint32, bc *core.BlockChain, worker *worker.Worker) error
  • func (ss *StateSync) RegisterNodeInfo() int
  • func (ss *StateSync) SyncLoop(bc *core.BlockChain, worker *worker.Worker, isBeacon bool, ...)
  • func (ss *StateSync) UpdateBlockAndStatus(block *types.Block, bc *core.BlockChain, verifyAllSig bool) error
• type SyncBlockTask
• type SyncCheckResult
• type SyncConfig
  • func (sc *SyncConfig) AddPeer(peer *SyncPeerConfig)
  • func (sc *SyncConfig) CloseConnections()
  • func (sc *SyncConfig) FindPeerByHash(peerHash []byte) *SyncPeerConfig
  • func (sc *SyncConfig) ForEachPeer(f func(peer *SyncPeerConfig) (brk bool))
  • func (sc *SyncConfig) GetBlockHashesConsensusAndCleanUp() error
  • func (sc *SyncConfig) InitForTesting(client *downloader.Client, blockHashes [][]byte)
  • func (sc *SyncConfig) RemovePeer(peer *SyncPeerConfig)
• type SyncPeerConfig
  • func CreateTestSyncPeerConfig(client *downloader.Client, blockHashes [][]byte) *SyncPeerConfig
  • func (peerConfig *SyncPeerConfig) GetBlocks(hashes [][]byte) ([][]byte, error)
  • func (peerConfig *SyncPeerConfig) GetClient() *downloader.Client
  • func (peerConfig *SyncPeerConfig) IsEqual(pc2 *SyncPeerConfig) bool

Constants

const (
	RegistrationNumber    = 3
	SyncingPortDifference = 3000

	SyncLoopBatchSize uint32 = 30 // maximum size for one query of block hashes

	LastMileBlocksSize = 50

	// after cutting off a number of connected peers, the result number of peers
	// shall be between numPeersLowBound and numPeersHighBound
	NumPeersLowBound = 3
)

Constants for syncing.

Variables

var (
	ErrRegistrationFail      = errors.New("[SYNC]: registration failed")
	ErrGetBlock              = errors.New("[SYNC]: get block failed")
	ErrGetBlockHash          = errors.New("[SYNC]: get blockhash failed")
	ErrProcessStateSync      = errors.New("[SYNC]: get blockhash failed")
	ErrGetConsensusHashes    = errors.New("[SYNC]: get consensus hashes failed")
	ErrGenStateSyncTaskQueue = errors.New("[SYNC]: generate state sync task queue failed")
	ErrDownloadBlocks        = errors.New("[SYNC]: get download blocks failed")
	ErrUpdateBlockAndStatus  = errors.New("[SYNC]: update block and status failed")
	ErrGenerateNewState      = errors.New("[SYNC]: get generate new state failed")
)

Errors ...

Functions

func CompareBlockByHash

func CompareBlockByHash(a *types.Block, b *types.Block) int

CompareBlockByHash compares two block by hash, it will be used in sort the blocks

func CompareSyncPeerConfigByblockHashes

func CompareSyncPeerConfigByblockHashes(a *SyncPeerConfig, b *SyncPeerConfig) int

CompareSyncPeerConfigByblockHashes compares two SyncPeerConfig by blockHashes.

func GetHowManyMaxConsensus

func GetHowManyMaxConsensus(blocks []*types.Block) (int, int)

GetHowManyMaxConsensus will get the most common blocks and the first such blockID

func GetSyncingPort

func GetSyncingPort(nodePort string) string

GetSyncingPort returns the syncing port.

func RlpDecodeBlockOrBlockWithSig

func RlpDecodeBlockOrBlockWithSig(payload []byte) (*types.Block, error)

RlpDecodeBlockOrBlockWithSig decode payload to types.Block or BlockWithSig. Return the block with commitSig if set.

Types

type BlockWithSig

type BlockWithSig struct {
	Block              *types.Block
	CommitSigAndBitmap []byte
}

BlockWithSig the serialization structure for request DownloaderRequest_BLOCKWITHSIG The block is encoded as block + commit signature

type StateSync

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

StateSync is the struct that implements StateSyncInterface.

func CreateStateSync

func CreateStateSync(bc *core.BlockChain, ip string, port string, peerHash [20]byte, isExplorer bool, role nodeconfig.Role) *StateSync

CreateStateSync returns the implementation of StateSyncInterface interface.

func (*StateSync) AddLastMileBlock

func (ss *StateSync) AddLastMileBlock(block *types.Block)

AddLastMileBlock add the latest a few block into queue for syncing only keep the latest blocks with size capped by LastMileBlocksSize

func (*StateSync) AddNewBlock

func (ss *StateSync) AddNewBlock(peerHash []byte, block *types.Block)

AddNewBlock will add newly received block into state syncing queue

func (*StateSync) CreateSyncConfig

func (ss *StateSync) CreateSyncConfig(peers []p2p.Peer, isBeacon bool) error

CreateSyncConfig creates SyncConfig for StateSync object.

func (*StateSync) GetActivePeerNumber

func (ss *StateSync) GetActivePeerNumber() int

GetActivePeerNumber returns the number of active peers

func (*StateSync) GetMaxPeerHeight

func (ss *StateSync) GetMaxPeerHeight() uint64

GetMaxPeerHeight ..

func (*StateSync) GetSyncStatus

func (ss *StateSync) GetSyncStatus() SyncCheckResult

GetSyncStatus get the last sync status for other modules (E.g. RPC, explorer). If the last sync result is not expired, return the sync result immediately. If the last result is expired, ask the remote DNS nodes for latest height and return the result.

func (*StateSync) GetSyncStatusDoubleChecked

func (ss *StateSync) GetSyncStatusDoubleChecked() SyncCheckResult

GetSyncStatusDoubleChecked return the sync status when enforcing a immediate query on DNS nodes with a double check to avoid false alarm.

func (*StateSync) IsSameBlockchainHeight

func (ss *StateSync) IsSameBlockchainHeight(bc *core.BlockChain) (uint64, bool)

IsSameBlockchainHeight checks whether the node is out of sync from other peers

func (*StateSync) ProcessStateSync

func (ss *StateSync) ProcessStateSync(startHash []byte, size uint32, bc *core.BlockChain, worker *worker.Worker) error

ProcessStateSync processes state sync from the blocks received but not yet processed so far

func (*StateSync) RegisterNodeInfo

func (ss *StateSync) RegisterNodeInfo() int

RegisterNodeInfo will register node to peers to accept future new block broadcasting return number of successful registration

func (*StateSync) SyncLoop

func (ss *StateSync) SyncLoop(bc *core.BlockChain, worker *worker.Worker, isBeacon bool, consensus *consensus.Consensus)

SyncLoop will keep syncing with peers until catches up

func (*StateSync) UpdateBlockAndStatus

func (ss *StateSync) UpdateBlockAndStatus(block *types.Block, bc *core.BlockChain, verifyAllSig bool) error

UpdateBlockAndStatus ...

type SyncBlockTask

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

SyncBlockTask is the task struct to sync a specific block.

type SyncCheckResult

type SyncCheckResult struct {
	IsInSync    bool
	OtherHeight uint64
	HeightDiff  uint64
}

type SyncConfig

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

SyncConfig contains an array of SyncPeerConfig.

func (*SyncConfig) AddPeer

func (sc *SyncConfig) AddPeer(peer *SyncPeerConfig)

AddPeer adds the given sync peer.

func (*SyncConfig) CloseConnections

func (sc *SyncConfig) CloseConnections()

CloseConnections close grpc connections for state sync clients

func (*SyncConfig) FindPeerByHash

func (sc *SyncConfig) FindPeerByHash(peerHash []byte) *SyncPeerConfig

FindPeerByHash returns the peer with the given hash, or nil if not found.

func (*SyncConfig) ForEachPeer

func (sc *SyncConfig) ForEachPeer(f func(peer *SyncPeerConfig) (brk bool))

ForEachPeer calls the given function with each peer. It breaks the iteration iff the function returns true.

func (*SyncConfig) GetBlockHashesConsensusAndCleanUp

func (sc *SyncConfig) GetBlockHashesConsensusAndCleanUp() error

GetBlockHashesConsensusAndCleanUp selects the most common peer config based on their block hashes to download/sync. Note that choosing the most common peer config does not guarantee that the blocks to be downloaded are the correct ones. The subsequent node syncing steps of verifying the block header chain will give such confirmation later. If later block header verification fails with the sync peer config chosen here, the entire sync loop gets retried with a new peer set.

func (*SyncConfig) InitForTesting

func (sc *SyncConfig) InitForTesting(client *downloader.Client, blockHashes [][]byte)

InitForTesting used for testing.

func (*SyncConfig) RemovePeer

func (sc *SyncConfig) RemovePeer(peer *SyncPeerConfig)

RemovePeer removes a peer from SyncConfig

type SyncPeerConfig

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

SyncPeerConfig is peer config to sync.

func CreateTestSyncPeerConfig

func CreateTestSyncPeerConfig(client *downloader.Client, blockHashes [][]byte) *SyncPeerConfig

CreateTestSyncPeerConfig used for testing.

func (*SyncPeerConfig) GetBlocks

func (peerConfig *SyncPeerConfig) GetBlocks(hashes [][]byte) ([][]byte, error)

GetBlocks gets blocks by calling grpc request to the corresponding peer.

func (*SyncPeerConfig) GetClient

func (peerConfig *SyncPeerConfig) GetClient() *downloader.Client

GetClient returns client pointer of downloader.Client

func (*SyncPeerConfig) IsEqual

func (peerConfig *SyncPeerConfig) IsEqual(pc2 *SyncPeerConfig) bool

IsEqual checks the equality between two sync peers