block

Documentation

Index

• Constants
• Variables
• type Block
  • func BuildOption(parentID ids.ID, innerBytes []byte) (Block, error)
  • func Parse(bytes []byte, chainID ids.ID) (Block, error)
  • func ParseWithoutVerification(bytes []byte) (Block, error)
• type Header
  • func BuildHeader(chainID ids.ID, parentID ids.ID, bodyID ids.ID) (Header, error)
  • func ParseHeader(bytes []byte) (Header, error)
• type ParseResult
  • func ParseBlocks(blks [][]byte, chainID ids.ID) []ParseResult
• type SignedBlock
  • func Build(parentID ids.ID, timestamp time.Time, pChainHeight uint64, ...) (SignedBlock, error)
  • func BuildUnsigned(parentID ids.ID, timestamp time.Time, pChainHeight uint64, blockBytes []byte) (SignedBlock, error)

Constants

const CodecVersion = 0

Variables

var Codec codec.Manager

Types

type Block

type Block interface {
	ID() ids.ID
	ParentID() ids.ID
	Block() []byte
	Bytes() []byte
	// contains filtered or unexported methods
}

func BuildOption

func BuildOption(
	parentID ids.ID,
	innerBytes []byte,
) (Block, error)

BuildOption the option block [parentID] is the ID of this option's wrapper parent block [innerBytes] is the byte representation of a child option block

func Parse

func Parse(bytes []byte, chainID ids.ID) (Block, error)

Parse a block and verify that the signature attached to the block is valid for the certificate provided in the block.

func ParseWithoutVerification

func ParseWithoutVerification(bytes []byte) (Block, error)

ParseWithoutVerification parses a block without verifying that the signature on the block is correct.

type Header

type Header interface {
	ChainID() ids.ID
	ParentID() ids.ID
	BodyID() ids.ID
	Bytes() []byte
}

func BuildHeader

func BuildHeader(
	chainID ids.ID,
	parentID ids.ID,
	bodyID ids.ID,
) (Header, error)

func ParseHeader

func ParseHeader(bytes []byte) (Header, error)

type ParseResult

type ParseResult struct {
	Block Block
	Err   error
}

func ParseBlocks

func ParseBlocks(blks [][]byte, chainID ids.ID) []ParseResult

ParseBlocks parses the given raw blocks into tuples of (Block, error). Each ParseResult is returned in the same order as its corresponding bytes in the input.

type SignedBlock

type SignedBlock interface {
	Block

	PChainHeight() uint64
	Timestamp() time.Time

	// Proposer returns the ID of the node that proposed this block. If no node
	// signed this block, [ids.EmptyNodeID] will be returned.
	Proposer() ids.NodeID
}

func Build

func Build(
	parentID ids.ID,
	timestamp time.Time,
	pChainHeight uint64,
	cert *staking.Certificate,
	blockBytes []byte,
	chainID ids.ID,
	key crypto.Signer,
) (SignedBlock, error)

func BuildUnsigned

func BuildUnsigned(
	parentID ids.ID,
	timestamp time.Time,
	pChainHeight uint64,
	blockBytes []byte,
) (SignedBlock, error)