blockchain

Documentation

Overview

Package blockchain provides two implementations of the fast-sync protocol.

- v0 was the very first implementation. it's battle tested, but does not have a lot of test coverage. - v2 is the newest implementation, with a focus on testability and readability.

Check out ADR-40 for the formal model and requirements.

Termination criteria

1. the maximum peer height is reached 2. termination timeout is triggered, which is set if the peer set is empty or there are no pending requests.

Index

• Constants
• func DecodeMsg(bz []byte) (proto.Message, error)
• func EncodeMsg(pb proto.Message) ([]byte, error)
• func ValidateMsg(pb proto.Message) error

Constants

const (
	// NOTE: keep up to date with bcproto.BlockResponse
	BlockResponseMessagePrefixSize   = 4
	BlockResponseMessageFieldKeySize = 1
	MaxMsgSize                       = types.MaxBlockSizeBytes +
		BlockResponseMessagePrefixSize +
		BlockResponseMessageFieldKeySize
)

Functions

func DecodeMsg

func DecodeMsg(bz []byte) (proto.Message, error)

DecodeMsg decodes a Protobuf message.

func EncodeMsg

func EncodeMsg(pb proto.Message) ([]byte, error)

EncodeMsg encodes a Protobuf message

func ValidateMsg

func ValidateMsg(pb proto.Message) error

ValidateMsg validates a message.