245f3146c2
New APIs added:
client.RegisterName(namespace, service) // makes service available to server
client.Notify(ctx, method, args...) // sends a notification
ClientFromContext(ctx) // to get a client in handler method
This is essentially a rewrite of the server-side code. JSON-RPC
processing code is now the same on both server and client side. Many
minor issues were fixed in the process and there is a new test suite for
JSON-RPC spec compliance (and non-compliance in some cases).
List of behavior changes:
- Method handlers are now called with a per-request context instead of a
per-connection context. The context is canceled right after the method
returns.
- Subscription error channels are always closed when the connection
ends. There is no need to also wait on the Notifier's Closed channel
to detect whether the subscription has ended.
- Client now omits "params" instead of sending "params": null when there
are no arguments to a call. The previous behavior was not compliant
with the spec. The server still accepts "params": null.
- Floating point numbers are allowed as "id". The spec doesn't allow
them, but we handle request "id" as json.RawMessage and guarantee that
the same number will be sent back.
- Logging is improved significantly. There is now a message at DEBUG
level for each RPC call served.
108 lines
3.3 KiB
Go
108 lines
3.3 KiB
Go
// 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/>.
|
|
|
|
package rpc
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"math"
|
|
"strings"
|
|
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
)
|
|
|
|
// 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
|
|
}
|
|
|
|
// 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
|
|
}
|
|
|
|
// 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() (msgs []*jsonrpcMessage, isBatch bool, err error)
|
|
Close()
|
|
jsonWriter
|
|
}
|
|
|
|
// jsonWriter can write JSON messages to its underlying connection.
|
|
// Implementations must be safe for concurrent use.
|
|
type jsonWriter interface {
|
|
Write(context.Context, interface{}) error
|
|
// Closed returns a channel which is closed when the connection is closed.
|
|
Closed() <-chan interface{}
|
|
// RemoteAddr returns the peer address of the connection.
|
|
RemoteAddr() string
|
|
}
|
|
|
|
type BlockNumber int64
|
|
|
|
const (
|
|
PendingBlockNumber = BlockNumber(-2)
|
|
LatestBlockNumber = BlockNumber(-1)
|
|
EarliestBlockNumber = BlockNumber(0)
|
|
)
|
|
|
|
// UnmarshalJSON parses the given JSON fragment into a BlockNumber. It supports:
|
|
// - "latest", "earliest" or "pending" as string arguments
|
|
// - 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]
|
|
}
|
|
|
|
switch input {
|
|
case "earliest":
|
|
*bn = EarliestBlockNumber
|
|
return nil
|
|
case "latest":
|
|
*bn = LatestBlockNumber
|
|
return nil
|
|
case "pending":
|
|
*bn = PendingBlockNumber
|
|
return nil
|
|
}
|
|
|
|
blckNum, err := hexutil.DecodeUint64(input)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if blckNum > math.MaxInt64 {
|
|
return fmt.Errorf("Blocknumber too high")
|
|
}
|
|
|
|
*bn = BlockNumber(blckNum)
|
|
return nil
|
|
}
|
|
|
|
func (bn BlockNumber) Int64() int64 {
|
|
return (int64)(bn)
|
|
}
|