Packages

final case class OpenChannelRequest(satPerVbyte: UInt64 = lnrpc.OpenChannelRequest._typemapper_satPerVbyte.toCustom(0L), 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: UInt32 = lnrpc.OpenChannelRequest._typemapper_remoteCsvDelay.toCustom(0), minConfs: Int = 0, spendUnconfirmed: Boolean = false, closeAddress: String = "", fundingShim: Option[FundingShim] = _root_.scala.None, remoteMaxValueInFlightMsat: UInt64 = lnrpc.OpenChannelRequest._typemapper_remoteMaxValueInFlightMsat.toCustom(0L), remoteMaxHtlcs: UInt32 = lnrpc.OpenChannelRequest._typemapper_remoteMaxHtlcs.toCustom(0), maxLocalCsv: UInt32 = lnrpc.OpenChannelRequest._typemapper_maxLocalCsv.toCustom(0), commitmentType: CommitmentType = lnrpc.CommitmentType.UNKNOWN_COMMITMENT_TYPE, zeroConf: Boolean = false, scidAlias: Boolean = false, baseFee: UInt64 = lnrpc.OpenChannelRequest._typemapper_baseFee.toCustom(0L), feeRate: UInt64 = lnrpc.OpenChannelRequest._typemapper_feeRate.toCustom(0L), useBaseFee: Boolean = false, useFeeRate: Boolean = false, remoteChanReserveSat: UInt64 = lnrpc.OpenChannelRequest._typemapper_remoteChanReserveSat.toCustom(0L), fundMax: Boolean = false, memo: String = "", outpoints: Seq[OutPoint] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[OpenChannelRequest] with Product with Serializable

satPerVbyte

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

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

Deprecated, use sat_per_vbyte. A manual fee rate set in sat/vbyte 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.

commitmentType

The explicit commitment type to use. Note this field will only be used if the remote peer supports explicit channel negotiation.

zeroConf

If this is true, then a zero-conf channel open will be attempted.

scidAlias

If this is true, then an option-scid-alias channel-type open will be attempted.

baseFee

The base fee charged regardless of the number of milli-satoshis sent.

feeRate

The fee rate in ppm (parts per million) that will be charged in proportion of the value of each forwarded HTLC.

useBaseFee

If use_base_fee is true the open channel announcement will update the channel base fee with the value specified in base_fee. In the case of a base_fee of 0 use_base_fee is needed downstream to distinguish whether to use the default base fee value specified in the config or 0.

useFeeRate

If use_fee_rate is true the open channel announcement will update the channel fee rate with the value specified in fee_rate. In the case of a fee_rate of 0 use_fee_rate is needed downstream to distinguish whether to use the default fee rate value specified in the config or 0.

remoteChanReserveSat

The number of satoshis we require the remote peer to reserve. This value, if specified, must be above the dust limit and below 20% of the channel capacity.

fundMax

If set, then lnd will attempt to commit all the coins under control of the internal wallet to open the channel, and the LocalFundingAmount field must be zero and is ignored.

memo

An optional note-to-self to go along with the channel containing some useful information. This is only ever stored locally and in no way impacts the channel's operation.

outpoints

A list of selected outpoints that are allocated for channel funding.

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

Instance Constructors

  1. new OpenChannelRequest(satPerVbyte: UInt64 = lnrpc.OpenChannelRequest._typemapper_satPerVbyte.toCustom(0L), 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: UInt32 = lnrpc.OpenChannelRequest._typemapper_remoteCsvDelay.toCustom(0), minConfs: Int = 0, spendUnconfirmed: Boolean = false, closeAddress: String = "", fundingShim: Option[FundingShim] = _root_.scala.None, remoteMaxValueInFlightMsat: UInt64 = lnrpc.OpenChannelRequest._typemapper_remoteMaxValueInFlightMsat.toCustom(0L), remoteMaxHtlcs: UInt32 = lnrpc.OpenChannelRequest._typemapper_remoteMaxHtlcs.toCustom(0), maxLocalCsv: UInt32 = lnrpc.OpenChannelRequest._typemapper_maxLocalCsv.toCustom(0), commitmentType: CommitmentType = lnrpc.CommitmentType.UNKNOWN_COMMITMENT_TYPE, zeroConf: Boolean = false, scidAlias: Boolean = false, baseFee: UInt64 = lnrpc.OpenChannelRequest._typemapper_baseFee.toCustom(0L), feeRate: UInt64 = lnrpc.OpenChannelRequest._typemapper_feeRate.toCustom(0L), useBaseFee: Boolean = false, useFeeRate: Boolean = false, remoteChanReserveSat: UInt64 = lnrpc.OpenChannelRequest._typemapper_remoteChanReserveSat.toCustom(0L), fundMax: Boolean = false, memo: String = "", outpoints: Seq[OutPoint] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    satPerVbyte

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

    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

    Deprecated, use sat_per_vbyte. A manual fee rate set in sat/vbyte 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.

    commitmentType

    The explicit commitment type to use. Note this field will only be used if the remote peer supports explicit channel negotiation.

    zeroConf

    If this is true, then a zero-conf channel open will be attempted.

    scidAlias

    If this is true, then an option-scid-alias channel-type open will be attempted.

    baseFee

    The base fee charged regardless of the number of milli-satoshis sent.

    feeRate

    The fee rate in ppm (parts per million) that will be charged in proportion of the value of each forwarded HTLC.

    useBaseFee

    If use_base_fee is true the open channel announcement will update the channel base fee with the value specified in base_fee. In the case of a base_fee of 0 use_base_fee is needed downstream to distinguish whether to use the default base fee value specified in the config or 0.

    useFeeRate

    If use_fee_rate is true the open channel announcement will update the channel fee rate with the value specified in fee_rate. In the case of a fee_rate of 0 use_fee_rate is needed downstream to distinguish whether to use the default fee rate value specified in the config or 0.

    remoteChanReserveSat

    The number of satoshis we require the remote peer to reserve. This value, if specified, must be above the dust limit and below 20% of the channel capacity.

    fundMax

    If set, then lnd will attempt to commit all the coins under control of the internal wallet to open the channel, and the LocalFundingAmount field must be zero and is ignored.

    memo

    An optional note-to-self to go along with the channel containing some useful information. This is only ever stored locally and in no way impacts the channel's operation.

    outpoints

    A list of selected outpoints that are allocated for channel funding.

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. def addAllOutpoints(__vs: Iterable[OutPoint]): OpenChannelRequest
  5. def addOutpoints(__vs: OutPoint*): OpenChannelRequest
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val baseFee: UInt64
  8. def clearFundingShim: OpenChannelRequest
  9. def clearOutpoints: OpenChannelRequest
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. val closeAddress: String
  12. val commitmentType: CommitmentType
  13. def companion: OpenChannelRequest.type
    Definition Classes
    OpenChannelRequest → GeneratedMessage
  14. def discardUnknownFields: OpenChannelRequest
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. val feeRate: UInt64
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. val fundMax: Boolean
  19. val fundingShim: Option[FundingShim]
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    OpenChannelRequest → GeneratedMessage
  22. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    OpenChannelRequest → GeneratedMessage
  23. def getFundingShim: FundingShim
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. val localFundingAmount: Long
  26. val maxLocalCsv: UInt32
  27. val memo: String
  28. val minConfs: Int
  29. val minHtlcMsat: Long
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. val nodePubkey: ByteString
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. val outpoints: Seq[OutPoint]
  35. val private: Boolean
  36. def productElementNames: Iterator[String]
    Definition Classes
    Product
  37. val pushSat: Long
  38. val remoteChanReserveSat: UInt64
  39. val remoteCsvDelay: UInt32
  40. val remoteMaxHtlcs: UInt32
  41. val remoteMaxValueInFlightMsat: UInt64
  42. val satPerVbyte: UInt64
  43. val scidAlias: Boolean
  44. def serializedSize: Int
    Definition Classes
    OpenChannelRequest → GeneratedMessage
  45. val spendUnconfirmed: Boolean
  46. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  47. val targetConf: Int
  48. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  49. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  50. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  51. def toProtoString: String
    Definition Classes
    OpenChannelRequest → GeneratedMessage
  52. val unknownFields: UnknownFieldSet
  53. def update(ms: (Lens[OpenChannelRequest, OpenChannelRequest]) => Mutation[OpenChannelRequest]*): OpenChannelRequest
    Definition Classes
    Updatable
  54. val useBaseFee: Boolean
  55. val useFeeRate: Boolean
  56. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  59. def withBaseFee(__v: UInt64): OpenChannelRequest
  60. def withCloseAddress(__v: String): OpenChannelRequest
  61. def withCommitmentType(__v: CommitmentType): OpenChannelRequest
  62. def withFeeRate(__v: UInt64): OpenChannelRequest
  63. def withFundMax(__v: Boolean): OpenChannelRequest
  64. def withFundingShim(__v: FundingShim): OpenChannelRequest
  65. def withLocalFundingAmount(__v: Long): OpenChannelRequest
  66. def withMaxLocalCsv(__v: UInt32): OpenChannelRequest
  67. def withMemo(__v: String): OpenChannelRequest
  68. def withMinConfs(__v: Int): OpenChannelRequest
  69. def withMinHtlcMsat(__v: Long): OpenChannelRequest
  70. def withNodePubkey(__v: ByteString): OpenChannelRequest
  71. def withNodePubkeyString(__v: String): OpenChannelRequest
  72. def withOutpoints(__v: Seq[OutPoint]): OpenChannelRequest
  73. def withPrivate(__v: Boolean): OpenChannelRequest
  74. def withPushSat(__v: Long): OpenChannelRequest
  75. def withRemoteChanReserveSat(__v: UInt64): OpenChannelRequest
  76. def withRemoteCsvDelay(__v: UInt32): OpenChannelRequest
  77. def withRemoteMaxHtlcs(__v: UInt32): OpenChannelRequest
  78. def withRemoteMaxValueInFlightMsat(__v: UInt64): OpenChannelRequest
  79. def withSatPerByte(__v: Long): OpenChannelRequest
  80. def withSatPerVbyte(__v: UInt64): OpenChannelRequest
  81. def withScidAlias(__v: Boolean): OpenChannelRequest
  82. def withSpendUnconfirmed(__v: Boolean): OpenChannelRequest
  83. def withTargetConf(__v: Int): OpenChannelRequest
  84. def withUnknownFields(__v: UnknownFieldSet): OpenChannelRequest
  85. def withUseBaseFee(__v: Boolean): OpenChannelRequest
  86. def withUseFeeRate(__v: Boolean): OpenChannelRequest
  87. def withZeroConf(__v: Boolean): OpenChannelRequest
  88. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  89. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    OpenChannelRequest → GeneratedMessage
  90. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  91. val zeroConf: Boolean

Deprecated Value Members

  1. val nodePubkeyString: String
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

  2. val satPerByte: Long
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped