fcrmerkletree

Documentation

Overview

Package fcrmerkletree - provides methods to work with Merkle Tree data structure

Index

• type FCRMerkleProof
  • func (mp FCRMerkleProof) MarshalJSON() ([]byte, error)
  • func (mp *FCRMerkleProof) UnmarshalJSON(p []byte) error
  • func (mp *FCRMerkleProof) VerifyContent(content merkletree.Content, root string) bool
• type FCRMerkleTree
  • func CreateMerkleTree(contents []merkletree.Content) (*FCRMerkleTree, error)
  • func (mt *FCRMerkleTree) GenerateMerkleProof(content merkletree.Content) (*FCRMerkleProof, error)
  • func (mt *FCRMerkleTree) GetMerkleRoot() string

Types

type FCRMerkleProof

type FCRMerkleProof struct {
	// contains filtered or unexported fields
}

FCRMerkleProof is the proof of a single cid in a merkle tree.

func (FCRMerkleProof) MarshalJSON

func (mp FCRMerkleProof) MarshalJSON() ([]byte, error)

MarshalJSON is used to marshal FCRMerkleProof into bytes.

func (*FCRMerkleProof) UnmarshalJSON

func (mp *FCRMerkleProof) UnmarshalJSON(p []byte) error

UnmarshalJSON is used to unmarshal bytes into FCRMerkleProof.

func (*FCRMerkleProof) VerifyContent

func (mp *FCRMerkleProof) VerifyContent(content merkletree.Content, root string) bool

VerifyContent is used to verify a given content and a given root matches the proof.

type FCRMerkleTree

type FCRMerkleTree struct {
	// contains filtered or unexported fields
}

FCRMerkleTree is used to store a list of CIDs.

func CreateMerkleTree

func CreateMerkleTree(contents []merkletree.Content) (*FCRMerkleTree, error)

CreateMerkleTree creates a merkle tree from a list of cids.

func (*FCRMerkleTree) GenerateMerkleProof

func (mt *FCRMerkleTree) GenerateMerkleProof(content merkletree.Content) (*FCRMerkleProof, error)

GenerateMerkleProof gets the merkle proof for a given cid.

func (*FCRMerkleTree) GetMerkleRoot

func (mt *FCRMerkleTree) GetMerkleRoot() string

GetMerkleRoot returns the merkle root of the tree.