2015-10-15 07:07:19 -07:00
|
|
|
// Copyright 2015 The go-ethereum Authors
|
|
|
|
// This file is part of the go-ethereum library.
|
|
|
|
//
|
|
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
|
|
|
// The go-ethereum library 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 Lesser General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
2015-12-16 01:58:01 -08:00
|
|
|
package rpc
|
2015-10-15 07:07:19 -07:00
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"math"
|
|
|
|
"math/big"
|
|
|
|
"reflect"
|
|
|
|
"strings"
|
|
|
|
"sync"
|
|
|
|
|
2015-12-16 01:58:01 -08:00
|
|
|
"gopkg.in/fatih/set.v0"
|
2015-10-15 07:07:19 -07:00
|
|
|
)
|
|
|
|
|
|
|
|
// API describes the set of methods offered over the RPC interface
|
|
|
|
type API struct {
|
|
|
|
Namespace string // namespace under which the rpc methods of Service are exposed
|
|
|
|
Version string // api version for DApp's
|
|
|
|
Service interface{} // receiver instance which holds the methods
|
|
|
|
Public bool // indication if the methods must be considered safe for public use
|
|
|
|
}
|
|
|
|
|
|
|
|
// callback is a method callback which was registered in the server
|
|
|
|
type callback struct {
|
|
|
|
rcvr reflect.Value // receiver of method
|
|
|
|
method reflect.Method // callback
|
|
|
|
argTypes []reflect.Type // input argument types
|
2015-12-09 09:28:07 -08:00
|
|
|
hasCtx bool // method's first argument is a context (not included in argTypes)
|
2015-10-15 07:07:19 -07:00
|
|
|
errPos int // err return idx, of -1 when method cannot return error
|
|
|
|
isSubscribe bool // indication if the callback is a subscription
|
|
|
|
}
|
|
|
|
|
|
|
|
// service represents a registered object
|
|
|
|
type service struct {
|
|
|
|
name string // name for service
|
|
|
|
rcvr reflect.Value // receiver of methods for the service
|
|
|
|
typ reflect.Type // receiver type
|
|
|
|
callbacks callbacks // registered handlers
|
|
|
|
subscriptions subscriptions // available subscriptions/notifications
|
|
|
|
}
|
|
|
|
|
|
|
|
// serverRequest is an incoming request
|
|
|
|
type serverRequest struct {
|
2016-03-14 01:38:54 -07:00
|
|
|
id interface{}
|
2015-10-15 07:07:19 -07:00
|
|
|
svcname string
|
|
|
|
rcvr reflect.Value
|
|
|
|
callb *callback
|
|
|
|
args []reflect.Value
|
|
|
|
isUnsubscribe bool
|
2016-07-12 08:47:15 -07:00
|
|
|
err Error
|
2015-10-15 07:07:19 -07:00
|
|
|
}
|
|
|
|
|
2016-03-29 06:07:40 -07:00
|
|
|
type serviceRegistry map[string]*service // collection of services
|
|
|
|
type callbacks map[string]*callback // collection of RPC callbacks
|
|
|
|
type subscriptions map[string]*callback // collection of subscription callbacks
|
|
|
|
type subscriptionRegistry map[string]*callback // collection of subscription callbacks
|
2015-10-15 07:07:19 -07:00
|
|
|
|
|
|
|
// Server represents a RPC server
|
|
|
|
type Server struct {
|
|
|
|
services serviceRegistry
|
|
|
|
muSubcriptions sync.Mutex // protects subscriptions
|
|
|
|
subscriptions subscriptionRegistry
|
2015-12-16 01:58:01 -08:00
|
|
|
|
|
|
|
run int32
|
|
|
|
codecsMu sync.Mutex
|
|
|
|
codecs *set.Set
|
2015-10-15 07:07:19 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
// rpcRequest represents a raw incoming RPC request
|
|
|
|
type rpcRequest struct {
|
|
|
|
service string
|
|
|
|
method string
|
2016-03-14 01:38:54 -07:00
|
|
|
id interface{}
|
2015-10-15 07:07:19 -07:00
|
|
|
isPubSub bool
|
|
|
|
params interface{}
|
2016-07-12 08:47:15 -07:00
|
|
|
err Error // invalid batch element
|
2015-10-15 07:07:19 -07:00
|
|
|
}
|
|
|
|
|
2016-07-12 08:47:15 -07:00
|
|
|
// Error wraps RPC errors, which contain an error code in addition to the message.
|
|
|
|
type Error interface {
|
|
|
|
Error() string // returns the message
|
|
|
|
ErrorCode() int // returns the code
|
2015-10-15 07:07:19 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
// ServerCodec implements reading, parsing and writing RPC messages for the server side of
|
|
|
|
// a RPC session. Implementations must be go-routine safe since the codec can be called in
|
|
|
|
// multiple go-routines concurrently.
|
|
|
|
type ServerCodec interface {
|
|
|
|
// Read next request
|
2016-07-12 08:47:15 -07:00
|
|
|
ReadRequestHeaders() ([]rpcRequest, bool, Error)
|
2015-10-15 07:07:19 -07:00
|
|
|
// Parse request argument to the given types
|
2016-07-12 08:47:15 -07:00
|
|
|
ParseRequestArguments([]reflect.Type, interface{}) ([]reflect.Value, Error)
|
2016-03-14 01:38:54 -07:00
|
|
|
// Assemble success response, expects response id and payload
|
|
|
|
CreateResponse(interface{}, interface{}) interface{}
|
|
|
|
// Assemble error response, expects response id and error
|
2016-07-12 08:47:15 -07:00
|
|
|
CreateErrorResponse(interface{}, Error) interface{}
|
2015-10-15 07:07:19 -07:00
|
|
|
// Assemble error response with extra information about the error through info
|
2016-07-12 08:47:15 -07:00
|
|
|
CreateErrorResponseWithInfo(id interface{}, err Error, info interface{}) interface{}
|
2015-10-15 07:07:19 -07:00
|
|
|
// Create notification response
|
|
|
|
CreateNotification(string, interface{}) interface{}
|
|
|
|
// Write msg to client.
|
|
|
|
Write(interface{}) error
|
|
|
|
// Close underlying data stream
|
|
|
|
Close()
|
|
|
|
// Closed when underlying connection is closed
|
|
|
|
Closed() <-chan interface{}
|
|
|
|
}
|
|
|
|
|
|
|
|
var (
|
|
|
|
pendingBlockNumber = big.NewInt(-2)
|
|
|
|
latestBlockNumber = big.NewInt(-1)
|
|
|
|
earliestBlockNumber = big.NewInt(0)
|
|
|
|
maxBlockNumber = big.NewInt(math.MaxInt64)
|
|
|
|
)
|
|
|
|
|
|
|
|
type BlockNumber int64
|
|
|
|
|
|
|
|
const (
|
|
|
|
PendingBlockNumber = BlockNumber(-2)
|
|
|
|
LatestBlockNumber = BlockNumber(-1)
|
|
|
|
)
|
|
|
|
|
|
|
|
// UnmarshalJSON parses the given JSON fragement into a BlockNumber. It supports:
|
2016-01-27 08:01:30 -08:00
|
|
|
// - "latest", "earliest" or "pending" as string arguments
|
2015-10-15 07:07:19 -07:00
|
|
|
// - the block number
|
|
|
|
// Returned errors:
|
|
|
|
// - an invalid block number error when the given argument isn't a known strings
|
|
|
|
// - an out of range error when the given block number is either too little or too large
|
|
|
|
func (bn *BlockNumber) UnmarshalJSON(data []byte) error {
|
|
|
|
input := strings.TrimSpace(string(data))
|
|
|
|
|
|
|
|
if len(input) >= 2 && input[0] == '"' && input[len(input)-1] == '"' {
|
|
|
|
input = input[1 : len(input)-1]
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(input) == 0 {
|
|
|
|
*bn = BlockNumber(latestBlockNumber.Int64())
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
in := new(big.Int)
|
|
|
|
_, ok := in.SetString(input, 0)
|
|
|
|
|
|
|
|
if !ok { // test if user supplied string tag
|
|
|
|
strBlockNumber := input
|
|
|
|
if strBlockNumber == "latest" {
|
|
|
|
*bn = BlockNumber(latestBlockNumber.Int64())
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
if strBlockNumber == "earliest" {
|
|
|
|
*bn = BlockNumber(earliestBlockNumber.Int64())
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
if strBlockNumber == "pending" {
|
|
|
|
*bn = BlockNumber(pendingBlockNumber.Int64())
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
return fmt.Errorf(`invalid blocknumber %s`, data)
|
|
|
|
}
|
|
|
|
|
|
|
|
if in.Cmp(earliestBlockNumber) >= 0 && in.Cmp(maxBlockNumber) <= 0 {
|
|
|
|
*bn = BlockNumber(in.Int64())
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
return fmt.Errorf("blocknumber not in range [%d, %d]", earliestBlockNumber, maxBlockNumber)
|
|
|
|
}
|
|
|
|
|
2016-07-27 08:47:46 -07:00
|
|
|
func (bn BlockNumber) Int64() int64 {
|
|
|
|
return (int64)(bn)
|
2015-10-15 07:07:19 -07:00
|
|
|
}
|