rpcserver

Documentation

Overview

Package rpcserver implements the RPC API and is used by the main package to start gRPC services.

Full documentation of the API implemented by this package is maintained in a language-agnostic document:

https://github.com/gcash/bchwallet/blob/master/rpc/documentation/api.md

Any API changes must be performed according to the steps listed here:

https://github.com/gcash/bchwallet/blob/master/rpc/documentation/serverchanges.md

Index

• func RegisterServices(server *grpc.Server)
• func ServiceReady(service string) error
• func StartWalletLoaderService(server *grpc.Server, loader *wallet.Loader, activeNet *netparams.Params)
• func StartWalletService(server *grpc.Server, wallet *wallet.Wallet)
• func UseLogger(l bchlog.Logger)

Functions

func RegisterServices

func RegisterServices(server *grpc.Server)

RegisterServices registers implementations of each gRPC service and registers it with the server. Not all service are ready to be used after registration.

func ServiceReady

func ServiceReady(service string) error

ServiceReady returns nil when the service is ready and a gRPC error when not.

func StartWalletLoaderService

func StartWalletLoaderService(server *grpc.Server, loader *wallet.Loader, activeNet *netparams.Params)

StartWalletLoaderService creates an implementation of the WalletLoaderService and registers it with the gRPC server.

func StartWalletService

func StartWalletService(server *grpc.Server, wallet *wallet.Wallet)

StartWalletService creates an implementation of the WalletService and registers it with the gRPC server.

func UseLogger

func UseLogger(l bchlog.Logger)

UseLogger sets the logger to use for the gRPC server.