htree

Documentation

Overview

Copyright 2022 Codenotary Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• Variables
• func VerifyInclusion(proof *InclusionProof, digest, root [sha256.Size]byte) bool
• type HTree
  • func New(maxWidth int) (*HTree, error)
  • func (t *HTree) BuildWith(digests [][sha256.Size]byte) error
  • func (t *HTree) InclusionProof(i int) (proof *InclusionProof, err error)
  • func (t *HTree) Root() (root [sha256.Size]byte, err error)
• type InclusionProof

Constants

const LeafPrefix = byte(0)

const NodePrefix = byte(1)

Variables

var ErrIllegalArguments = errors.New("htree: illegal arguments")

var ErrIllegalState = errors.New("htree: illegal state")

var ErrMaxWidthExceeded = errors.New("htree: max width exceeded")

Functions

func VerifyInclusion

func VerifyInclusion(proof *InclusionProof, digest, root [sha256.Size]byte) bool

Types

type HTree

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

func New

func New(maxWidth int) (*HTree, error)

func (*HTree) BuildWith

func (t *HTree) BuildWith(digests [][sha256.Size]byte) error

func (*HTree) InclusionProof

func (t *HTree) InclusionProof(i int) (proof *InclusionProof, err error)

InclusionProof returns the shortest list of additional nodes required to compute the root It's an adaption from the algorithm for proof construction at github.com/codenotary/merkletree

func (*HTree) Root

func (t *HTree) Root() (root [sha256.Size]byte, err error)

type InclusionProof

type InclusionProof struct {
	Leaf  int
	Width int
	Terms [][sha256.Size]byte
}