Packages

final case class BatchOpenChannel(nodePubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, localFundingAmount: Long = 0L, pushSat: Long = 0L, private: Boolean = false, minHtlcMsat: Long = 0L, remoteCsvDelay: UInt32 = lnrpc.BatchOpenChannel._typemapper_remoteCsvDelay.toCustom(0), closeAddress: String = "", pendingChanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, commitmentType: CommitmentType = lnrpc.CommitmentType.UNKNOWN_COMMITMENT_TYPE, remoteMaxValueInFlightMsat: UInt64 = lnrpc.BatchOpenChannel._typemapper_remoteMaxValueInFlightMsat.toCustom(0L), remoteMaxHtlcs: UInt32 = lnrpc.BatchOpenChannel._typemapper_remoteMaxHtlcs.toCustom(0), maxLocalCsv: UInt32 = lnrpc.BatchOpenChannel._typemapper_maxLocalCsv.toCustom(0), zeroConf: Boolean = false, scidAlias: Boolean = false, baseFee: UInt64 = lnrpc.BatchOpenChannel._typemapper_baseFee.toCustom(0L), feeRate: UInt64 = lnrpc.BatchOpenChannel._typemapper_feeRate.toCustom(0L), useBaseFee: Boolean = false, useFeeRate: Boolean = false, remoteChanReserveSat: UInt64 = lnrpc.BatchOpenChannel._typemapper_remoteChanReserveSat.toCustom(0L), memo: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BatchOpenChannel] 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.

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.

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.

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.

pendingChanId

An optional, unique identifier of 32 random bytes that will be used as the pending channel ID to identify the channel while it is in the pre-pending state.

commitmentType

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

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.

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.

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.

Annotations
@SerialVersionUID()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BatchOpenChannel
  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 BatchOpenChannel(nodePubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, localFundingAmount: Long = 0L, pushSat: Long = 0L, private: Boolean = false, minHtlcMsat: Long = 0L, remoteCsvDelay: UInt32 = lnrpc.BatchOpenChannel._typemapper_remoteCsvDelay.toCustom(0), closeAddress: String = "", pendingChanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, commitmentType: CommitmentType = lnrpc.CommitmentType.UNKNOWN_COMMITMENT_TYPE, remoteMaxValueInFlightMsat: UInt64 = lnrpc.BatchOpenChannel._typemapper_remoteMaxValueInFlightMsat.toCustom(0L), remoteMaxHtlcs: UInt32 = lnrpc.BatchOpenChannel._typemapper_remoteMaxHtlcs.toCustom(0), maxLocalCsv: UInt32 = lnrpc.BatchOpenChannel._typemapper_maxLocalCsv.toCustom(0), zeroConf: Boolean = false, scidAlias: Boolean = false, baseFee: UInt64 = lnrpc.BatchOpenChannel._typemapper_baseFee.toCustom(0L), feeRate: UInt64 = lnrpc.BatchOpenChannel._typemapper_feeRate.toCustom(0L), useBaseFee: Boolean = false, useFeeRate: Boolean = false, remoteChanReserveSat: UInt64 = lnrpc.BatchOpenChannel._typemapper_remoteChanReserveSat.toCustom(0L), memo: String = "", 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.

    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.

    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.

    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.

    pendingChanId

    An optional, unique identifier of 32 random bytes that will be used as the pending channel ID to identify the channel while it is in the pre-pending state.

    commitmentType

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

    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.

    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.

    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.

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. val baseFee: UInt64
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val closeAddress: String
  8. val commitmentType: CommitmentType
  9. def companion: BatchOpenChannel.type
    Definition Classes
    BatchOpenChannel → GeneratedMessage
  10. def discardUnknownFields: BatchOpenChannel
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. val feeRate: UInt64
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    BatchOpenChannel → GeneratedMessage
  16. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    BatchOpenChannel → GeneratedMessage
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val localFundingAmount: Long
  19. val maxLocalCsv: UInt32
  20. val memo: String
  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 pendingChanId: ByteString
  27. val private: Boolean
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. val pushSat: Long
  30. val remoteChanReserveSat: UInt64
  31. val remoteCsvDelay: UInt32
  32. val remoteMaxHtlcs: UInt32
  33. val remoteMaxValueInFlightMsat: UInt64
  34. val scidAlias: Boolean
  35. def serializedSize: Int
    Definition Classes
    BatchOpenChannel → GeneratedMessage
  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  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
    BatchOpenChannel → GeneratedMessage
  41. val unknownFields: UnknownFieldSet
  42. def update(ms: (Lens[BatchOpenChannel, BatchOpenChannel]) => Mutation[BatchOpenChannel]*): BatchOpenChannel
    Definition Classes
    Updatable
  43. val useBaseFee: Boolean
  44. val useFeeRate: Boolean
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  48. def withBaseFee(__v: UInt64): BatchOpenChannel
  49. def withCloseAddress(__v: String): BatchOpenChannel
  50. def withCommitmentType(__v: CommitmentType): BatchOpenChannel
  51. def withFeeRate(__v: UInt64): BatchOpenChannel
  52. def withLocalFundingAmount(__v: Long): BatchOpenChannel
  53. def withMaxLocalCsv(__v: UInt32): BatchOpenChannel
  54. def withMemo(__v: String): BatchOpenChannel
  55. def withMinHtlcMsat(__v: Long): BatchOpenChannel
  56. def withNodePubkey(__v: ByteString): BatchOpenChannel
  57. def withPendingChanId(__v: ByteString): BatchOpenChannel
  58. def withPrivate(__v: Boolean): BatchOpenChannel
  59. def withPushSat(__v: Long): BatchOpenChannel
  60. def withRemoteChanReserveSat(__v: UInt64): BatchOpenChannel
  61. def withRemoteCsvDelay(__v: UInt32): BatchOpenChannel
  62. def withRemoteMaxHtlcs(__v: UInt32): BatchOpenChannel
  63. def withRemoteMaxValueInFlightMsat(__v: UInt64): BatchOpenChannel
  64. def withScidAlias(__v: Boolean): BatchOpenChannel
  65. def withUnknownFields(__v: UnknownFieldSet): BatchOpenChannel
  66. def withUseBaseFee(__v: Boolean): BatchOpenChannel
  67. def withUseFeeRate(__v: Boolean): BatchOpenChannel
  68. def withZeroConf(__v: Boolean): BatchOpenChannel
  69. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  70. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    BatchOpenChannel → GeneratedMessage
  71. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  72. val zeroConf: Boolean

Inherited from Updatable[BatchOpenChannel]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped