github.com/codysnider/go-ethereum@v1.10.18-0.20220420071915-14f4ae99222a/rpc/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 rpc
    18  
    19  import "fmt"
    20  
    21  // HTTPError is returned by client operations when the HTTP status code of the
    22  // response is not a 2xx status.
    23  type HTTPError struct {
    24  	StatusCode int
    25  	Status     string
    26  	Body       []byte
    27  }
    28  
    29  func (err HTTPError) Error() string {
    30  	if len(err.Body) == 0 {
    31  		return err.Status
    32  	}
    33  	return fmt.Sprintf("%v: %s", err.Status, err.Body)
    34  }
    35  
    36  // Error wraps RPC errors, which contain an error code in addition to the message.
    37  type Error interface {
    38  	Error() string  // returns the message
    39  	ErrorCode() int // returns the code
    40  }
    41  
    42  // A DataError contains some data in addition to the error message.
    43  type DataError interface {
    44  	Error() string          // returns the message
    45  	ErrorData() interface{} // returns the error data
    46  }
    47  
    48  // Error types defined below are the built-in JSON-RPC errors.
    49  
    50  var (
    51  	_ Error = new(methodNotFoundError)
    52  	_ Error = new(subscriptionNotFoundError)
    53  	_ Error = new(parseError)
    54  	_ Error = new(invalidRequestError)
    55  	_ Error = new(invalidMessageError)
    56  	_ Error = new(invalidParamsError)
    57  	_ Error = new(CustomError)
    58  )
    59  
    60  const defaultErrorCode = -32000
    61  
    62  type methodNotFoundError struct{ method string }
    63  
    64  func (e *methodNotFoundError) ErrorCode() int { return -32601 }
    65  
    66  func (e *methodNotFoundError) Error() string {
    67  	return fmt.Sprintf("the method %s does not exist/is not available", e.method)
    68  }
    69  
    70  type subscriptionNotFoundError struct{ namespace, subscription string }
    71  
    72  func (e *subscriptionNotFoundError) ErrorCode() int { return -32601 }
    73  
    74  func (e *subscriptionNotFoundError) Error() string {
    75  	return fmt.Sprintf("no %q subscription in %s namespace", e.subscription, e.namespace)
    76  }
    77  
    78  // Invalid JSON was received by the server.
    79  type parseError struct{ message string }
    80  
    81  func (e *parseError) ErrorCode() int { return -32700 }
    82  
    83  func (e *parseError) Error() string { return e.message }
    84  
    85  // received message isn't a valid request
    86  type invalidRequestError struct{ message string }
    87  
    88  func (e *invalidRequestError) ErrorCode() int { return -32600 }
    89  
    90  func (e *invalidRequestError) Error() string { return e.message }
    91  
    92  // received message is invalid
    93  type invalidMessageError struct{ message string }
    94  
    95  func (e *invalidMessageError) ErrorCode() int { return -32700 }
    96  
    97  func (e *invalidMessageError) Error() string { return e.message }
    98  
    99  // unable to decode supplied params, or an invalid number of parameters
   100  type invalidParamsError struct{ message string }
   101  
   102  func (e *invalidParamsError) ErrorCode() int { return -32602 }
   103  
   104  func (e *invalidParamsError) Error() string { return e.message }
   105  
   106  type CustomError struct {
   107  	Code            int
   108  	ValidationError string
   109  }
   110  
   111  func (e *CustomError) ErrorCode() int { return e.Code }
   112  
   113  func (e *CustomError) Error() string { return e.ValidationError }