merkletree

package module

Go to main page

Versions in this module

v0

v0.5.0

Aug 14, 2026

Changes in this version

+ var ErrMalformedProof = errors.New("error: proof is malformed")

+ var ErrMalformedTree = errors.New("error: tree is empty or malformed")

+ func VerifyProof(content Content, path [][]byte, index []int64, root []byte, opts ...TreeOption) (bool, error)

+ func VerifyProofWithDigest(digest []byte, path [][]byte, index []int64, root []byte, opts ...TreeOption) (bool, error)

type MerkleTree

+ func (m *MerkleTree) AppendMerklePath(path [][]byte, index []int64, content Content) ([][]byte, []int64, error)

+ func (m *MerkleTree) AppendMerklePathByIndex(path [][]byte, index []int64, i int) ([][]byte, []int64, error)

+ func (m *MerkleTree) GetMerklePathByIndex(i int) ([][]byte, []int64, error)

+ func (m *MerkleTree) VerifyProof(content Content, path [][]byte, index []int64) (bool, error)

type TreeOption

+ func WithLeafIndex() TreeOption

+ func WithParallelism(n int) TreeOption

v0.4.0

Aug 14, 2026

Changes in this version

+ var ErrContentNotFound = errors.New("error: content not found in tree")

+ var ErrCorruptData = errors.New("merkletree: corrupt serialized tree")

+ var ErrNilContent = errors.New("error: cannot construct tree with nil content")

+ var ErrNoContent = errors.New("error: cannot construct tree with no content")

+ var ErrNoContentType = errors.New("merkletree: unregistered content type")

+ var ErrNoHashStrategy = errors.New("merkletree: unknown hash strategy")

+ var ErrRootMismatch = errors.New("merkletree: rebuilt Merkle root does not match the encoded root")

+ var ErrUnsupportedVersion = errors.New("merkletree: unsupported serialization version")

+ func HashStrategyNames() []string

+ func RegisterContent(c Content)

+ func RegisterContentName(name string, c Content)

+ func RegisterHashStrategy(name string, strategy func() hash.Hash)

+ type ContentMarshalFunc func(Content) ([]byte, error)

+ type ContentUnmarshalFunc func([]byte) (Content, error)

+ type MarshalOption func(*marshalConfig)

+ func WithHashStrategyName(name string) MarshalOption

type MerkleTree

+ func NewTreeWithOptions(cs []Content, opts ...TreeOption) (*MerkleTree, error)

+ func UnmarshalWith(data []byte, dec ContentUnmarshalFunc, opts ...UnmarshalOption) (*MerkleTree, error)

+ func (m *MerkleTree) RFC6962() bool

+ func (m *MerkleTree) Sorted() bool

+ func (m *MerkleTree) UnmarshalBinary(data []byte) error

+ func (m *MerkleTree) UnmarshalJSON(data []byte) error

+ func (m MerkleTree) MarshalBinary() ([]byte, error)

+ func (m MerkleTree) MarshalJSON() ([]byte, error)

+ func (m MerkleTree) MarshalWith(enc ContentMarshalFunc, opts ...MarshalOption) ([]byte, error)

+ type TreeOption func(*MerkleTree)

+ func WithHasher(strategy func() hash.Hash) TreeOption

+ func WithRFC6962() TreeOption

+ func WithSortedSiblings() TreeOption

+ type UnmarshalOption func(*unmarshalConfig)

+ func WithHashStrategy(strategy func() hash.Hash) UnmarshalOption

v0.3.0

Aug 13, 2026

Changes in this version

type MerkleTree

+ func NewTreeWithHashStrategySorted(cs []Content, hashStrategy func() hash.Hash, sort bool) (*MerkleTree, error)

v0.2.0

Aug 21, 2019

Changes in this version

type MerkleTree

+ func NewTreeWithHashStrategy(cs []Content, hashStrategy func() hash.Hash) (*MerkleTree, error)

type Node

+ Tree *MerkleTree

+ func (n *Node) String() string

v0.1.0

Aug 21, 2019

Changes in this version

+ type Content interface

+ CalculateHash func() ([]byte, error)

+ Equals func(other Content) (bool, error)

+ type MerkleTree struct

+ Leafs []*Node

+ Root *Node

+ func NewTree(cs []Content) (*MerkleTree, error)

+ func (m *MerkleTree) GetMerklePath(content Content) ([][]byte, []int64, error)

+ func (m *MerkleTree) MerkleRoot() []byte

+ func (m *MerkleTree) RebuildTree() error

+ func (m *MerkleTree) RebuildTreeWith(cs []Content) error

+ func (m *MerkleTree) String() string

+ func (m *MerkleTree) VerifyContent(content Content) (bool, error)

+ func (m *MerkleTree) VerifyTree() (bool, error)

+ type Node struct

+ C Content

+ Hash []byte

+ Left *Node

+ Parent *Node

+ Right *Node

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL