diff --git a/lnrpc/README.md b/lnrpc/README.md index 6d7e63b4..2a1169da 100644 --- a/lnrpc/README.md +++ b/lnrpc/README.md @@ -15,7 +15,9 @@ need to be used to generate the compiled protos for a specific language. The following languages are supported as clients to `lnrpc`: C++, Go, Node.js, Java, Ruby, Android Java, PHP, Python, C#, Objective-C. -The list of defined RPC's on the main service are the following (with a brief +## Service: Lightning + +The list of defined RPCs on the service `Lightning` are the following (with a brief description): * WalletBalance @@ -37,6 +39,8 @@ description): * Returns a new address, the following address types are supported: pay-to-public-key-hash (p2pkh), pay-to-witness-key-hash (p2wkh), and nested-pay-to-witness-key-hash (np2wkh). + * NewWitnessAddress + * Returns a new witness address (np2wkh) under control of the local wallet. * SignMessage * Signs a message with the node's identity key and returns a zbase32 encoded signature. @@ -55,6 +59,8 @@ description): * List the number of pending (not fully confirmed) channels. * ListChannels * List all active channels the daemon manages. + * OpenChannelSync + * OpenChannelSync is a synchronous version of the OpenChannel RPC call. * OpenChannel * Attempts to open a channel to a target peer with a specific amount and push amount. @@ -64,6 +70,8 @@ description): broadcast the latest channel state. * SendPayment * Send a payment over Lightning to a target peer. + * SendPaymentSync + * SendPaymentSync is the synchronous non-streaming version of SendPayment. * AddInvoice * Adds an invoice to the daemon. Invoices are automatically settled once seen as an incoming HTLC. @@ -74,8 +82,13 @@ description): * SubscribeInvoices * Creates a uni-directional stream which receives async notifications as the daemon settles invoices + * DecodePayReq + * Decode a payment request, returning a full description of the conditions + encoded within the payment request. * ListPayments * List all outgoing Lightning payments the daemon has made. + * DeleteAllPayments + * Deletes all outgoing payments from DB. * DescribeGraph * Returns a description of the known channel graph from the PoV of the node. @@ -84,11 +97,35 @@ description): * GetNodeInfo * Returns information for a particular node identified by its identity public key. - * QueryRoute + * QueryRoutes * Queries for a possible route to a target peer which can carry a certain amount of payment. * GetNetworkInfo * Returns some network level statistics. + * StopDaemon + * Sends a shutdown request to the interrupt handler, triggering a graceful + shutdown of the daemon. + * SubscribeChannelGraph + * Creates a stream which receives async notifications upon any changes to the + channel graph topology from the point of view of the responding node. + * DebugLevel + * Set logging verbosity of lnd programmatically + * FeeReport + * Allows the caller to obtain a report detailing the current fee schedule + enforced by the node globally for each channel. + * UpdateChannelPolicy + * Allows the caller to update the fee schedule and channel policies for all channels + globally, or a particular channel + +## Service: WalletUnlocker + +The list of defined RPCs on the service `WalletUnlocker` are the following (with a brief +description): + + * CreateWallet + * Set encryption password for the wallet database. + * UnlockWallet + * Provide a password to unlock the wallet database. ## Installation and Updating