Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ILightningClient

Hierarchy

  • ILightningClient

Implemented by

Index

Methods

Methods

abandonChannel

addInvoice

  • addInvoice(request: Invoice, callback: (error: ServiceError | null, response: AddInvoiceResponse) => void): ClientUnaryCall
  • addInvoice(request: Invoice, metadata: Metadata, callback: (error: ServiceError | null, response: AddInvoiceResponse) => void): ClientUnaryCall
  • addInvoice(request: Invoice, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: AddInvoiceResponse) => void): ClientUnaryCall

bakeMacaroon

channelAcceptor

channelBalance

closeChannel

closedChannels

connectPeer

debugLevel

decodePayReq

  • decodePayReq(request: PayReqString, callback: (error: ServiceError | null, response: PayReq) => void): ClientUnaryCall
  • decodePayReq(request: PayReqString, metadata: Metadata, callback: (error: ServiceError | null, response: PayReq) => void): ClientUnaryCall
  • decodePayReq(request: PayReqString, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: PayReq) => void): ClientUnaryCall

  • Parameters

    • request: PayReqString
    • callback: (error: ServiceError | null, response: PayReq) => void
        • (error: ServiceError | null, response: PayReq): void

        • Parameters

          • error: ServiceError | null
          • response: PayReq

          Returns void

    Returns ClientUnaryCall

  • Parameters

    • request: PayReqString
    • metadata: Metadata
    • callback: (error: ServiceError | null, response: PayReq) => void
        • (error: ServiceError | null, response: PayReq): void

        • Parameters

          • error: ServiceError | null
          • response: PayReq

          Returns void

    Returns ClientUnaryCall

  • Parameters

    • request: PayReqString
    • metadata: Metadata
    • options: Partial<CallOptions>
    • callback: (error: ServiceError | null, response: PayReq) => void
        • (error: ServiceError | null, response: PayReq): void

        • Parameters

          • error: ServiceError | null
          • response: PayReq

          Returns void

    Returns ClientUnaryCall

deleteAllPayments

describeGraph

  • describeGraph(request: ChannelGraphRequest, callback: (error: ServiceError | null, response: ChannelGraph) => void): ClientUnaryCall
  • describeGraph(request: ChannelGraphRequest, metadata: Metadata, callback: (error: ServiceError | null, response: ChannelGraph) => void): ClientUnaryCall
  • describeGraph(request: ChannelGraphRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: ChannelGraph) => void): ClientUnaryCall

disconnectPeer

estimateFee

exportAllChannelBackups

exportChannelBackup

feeReport

forwardingHistory

fundingStateStep

getChanInfo

  • getChanInfo(request: ChanInfoRequest, callback: (error: ServiceError | null, response: ChannelEdge) => void): ClientUnaryCall
  • getChanInfo(request: ChanInfoRequest, metadata: Metadata, callback: (error: ServiceError | null, response: ChannelEdge) => void): ClientUnaryCall
  • getChanInfo(request: ChanInfoRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: ChannelEdge) => void): ClientUnaryCall

getInfo

  • getInfo(request: GetInfoRequest, callback: (error: ServiceError | null, response: GetInfoResponse) => void): ClientUnaryCall
  • getInfo(request: GetInfoRequest, metadata: Metadata, callback: (error: ServiceError | null, response: GetInfoResponse) => void): ClientUnaryCall
  • getInfo(request: GetInfoRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: GetInfoResponse) => void): ClientUnaryCall

getNetworkInfo

  • getNetworkInfo(request: NetworkInfoRequest, callback: (error: ServiceError | null, response: NetworkInfo) => void): ClientUnaryCall
  • getNetworkInfo(request: NetworkInfoRequest, metadata: Metadata, callback: (error: ServiceError | null, response: NetworkInfo) => void): ClientUnaryCall
  • getNetworkInfo(request: NetworkInfoRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: NetworkInfo) => void): ClientUnaryCall

