Packages

final case class CloseChannelRequest(channelPoint: Option[ChannelPoint] = _root_.scala.None, force: Boolean = false, targetConf: Int = 0, satPerByte: Long = 0L, deliveryAddress: String = "", satPerVbyte: UInt64 = lnrpc.CloseChannelRequest._typemapper_satPerVbyte.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CloseChannelRequest] with Product with Serializable

channelPoint

The outpoint (txid:index) of the funding transaction. With this value, Bob will be able to generate a signature for Alice's version of the commitment transaction.

force

If true, then the channel will be closed forcibly. This means the current commitment transaction will be signed and broadcast.

targetConf

The target number of blocks that the closure 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 closure transaction.

deliveryAddress

An optional address to send funds to in the case of a cooperative close. If the channel was opened with an upfront shutdown script and this field is set, the request to close will fail because the channel must pay out to the upfront shutdown addresss.

satPerVbyte

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

Annotations
@SerialVersionUID()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CloseChannelRequest
  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 CloseChannelRequest(channelPoint: Option[ChannelPoint] = _root_.scala.None, force: Boolean = false, targetConf: Int = 0, satPerByte: Long = 0L, deliveryAddress: String = "", satPerVbyte: UInt64 = lnrpc.CloseChannelRequest._typemapper_satPerVbyte.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    channelPoint

    The outpoint (txid:index) of the funding transaction. With this value, Bob will be able to generate a signature for Alice's version of the commitment transaction.

    force

    If true, then the channel will be closed forcibly. This means the current commitment transaction will be signed and broadcast.

    targetConf

    The target number of blocks that the closure 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 closure transaction.

    deliveryAddress

    An optional address to send funds to in the case of a cooperative close. If the channel was opened with an upfront shutdown script and this field is set, the request to close will fail because the channel must pay out to the upfront shutdown addresss.

    satPerVbyte

    A manual fee rate set in sat/vbyte that should be used when crafting the closure 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. val channelPoint: Option[ChannelPoint]
  6. def clearChannelPoint: CloseChannelRequest
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def companion: CloseChannelRequest.type
    Definition Classes
    CloseChannelRequest → GeneratedMessage
  9. val deliveryAddress: String
  10. def discardUnknownFields: CloseChannelRequest
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. val force: Boolean
  14. def getChannelPoint: ChannelPoint
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    CloseChannelRequest → GeneratedMessage
  17. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    CloseChannelRequest → GeneratedMessage
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. val satPerVbyte: UInt64
  24. def serializedSize: Int
    Definition Classes
    CloseChannelRequest → GeneratedMessage
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. val targetConf: Int
  27. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  28. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  29. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  30. def toProtoString: String
    Definition Classes
    CloseChannelRequest → GeneratedMessage
  31. val unknownFields: UnknownFieldSet
  32. def update(ms: (Lens[CloseChannelRequest, CloseChannelRequest]) => Mutation[CloseChannelRequest]*): CloseChannelRequest
    Definition Classes
    Updatable
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. def withChannelPoint(__v: ChannelPoint): CloseChannelRequest
  37. def withDeliveryAddress(__v: String): CloseChannelRequest
  38. def withForce(__v: Boolean): CloseChannelRequest
  39. def withSatPerByte(__v: Long): CloseChannelRequest
  40. def withSatPerVbyte(__v: UInt64): CloseChannelRequest
  41. def withTargetConf(__v: Int): CloseChannelRequest
  42. def withUnknownFields(__v: UnknownFieldSet): CloseChannelRequest
  43. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  44. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    CloseChannelRequest → GeneratedMessage
  45. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. 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