blocksync

Documentation

Index

• type BlockByHeight
• type BlockSync
  • func NewBlockSyncer(cfg config.BlockSync, tipHeightHandler TipHeight, ...) (BlockSync, error)
  • func NewDummyBlockSyncer() BlockSync
• type CommitBlock
• type RequestBlocks
• type TipHeight

Types

type BlockByHeight

type BlockByHeight func(uint64) (*block.Block, error)

BlockByHeight returns the block of a given height

type BlockSync

type BlockSync interface {
	lifecycle.StartStopper

	// TargetHeight returns the target height to sync to
	TargetHeight() uint64
	// ProcessSyncRequest processes a block sync request
	ProcessSyncRequest(context.Context, uint64, uint64, func(context.Context, *block.Block) error) error
	// ProcessBlock processes an incoming block
	ProcessBlock(context.Context, string, *block.Block) error
	// SyncStatus report block sync status
	SyncStatus() (startingHeight uint64, currentHeight uint64, targetHeight uint64, syncSpeedDesc string)
}

BlockSync defines the interface of blocksyncer

func NewBlockSyncer

func NewBlockSyncer(
	cfg config.BlockSync,
	tipHeightHandler TipHeight,
	blockByHeightHandler BlockByHeight,
	commitBlockHandler CommitBlock,
	requestBlocksHandler RequestBlocks,
) (BlockSync, error)

NewBlockSyncer returns a new block syncer instance

func NewDummyBlockSyncer

func NewDummyBlockSyncer() BlockSync

NewDummyBlockSyncer creates a dummy BlockSync

type CommitBlock

type CommitBlock func(*block.Block) error

CommitBlock commits a block to blockchain

type RequestBlocks

type RequestBlocks func(ctx context.Context, start uint64, end uint64, repeat int)

RequestBlocks send a block request to peers

type TipHeight

type TipHeight func() uint64

TipHeight returns the tip height of blockchain