fcrmerkletree

package

v0.0.0-...-7a4b066 Latest Latest Go to latest Published: Aug 3, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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

This section is empty.

This section is empty.

This section is empty.

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

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

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

FromBytes is used to turn bytes into FCRMerkleProof.

func (mp *FCRMerkleProof) ToBytes() ([]byte, error)

ToBytes is used to turn FCRMerkleProof into bytes.

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 struct {
	// contains filtered or unexported fields
}

FCRMerkleTree is used to store a list of CIDs.

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

CreateMerkleTree creates a merkle tree from a list of cids.

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

GenerateMerkleProof gets the merkle proof for a given cid.

func (mt *FCRMerkleTree) GetMerkleRoot() string

GetMerkleRoot returns the merkle root of the tree.