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()
- Alphabetic
- By Inheritance
- OpenChannelRequest
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllOutpoints(__vs: Iterable[OutPoint]): OpenChannelRequest
- def addOutpoints(__vs: OutPoint*): OpenChannelRequest
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val baseFee: UInt64
- def clearFundingShim: OpenChannelRequest
- def clearOutpoints: OpenChannelRequest
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val closeAddress: String
- val commitmentType: CommitmentType
- def companion: OpenChannelRequest.type
- Definition Classes
- OpenChannelRequest → GeneratedMessage
- def discardUnknownFields: OpenChannelRequest
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val feeRate: UInt64
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- val fundMax: Boolean
- val fundingShim: Option[FundingShim]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- OpenChannelRequest → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- OpenChannelRequest → GeneratedMessage
- def getFundingShim: FundingShim
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val localFundingAmount: Long
- val maxLocalCsv: UInt32
- val memo: String
- val minConfs: Int
- val minHtlcMsat: Long
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val nodePubkey: ByteString
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val outpoints: Seq[OutPoint]
- val private: Boolean
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val pushSat: Long
- val remoteChanReserveSat: UInt64
- val remoteCsvDelay: UInt32
- val remoteMaxHtlcs: UInt32
- val remoteMaxValueInFlightMsat: UInt64
- val satPerVbyte: UInt64
- val scidAlias: Boolean
- def serializedSize: Int
- Definition Classes
- OpenChannelRequest → GeneratedMessage
- val spendUnconfirmed: Boolean
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val targetConf: Int
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- OpenChannelRequest → GeneratedMessage
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[OpenChannelRequest, OpenChannelRequest]) => Mutation[OpenChannelRequest]*): OpenChannelRequest
- Definition Classes
- Updatable
- val useBaseFee: Boolean
- val useFeeRate: Boolean
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withBaseFee(__v: UInt64): OpenChannelRequest
- def withCloseAddress(__v: String): OpenChannelRequest
- def withCommitmentType(__v: CommitmentType): OpenChannelRequest
- def withFeeRate(__v: UInt64): OpenChannelRequest
- def withFundMax(__v: Boolean): OpenChannelRequest
- def withFundingShim(__v: FundingShim): OpenChannelRequest
- def withLocalFundingAmount(__v: Long): OpenChannelRequest
- def withMaxLocalCsv(__v: UInt32): OpenChannelRequest
- def withMemo(__v: String): OpenChannelRequest
- def withMinConfs(__v: Int): OpenChannelRequest
- def withMinHtlcMsat(__v: Long): OpenChannelRequest
- def withNodePubkey(__v: ByteString): OpenChannelRequest
- def withNodePubkeyString(__v: String): OpenChannelRequest
- def withOutpoints(__v: Seq[OutPoint]): OpenChannelRequest
- def withPrivate(__v: Boolean): OpenChannelRequest
- def withPushSat(__v: Long): OpenChannelRequest
- def withRemoteChanReserveSat(__v: UInt64): OpenChannelRequest
- def withRemoteCsvDelay(__v: UInt32): OpenChannelRequest
- def withRemoteMaxHtlcs(__v: UInt32): OpenChannelRequest
- def withRemoteMaxValueInFlightMsat(__v: UInt64): OpenChannelRequest
- def withSatPerByte(__v: Long): OpenChannelRequest
- def withSatPerVbyte(__v: UInt64): OpenChannelRequest
- def withScidAlias(__v: Boolean): OpenChannelRequest
- def withSpendUnconfirmed(__v: Boolean): OpenChannelRequest
- def withTargetConf(__v: Int): OpenChannelRequest
- def withUnknownFields(__v: UnknownFieldSet): OpenChannelRequest
- def withUseBaseFee(__v: Boolean): OpenChannelRequest
- def withUseFeeRate(__v: Boolean): OpenChannelRequest
- def withZeroConf(__v: Boolean): OpenChannelRequest
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- OpenChannelRequest → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- val zeroConf: Boolean