header

Documentation

Index

• Variables
• func AddSupportToChooser(existing traversal.LinkTargetNodePrototypeChooser) traversal.LinkTargetNodePrototypeChooser
• func AppendEncode(enc []byte, inNode ipld.Node) ([]byte, error)
• func Decode(na ipld.NodeAssembler, in io.Reader) error
• func DecodeBytes(na ipld.NodeAssembler, src []byte) error
• func DecodeHeader(na ipld.NodeAssembler, hp types.Header) error
• func Decoder(na ipld.NodeAssembler, r io.Reader) error
• func Encode(node ipld.Node, w io.Writer) error
• func EncodeHeader(header *types.Header, inNode ipld.Node) error
• func Encoder(inNode ipld.Node, w io.Writer) error
• func Marshal(inNode ipld.Node, w io.Writer) error
• func Unmarshal(na ipld.NodeAssembler, r io.Reader) error

Variables

var (
	MultiCodecType = uint64(cid.DagCBOR) // TODO: replace this with the chosen codec
	MultiHashType  = uint64(multihash.SHA2_256)
)

Functions

func AddSupportToChooser

func AddSupportToChooser(existing traversal.LinkTargetNodePrototypeChooser) traversal.LinkTargetNodePrototypeChooser

AddSupportToChooser takes an existing node prototype chooser and subs in Header for the tendermint header multicodec code.

func AppendEncode

func AppendEncode(enc []byte, inNode ipld.Node) ([]byte, error)

AppendEncode is like Encode, but it uses a destination buffer directly. This means less copying of bytes, and if the destination has enough capacity, fewer allocations.

func Decode

func Decode(na ipld.NodeAssembler, in io.Reader) error

Decode provides an IPLD codec decode interface for Cosmos Header IPLDs. This function is registered via the go-ipld-prime link loader for multicodec code XXX when this package is invoked via init.

func DecodeBytes

func DecodeBytes(na ipld.NodeAssembler, src []byte) error

DecodeBytes is like Decode, but it uses an input buffer directly. Decode will grab or read all the bytes from an io.Reader anyway, so this can save having to copy the bytes or create a bytes.Buffer.

func DecodeHeader

func DecodeHeader(na ipld.NodeAssembler, hp types.Header) error

DecodeHeader is like Decode, but it uses an input tendermint Header type

func Decoder

func Decoder(na ipld.NodeAssembler, r io.Reader) error

Deprecated: use Decode instead.

func Encode

func Encode(node ipld.Node, w io.Writer) error

Encode provides an IPLD codec encode interface for Tendermint header IPLDs. This function is registered via the go-ipld-prime link loader for multicodec code XXX when this package is invoked via init. It expects the root node a HeaderTree (merkle tree of all the header fields)

func EncodeHeader

func EncodeHeader(header *types.Header, inNode ipld.Node) error

EncodeHeader packs the node into the provided Tendermint Header

func Encoder

func Encoder(inNode ipld.Node, w io.Writer) error

Deprecated: use Encode instead.

func Marshal

func Marshal(inNode ipld.Node, w io.Writer) error

Deprecated: use Encode instead.

func Unmarshal

func Unmarshal(na ipld.NodeAssembler, r io.Reader) error

Deprecated: use Decode instead.