github.com/r8d8/go-ethereum@v5.5.2+incompatible/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  	"fmt"
    21  
    22  	"github.com/ethereumproject/go-ethereum/common"
    23  )
    24  
    25  // MissingNodeError is returned by the trie functions (TryGet, TryUpdate, TryDelete)
    26  // in the case where a trie node is not present in the local database. Contains
    27  // information necessary for retrieving the missing node through an ODR service.
    28  //
    29  // NodeHash is the hash of the missing node
    30  //
    31  // RootHash is the original root of the trie that contains the node
    32  //
    33  // Key is a binary-encoded key that contains the prefix that leads to the first
    34  // missing node and optionally a suffix that hints on which further nodes should
    35  // also be retrieved
    36  //
    37  // PrefixLen is the nibble length of the key prefix that leads from the root to
    38  // the missing node
    39  //
    40  // SuffixLen is the nibble length of the remaining part of the key that hints on
    41  // which further nodes should also be retrieved (can be zero when there are no
    42  // such hints in the error message)
    43  
    44  // MissingNodeError is returned by the trie functions (TryGet, TryUpdate, TryDelete)
    45  // in the case where a trie node is not present in the local database. It contains
    46  // information necessary for retrieving the missing node.
    47  type MissingNodeError struct {
    48  	NodeHash common.Hash // hash of the missing node
    49  	Path     []byte      // hex-encoded path to the missing node
    50  }
    51  
    52  func (err *MissingNodeError) Error() string {
    53  	return fmt.Sprintf("missing trie node %x (path %x)", err.NodeHash, err.Path)
    54  }