hashednode.go

// This is free and unencumbered software released into the public domain.
//
// Anyone is free to copy, modify, publish, use, compile, sell, or
// distribute this software, either in source code form or as a compiled
// binary, for any purpose, commercial or non-commercial, and by any
// means.
//
// In jurisdictions that recognize copyright laws, the author or authors
// of this software dedicate any and all copyright interest in the
// software to the public domain. We make this dedication for the benefit
// of the public at large and to the detriment of our heirs and
// successors. We intend this dedication to be an overt act of
// relinquishment in perpetuity of all present and future rights to this
// software under copyright law.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
// IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
// OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
//
// For more information, please refer to <https://unlicense.org>

package verkle

import (
	"errors"
	"fmt"
)

type HashedNode struct{}

func (HashedNode) Insert([]byte, []byte, NodeResolverFn) error {
	return errInsertIntoHash
}

func (HashedNode) Delete([]byte, NodeResolverFn) (bool, error) {
	return false, errors.New("cant delete a hashed node in-place")
}

func (HashedNode) Get([]byte, NodeResolverFn) ([]byte, error) {
	return nil, errors.New("can not read from a hash node")
}

func (HashedNode) Commit() *Point {
	// TODO: we should reconsider what to do with the VerkleNode interface and how
	//       HashedNode fits into the picture, since Commit(), Commitment() and Hash()
	//	     now panics. Despite these calls must not happen at runtime, it is still
	//	     quite risky. The reason we end up in this place is because PBSS came quite
	//	     recently compared with the VerkleNode interface design. We should probably
	//	     reconsider splitting the interface or find some safer workaround.
	panic("can not commit a hash node")
}

func (HashedNode) Commitment() *Point {
	panic("can not get commitment of a hash node")
}

func (HashedNode) GetProofItems(keylist, NodeResolverFn) (*ProofElements, []byte, [][]byte, error) {
	return nil, nil, nil, errors.New("can not get the full path, and there is no proof of absence")
}

func (HashedNode) Serialize() ([]byte, error) {
	return nil, errSerializeHashedNode
}

func (HashedNode) Copy() VerkleNode {
	return HashedNode{}
}

func (HashedNode) toDot(parent, path string) string {
	return fmt.Sprintf("hash%s [label=\"unresolved\"]\n%s -> hash%s\n", path, parent, path)
}

func (HashedNode) setDepth(_ byte) {
	// do nothing
}

func (HashedNode) Hash() *Fr {
	panic("can not hash a hashed node")
}