getNodeInfo

  • getNodeInfo(request: NodeInfoRequest, callback: (error: ServiceError | null, response: NodeInfo) => void): ClientUnaryCall
  • getNodeInfo(request: NodeInfoRequest, metadata: Metadata, callback: (error: ServiceError | null, response: NodeInfo) => void): ClientUnaryCall
  • getNodeInfo(request: NodeInfoRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: NodeInfo) => void): ClientUnaryCall

getTransactions

listChannels

listInvoices

listPayments

listPeers

listUnspent

lookupInvoice

  • lookupInvoice(request: PaymentHash, callback: (error: ServiceError | null, response: Invoice) => void): ClientUnaryCall
  • lookupInvoice(request: PaymentHash, metadata: Metadata, callback: (error: ServiceError | null, response: Invoice) => void): ClientUnaryCall
  • lookupInvoice(request: PaymentHash, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: Invoice) => void): ClientUnaryCall

  • Parameters

    • request: PaymentHash
    • callback: (error: ServiceError | null, response: Invoice) => void
        • (error: ServiceError | null, response: Invoice): void

        • Parameters

          • error: ServiceError | null
          • response: Invoice

          Returns void

    Returns ClientUnaryCall

  • Parameters

    • request: PaymentHash
    • metadata: Metadata
    • callback: (error: ServiceError | null, response: Invoice) => void
        • (error: ServiceError | null, response: Invoice): void

        • Parameters

          • error: ServiceError | null
          • response: Invoice

          Returns void

    Returns ClientUnaryCall

  • Parameters

    • request: PaymentHash
    • metadata: Metadata
    • options: Partial<CallOptions>
    • callback: (error: ServiceError | null, response: Invoice) => void
        • (error: ServiceError | null, response: Invoice): void

        • Parameters

          • error: ServiceError | null
          • response: Invoice

          Returns void

    Returns ClientUnaryCall

newAddress

openChannel

openChannelSync

  • openChannelSync(request: OpenChannelRequest, callback: (error: ServiceError | null, response: ChannelPoint) => void): ClientUnaryCall
  • openChannelSync(request: OpenChannelRequest, metadata: Metadata, callback: (error: ServiceError | null, response: ChannelPoint) => void): ClientUnaryCall
  • openChannelSync(request: OpenChannelRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: ChannelPoint) => void): ClientUnaryCall

pendingChannels

queryRoutes

restoreChannelBackups

sendCoins

sendMany

sendPayment

sendPaymentSync

  • sendPaymentSync(request: SendRequest, callback: (error: ServiceError | null, response: SendResponse) => void): ClientUnaryCall
  • sendPaymentSync(request: SendRequest, metadata: Metadata, callback: (error: ServiceError | null, response: SendResponse) => void): ClientUnaryCall
  • sendPaymentSync(request: SendRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: SendResponse) => void): ClientUnaryCall

sendToRoute

sendToRouteSync

  • sendToRouteSync(request: SendToRouteRequest, callback: (error: ServiceError | null, response: SendResponse) => void): ClientUnaryCall
  • sendToRouteSync(request: SendToRouteRequest, metadata: Metadata, callback: (error: ServiceError | null, response: SendResponse) => void): ClientUnaryCall
  • sendToRouteSync(request: SendToRouteRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: SendResponse) => void): ClientUnaryCall

signMessage

stopDaemon

  • stopDaemon(request: StopRequest, callback: (error: ServiceError | null, response: StopResponse) => void): ClientUnaryCall
  • stopDaemon(request: StopRequest, metadata: Metadata, callback: (error: ServiceError | null, response: StopResponse) => void): ClientUnaryCall
  • stopDaemon(request: StopRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: StopResponse) => void): ClientUnaryCall

subscribeChannelBackups

subscribeChannelEvents

subscribeChannelGraph

subscribeInvoices

subscribePeerEvents

subscribeTransactions

updateChannelPolicy

verifyChanBackup

verifyMessage

walletBalance

Generated using TypeDoc