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/decred/dcrwallet/blob/master/rpc/documentation/api.md

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

https://github.com/decred/dcrwallet/blob/master/rpc/documentation/serverchanges.md

Index

• func RegisterServices(server *grpc.Server)
• func ServiceReady(service string) error
• func StartAccountMixerService(server *grpc.Server, loader *loader.Loader)
• func StartAgendaService(server *grpc.Server, activeNet *chaincfg.Params)
• func StartDecodeMessageService(server *grpc.Server, chainParams *chaincfg.Params)
• func StartMessageVerificationService(server *grpc.Server, chainParams *chaincfg.Params)
• func StartNetworkService(server *grpc.Server, wallet *wallet.Wallet)
• func StartTicketBuyerV2Service(server *grpc.Server, loader *loader.Loader)
• func StartVotingService(server *grpc.Server, wallet *wallet.Wallet)
• func StartWalletLoaderService(server *grpc.Server, loader *loader.Loader, activeNet *netparams.Params)
• func StartWalletService(server *grpc.Server, wallet *wallet.Wallet, dialCSPP dialFunc)
• func UseLogger(l slog.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 StartAccountMixerService

func StartAccountMixerService(server *grpc.Server, loader *loader.Loader)

StartAccountMixerService starts the AccountMixerService.

func StartAgendaService

func StartAgendaService(server *grpc.Server, activeNet *chaincfg.Params)

func StartDecodeMessageService

func StartDecodeMessageService(server *grpc.Server, chainParams *chaincfg.Params)

StartDecodeMessageService starts the MessageDecode service

func StartMessageVerificationService

func StartMessageVerificationService(server *grpc.Server, chainParams *chaincfg.Params)

StartMessageVerificationService starts the MessageVerification service

func StartNetworkService

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

StartNetworkService starts the NetworkService.

func StartTicketBuyerV2Service

func StartTicketBuyerV2Service(server *grpc.Server, loader *loader.Loader)

StartTicketBuyerV2Service starts the TicketBuyerV2Service.

func StartVotingService

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

StartVotingService starts the VotingService.

func StartWalletLoaderService

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

StartWalletLoaderService starts the WalletLoaderService.

func StartWalletService

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

StartWalletService starts the WalletService.

func UseLogger

func UseLogger(l slog.Logger)

UseLogger sets the logger to use for the gRPC server.