Packages

class LndRpcClient extends NativeProcessFactory with LndUtils with LndRouterClient with StartStopAsync[LndRpcClient] with Logging

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LndRpcClient
  2. StartStopAsync
  3. StartStop
  4. LndRouterClient
  5. LndUtils
  6. NativeProcessFactory
  7. Logging
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LndRpcClient(instance: LndInstance, binaryOpt: Option[File] = None)(implicit system: ActorSystem)

    binaryOpt

    Path to lnd executable

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit def LndTransactionToTxDetails(details: Transaction): TxDetails
    Definition Classes
    LndUtils
  5. def abandonChannel(request: AbandonChannelRequest): Future[Unit]
  6. def abandonChannel(outPoint: TransactionOutPoint, pendingFundingShimOnly: Boolean): Future[Unit]
  7. def addInvoice(invoice: Invoice): Future[AddInvoiceResult]
  8. def addInvoice(descriptionHash: Sha256Digest, value: MilliSatoshis, expiry: Long): Future[AddInvoiceResult]
  9. def addInvoice(memo: String, value: MilliSatoshis, expiry: Long): Future[AddInvoiceResult]
  10. def addInvoice(descriptionHash: Sha256Digest, value: Satoshis, expiry: Long): Future[AddInvoiceResult]
  11. def addInvoice(memo: String, value: Satoshis, expiry: Long): Future[AddInvoiceResult]
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def attemptToPayRoutes(invoice: LnInvoice, routes: Vector[Route]): Future[Option[HTLCAttempt]]
    Definition Classes
    LndRouterClient
  14. implicit def byteStringToByteVec(byteString: ByteString): ByteVector
    Definition Classes
    LndUtils
  15. implicit def byteStringVecToByteVecs(byteStrings: Vector[ByteString]): Vector[ByteVector]
    Definition Classes
    LndUtils
  16. implicit def byteVecToByteString(byteVector: ByteVector): ByteString
    Definition Classes
    LndUtils
  17. def cancelInvoice(hash: Sha256Digest): Future[Unit]
  18. def cancelInvoice(invoice: LnInvoice): Future[Unit]
  19. def channelBalance(): Future[ChannelBalances]
  20. implicit def channelPointToOutpoint(channelPoint: ChannelPoint): TransactionOutPoint
    Definition Classes
    LndUtils
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  22. def closeChannel(request: CloseChannelRequest): Future[TransactionOutPoint]
  23. def closeChannel(outPoint: TransactionOutPoint): Future[TransactionOutPoint]
  24. def closeChannel(outPoint: TransactionOutPoint, force: Boolean, feeRate: SatoshisPerVirtualByte): Future[TransactionOutPoint]
  25. def cmd: String

    The command to start the daemon on the underlying OS

    The command to start the daemon on the underlying OS

    Definition Classes
    LndRpcClient → NativeProcessFactory
  26. def computeInputScript(request: SignReq): Future[Vector[(ScriptSignature, ScriptWitness)]]
  27. def computeInputScript(tx: Transaction, signDescriptors: Vector[SignDescriptor]): Future[Vector[(ScriptSignature, ScriptWitness)]]
  28. def computeInputScript(tx: Transaction, inputIdx: Int, output: TransactionOutput): Future[(ScriptSignature, ScriptWitness)]
  29. def connectPeer(request: ConnectPeerRequest): Future[Unit]
  30. def connectPeer(nodeId: NodeId, addr: InetSocketAddress, permanent: Boolean): Future[Unit]
  31. def connectPeer(nodeId: NodeId, addr: InetSocketAddress): Future[Unit]
  32. def debug(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  33. def debug(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  34. def debug(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  35. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  37. def error(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  38. def error(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  39. def error(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  40. implicit val executionContext: ExecutionContext
    Definition Classes
    LndRpcClient → NativeProcessFactory
  41. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  42. def finalizePSBT(request: FinalizePsbtRequest): Future[PSBT]
  43. def finalizePSBT(psbt: PSBT): Future[PSBT]
  44. def findChannel(chanId: ShortChannelId): Future[Option[Channel]]
  45. def findChannel(channelPoint: TransactionOutPoint): Future[Option[Channel]]
  46. def fundPSBT(request: FundPsbtRequest): Future[PSBT]
  47. def fundPSBT(psbt: PSBT, feeRate: SatoshisPerVirtualByte): Future[PSBT]
  48. def fundPSBT(psbt: PSBT, feeRate: SatoshisPerVirtualByte, spendUnconfirmed: Boolean): Future[PSBT]
  49. def fundPSBT(psbt: PSBT, feeRate: SatoshisPerVirtualByte, account: String, spendUnconfirmed: Boolean): Future[PSBT]
  50. def fundPSBT(inputs: Vector[TransactionOutPoint], outputs: Map[BitcoinAddress, CurrencyUnit], feeRate: SatoshisPerVirtualByte, account: String, spendUnconfirmed: Boolean): Future[PSBT]
  51. def fundPSBT(inputs: Vector[TransactionOutPoint], outputs: Map[BitcoinAddress, CurrencyUnit], feeRate: SatoshisPerVirtualByte, spendUnconfirmed: Boolean): Future[PSBT]
  52. def genSeed(): Future[GenSeedResponse]
  53. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  54. def getInfo: Future[GetInfoResponse]
  55. def getNewAddress: Future[BitcoinAddress]
  56. def getTransaction(txId: DoubleSha256DigestBE): Future[Option[TxDetails]]
  57. def getTransactions(request: GetTransactionsRequest): Future[Vector[TxDetails]]
  58. def getTransactions(startHeight: Int, endHeight: Int): Future[Vector[TxDetails]]
  59. def getTransactions(startHeight: Int): Future[Vector[TxDetails]]
  60. def getTransactions(): Future[Vector[TxDetails]]
  61. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  62. def info(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def info(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def info(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def initWallet(password: String): Future[ByteString]
  66. val instance: LndInstance
  67. lazy val invoices: InvoicesClient
  68. def isAlive(): Boolean
    Definition Classes
    NativeProcessFactory
  69. def isConnected(nodeId: NodeId): Future[Boolean]
  70. def isDebugEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  71. def isErrorEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  72. def isInfoEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  73. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  74. def isStarted: Future[Boolean]

    Boolean check to verify the state of the client

    Boolean check to verify the state of the client

    returns

    Future Boolean representing if client has started

  75. def isStopped: Future[Boolean]

    Checks to see if the client stopped successfully

  76. def isTraceEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  77. def isWarnEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  78. def leaseOutput(request: LeaseOutputRequest): Future[UInt64]

    LeaseOutput locks an output to the given ID, preventing it from being available for any future coin selection attempts.

    LeaseOutput locks an output to the given ID, preventing it from being available for any future coin selection attempts. The absolute time of the lock's expiration is returned. The expiration of the lock can be extended by successive invocations of this RPC.

    request

    LeaseOutputRequest

    returns

    Unix timestamp for when the lease expires

  79. def leaseOutput(outpoint: TransactionOutPoint, leaseSeconds: Long): Future[UInt64]
  80. def listChannels(request: ListChannelsRequest = ListChannelsRequest()): Future[Vector[Channel]]
  81. def listLeases(request: ListLeasesRequest): Future[Vector[UTXOLease]]
  82. def listLeases(): Future[Vector[UTXOLease]]
  83. def listPeers(): Future[Vector[Peer]]
  84. def listUnspent(request: ListUnspentRequest): Future[Vector[UTXOResult]]
  85. def listUnspent: Future[Vector[UTXOResult]]
  86. lazy val lnd: LightningClient
  87. def logger: Logger
    Attributes
    protected
    Definition Classes
    Logging
  88. def loggerName: String
    Attributes
    protected
    Definition Classes
    Logging
  89. def lookupInvoice(req: LookupInvoiceMsg): Future[Invoice]
  90. def lookupInvoice(rHash: PaymentHashTag): Future[Invoice]
  91. def monitorInvoice(rHash: PaymentHashTag, interval: FiniteDuration = 1.second, maxAttempts: Int = 60): Future[Invoice]
  92. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  93. def nodeId: Future[NodeId]
  94. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  95. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  96. def openChannel(request: OpenChannelRequest): Future[Option[TransactionOutPoint]]
  97. def openChannel(nodeId: NodeId, fundingAmount: CurrencyUnit, pushAmt: CurrencyUnit, satPerVByte: SatoshisPerVirtualByte, privateChannel: Boolean): Future[Option[TransactionOutPoint]]
  98. def openChannel(nodeId: NodeId, fundingAmount: CurrencyUnit, satPerVByte: SatoshisPerVirtualByte, privateChannel: Boolean): Future[Option[TransactionOutPoint]]
  99. implicit def outPointToChannelPoint(outPoint: TransactionOutPoint): ChannelPoint
    Definition Classes
    LndUtils
  100. implicit def outpointToTxOutPoint(op: OutPoint): TransactionOutPoint
    Definition Classes
    LndUtils
  101. implicit def outpointVecToTxOutPointVec(ops: Vector[OutPoint]): Vector[TransactionOutPoint]
    Definition Classes
    LndUtils
  102. implicit def outputToTxOut(output: TransactionOutput): TxOut
    Definition Classes
    LndUtils
  103. implicit def outputVecToTxOuts(outputs: Vector[TransactionOutput]): Vector[TxOut]
    Definition Classes
    LndUtils
  104. def probe(amount: Satoshis, node: NodeId, routeHints: Vector[LnRoute]): Future[Vector[Route]]
    Definition Classes
    LndRouterClient
  105. def probe(invoice: LnInvoice): Future[Vector[Route]]
    Definition Classes
    LndRouterClient
  106. def probeAndPay(invoice: LnInvoice): Future[Option[HTLCAttempt]]
    Definition Classes
    LndRouterClient
  107. def publishTransaction(tx: Transaction): Future[Option[String]]

    Broadcasts the given transaction

    Broadcasts the given transaction

    returns

    None if no error, otherwise the error string

  108. def queryRoutes(request: QueryRoutesRequest): Future[QueryRoutesResponse]
    Definition Classes
    LndRouterClient
  109. def queryRoutes(amount: Satoshis, node: NodeId, routeHints: Vector[LnRoute]): Future[QueryRoutesResponse]
    Definition Classes
    LndRouterClient
  110. def releaseOutput(request: ReleaseOutputRequest): Future[Unit]
  111. def releaseOutput(outpoint: TransactionOutPoint): Future[Unit]
  112. lazy val router: RouterClient
  113. def sendCustomMessage(request: SendCustomMessageRequest): Future[Unit]
  114. def sendCustomMessage(peer: NodeId, tpe: BigSizeUInt, data: ByteVector): Future[Unit]
  115. def sendCustomMessage(peer: NodeId, tlv: TLV): Future[Unit]
  116. def sendCustomMessage(peer: NodeId, lnMessage: LnMessage[TLV]): Future[Unit]
  117. def sendOutputs(request: SendOutputsRequest): Future[Transaction]
  118. def sendOutputs(outputs: Vector[TransactionOutput], feeRate: SatoshisPerKW, spendUnconfirmed: Boolean): Future[Transaction]
  119. def sendOutputs(outputs: Vector[TransactionOutput], feeRate: SatoshisPerVirtualByte, spendUnconfirmed: Boolean): Future[Transaction]
  120. def sendPayment(request: SendPaymentRequest): Future[Payment]
  121. def sendPayment(nodeId: NodeId, amount: CurrencyUnit, timeout: FiniteDuration): Future[Payment]
  122. def sendPayment(invoice: LnInvoice, feeLimit: Satoshis, timeout: FiniteDuration): Future[Payment]
  123. def sendPayment(invoice: LnInvoice, timeout: FiniteDuration): Future[Payment]
  124. def sendToRoute(invoice: LnInvoice, route: Route): Future[HTLCAttempt]
    Definition Classes
    LndRouterClient
  125. def sendToRoute(request: SendToRouteRequest): Future[HTLCAttempt]
    Definition Classes
    LndRouterClient
  126. def sendToRoute(hash: Sha256Digest, route: Route): Future[HTLCAttempt]
    Definition Classes
    LndRouterClient
  127. def signPSBT(request: SignPsbtRequest): Future[PSBT]
  128. def signPSBT(psbt: PSBT): Future[PSBT]
  129. lazy val signer: SignerClient
  130. def start(): Future[LndRpcClient]

    Starts lnd on the local system.

    Starts lnd on the local system.

    Definition Classes
    LndRpcClient → StartStop
  131. def startBinary(): Future[Unit]

    Starts the binary by spinning up a new process

    Starts the binary by spinning up a new process

    Definition Classes
    NativeProcessFactory
  132. def stop(): Future[LndRpcClient]

    Returns a Future LndRpcClient if able to shut down Lnd instance, inherits from the StartStop trait

    Returns a Future LndRpcClient if able to shut down Lnd instance, inherits from the StartStop trait

    returns

    A future LndRpcClient that is stopped

    Definition Classes
    LndRpcClient → StartStop
  133. def stopBinary(): Future[Unit]

    Stops the binary by destroying the underlying operating system process

    Stops the binary by destroying the underlying operating system process

    If the client is a remote client (not started on the host operating system) this method is a no-op

    Definition Classes
    NativeProcessFactory
  134. def subscribeChannelBackups(): Source[ChanBackupSnapshot, NotUsed]
  135. def subscribeChannelEvents(): Source[ChannelEventUpdate, NotUsed]
  136. def subscribeChannelGraph(): Source[GraphTopologyUpdate, NotUsed]
  137. def subscribeCustomMessages(): Source[(NodeId, TLV), NotUsed]
  138. def subscribeInvoices(): Source[Invoice, NotUsed]
  139. def subscribePeerEvents(): Source[PeerEvent, NotUsed]
  140. def subscribeTransactions(): Source[TxDetails, NotUsed]
  141. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  142. implicit val system: ActorSystem
  143. def toString(): String
    Definition Classes
    AnyRef → Any
  144. def trace(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  145. def trace(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  146. def trace(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  147. implicit def txOutToTxOutput(txOut: TxOut): TransactionOutput
    Definition Classes
    LndUtils
  148. implicit def txOutpointToOutpoint(outpoint: TransactionOutPoint): OutPoint
    Definition Classes
    LndUtils
  149. implicit def txOutpointToOutpointVec(ops: Vector[TransactionOutPoint]): Vector[OutPoint]
    Definition Classes
    LndUtils
  150. implicit val uint32Mapper: TypeMapper[Int, UInt32]
    Definition Classes
    LndUtils
  151. implicit val uint64Mapper: TypeMapper[Long, UInt64]
    Definition Classes
    LndUtils
  152. def unlockWallet(password: String): Future[Unit]
  153. lazy val unlocker: WalletUnlockerClient
  154. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  155. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  156. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  157. lazy val wallet: WalletKitClient
  158. def walletBalance(): Future[WalletBalances]
  159. def warn(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  160. def warn(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  161. def warn(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging

Inherited from StartStopAsync[LndRpcClient]

Inherited from StartStop[Future[LndRpcClient]]

Inherited from LndRouterClient

Inherited from LndUtils

Inherited from NativeProcessFactory

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped