github.com/tirogen/go-ethereum@v1.10.12-0.20221226051715-250cfede41b6/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(internalServerError) 58 ) 59 60 const ( 61 errcodeDefault = -32000 62 errcodeNotificationsUnsupported = -32001 63 errcodeTimeout = -32002 64 errcodePanic = -32603 65 errcodeMarshalError = -32603 66 ) 67 68 const ( 69 errMsgTimeout = "request timed out" 70 ) 71 72 type methodNotFoundError struct{ method string } 73 74 func (e *methodNotFoundError) ErrorCode() int { return -32601 } 75 76 func (e *methodNotFoundError) Error() string { 77 return fmt.Sprintf("the method %s does not exist/is not available", e.method) 78 } 79 80 type subscriptionNotFoundError struct{ namespace, subscription string } 81 82 func (e *subscriptionNotFoundError) ErrorCode() int { return -32601 } 83 84 func (e *subscriptionNotFoundError) Error() string { 85 return fmt.Sprintf("no %q subscription in %s namespace", e.subscription, e.namespace) 86 } 87 88 // Invalid JSON was received by the server. 89 type parseError struct{ message string } 90 91 func (e *parseError) ErrorCode() int { return -32700 } 92 93 func (e *parseError) Error() string { return e.message } 94 95 // received message isn't a valid request 96 type invalidRequestError struct{ message string } 97 98 func (e *invalidRequestError) ErrorCode() int { return -32600 } 99 100 func (e *invalidRequestError) Error() string { return e.message } 101 102 // received message is invalid 103 type invalidMessageError struct{ message string } 104 105 func (e *invalidMessageError) ErrorCode() int { return -32700 } 106 107 func (e *invalidMessageError) Error() string { return e.message } 108 109 // unable to decode supplied params, or an invalid number of parameters 110 type invalidParamsError struct{ message string } 111 112 func (e *invalidParamsError) ErrorCode() int { return -32602 } 113 114 func (e *invalidParamsError) Error() string { return e.message } 115 116 // internalServerError is used for server errors during request processing. 117 type internalServerError struct { 118 code int 119 message string 120 } 121 122 func (e *internalServerError) ErrorCode() int { return e.code } 123 124 func (e *internalServerError) Error() string { return e.message }