merklehasher

package

v3.0.0-rc.3 Latest Latest Go to latest Published: May 22, 2023 License: MIT Imports: 7 Imported by: 4

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

View Source

const (
	LeafHashPrefix = 0
	NodeHashPrefix = 1
)

Domain separation prefixes.

This section is empty.

This section is empty.

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

Hasher implements the hashing algorithm described in the IOTA protocol RFC-12.

func NewHasher(h crypto.Hash) *Hasher

NewHasher creates a new Hasher using the provided hash function.

func (t *Hasher) ComputeProof(blockIDs iotago.BlockIDs, blockID iotago.BlockID) (*Proof, error)

ComputeProof computes the audit path given the blockIDs and the blockID we want to create the inclusion proof for.

func (t *Hasher) ComputeProofForIndex(blockIDs iotago.BlockIDs, index int) (*Proof, error)

ComputeProofForIndex computes the audit path given the blockIDs and the index of the blockID we want to create the inclusion proof for.

func (t *Hasher) EmptyRoot() []byte

EmptyRoot returns a special case for an empty tree. This is equivalent to Hash(nil).

func (t *Hasher) Hash(data [][]byte) []byte

Hash computes the Merkle tree hash of the provided data.

func (t *Hasher) HashBlockIDs(blockIDs iotago.BlockIDs) []byte

HashBlockIDs computes the Merkle tree hash of the provided BlockIDs.

func (t *Hasher) Size() int

Size returns the length, in bytes, of a digest resulting from the given hash function.

type Proof struct {
	Left  hashable
	Right hashable
}

func (p *Proof) ContainsValue(value iotago.BlockID) (bool, error)

func (p *Proof) Hash(hasher *Hasher) []byte

func (p *Proof) MarshalJSON() ([]byte, error)

func (p *Proof) UnmarshalJSON(bytes []byte) error