bmt

README

# Binary Merkle Tree hash

This package provides an interface and a selection of implementations of the Binary Merkle Tree hash

Documentation

Overview

Package bmt defines the interface for the Binary Merkle Tree hash.

Index

• Constants
• Variables
• type Hash

Constants

const (
	SpanSize = 8
)

Variables

var ErrOverflow = errors.New("BMT hash capacity exceeded")

Types

type Hash

type Hash interface {
	hash.Hash

	// SetSpan sets the length prefix of BMT hash.
	SetSpan(int64) error

	// SetSpanBytes sets the length prefix of BMT hash in byte form.
	SetSpanBytes([]byte) error

	// Capacity returns the maximum amount of bytes that will be processed by the implementation.
	Capacity() int

	// WriteSection writes to a specific section of the data to be hashed.
	WriteSection(idx int, data []byte) error
}

Hash provides the necessary extension of the hash interface to add the length-prefix of the BMT hash.

Any implementation should make it possible to generate a BMT hash using the hash.Hash interface only. However, the limitation will be that the Span of the BMT hash always must be limited to the amount of bytes actually written.