Rename maxHtlcAmount to maxHtlcValueInFlight in Commitments (#3131)

Author: thomash-acinq

eclair-core/src/main/scala/fr/acinq/eclair/channel/Commitments.scala

@@ -39,7 +39,7 @@ case class ChannelParams(channelId: ByteVector32,
   val remoteCommitParams: CommitParams = CommitParams(remoteParams.dustLimit, remoteParams.htlcMinimum, remoteParams.maxHtlcValueInFlightMsat, remoteParams.maxAcceptedHtlcs, localParams.toRemoteDelay)
 
   // We can safely cast to millisatoshis since we verify that it's less than a valid millisatoshi amount.
-  val maxHtlcAmount: MilliSatoshi = Seq(localParams.maxHtlcValueInFlightMsat, remoteParams.maxHtlcValueInFlightMsat, UInt64(MilliSatoshi.MaxMoney.toLong)).min.toBigInt.toLong.msat
+  val maxHtlcValueInFlight: MilliSatoshi = Seq(localParams.maxHtlcValueInFlightMsat, remoteParams.maxHtlcValueInFlightMsat, UInt64(MilliSatoshi.MaxMoney.toLong)).min.toBigInt.toLong.msat
 
   // If we've set the 0-conf feature bit for this peer, we will always use 0-conf with them.
   val zeroConf: Boolean = localParams.initFeatures.hasFeature(Features.ZeroConf)
@@ -508,7 +508,7 @@ case class Commitment(fundingTxIndex: Long,
     // We apply local *and* remote restrictions, to ensure both peers are happy with the resulting number of HTLCs.
     // NB: we need the `toSeq` because otherwise duplicate amountMsat would be removed (since outgoingHtlcs is a Set).
     val htlcValueInFlight = outgoingHtlcs.toSeq.map(_.amountMsat).sum
-    val allowedHtlcValueInFlight = UInt64(params.maxHtlcAmount.toLong)
+    val allowedHtlcValueInFlight = UInt64(params.maxHtlcValueInFlight.toLong)
     if (allowedHtlcValueInFlight < htlcValueInFlight) {
       return Left(HtlcValueTooHighInFlight(params.channelId, maximum = allowedHtlcValueInFlight, actual = htlcValueInFlight))
     }

eclair-core/src/main/scala/fr/acinq/eclair/channel/Helpers.scala

@@ -368,17 +368,17 @@ object Helpers {
   def maxHtlcAmount(nodeParams: NodeParams, commitments: Commitments): MilliSatoshi = {
     if (!commitments.announceChannel) {
       // The channel is private, let's not change the channel update needlessly.
-      return commitments.channelParams.maxHtlcAmount
+      return commitments.channelParams.maxHtlcValueInFlight
     }
     for (balanceThreshold <- nodeParams.channelConf.balanceThresholds) {
       if (commitments.availableBalanceForSend <= balanceThreshold.available) {
         // Our maximum HTLC amount must always be greater than htlc_minimum_msat.
         val allowedHtlcAmount = Seq(balanceThreshold.maxHtlcAmount.toMilliSatoshi, commitments.channelParams.localCommitParams.htlcMinimum, commitments.channelParams.remoteCommitParams.htlcMinimum).max
         // But it cannot exceed the channel's max_htlc_value_in_flight_msat.
-        return allowedHtlcAmount.min(commitments.channelParams.maxHtlcAmount)
+        return allowedHtlcAmount.min(commitments.channelParams.maxHtlcValueInFlight)
       }
     }
-    commitments.channelParams.maxHtlcAmount
+    commitments.channelParams.maxHtlcValueInFlight
   }
 
   def getRelayFees(nodeParams: NodeParams, remoteNodeId: PublicKey, announceChannel: Boolean): RelayFees = {

eclair-core/src/main/scala/fr/acinq/eclair/reputation/Reputation.scala

@@ -135,14 +135,14 @@ object Reputation {
       // We want to allow some small HTLCs but still keep slots for larger ones.
       // We never want to reject HTLCs of size above `maxHtlcAmount / maxAcceptedHtlcs` as too small because we want to allow filling all the slots with HTLCs of equal sizes.
       // We use exponentially spaced thresholds in between.
-      if (amountMsat.toLong < 1 || amountMsat.toLong.toDouble < math.pow(params.maxHtlcAmount.toLong.toDouble / maxAcceptedHtlcs, i / maxAcceptedHtlcs)) {
+      if (amountMsat.toLong < 1 || amountMsat.toLong.toDouble < math.pow(params.maxHtlcValueInFlight.toLong.toDouble / maxAcceptedHtlcs, i / maxAcceptedHtlcs)) {
         return Left(TooManySmallHtlcs(params.channelId, number = i + 1, below = amountMsat))
       }
     }
 
     val htlcValueInFlight = outgoingHtlcs.map(_.amountMsat).sum
     val slotsOccupancy = outgoingHtlcs.size.toDouble / maxAcceptedHtlcs
-    val valueOccupancy = htlcValueInFlight.toLong.toDouble / params.maxHtlcAmount.toLong.toDouble
+    val valueOccupancy = htlcValueInFlight.toLong.toDouble / params.maxHtlcValueInFlight.toLong.toDouble
     val occupancy = slotsOccupancy max valueOccupancy
     // Because there are only 8 endorsement levels, the highest endorsement corresponds to a confidence between 87.5% and 100%.
     // So even for well-behaved peers setting the highest endorsement we still expect a confidence of less than 93.75%.