Packages

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

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CLightningRpcClient
  2. StartStopAsync
  3. StartStop
  4. NativeProcessFactory
  5. BitcoinSLogger
  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
    CLightningRpcClientNativeProcessFactory
  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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. implicit val executionContext: ExecutionContext
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  22. def findChannel(shortChanId: ShortChannelId): Future[Option[Channel]]
  23. def findPeer(nodeId: NodeId): Future[Option[CLightningPeer]]
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def getInfo: Future[CLightningInfo]
  26. def getNewAddress(addressType: AddressType): Future[BitcoinAddress]
  27. def getNewAddress: Future[BitcoinAddress]
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def initChannelOpen(nodeId: NodeId, amount: CurrencyUnit, privateChannel: Boolean): Future[FundChannelStartResult]
  30. val instance: CLightningInstanceLocal
  31. def isAlive(): Boolean
    Definition Classes
    NativeProcessFactory
  32. def isConnected(nodeId: NodeId): Future[Boolean]
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. def listChannels(): Future[Vector[Channel]]
  35. def listFunds(spent: Boolean): Future[ListFundsResult]
  36. def listFunds: Future[ListFundsResult]
  37. def listInvoices: Future[Vector[CLightningLookupInvoiceResult]]
  38. def listPeers: Future[Vector[CLightningPeer]]
  39. def listTransactions(): Future[Vector[CLightningTransaction]]
  40. def logger: Logger
    Definition Classes
    BitcoinSLogger
  41. def lookupInvoice(paymentHash: Sha256Digest): Future[Option[CLightningLookupInvoiceResult]]
  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. def nodeId: Future[NodeId]
  44. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. def openChannel(nodeId: NodeId, fundingAmount: CurrencyUnit, pushAmt: CurrencyUnit, feeRate: FeeUnit, privateChannel: Boolean): Future[FundChannelResult]
  47. def payInvoice(invoice: LnInvoice, amount: CurrencyUnit): Future[CLightningPayResult]
  48. def payInvoice(invoice: LnInvoice): Future[CLightningPayResult]
  49. def reserveInputs(psbt: PSBT, exclusive: Boolean, reserve: Int): Future[Vector[InputReservation]]
  50. def reserveInputs(psbt: PSBT, exclusive: Boolean): Future[Vector[InputReservation]]
  51. def reserveInputs(psbt: PSBT): Future[Vector[InputReservation]]
  52. def sendCustomMessage(peer: NodeId, lnMessage: LnMessage[TLV]): Future[SendCustomMessageResult]
  53. def sendCustomMessage(peer: NodeId, tlv: TLV): Future[SendCustomMessageResult]
  54. def sendCustomMessage(peer: NodeId, tpe: BigSizeUInt, data: ByteVector): Future[SendCustomMessageResult]
  55. def sendToAddress(address: BitcoinAddress, amount: Satoshis, feeRate: FeeUnit): Future[WithdrawResult]
  56. def sendToAddress(address: BitcoinAddress, amount: Satoshis): Future[WithdrawResult]
  57. def signPSBT(psbt: PSBT, indexesToSign: Vector[Int]): Future[PSBT]
  58. def signPSBT(psbt: PSBT): Future[PSBT]
  59. def start(): Future[CLightningRpcClient]
    Definition Classes
    CLightningRpcClientStartStop
  60. 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
  61. def stop(): Future[CLightningRpcClient]
    Definition Classes
    CLightningRpcClientStartStop
  62. 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
  63. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  64. def toString(): String
    Definition Classes
    AnyRef → Any
  65. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  68. def waitInvoice(label: String): Future[CLightningLookupInvoiceResult]
  69. def walletBalance(): Future[WalletBalances]
  70. def withdraw(address: BitcoinAddress, amount: Satoshis, feeRate: FeeUnit): Future[WithdrawResult]
  71. def withdraw(address: BitcoinAddress, amount: Satoshis): Future[WithdrawResult]

Inherited from NativeProcessFactory

Inherited from BitcoinSLogger

Inherited from AnyRef

Inherited from Any

Ungrouped