497ffc11f0
This is a rather monolithic commit that moves the old RPC server to its own package (rpc/legacyrpc), introduces a new RPC server using gRPC (rpc/rpcserver), and provides the ability to defer wallet loading until request at a later time by an RPC (--noinitialload). The legacy RPC server remains the default for now while the new gRPC server is not enabled by default. Enabling the new server requires setting a listen address (--experimenalrpclisten). This experimental flag is used to effectively feature gate the server until it is ready to use as a default. Both RPC servers can be run at the same time, but require binding to different listen addresses. In theory, with the legacy RPC server now living in its own package it should become much easier to unit test the handlers. This will be useful for any future changes to the package, as compatibility with Core's wallet is still desired. Type safety has also been improved in the legacy RPC server. Multiple handler types are now used for methods that do and do not require the RPC client as a dependency. This can statically help prevent nil pointer dereferences, and was very useful for catching bugs during refactoring. To synchronize the wallet loading process between the main package (the default) and through the gRPC WalletLoader service (with the --noinitialload option), as well as increasing the loose coupling of packages, a new wallet.Loader type has been added. All creating and loading of existing wallets is done through a single Loader instance, and callbacks can be attached to the instance to run after the wallet has been opened. This is how the legacy RPC server is associated with a loaded wallet, even after the wallet is loaded by a gRPC method in a completely unrelated package. Documentation for the new RPC server has been added to the rpc/documentation directory. The documentation includes a specification for the new RPC API, addresses how to make changes to the server implementation, and provides short example clients in several different languages. Some of the new RPC methods are not implementated exactly as described by the specification. These are considered bugs with the implementation, not the spec. Known bugs are commented as such.
82 lines
2.3 KiB
Go
82 lines
2.3 KiB
Go
// Copyright (c) 2015-2016 The btcsuite developers
|
|
//
|
|
// Permission to use, copy, modify, and distribute this software for any
|
|
// purpose with or without fee is hereby granted, provided that the above
|
|
// copyright notice and this permission notice appear in all copies.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
package rpcserver
|
|
|
|
import (
|
|
"os"
|
|
"strings"
|
|
|
|
"google.golang.org/grpc/grpclog"
|
|
|
|
"github.com/btcsuite/btclog"
|
|
)
|
|
|
|
// UseLogger sets the logger to use for the gRPC server.
|
|
func UseLogger(l btclog.Logger) {
|
|
grpclog.SetLogger(logger{l})
|
|
}
|
|
|
|
// logger uses a btclog.Logger to implement the grpclog.Logger interface.
|
|
type logger struct {
|
|
btclog.Logger
|
|
}
|
|
|
|
// stripGrpcPrefix removes the package prefix for all logs made to the grpc
|
|
// logger, since these are already included as the btclog subsystem name.
|
|
func stripGrpcPrefix(logstr string) string {
|
|
return strings.TrimPrefix(logstr, "grpc: ")
|
|
}
|
|
|
|
// stripGrpcPrefixArgs removes the package prefix from the first argument, if it
|
|
// exists and is a string, returning the same arg slice after reassigning the
|
|
// first arg.
|
|
func stripGrpcPrefixArgs(args ...interface{}) []interface{} {
|
|
if len(args) == 0 {
|
|
return args
|
|
}
|
|
firstArgStr, ok := args[0].(string)
|
|
if ok {
|
|
args[0] = stripGrpcPrefix(firstArgStr)
|
|
}
|
|
return args
|
|
}
|
|
|
|
func (l logger) Fatal(args ...interface{}) {
|
|
l.Critical(stripGrpcPrefixArgs(args)...)
|
|
os.Exit(1)
|
|
}
|
|
|
|
func (l logger) Fatalf(format string, args ...interface{}) {
|
|
l.Criticalf(stripGrpcPrefix(format), args...)
|
|
os.Exit(1)
|
|
}
|
|
|
|
func (l logger) Fatalln(args ...interface{}) {
|
|
l.Critical(stripGrpcPrefixArgs(args)...)
|
|
os.Exit(1)
|
|
}
|
|
|
|
func (l logger) Print(args ...interface{}) {
|
|
l.Info(stripGrpcPrefixArgs(args)...)
|
|
}
|
|
|
|
func (l logger) Printf(format string, args ...interface{}) {
|
|
l.Infof(stripGrpcPrefix(format), args...)
|
|
}
|
|
|
|
func (l logger) Println(args ...interface{}) {
|
|
l.Info(stripGrpcPrefixArgs(args)...)
|
|
}
|