Class: Lnrpc::Lightning::Service

Inherits:
Object
  • Object
show all
Includes:
GRPC::GenericService
Defined in:
lib/grpc_services/lightning_services_pb.rb

Overview

Comments in this file will be directly parsed into the API Documentation as descriptions of the associated method, message, or field. These descriptions should go right above the definition of the object, and can be in either block or // comment format.

An RPC method can be matched to an lncli command by placing a line in the beginning of the description in exactly the following format: lncli: ‘methodname`

Failure to specify the exact name of the command will cause documentation generation to fail.

More information on how exactly the gRPC documentation is generated from this proto file can be found here: github.com/lightninglabs/lightning-api

Lightning is the main RPC server of the daemon.