Package net.osslabz.lnd.dto

Class LnrpcOpenChannelRequest

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

  • Field Details

  • Constructor Details

    • LnrpcOpenChannelRequest

      public LnrpcOpenChannelRequest()

  • Method Details

    • satPerVbyte

      public LnrpcOpenChannelRequest satPerVbyte(String satPerVbyte)

    • getSatPerVbyte

      @Nullable public String getSatPerVbyte()
      A manual fee rate set in sat/vbyte that should be used when crafting the funding transaction.
      Returns:
      satPerVbyte

    • setSatPerVbyte

      public void setSatPerVbyte(String satPerVbyte)

    • nodePubkey

      public LnrpcOpenChannelRequest nodePubkey(byte[] nodePubkey)

    • getNodePubkey

      @Nullable public byte[] getNodePubkey()
      The pubkey of the node to open a channel with. When using REST, this field must be encoded as base64.
      Returns:
      nodePubkey

    • setNodePubkey

      public void setNodePubkey(byte[] nodePubkey)

    • nodePubkeyString

      public LnrpcOpenChannelRequest nodePubkeyString(String nodePubkeyString)

    • getNodePubkeyString

      @Nullable public String getNodePubkeyString()
      The hex encoded pubkey of the node to open a channel with. Deprecated now that the REST gateway supports base64 encoding of bytes fields.
      Returns:
      nodePubkeyString

    • setNodePubkeyString

      public void setNodePubkeyString(String nodePubkeyString)

    • localFundingAmount

      public LnrpcOpenChannelRequest localFundingAmount(String localFundingAmount)

    • getLocalFundingAmount

      @Nullable public String getLocalFundingAmount()
      Get localFundingAmount
      Returns:
      localFundingAmount

    • setLocalFundingAmount

      public void setLocalFundingAmount(String localFundingAmount)

    • pushSat

      public LnrpcOpenChannelRequest pushSat(String pushSat)

    • getPushSat

      @Nullable public String getPushSat()
      Get pushSat
      Returns:
      pushSat

    • setPushSat

      public void setPushSat(String pushSat)

    • targetConf

      public LnrpcOpenChannelRequest targetConf(Integer targetConf)

    • getTargetConf

      @Nullable public Integer getTargetConf()
      The target number of blocks that the funding transaction should be confirmed by.
      Returns:
      targetConf

    • setTargetConf

      public void setTargetConf(Integer targetConf)

    • satPerByte

      public LnrpcOpenChannelRequest satPerByte(String satPerByte)

    • getSatPerByte

      @Nullable public String getSatPerByte()
      Deprecated, use sat_per_vbyte. A manual fee rate set in sat/vbyte that should be used when crafting the funding transaction.
      Returns:
      satPerByte

    • setSatPerByte

      public void setSatPerByte(String satPerByte)

    • _private

      public LnrpcOpenChannelRequest _private(Boolean _private)

    • getPrivate

      @Nullable public Boolean getPrivate()
      Whether this channel should be private, not announced to the greater network.
      Returns:
      _private

    • setPrivate

      public void setPrivate(Boolean _private)

    • minHtlcMsat

      public LnrpcOpenChannelRequest minHtlcMsat(String minHtlcMsat)

    • getMinHtlcMsat

      @Nullable public String getMinHtlcMsat()
      The minimum value in millisatoshi we will require for incoming HTLCs on the channel.
      Returns:
      minHtlcMsat

    • setMinHtlcMsat

      public void setMinHtlcMsat(String minHtlcMsat)

    • remoteCsvDelay

      public LnrpcOpenChannelRequest remoteCsvDelay(Long remoteCsvDelay)

    • getRemoteCsvDelay

      @Nullable public Long getRemoteCsvDelay()
      The delay we require on the remote's commitment transaction. If this is not set, it will be scaled automatically with the channel size.
      Returns:
      remoteCsvDelay

    • setRemoteCsvDelay

      public void setRemoteCsvDelay(Long remoteCsvDelay)

    • minConfs

      public LnrpcOpenChannelRequest minConfs(Integer minConfs)

    • getMinConfs

      @Nullable public Integer getMinConfs()
      The minimum number of confirmations each one of your outputs used for the funding transaction must satisfy.
      Returns:
      minConfs

    • setMinConfs

      public void setMinConfs(Integer minConfs)

    • spendUnconfirmed

      public LnrpcOpenChannelRequest spendUnconfirmed(Boolean spendUnconfirmed)

    • getSpendUnconfirmed

      @Nullable public Boolean getSpendUnconfirmed()
      Whether unconfirmed outputs should be used as inputs for the funding transaction.
      Returns:
      spendUnconfirmed

    • setSpendUnconfirmed

      public void setSpendUnconfirmed(Boolean spendUnconfirmed)

    • closeAddress

      public LnrpcOpenChannelRequest closeAddress(String closeAddress)

    • getCloseAddress

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

    • setCloseAddress

      public void setCloseAddress(String closeAddress)

    • fundingShim

      public LnrpcOpenChannelRequest fundingShim(LnrpcFundingShim fundingShim)

    • getFundingShim

      @Nullable public LnrpcFundingShim getFundingShim()
      Get fundingShim
      Returns:
      fundingShim

    • setFundingShim

      public void setFundingShim(LnrpcFundingShim fundingShim)

    • remoteMaxValueInFlightMsat

      public LnrpcOpenChannelRequest remoteMaxValueInFlightMsat(String remoteMaxValueInFlightMsat)

    • getRemoteMaxValueInFlightMsat

      @Nullable public String getRemoteMaxValueInFlightMsat()
      The maximum amount of coins in millisatoshi that can be pending within the channel. It only applies to the remote party.
      Returns:
      remoteMaxValueInFlightMsat

    • setRemoteMaxValueInFlightMsat

      public void setRemoteMaxValueInFlightMsat(String remoteMaxValueInFlightMsat)

    • remoteMaxHtlcs

      public LnrpcOpenChannelRequest remoteMaxHtlcs(Long remoteMaxHtlcs)

    • getRemoteMaxHtlcs

      @Nullable public Long getRemoteMaxHtlcs()
      The maximum number of concurrent HTLCs we will allow the remote party to add to the commitment transaction.
      Returns:
      remoteMaxHtlcs

    • setRemoteMaxHtlcs

      public void setRemoteMaxHtlcs(Long remoteMaxHtlcs)

    • maxLocalCsv

      public LnrpcOpenChannelRequest maxLocalCsv(Long maxLocalCsv)

    • getMaxLocalCsv

      @Nullable public Long getMaxLocalCsv()
      Max local csv is the maximum csv delay we will allow for our own commitment transaction.
      Returns:
      maxLocalCsv

    • setMaxLocalCsv

      public void setMaxLocalCsv(Long maxLocalCsv)

    • commitmentType

      public LnrpcOpenChannelRequest commitmentType(LnrpcCommitmentType commitmentType)

    • getCommitmentType

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

    • setCommitmentType

      public void setCommitmentType(LnrpcCommitmentType commitmentType)

    • zeroConf

      public LnrpcOpenChannelRequest zeroConf(Boolean zeroConf)

    • getZeroConf

      @Nullable public Boolean getZeroConf()
      If this is true, then a zero-conf channel open will be attempted.
      Returns:
      zeroConf

    • setZeroConf

      public void setZeroConf(Boolean zeroConf)

    • scidAlias

      public LnrpcOpenChannelRequest scidAlias(Boolean scidAlias)

    • getScidAlias

      @Nullable public Boolean getScidAlias()
      If this is true, then an option-scid-alias channel-type open will be attempted.
      Returns:
      scidAlias

    • setScidAlias

      public void setScidAlias(Boolean scidAlias)

    • baseFee

      public LnrpcOpenChannelRequest baseFee(String baseFee)

    • getBaseFee

      @Nullable public String getBaseFee()
      The base fee charged regardless of the number of milli-satoshis sent.
      Returns:
      baseFee

    • setBaseFee

      public void setBaseFee(String baseFee)

    • feeRate

      public LnrpcOpenChannelRequest feeRate(String feeRate)

    • getFeeRate

      @Nullable public String getFeeRate()
      The fee rate in ppm (parts per million) that will be charged in proportion of the value of each forwarded HTLC.
      Returns:
      feeRate

    • setFeeRate

      public void setFeeRate(String feeRate)

    • useBaseFee

      public LnrpcOpenChannelRequest useBaseFee(Boolean useBaseFee)

    • getUseBaseFee

      @Nullable public Boolean getUseBaseFee()
      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.
      Returns:
      useBaseFee

    • setUseBaseFee

      public void setUseBaseFee(Boolean useBaseFee)

    • useFeeRate

      public LnrpcOpenChannelRequest useFeeRate(Boolean useFeeRate)

    • getUseFeeRate

      @Nullable public Boolean getUseFeeRate()
      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.
      Returns:
      useFeeRate

    • setUseFeeRate

      public void setUseFeeRate(Boolean useFeeRate)

    • remoteChanReserveSat

      public LnrpcOpenChannelRequest remoteChanReserveSat(String remoteChanReserveSat)

    • getRemoteChanReserveSat

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

    • setRemoteChanReserveSat

      public void setRemoteChanReserveSat(String remoteChanReserveSat)

    • 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