github.com/theQRL/go-zond@v0.1.1/trie/errors.go (about)

     1  // Copyright 2015 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package trie
    18  
    19  import (
    20  	"errors"
    21  	"fmt"
    22  
    23  	"github.com/theQRL/go-zond/common"
    24  )
    25  
    26  // ErrCommitted is returned when a already committed trie is requested for usage.
    27  // The potential usages can be `Get`, `Update`, `Delete`, `NodeIterator`, `Prove`
    28  // and so on.
    29  var ErrCommitted = errors.New("trie is already committed")
    30  
    31  // MissingNodeError is returned by the trie functions (Get, Update, Delete)
    32  // in the case where a trie node is not present in the local database. It contains
    33  // information necessary for retrieving the missing node.
    34  type MissingNodeError struct {
    35  	Owner    common.Hash // owner of the trie if it's 2-layered trie
    36  	NodeHash common.Hash // hash of the missing node
    37  	Path     []byte      // hex-encoded path to the missing node
    38  	err      error       // concrete error for missing trie node
    39  }
    40  
    41  // Unwrap returns the concrete error for missing trie node which
    42  // allows us for further analysis outside.
    43  func (err *MissingNodeError) Unwrap() error {
    44  	return err.err
    45  }
    46  
    47  func (err *MissingNodeError) Error() string {
    48  	if err.Owner == (common.Hash{}) {
    49  		return fmt.Sprintf("missing trie node %x (path %x) %v", err.NodeHash, err.Path, err.err)
    50  	}
    51  	return fmt.Sprintf("missing trie node %x (owner %x) (path %x) %v", err.NodeHash, err.Owner, err.Path, err.err)
    52  }