Packages

class CLightningRpcClient extends CLightningUnixSocketHandler with NativeProcessFactory with StartStopAsync[CLightningRpcClient] with Logging

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

Instance Constructors

  1. new CLightningRpcClient(instance: CLightningInstanceLocal, binary: File)(implicit executionContext: ExecutionContext)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def cancelChannelOpen(nodeId: NodeId): Future[FundChannelCancelResult]
  6. def clightningCall[T](command: String, parameters: JsValue = JsArray.empty)(implicit reader: Reads[T]): Future[T]
    Definition Classes
    CLightningUnixSocketHandler
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def closeChannel(channelId: FundedChannelId): Future[CloseChannelResult]
  9. def closeChannel(shortChanId: ShortChannelId): Future[CloseChannelResult]
  10. def closeChannel(id: NodeId): Future[CloseChannelResult]
  11. val cmd: String

    The command to start the daemon on the underlying OS

    The command to start the daemon on the underlying OS

    Definition Classes
    CLightningRpcClient → NativeProcessFactory
  12. def completeChannelOpen(nodeId: NodeId, psbt: PSBT): Future[FundChannelCompleteResult]
  13. def connect(nodeId: NodeId): Future[ConnectResult]
  14. def connect(uri: NodeUri): Future[ConnectResult]
  15. def connect(nodeId: NodeId, host: String, port: Int): Future[ConnectResult]
  16. def connect(nodeId: NodeId, addr: InetSocketAddress): Future[ConnectResult]
  17. def createInvoice(amount: CurrencyUnit, label: String, description: String, expirySeconds: Long): Future[CLightningInvoiceResult]
  18. def debug(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  19. def debug(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  20. def debug(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. def error(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def error(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def error(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. implicit val executionContext: ExecutionContext
    Definition Classes
    CLightningRpcClient → NativeProcessFactory
  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  28. def findChannel(shortChanId: ShortChannelId): Future[Option[Channel]]
  29. def findPeer(nodeId: NodeId): Future[Option[CLightningPeer]]
  30. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. def getInfo: Future[CLightningInfo]
  32. def getNewAddress(addressType: AddressType): Future[BitcoinAddress]
  33. def getNewAddress: Future[BitcoinAddress]
  34. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  35. def info(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  36. def info(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  37. def info(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  38. def initChannelOpen(nodeId: NodeId, amount: CurrencyUnit, privateChannel: Boolean): Future[FundChannelStartResult]
  39. val instance: CLightningInstanceLocal
  40. def isAlive(): Boolean
    Definition Classes
    NativeProcessFactory
  41. def isConnected(nodeId: NodeId): Future[Boolean]
  42. def isDebugEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  43. def isErrorEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  44. def isInfoEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. def isTraceEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  47. def isWarnEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  48. def listChannels(): Future[Vector[Channel]]
  49. def listFunds(spent: Boolean): Future[ListFundsResult]
  50. def listFunds: Future[ListFundsResult]
  51. def listInvoices: Future[Vector[CLightningLookupInvoiceResult]]
  52. def listPeers: Future[Vector[CLightningPeer]]
  53. def listTransactions(): Future[Vector[CLightningTransaction]]
  54. def logger: Logger
    Attributes
    protected
    Definition Classes
    Logging
  55. def loggerName: String
    Attributes
    protected
    Definition Classes
    Logging
  56. def lookupInvoice(paymentHash: Sha256Digest): Future[Option[CLightningLookupInvoiceResult]]
  57. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  58. def nodeId: Future[NodeId]
  59. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  60. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  61. def openChannel(nodeId: NodeId, fundingAmount: CurrencyUnit, pushAmt: CurrencyUnit, feeRate: FeeUnit, privateChannel: Boolean): Future[FundChannelResult]
  62. def payInvoice(invoice: LnInvoice, amount: CurrencyUnit): Future[CLightningPayResult]
  63. def payInvoice(invoice: LnInvoice): Future[CLightningPayResult]
  64. def reserveInputs(psbt: PSBT, exclusive: Boolean, reserve: Int): Future[Vector[InputReservation]]
  65. def reserveInputs(psbt: PSBT, exclusive: Boolean): Future[Vector[InputReservation]]
  66. def reserveInputs(psbt: PSBT): Future[Vector[InputReservation]]
  67. def sendCustomMessage(peer: NodeId, lnMessage: LnMessage[TLV]): Future[SendCustomMessageResult]
  68. def sendCustomMessage(peer: NodeId, tlv: TLV): Future[SendCustomMessageResult]
  69. def sendCustomMessage(peer: NodeId, tpe: BigSizeUInt, data: ByteVector): Future[SendCustomMessageResult]
  70. def sendToAddress(address: BitcoinAddress, amount: Satoshis, feeRate: FeeUnit): Future[WithdrawResult]
  71. def sendToAddress(address: BitcoinAddress, amount: Satoshis): Future[WithdrawResult]
  72. def signPSBT(psbt: PSBT, indexesToSign: Vector[Int]): Future[PSBT]
  73. def signPSBT(psbt: PSBT): Future[PSBT]
  74. def start(): Future[CLightningRpcClient]
    Definition Classes
    CLightningRpcClient → StartStop
  75. 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
  76. def stop(): Future[CLightningRpcClient]
    Definition Classes
    CLightningRpcClient → StartStop
  77. 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
  78. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  79. def toString(): String
    Definition Classes
    AnyRef → Any
  80. def trace(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def trace(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def trace(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  84. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  85. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  86. def waitInvoice(label: String): Future[CLightningLookupInvoiceResult]
  87. def walletBalance(): Future[WalletBalances]
  88. def warn(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  89. def warn(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  90. def warn(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  91. def withdraw(address: BitcoinAddress, amount: Satoshis, feeRate: FeeUnit): Future[WithdrawResult]
  92. def withdraw(address: BitcoinAddress, amount: Satoshis): Future[WithdrawResult]

Inherited from StartStopAsync[CLightningRpcClient]

Inherited from StartStop[Future[CLightningRpcClient]]

Inherited from NativeProcessFactory

Inherited from Logging

Inherited from CLightningUnixSocketHandler

Inherited from AnyRef

Inherited from Any

Ungrouped