Package net.osslabz.lnd.dto

Class LnrpcChannel

java.lang.Object
net.osslabz.lnd.dto.LnrpcChannel
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-06-07T12:03:34.958542131Z[Etc/UTC]") public class LnrpcChannel extends Object
LnrpcChannel

  • Field Details

  • Constructor Details

    • LnrpcChannel

      public LnrpcChannel()

  • Method Details

    • active

      public LnrpcChannel active(Boolean active)

    • getActive

      @Nullable public Boolean getActive()
      Get active
      Returns:
      active

    • setActive

      public void setActive(Boolean active)

    • remotePubkey

      public LnrpcChannel remotePubkey(String remotePubkey)

    • getRemotePubkey

      @Nullable public String getRemotePubkey()
      Get remotePubkey
      Returns:
      remotePubkey

    • setRemotePubkey

      public void setRemotePubkey(String remotePubkey)

    • channelPoint

      public LnrpcChannel channelPoint(String channelPoint)

    • getChannelPoint

      @Nullable public String getChannelPoint()
      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.
      Returns:
      channelPoint

    • setChannelPoint

      public void setChannelPoint(String channelPoint)

    • chanId

      public LnrpcChannel chanId(String chanId)

    • getChanId

      @Nullable public String getChanId()
      The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.
      Returns:
      chanId

    • setChanId

      public void setChanId(String chanId)

    • capacity

      public LnrpcChannel capacity(String capacity)

    • getCapacity

      @Nullable public String getCapacity()
      Get capacity
      Returns:
      capacity

    • setCapacity

      public void setCapacity(String capacity)

    • localBalance

      public LnrpcChannel localBalance(String localBalance)

    • getLocalBalance

      @Nullable public String getLocalBalance()
      Get localBalance
      Returns:
      localBalance

    • setLocalBalance

      public void setLocalBalance(String localBalance)

    • remoteBalance

      public LnrpcChannel remoteBalance(String remoteBalance)

    • getRemoteBalance

      @Nullable public String getRemoteBalance()
      Get remoteBalance
      Returns:
      remoteBalance

    • setRemoteBalance

      public void setRemoteBalance(String remoteBalance)

    • commitFee

      public LnrpcChannel commitFee(String commitFee)

    • getCommitFee

      @Nullable public String getCommitFee()
      The amount calculated to be paid in fees for the current set of commitment transactions. The fee amount is persisted with the channel in order to allow the fee amount to be removed and recalculated with each channel state update, including updates that happen after a system restart.
      Returns:
      commitFee

    • setCommitFee

      public void setCommitFee(String commitFee)

    • commitWeight

      public LnrpcChannel commitWeight(String commitWeight)

    • getCommitWeight

      @Nullable public String getCommitWeight()
      Get commitWeight
      Returns:
      commitWeight

    • setCommitWeight

      public void setCommitWeight(String commitWeight)

    • feePerKw

      public LnrpcChannel feePerKw(String feePerKw)

    • getFeePerKw

      @Nullable public String getFeePerKw()
      The required number of satoshis per kilo-weight that the requester will pay at all times, for both the funding transaction and commitment transaction. This value can later be updated once the channel is open.
      Returns:
      feePerKw

    • setFeePerKw

      public void setFeePerKw(String feePerKw)

    • unsettledBalance

      public LnrpcChannel unsettledBalance(String unsettledBalance)

    • getUnsettledBalance

      @Nullable public String getUnsettledBalance()
      Get unsettledBalance
      Returns:
      unsettledBalance

    • setUnsettledBalance

      public void setUnsettledBalance(String unsettledBalance)

    • totalSatoshisSent

      public LnrpcChannel totalSatoshisSent(String totalSatoshisSent)

    • getTotalSatoshisSent

      @Nullable public String getTotalSatoshisSent()
      The total number of satoshis we've sent within this channel.
      Returns:
      totalSatoshisSent

    • setTotalSatoshisSent

      public void setTotalSatoshisSent(String totalSatoshisSent)

    • totalSatoshisReceived

      public LnrpcChannel totalSatoshisReceived(String totalSatoshisReceived)

    • getTotalSatoshisReceived

      @Nullable public String getTotalSatoshisReceived()
      The total number of satoshis we've received within this channel.
      Returns:
      totalSatoshisReceived

    • setTotalSatoshisReceived

      public void setTotalSatoshisReceived(String totalSatoshisReceived)

    • numUpdates

      public LnrpcChannel numUpdates(String numUpdates)

    • getNumUpdates

      @Nullable public String getNumUpdates()
      The total number of updates conducted within this channel.
      Returns:
      numUpdates

    • setNumUpdates

      public void setNumUpdates(String numUpdates)

    • pendingHtlcs

      public LnrpcChannel pendingHtlcs(List<LnrpcHTLC> pendingHtlcs)

    • addPendingHtlcsItem

      public LnrpcChannel addPendingHtlcsItem(LnrpcHTLC pendingHtlcsItem)

    • getPendingHtlcs

      @Nullable public List<LnrpcHTLC> getPendingHtlcs()
      The list of active, uncleared HTLCs currently pending within the channel.
      Returns:
      pendingHtlcs

    • setPendingHtlcs

      public void setPendingHtlcs(List<LnrpcHTLC> pendingHtlcs)

    • csvDelay

      public LnrpcChannel csvDelay(Long csvDelay)

    • getCsvDelay

      @Nullable public Long getCsvDelay()
      Deprecated. The CSV delay expressed in relative blocks. If the channel is force closed, we will need to wait for this many blocks before we can regain our funds.
      Returns:
      csvDelay

    • setCsvDelay

      public void setCsvDelay(Long csvDelay)

    • _private

      public LnrpcChannel _private(Boolean _private)

    • getPrivate

      @Nullable public Boolean getPrivate()
      Whether this channel is advertised to the network or not.
      Returns:
      _private

    • setPrivate

      public void setPrivate(Boolean _private)

    • initiator

      public LnrpcChannel initiator(Boolean initiator)

    • getInitiator

      @Nullable public Boolean getInitiator()
      True if we were the ones that created the channel.
      Returns:
      initiator

    • setInitiator

      public void setInitiator(Boolean initiator)

    • chanStatusFlags

      public LnrpcChannel chanStatusFlags(String chanStatusFlags)

    • getChanStatusFlags

      @Nullable public String getChanStatusFlags()
      A set of flags showing the current state of the channel.
      Returns:
      chanStatusFlags

    • setChanStatusFlags

      public void setChanStatusFlags(String chanStatusFlags)

    • localChanReserveSat

      public LnrpcChannel localChanReserveSat(String localChanReserveSat)

    • getLocalChanReserveSat

      @Nullable public String getLocalChanReserveSat()
      Deprecated. The minimum satoshis this node is required to reserve in its balance.
      Returns:
      localChanReserveSat

    • setLocalChanReserveSat

      public void setLocalChanReserveSat(String localChanReserveSat)

    • remoteChanReserveSat

      public LnrpcChannel remoteChanReserveSat(String remoteChanReserveSat)

    • getRemoteChanReserveSat

      @Nullable public String getRemoteChanReserveSat()
      Deprecated. The minimum satoshis the other node is required to reserve in its balance.
      Returns:
      remoteChanReserveSat

    • setRemoteChanReserveSat

      public void setRemoteChanReserveSat(String remoteChanReserveSat)

    • staticRemoteKey

      public LnrpcChannel staticRemoteKey(Boolean staticRemoteKey)

    • getStaticRemoteKey

      @Nullable public Boolean getStaticRemoteKey()
      Deprecated. Use commitment_type.
      Returns:
      staticRemoteKey

    • setStaticRemoteKey

      public void setStaticRemoteKey(Boolean staticRemoteKey)

    • commitmentType

      public LnrpcChannel commitmentType(LnrpcCommitmentType commitmentType)

    • getCommitmentType

      @Nullable public LnrpcCommitmentType getCommitmentType()
      Get commitmentType
      Returns:
      commitmentType

    • setCommitmentType

      public void setCommitmentType(LnrpcCommitmentType commitmentType)

    • lifetime

      public LnrpcChannel lifetime(String lifetime)

    • getLifetime

      @Nullable public String getLifetime()
      The number of seconds that the channel has been monitored by the channel scoring system. Scores are currently not persisted, so this value may be less than the lifetime of the channel [EXPERIMENTAL].
      Returns:
      lifetime

    • setLifetime

      public void setLifetime(String lifetime)

    • uptime

      public LnrpcChannel uptime(String uptime)

    • getUptime

      @Nullable public String getUptime()
      The number of seconds that the remote peer has been observed as being online by the channel scoring system over the lifetime of the channel [EXPERIMENTAL].
      Returns:
      uptime

    • setUptime

      public void setUptime(String uptime)

    • closeAddress

      public LnrpcChannel closeAddress(String closeAddress)

    • getCloseAddress

      @Nullable public String getCloseAddress()
      Close address is the address that we will enforce payout to on cooperative close if the channel was opened utilizing option upfront shutdown. This value can be set on channel open by setting close_address in an open channel request. If this value is not set, you can still choose a payout address by cooperatively closing with the delivery_address field set.
      Returns:
      closeAddress

    • setCloseAddress

      public void setCloseAddress(String closeAddress)

    • pushAmountSat

      public LnrpcChannel pushAmountSat(String pushAmountSat)

    • getPushAmountSat

      @Nullable public String getPushAmountSat()
      The amount that the initiator of the channel optionally pushed to the remote party on channel open. This amount will be zero if the channel initiator did not push any funds to the remote peer. If the initiator field is true, we pushed this amount to our peer, if it is false, the remote peer pushed this amount to us.
      Returns:
      pushAmountSat

    • setPushAmountSat

      public void setPushAmountSat(String pushAmountSat)

    • thawHeight

      public LnrpcChannel thawHeight(Long thawHeight)

    • getThawHeight

      @Nullable public Long getThawHeight()
      This uint32 indicates if this channel is to be considered 'frozen'. A frozen channel doest not allow a cooperative channel close by the initiator. The thaw_height is the height that this restriction stops applying to the channel. This field is optional, not setting it or using a value of zero will mean the channel has no additional restrictions. The height can be interpreted in two ways: as a relative height if the value is less than 500,000, or as an absolute height otherwise.
      Returns:
      thawHeight

    • setThawHeight

      public void setThawHeight(Long thawHeight)

    • localConstraints

      public LnrpcChannel localConstraints(LnrpcChannelConstraints localConstraints)

    • getLocalConstraints

      @Nullable public LnrpcChannelConstraints getLocalConstraints()
      Get localConstraints
      Returns:
      localConstraints

    • setLocalConstraints

      public void setLocalConstraints(LnrpcChannelConstraints localConstraints)

    • remoteConstraints

      public LnrpcChannel remoteConstraints(LnrpcChannelConstraints remoteConstraints)

    • getRemoteConstraints

      @Nullable public LnrpcChannelConstraints getRemoteConstraints()
      Get remoteConstraints
      Returns:
      remoteConstraints

    • setRemoteConstraints

      public void setRemoteConstraints(LnrpcChannelConstraints remoteConstraints)

    • aliasScids

      public LnrpcChannel aliasScids(List<String> aliasScids)

    • addAliasScidsItem

      public LnrpcChannel addAliasScidsItem(String aliasScidsItem)

    • getAliasScids

      @Nullable public List<String> getAliasScids()
      This lists out the set of alias short channel ids that exist for a channel. This may be empty.
      Returns:
      aliasScids

    • setAliasScids

      public void setAliasScids(List<String> aliasScids)

    • zeroConf

      public LnrpcChannel zeroConf(Boolean zeroConf)

    • getZeroConf

      @Nullable public Boolean getZeroConf()
      Whether or not this is a zero-conf channel.
      Returns:
      zeroConf

    • setZeroConf

      public void setZeroConf(Boolean zeroConf)

    • zeroConfConfirmedScid

      public LnrpcChannel zeroConfConfirmedScid(String zeroConfConfirmedScid)

    • getZeroConfConfirmedScid

      @Nullable public String getZeroConfConfirmedScid()
      This is the confirmed / on-chain zero-conf SCID.
      Returns:
      zeroConfConfirmedScid

    • setZeroConfConfirmedScid

      public void setZeroConfConfirmedScid(String zeroConfConfirmedScid)

    • peerAlias

      public LnrpcChannel peerAlias(String peerAlias)

    • getPeerAlias

      @Nullable public String getPeerAlias()
      The configured alias name of our peer.
      Returns:
      peerAlias

    • setPeerAlias

      public void setPeerAlias(String peerAlias)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object