aboutsummaryrefslogtreecommitdiffstats
path: root/rpc/types.go
blob: 1f49a3deac53ea67260acfae4de9e9ce8450e4bd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
/*
  This file is part of go-ethereum

  go-ethereum is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  go-ethereum is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with go-ethereum.  If not, see <http://www.gnu.org/licenses/>.
*/
package rpc

import (
    "encoding/binary"
    "encoding/hex"
    "encoding/json"
    "fmt"
    "math/big"
    "strings"

    "errors"
    "net"
    "net/http"
    "time"

    "io"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/core/types"
)

type hexdata struct {
    data  []byte
    isNil bool
}

func (d *hexdata) String() string {
    return "0x" + common.Bytes2Hex(d.data)
}

func (d *hexdata) MarshalJSON() ([]byte, error) {
    if d.isNil {
        return json.Marshal(nil)
    }
    return json.Marshal(d.String())
}

func newHexData(input interface{}) *hexdata {
    d := new(hexdata)

    if input == nil {
        d.isNil = true
        return d
    }
    switch input := input.(type) {
    case []byte:
        d.data = input
    case common.Hash:
        d.data = input.Bytes()
    case *common.Hash:
        if input == nil {
            d.isNil = true
        } else {
            d.data = input.Bytes()
        }
    case common.Address:
        d.data = input.Bytes()
    case *common.Address:
        if input == nil {
            d.isNil = true
        } else {
            d.data = input.Bytes()
        }
    case types.Bloom:
        d.data = input.Bytes()
    case *types.Bloom:
        if input == nil {
            d.isNil = true
        } else {
            d.data = input.Bytes()
        }
    case *big.Int:
        if input == nil {
            d.isNil = true
        } else {
            d.data = input.Bytes()
        }
    case int64:
        d.data = big.NewInt(input).Bytes()
    case uint64:
        buff := make([]byte, 8)
        binary.BigEndian.PutUint64(buff, input)
        d.data = buff
    case int:
        d.data = big.NewInt(int64(input)).Bytes()
    case uint:
        d.data = big.NewInt(int64(input)).Bytes()
    case int8:
        d.data = big.NewInt(int64(input)).Bytes()
    case uint8:
        d.data = big.NewInt(int64(input)).Bytes()
    case int16:
        d.data = big.NewInt(int64(input)).Bytes()
    case uint16:
        buff := make([]byte, 2)
        binary.BigEndian.PutUint16(buff, input)
        d.data = buff
    case int32:
        d.data = big.NewInt(int64(input)).Bytes()
    case uint32:
        buff := make([]byte, 4)
        binary.BigEndian.PutUint32(buff, input)
        d.data = buff
    case string: // hexstring
        // aaargh ffs TODO: avoid back-and-forth hex encodings where unneeded
        bytes, err := hex.DecodeString(strings.TrimPrefix(input, "0x"))
        if err != nil {
            d.isNil = true
        } else {
            d.data = bytes
        }
    default:
        d.isNil = true
    }

    return d
}

type hexnum struct {
    data  []byte
    isNil bool
}

func (d *hexnum) String() string {
    // Get hex string from bytes
    out := common.Bytes2Hex(d.data)
    // Trim leading 0s
    out = strings.TrimLeft(out, "0")
    // Output "0x0" when value is 0
    if len(out) == 0 {
        out = "0"
    }
    return "0x" + out
}

func (d *hexnum) MarshalJSON() ([]byte, error) {
    if d.isNil {
        return json.Marshal(nil)
    }
    return json.Marshal(d.String())
}

func newHexNum(input interface{}) *hexnum {
    d := new(hexnum)

    d.data = newHexData(input).data

    return d
}

type RpcConfig struct {
    ListenAddress string
    ListenPort    uint
    CorsDomain    string
}

type InvalidTypeError struct {
    method string
    msg    string
}

func (e *InvalidTypeError) Error() string {
    return fmt.Sprintf("invalid type on field %s: %s", e.method, e.msg)
}

func NewInvalidTypeError(method, msg string) *InvalidTypeError {
    return &InvalidTypeError{
        method: method,
        msg:    msg,
    }
}

type InsufficientParamsError struct {
    have int
    want int
}

func (e *InsufficientParamsError) Error() string {
    return fmt.Sprintf("insufficient params, want %d have %d", e.want, e.have)
}

func NewInsufficientParamsError(have int, want int) *InsufficientParamsError {
    return &InsufficientParamsError{
        have: have,
        want: want,
    }
}

