org.lightningj.lnd.invoices.proto

Interface InvoicesGrpc.AsyncService

All Known Implementing Classes:

InvoicesGrpc.InvoicesImplBase

Enclosing class:

InvoicesGrpc

public static interface InvoicesGrpc.AsyncService

 Invoices is a service that can be used to create, accept, settle and cancel
 invoices.
 

Method Summary

Modifier and Type	Method and Description
default void	addHoldInvoice(InvoicesOuterClass.AddHoldInvoiceRequest request, io.grpc.stub.StreamObserver<InvoicesOuterClass.AddHoldInvoiceResp> responseObserver) AddHoldInvoice creates a hold invoice.
default void	cancelInvoice(InvoicesOuterClass.CancelInvoiceMsg request, io.grpc.stub.StreamObserver<InvoicesOuterClass.CancelInvoiceResp> responseObserver) CancelInvoice cancels a currently open invoice.
default void	lookupInvoiceV2(InvoicesOuterClass.LookupInvoiceMsg request, io.grpc.stub.StreamObserver<LightningApi.Invoice> responseObserver) LookupInvoiceV2 attempts to look up at invoice.
default void	settleInvoice(InvoicesOuterClass.SettleInvoiceMsg request, io.grpc.stub.StreamObserver<InvoicesOuterClass.SettleInvoiceResp> responseObserver) SettleInvoice settles an accepted invoice.
default void	subscribeSingleInvoice(InvoicesOuterClass.SubscribeSingleInvoiceRequest request, io.grpc.stub.StreamObserver<LightningApi.Invoice> responseObserver) SubscribeSingleInvoice returns a uni-directional stream (server -> client) to notify the client of state transitions of the specified invoice.

Method Detail

subscribeSingleInvoice

default void subscribeSingleInvoice(InvoicesOuterClass.SubscribeSingleInvoiceRequest request,
                                    io.grpc.stub.StreamObserver<LightningApi.Invoice> responseObserver)

SubscribeSingleInvoice returns a uni-directional stream (server -> client)
to notify the client of state transitions of the specified invoice.
Initially the current invoice state is always sent out.
 

cancelInvoice

default void cancelInvoice(InvoicesOuterClass.CancelInvoiceMsg request,
                           io.grpc.stub.StreamObserver<InvoicesOuterClass.CancelInvoiceResp> responseObserver)

CancelInvoice cancels a currently open invoice. If the invoice is already
canceled, this call will succeed. If the invoice is already settled, it will
fail.
 

addHoldInvoice

default void addHoldInvoice(InvoicesOuterClass.AddHoldInvoiceRequest request,
                            io.grpc.stub.StreamObserver<InvoicesOuterClass.AddHoldInvoiceResp> responseObserver)

AddHoldInvoice creates a hold invoice. It ties the invoice to the hash
supplied in the request.
 

settleInvoice

default void settleInvoice(InvoicesOuterClass.SettleInvoiceMsg request,
                           io.grpc.stub.StreamObserver<InvoicesOuterClass.SettleInvoiceResp> responseObserver)

SettleInvoice settles an accepted invoice. If the invoice is already
settled, this call will succeed.
 

lookupInvoiceV2

default void lookupInvoiceV2(InvoicesOuterClass.LookupInvoiceMsg request,
                             io.grpc.stub.StreamObserver<LightningApi.Invoice> responseObserver)

LookupInvoiceV2 attempts to look up at invoice. An invoice can be refrenced
using either its payment hash, payment address, or set ID.