common

Documentation

Overview

The common package contains types used by multiple mini-protocols

Index

• type Point
  • func NewPoint(slot uint64, blockHash []byte) Point
  • func NewPointOrigin() Point
  • func (p *Point) MarshalCBOR() ([]byte, error)
  • func (p *Point) UnmarshalCBOR(data []byte) error

Types

type Point

type Point struct {
	Slot uint64
	Hash []byte
	// contains filtered or unexported fields
}

The Point type represents a point on the blockchain. It consists of a slot number and block hash

func NewPoint

func NewPoint(slot uint64, blockHash []byte) Point

NewPoint returns a Point object with the specified slot number and block hash

func NewPointOrigin

func NewPointOrigin() Point

NewPointOrigin returns an "empty" Point object which represents the origin of the blockchain

func (*Point) MarshalCBOR

func (p *Point) MarshalCBOR() ([]byte, error)

MarshalCBOR is a helper function for encoding a Point object to CBOR. The object content can vary, so we need to do some special handling when encoding. It is not intended to be called directly.

func (*Point) UnmarshalCBOR

func (p *Point) UnmarshalCBOR(data []byte) error

UnmarshalCBOR is a helper function for decoding a Point object from CBOR. The object content can vary, so we need to do some special handling when decoding. It is not intended to be called directly.