type NotImplementedError struct {
    Method string
}

func (e *NotImplementedError) Error() string {
    return fmt.Sprintf("%s method not implemented", e.Method)
}

func NewNotImplementedError(method string) *NotImplementedError {
    return &NotImplementedError{
        Method: method,
    }
}

type NotAvailableError struct {
    Method string
    Reason string
}

func (e *NotAvailableError) Error() string {
    return fmt.Sprintf("%s method not available: %s", e.Method, e.Reason)
}

func NewNotAvailableError(method string, reason string) *NotAvailableError {
    return &NotAvailableError{
        Method: method,
        Reason: reason,
    }
}

type DecodeParamError struct {
    err string
}

func (e *DecodeParamError) Error() string {
    return fmt.Sprintf("could not decode, %s", e.err)

}

func NewDecodeParamError(errstr string) error {
    return &DecodeParamError{
        err: errstr,
    }
}

type ValidationError struct {
    ParamName string
    msg       string
}

func (e *ValidationError) Error() string {
    return fmt.Sprintf("%s not valid, %s", e.ParamName, e.msg)
}

func NewValidationError(param string, msg string) error {
    return &ValidationError{
        ParamName: param,
        msg:       msg,
    }
}

type RpcRequest struct {
    Id      interface{}     `json:"id"`
    Jsonrpc string          `json:"jsonrpc"`
    Method  string          `json:"method"`
    Params  json.RawMessage `json:"params"`
}

type RpcSuccessResponse struct {
    Id      interface{} `json:"id"`
    Jsonrpc string      `json:"jsonrpc"`
    Result  interface{} `json:"result"`
}

type RpcErrorResponse struct {
    Id      interface{}     `json:"id"`
    Jsonrpc string          `json:"jsonrpc"`
    Error   *RpcErrorObject `json:"error"`
}

type RpcErrorObject struct {
    Code    int    `json:"code"`
    Message string `json:"message"`
    // Data    interface{} `json:"data"`
}

type listenerHasStoppedError struct {
    msg string
}

func (self listenerHasStoppedError) Error() string {
    return self.msg
}

var listenerStoppedError = listenerHasStoppedError{"Listener stopped"}

// When https://github.com/golang/go/issues/4674 is fixed this could be replaced
type stoppableTCPListener struct {
    *net.TCPListener
    stop chan struct{} // closed when the listener must stop
}

// Wraps the default handler and checks if the RPC service was stopped. In that case it returns an
// error indicating that the service was stopped. This will only happen for connections which are
// kept open (HTTP keep-alive) when the RPC service was shutdown.
func newStoppableHandler(h http.Handler, stop chan struct{}) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        select {
        case <-stop:
            w.Header().Set("Content-Type", "application/json")
            jsonerr := &RpcErrorObject{-32603, "RPC service stopped"}
            send(w, &RpcErrorResponse{Jsonrpc: jsonrpcver, Id: nil, Error: jsonerr})
        default:
            h.ServeHTTP(w, r)
        }
    })
}

// Stop the listener and all accepted and still active connections.
func (self *stoppableTCPListener) Stop() {
    close(self.stop)
}

func newStoppableTCPListener(addr string) (*stoppableTCPListener, error) {
    wl, err := net.Listen("tcp", addr)
    if err != nil {
        return nil, err
    }

    if tcpl, ok := wl.(*net.TCPListener); ok {
        stop := make(chan struct{})
        l := &stoppableTCPListener{tcpl, stop}
        return l, nil
    }

    return nil, errors.New("Unable to create TCP listener for RPC service")
}

func (self *stoppableTCPListener) Accept() (net.Conn, error) {
    for {
        self.SetDeadline(time.Now().Add(time.Duration(1 * time.Second)))
        c, err := self.TCPListener.AcceptTCP()

        select {
        case <-self.stop:
            if c != nil { // accept timeout
                c.Close()
            }
            self.TCPListener.Close()
            return nil, listenerStoppedError
        default:
        }

        if err != nil {
            if netErr, ok := err.(net.Error); ok && netErr.Timeout() && netErr.Temporary() {
                continue // regular timeout
            }
        }

        return &closableConnection{c, self.stop}, err
    }
}

type closableConnection struct {
    *net.TCPConn
    closed chan struct{}
}

func (self *closableConnection) Read(b []byte) (n int, err error) {
    select {
    case <-self.closed:
        self.TCPConn.Close()
        return 0, io.EOF
    default:
        return self.TCPConn.Read(b)
    }
}