Packages

final case class OpenChannelRequest(nodePubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, nodePubkeyString: String = "", localFundingAmount: Long = 0L, pushSat: Long = 0L, targetConf: Int = 0, satPerByte: Long = 0L, private: Boolean = false, minHtlcMsat: Long = 0L, remoteCsvDelay: Int = 0, minConfs: Int = 0, spendUnconfirmed: Boolean = false, closeAddress: String = "", fundingShim: Option[FundingShim] = _root_.scala.None, remoteMaxValueInFlightMsat: Long = 0L, remoteMaxHtlcs: Int = 0, maxLocalCsv: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[OpenChannelRequest] with Product with Serializable

nodePubkey

The pubkey of the node to open a channel with. When using REST, this field must be encoded as base64.

nodePubkeyString

The hex encoded pubkey of the node to open a channel with. Deprecated now that the REST gateway supports base64 encoding of bytes fields.

localFundingAmount

The number of satoshis the wallet should commit to the channel

pushSat

The number of satoshis to push to the remote side as part of the initial commitment state

targetConf

The target number of blocks that the funding transaction should be confirmed by.

satPerByte

A manual fee rate set in sat/byte that should be used when crafting the funding transaction.

private

Whether this channel should be private, not announced to the greater network.

minHtlcMsat

The minimum value in millisatoshi we will require for incoming HTLCs on the channel.

remoteCsvDelay

The delay we require on the remote's commitment transaction. If this is not set, it will be scaled automatically with the channel size.

minConfs

The minimum number of confirmations each one of your outputs used for the funding transaction must satisfy.

spendUnconfirmed

Whether unconfirmed outputs should be used as inputs for the funding transaction.

closeAddress

Close address is an optional address which specifies the address to which funds should be paid out to upon cooperative close. This field may only be set if the peer supports the option upfront feature bit (call listpeers to check). The remote peer will only accept cooperative closes to this address if it is set. Note: If this value is set on channel creation, you will *not* be able to cooperatively close out to a different address.

fundingShim

Funding shims are an optional argument that allow the caller to intercept certain funding functionality. For example, a shim can be provided to use a particular key for the commitment key (ideally cold) rather than use one that is generated by the wallet as normal, or signal that signing will be carried out in an interactive manner (PSBT based).

remoteMaxValueInFlightMsat

The maximum amount of coins in millisatoshi that can be pending within the channel. It only applies to the remote party.

remoteMaxHtlcs

The maximum number of concurrent HTLCs we will allow the remote party to add to the commitment transaction.

maxLocalCsv

Max local csv is the maximum csv delay we will allow for our own commitment transaction.

Annotations
@SerialVersionUID()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpenChannelRequest
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new OpenChannelRequest(nodePubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, nodePubkeyString: String = "", localFundingAmount: Long = 0L, pushSat: Long = 0L, targetConf: Int = 0, satPerByte: Long = 0L, private: Boolean = false, minHtlcMsat: Long = 0L, remoteCsvDelay: Int = 0, minConfs: Int = 0, spendUnconfirmed: Boolean = false, closeAddress: String = "", fundingShim: Option[FundingShim] = _root_.scala.None, remoteMaxValueInFlightMsat: Long = 0L, remoteMaxHtlcs: Int = 0, maxLocalCsv: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    nodePubkey

    The pubkey of the node to open a channel with. When using REST, this field must be encoded as base64.

    nodePubkeyString

    The hex encoded pubkey of the node to open a channel with. Deprecated now that the REST gateway supports base64 encoding of bytes fields.

    localFundingAmount

    The number of satoshis the wallet should commit to the channel

    pushSat

    The number of satoshis to push to the remote side as part of the initial commitment state

    targetConf

    The target number of blocks that the funding transaction should be confirmed by.

    satPerByte

    A manual fee rate set in sat/byte that should be used when crafting the funding transaction.

    private

    Whether this channel should be private, not announced to the greater network.

    minHtlcMsat

    The minimum value in millisatoshi we will require for incoming HTLCs on the channel.

    remoteCsvDelay

    The delay we require on the remote's commitment transaction. If this is not set, it will be scaled automatically with the channel size.

    minConfs

    The minimum number of confirmations each one of your outputs used for the funding transaction must satisfy.

    spendUnconfirmed

    Whether unconfirmed outputs should be used as inputs for the funding transaction.

    closeAddress

    Close address is an optional address which specifies the address to which funds should be paid out to upon cooperative close. This field may only be set if the peer supports the option upfront feature bit (call listpeers to check). The remote peer will only accept cooperative closes to this address if it is set. Note: If this value is set on channel creation, you will *not* be able to cooperatively close out to a different address.

    fundingShim

    Funding shims are an optional argument that allow the caller to intercept certain funding functionality. For example, a shim can be provided to use a particular key for the commitment key (ideally cold) rather than use one that is generated by the wallet as normal, or signal that signing will be carried out in an interactive manner (PSBT based).

    remoteMaxValueInFlightMsat

    The maximum amount of coins in millisatoshi that can be pending within the channel. It only applies to the remote party.

    remoteMaxHtlcs

    The maximum number of concurrent HTLCs we will allow the remote party to add to the commitment transaction.

    maxLocalCsv

    Max local csv is the maximum csv delay we will allow for our own commitment transaction.

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 clearFundingShim: OpenChannelRequest
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val closeAddress: String
  8. def companion: OpenChannelRequest
    Definition Classes
    OpenChannelRequest → GeneratedMessage
  9. def discardUnknownFields: OpenChannelRequest
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. val fundingShim: Option[FundingShim]
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    OpenChannelRequest → GeneratedMessage
  15. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    OpenChannelRequest → GeneratedMessage
  16. def getFundingShim: FundingShim
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val localFundingAmount: Long
  19. val maxLocalCsv: Int
  20. val minConfs: Int
  21. val minHtlcMsat: Long
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. val nodePubkey: ByteString
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. val private: Boolean
  27. def productElementNames: Iterator[String]
    Definition Classes
    Product
  28. val pushSat: Long
  29. val remoteCsvDelay: Int
  30. val remoteMaxHtlcs: Int
  31. val remoteMaxValueInFlightMsat: Long
  32. val satPerByte: Long
  33. def serializedSize: Int
    Definition Classes
    OpenChannelRequest → GeneratedMessage
  34. val spendUnconfirmed: Boolean
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. val targetConf: Int
  37. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  38. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  39. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  40. def toProtoString: String
    Definition Classes
    OpenChannelRequest → GeneratedMessage
  41. val unknownFields: UnknownFieldSet
  42. def update(ms: (Lens[OpenChannelRequest, OpenChannelRequest]) => Mutation[OpenChannelRequest]*): OpenChannelRequest
    Definition Classes
    Updatable
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  46. def withCloseAddress(__v: String): OpenChannelRequest
  47. def withFundingShim(__v: FundingShim): OpenChannelRequest
  48. def withLocalFundingAmount(__v: Long): OpenChannelRequest
  49. def withMaxLocalCsv(__v: Int): OpenChannelRequest
  50. def withMinConfs(__v: Int): OpenChannelRequest
  51. def withMinHtlcMsat(__v: Long): OpenChannelRequest
  52. def withNodePubkey(__v: ByteString): OpenChannelRequest
  53. def withNodePubkeyString(__v: String): OpenChannelRequest
  54. def withPrivate(__v: Boolean): OpenChannelRequest
  55. def withPushSat(__v: Long): OpenChannelRequest
  56. def withRemoteCsvDelay(__v: Int): OpenChannelRequest
  57. def withRemoteMaxHtlcs(__v: Int): OpenChannelRequest
  58. def withRemoteMaxValueInFlightMsat(__v: Long): OpenChannelRequest
  59. def withSatPerByte(__v: Long): OpenChannelRequest
  60. def withSpendUnconfirmed(__v: Boolean): OpenChannelRequest
  61. def withTargetConf(__v: Int): OpenChannelRequest
  62. def withUnknownFields(__v: UnknownFieldSet): OpenChannelRequest
  63. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  64. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    OpenChannelRequest → GeneratedMessage
  65. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. val nodePubkeyString: String
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

Inherited from Product

Inherited from Equals

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped