From 2e854e36ec7bc8b37dda900896af4c56871f62d2 Mon Sep 17 00:00:00 2001 From: rorp Date: Sun, 20 Oct 2024 11:28:34 -0700 Subject: [PATCH 1/3] Add limited support for Blip18 inbound fees --- eclair-core/src/main/resources/reference.conf | 2 + .../scala/fr/acinq/eclair/NodeParams.scala | 5 +- .../acinq/eclair/payment/relay/Relayer.scala | 8 + .../payment/send/PaymentLifecycle.scala | 4 +- .../remote/EclairInternalsSerializer.scala | 4 +- .../scala/fr/acinq/eclair/router/Graph.scala | 17 +- .../eclair/router/RouteCalculation.scala | 77 +++- .../scala/fr/acinq/eclair/router/Router.scala | 34 +- .../wire/protocol/LightningMessageTypes.scala | 3 + .../eclair/wire/protocol/RoutingTlv.scala | 11 +- .../router/Blip18RouteCalculationSpec.scala | 371 ++++++++++++++++++ .../eclair/router/RouteCalculationSpec.scala | 2 +- .../acinq/eclair/api/handlers/Payment.scala | 8 +- 13 files changed, 513 insertions(+), 33 deletions(-) create mode 100644 eclair-core/src/test/scala/fr/acinq/eclair/router/Blip18RouteCalculationSpec.scala diff --git a/eclair-core/src/main/resources/reference.conf b/eclair-core/src/main/resources/reference.conf index 77dd6f058c..d65412faf2 100644 --- a/eclair-core/src/main/resources/reference.conf +++ b/eclair-core/src/main/resources/reference.conf @@ -448,6 +448,8 @@ eclair { min-amount-satoshis = 15000 // minimum amount sent via partial HTLCs max-parts = 5 // maximum number of HTLCs sent per payment: increasing this value will impact performance } + blip18-inbound-fees = false + exclude-channels-with-positive-inbound-fees = false } // The path-finding algo uses one or more sets of parameters named experiments. Each experiment has a percentage diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/NodeParams.scala b/eclair-core/src/main/scala/fr/acinq/eclair/NodeParams.scala index 09b4fc9261..3f5fe8b85f 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/NodeParams.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/NodeParams.scala @@ -461,8 +461,9 @@ object NodeParams extends Logging { Satoshi(config.getLong("mpp.min-amount-satoshis")).toMilliSatoshi, config.getInt("mpp.max-parts")), experimentName = name, - experimentPercentage = config.getInt("percentage")) - + experimentPercentage = config.getInt("percentage"), + blip18InboundFees = config.getBoolean("blip18-inbound-fees"), + excludePositiveInboundFees = config.getBoolean("exclude-channels-with-positive-inbound-fees")) def getPathFindingExperimentConf(config: Config): PathFindingExperimentConf = { val experiments = config.root.asScala.keys.map(name => name -> getPathFindingConf(config.getConfig(name), name)) diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/Relayer.scala b/eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/Relayer.scala index 1600e185cd..2238252c32 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/Relayer.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/Relayer.scala @@ -134,6 +134,14 @@ object Relayer extends Logging { require(feeProportionalMillionths >= 0.0, "feeProportionalMillionths must be nonnegative") } + case class InboundFees(feeBase: MilliSatoshi, feeProportionalMillionths: Long) + + object InboundFees { + def apply(feeBaseInt32: Int, feeProportionalMillionthsInt32: Int): InboundFees = { + InboundFees(MilliSatoshi(feeBaseInt32), feeProportionalMillionthsInt32) + } + } + case class AsyncPaymentsParams(holdTimeoutBlocks: Int, cancelSafetyBeforeTimeout: CltvExpiryDelta) case class RelayParams(publicChannelFees: RelayFees, diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/payment/send/PaymentLifecycle.scala b/eclair-core/src/main/scala/fr/acinq/eclair/payment/send/PaymentLifecycle.scala index 442ce2f3fc..22e0ba27f6 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/payment/send/PaymentLifecycle.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/payment/send/PaymentLifecycle.scala @@ -455,8 +455,8 @@ object PaymentLifecycle { override val amount = route.fold(_.amount, _.amount) def printRoute(): String = route match { - case Left(PredefinedChannelRoute(_, _, channels, _)) => channels.mkString("->") - case Left(PredefinedNodeRoute(_, nodes, _)) => nodes.mkString("->") + case Left(PredefinedChannelRoute(_, _, channels, _, _, _)) => channels.mkString("->") + case Left(PredefinedNodeRoute(_, nodes, _, _, _)) => nodes.mkString("->") case Right(route) => route.printNodes() } } diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/remote/EclairInternalsSerializer.scala b/eclair-core/src/main/scala/fr/acinq/eclair/remote/EclairInternalsSerializer.scala index 0f66a6f93f..69b24e412a 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/remote/EclairInternalsSerializer.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/remote/EclairInternalsSerializer.scala @@ -80,7 +80,9 @@ object EclairInternalsSerializer { ("heuristicsParams" | either(bool(8), weightRatiosCodec, heuristicsConstantsCodec)) :: ("mpp" | multiPartParamsCodec) :: ("experimentName" | utf8_32) :: - ("experimentPercentage" | int32)).as[PathFindingConf] + ("experimentPercentage" | int32) :: + ("blip18InboundFees" | bool(8)) :: + ("excludePositiveInboundFees" | bool(8))).as[PathFindingConf] val pathFindingExperimentConfCodec: Codec[PathFindingExperimentConf] = ( "experiments" | listOfN(int32, pathFindingConfCodec).xmap[Map[String, PathFindingConf]](_.map(e => e.experimentName -> e).toMap, _.values.toList) diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/router/Graph.scala b/eclair-core/src/main/scala/fr/acinq/eclair/router/Graph.scala index 89af943807..461f33519d 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/router/Graph.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/router/Graph.scala @@ -120,10 +120,11 @@ object Graph { wr: Either[WeightRatios, HeuristicsConstants], currentBlockHeight: BlockHeight, boundaries: RichWeight => Boolean, - includeLocalChannelCost: Boolean): Seq[WeightedPath] = { + includeLocalChannelCost: Boolean, + excludePositiveInboundFees: Boolean = false): Seq[WeightedPath] = { // find the shortest path (k = 0) val targetWeight = RichWeight(amount, 0, CltvExpiryDelta(0), 1.0, 0 msat, 0 msat, 0.0) - val shortestPath = dijkstraShortestPath(graph, sourceNode, targetNode, ignoredEdges, ignoredVertices, extraEdges, targetWeight, boundaries, currentBlockHeight, wr, includeLocalChannelCost) + val shortestPath = dijkstraShortestPath(graph, sourceNode, targetNode, ignoredEdges, ignoredVertices, extraEdges, targetWeight, boundaries, currentBlockHeight, wr, includeLocalChannelCost, excludePositiveInboundFees) if (shortestPath.isEmpty) { return Seq.empty // if we can't even find a single path, avoid returning a Seq(Seq.empty) } @@ -162,7 +163,7 @@ object Graph { val alreadyExploredVertices = rootPathEdges.map(_.desc.b).toSet val rootPathWeight = pathWeight(sourceNode, rootPathEdges, amount, currentBlockHeight, wr, includeLocalChannelCost) // find the "spur" path, a sub-path going from the spur node to the target avoiding previously found sub-paths - val spurPath = dijkstraShortestPath(graph, sourceNode, spurNode, ignoredEdges ++ alreadyExploredEdges, ignoredVertices ++ alreadyExploredVertices, extraEdges, rootPathWeight, boundaries, currentBlockHeight, wr, includeLocalChannelCost) + val spurPath = dijkstraShortestPath(graph, sourceNode, spurNode, ignoredEdges ++ alreadyExploredEdges, ignoredVertices ++ alreadyExploredVertices, extraEdges, rootPathWeight, boundaries, currentBlockHeight, wr, includeLocalChannelCost, excludePositiveInboundFees) if (spurPath.nonEmpty) { val completePath = spurPath ++ rootPathEdges val candidatePath = WeightedPath(completePath, pathWeight(sourceNode, completePath, amount, currentBlockHeight, wr, includeLocalChannelCost)) @@ -210,7 +211,8 @@ object Graph { boundaries: RichWeight => Boolean, currentBlockHeight: BlockHeight, wr: Either[WeightRatios, HeuristicsConstants], - includeLocalChannelCost: Boolean): Seq[GraphEdge] = { + includeLocalChannelCost: Boolean, + excludePositiveInboundFees: Boolean): Seq[GraphEdge] = { // the graph does not contain source/destination nodes val sourceNotInGraph = !g.containsVertex(sourceNode) && !extraEdges.exists(_.desc.a == sourceNode) val targetNotInGraph = !g.containsVertex(targetNode) && !extraEdges.exists(_.desc.b == targetNode) @@ -251,7 +253,8 @@ object Graph { edge.params.htlcMaximum_opt.forall(current.weight.amount <= _) && current.weight.amount >= edge.params.htlcMinimum && !ignoredEdges.contains(edge.desc) && - !ignoredVertices.contains(neighbor)) { + !ignoredVertices.contains(neighbor) && + (!excludePositiveInboundFees || g.getBackEdge(edge).forall(e => e.params.inboundFees_opt.forall(i => i.feeBase.toLong <= 0 && i.feeProportionalMillionths <= 0)))) { // NB: this contains the amount (including fees) that will need to be sent to `neighbor`, but the amount that // will be relayed through that edge is the one in `currentWeight`. val neighborWeight = addEdgeWeight(sourceNode, edge, current.weight, currentBlockHeight, wr, includeLocalChannelCost) @@ -686,6 +689,10 @@ object Graph { def getEdge(desc: ChannelDesc): Option[GraphEdge] = vertices.get(desc.b).flatMap(_.incomingEdges.get(desc)) + def getBackEdge(desc: ChannelDesc): Option[GraphEdge] = getEdge(desc.copy(a = desc.b, b = desc.a)) + + def getBackEdge(edge: GraphEdge): Option[GraphEdge] = getBackEdge(edge.desc) + /** * @param keyA the key associated with the starting vertex * @param keyB the key associated with the ending vertex diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/router/RouteCalculation.scala b/eclair-core/src/main/scala/fr/acinq/eclair/router/RouteCalculation.scala index 8c8e524afb..0ffa4f301e 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/router/RouteCalculation.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/router/RouteCalculation.scala @@ -29,6 +29,7 @@ import fr.acinq.eclair.router.Graph.GraphStructure.{DirectedGraph, GraphEdge} import fr.acinq.eclair.router.Graph.{InfiniteLoop, MessagePath, NegativeProbability, RichWeight} import fr.acinq.eclair.router.Monitoring.{Metrics, Tags} import fr.acinq.eclair.router.Router._ +import fr.acinq.eclair.wire.protocol.ChannelUpdateTlv.Blip18InboundFee import kamon.tag.TagSet import scala.annotation.tailrec @@ -59,6 +60,14 @@ object RouteCalculation { } } + def validatePositiveInboundFees(route: Route, excludePositiveInboundFees: Boolean): Try[Route] = { + if (!excludePositiveInboundFees || route.hops.forall(hop => hop.params.inboundFees_opt.forall(i => i.feeBase <= 0.msat && i.feeProportionalMillionths <= 0))) { + Success(route) + } else { + Failure(new IllegalArgumentException("Route contains hops with positive inbound fees")) + } + } + Logs.withMdc(log)(Logs.mdc( category_opt = Some(LogCategory.PAYMENT), parentPaymentId_opt = fr.paymentContext.map(_.parentId), @@ -70,22 +79,31 @@ object RouteCalculation { val g = extraEdges.foldLeft(d.graphWithBalances.graph) { case (g: DirectedGraph, e: GraphEdge) => g.addEdge(e) } fr.route match { - case PredefinedNodeRoute(amount, hops, maxFee_opt) => + case PredefinedNodeRoute(amount, hops, maxFee_opt, blip18InboundFees, excludePositiveInboundFees) => // split into sublists [(a,b),(b,c), ...] then get the edges between each of those pairs hops.sliding(2).map { case List(v1, v2) => g.getEdgesBetween(v1, v2) }.toList match { case edges if edges.nonEmpty && edges.forall(_.nonEmpty) => // select the largest edge (using balance when available, otherwise capacity). val selectedEdges = edges.map(es => es.maxBy(e => e.balance_opt.getOrElse(e.capacity.toMilliSatoshi))) val hops = selectedEdges.map(e => ChannelHop(getEdgeRelayScid(d, localNodeId, e), e.desc.a, e.desc.b, e.params)) - validateMaxRouteFee(Route(amount, hops, None), maxFee_opt) match { - case Success(route) => ctx.sender() ! RouteResponse(route :: Nil) + val route = if (blip18InboundFees) { + validatePositiveInboundFees(routeWithInboundFees(amount, hops, g), excludePositiveInboundFees) + } else { + Success(Route(amount, hops, None)) + } + route match { + case Success(r) => + validateMaxRouteFee(r, maxFee_opt) match { + case Success(validatedRoute) => ctx.sender() ! RouteResponse(validatedRoute :: Nil) + case Failure(f) => ctx.sender() ! Status.Failure(f) + } case Failure(f) => ctx.sender() ! Status.Failure(f) } case _ => // some nodes in the supplied route aren't connected in our graph ctx.sender() ! Status.Failure(new IllegalArgumentException("Not all the nodes in the supplied route are connected with public channels")) } - case PredefinedChannelRoute(amount, targetNodeId, shortChannelIds, maxFee_opt) => + case PredefinedChannelRoute(amount, targetNodeId, shortChannelIds, maxFee_opt, blip18InboundFees, excludePositiveInboundFees) => val (end, hops) = shortChannelIds.foldLeft((localNodeId, Seq.empty[ChannelHop])) { case ((currentNode, previousHops), shortChannelId) => val channelDesc_opt = d.resolve(shortChannelId) match { @@ -109,8 +127,17 @@ object RouteCalculation { if (end != targetNodeId || hops.length != shortChannelIds.length) { ctx.sender() ! Status.Failure(new IllegalArgumentException("The sequence of channels provided cannot be used to build a route to the target node")) } else { - validateMaxRouteFee(Route(amount, hops, None), maxFee_opt) match { - case Success(route) => ctx.sender() ! RouteResponse(route :: Nil) + val route = if (blip18InboundFees) { + validatePositiveInboundFees(routeWithInboundFees(amount, hops, g), excludePositiveInboundFees) + } else { + Success(Route(amount, hops, None)) + } + route match { + case Success(r) => + validateMaxRouteFee(r, maxFee_opt) match { + case Success(validatedRoute) => ctx.sender() ! RouteResponse(validatedRoute :: Nil) + case Failure(f) => ctx.sender() ! Status.Failure(f) + } case Failure(f) => ctx.sender() ! Status.Failure(f) } } @@ -306,11 +333,39 @@ object RouteCalculation { routeParams: RouteParams, currentBlockHeight: BlockHeight): Try[Seq[Route]] = Try { findRouteInternal(g, localNodeId, targetNodeId, amount, maxFee, numRoutes, extraEdges, ignoredEdges, ignoredVertices, routeParams, currentBlockHeight) match { - case Right(routes) => routes.map(route => Route(amount, route.path.map(graphEdgeToHop), None)) + case Right(routes) => routes.map { route => + if (routeParams.blip18InboundFees) + routeWithInboundFees(amount, route.path.map(graphEdgeToHop), g) + else + Route(amount, route.path.map(graphEdgeToHop), None) + } case Left(ex) => return Failure(ex) } } + private def routeWithInboundFees(amount: MilliSatoshi, routeHops: Seq[ChannelHop], g: DirectedGraph): Route = { + if (routeHops.tail.isEmpty) { + Route(amount, routeHops, None) + } else { + val hops = routeHops.reverse + val updatedHops = routeHops.head :: hops.zip(hops.tail).foldLeft(List.empty[ChannelHop]) { (hops, x) => + val (curr, prev) = x + val maybeEdge = g.getBackEdge(ChannelDesc(prev.shortChannelId, prev.nodeId, prev.nextNodeId)) + val hop = curr.copy(params = curr.params match { + case hopParams: HopRelayParams.FromAnnouncement => + maybeEdge match { + case Some(backEdge) => hopParams.copy(updatedInboundFees_opt = backEdge.params.inboundFees_opt) + case _ => hopParams + } + case hopParams => hopParams + }) + + hop :: hops + } + Route(amount, updatedHops, None) + } + } + @tailrec private def findRouteInternal(g: DirectedGraph, localNodeId: PublicKey, @@ -335,7 +390,7 @@ object RouteCalculation { val boundaries: RichWeight => Boolean = { weight => feeOk(weight.amount - amount) && lengthOk(weight.length) && cltvOk(weight.cltv) } - val foundRoutes: Seq[Graph.WeightedPath] = Graph.yenKshortestPaths(g, localNodeId, targetNodeId, amount, ignoredEdges, ignoredVertices, extraEdges, numRoutes, routeParams.heuristics, currentBlockHeight, boundaries, routeParams.includeLocalChannelCost) + val foundRoutes: Seq[Graph.WeightedPath] = Graph.yenKshortestPaths(g, localNodeId, targetNodeId, amount, ignoredEdges, ignoredVertices, extraEdges, numRoutes, routeParams.heuristics, currentBlockHeight, boundaries, routeParams.includeLocalChannelCost, routeParams.excludePositiveInboundFees) if (foundRoutes.nonEmpty) { val (directRoutes, indirectRoutes) = foundRoutes.partition(_.path.length == 1) val routes = if (routeParams.randomize) { @@ -426,7 +481,11 @@ object RouteCalculation { case Right(routes) => // We use these shortest paths to find a set of non-conflicting HTLCs that send the total amount. split(amount, mutable.Queue(routes: _*), initializeUsedCapacity(pendingHtlcs), routeParams1) match { - case Right(routes) if validateMultiPartRoute(amount, maxFee, routes, routeParams.includeLocalChannelCost) => Right(routes) + case Right(routes) if validateMultiPartRoute(amount, maxFee, routes, routeParams.includeLocalChannelCost) => + if (routeParams.blip18InboundFees) + Right(routes.map(r => routeWithInboundFees(r.amount, r.hops, g))) + else + Right(routes) case _ => Left(RouteNotFound) } case Left(ex) => Left(ex) diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/router/Router.scala b/eclair-core/src/main/scala/fr/acinq/eclair/router/Router.scala index 4974931a35..94b48b14ac 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/router/Router.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/router/Router.scala @@ -344,14 +344,18 @@ object Router { heuristics: Either[WeightRatios, HeuristicsConstants], mpp: MultiPartParams, experimentName: String, - experimentPercentage: Int) { + experimentPercentage: Int, + blip18InboundFees: Boolean = false, + excludePositiveInboundFees: Boolean = false) { def getDefaultRouteParams: RouteParams = RouteParams( randomize = randomize, boundaries = boundaries, heuristics = heuristics, mpp = mpp, experimentName = experimentName, - includeLocalChannelCost = false + includeLocalChannelCost = false, + blip18InboundFees = blip18InboundFees, + excludePositiveInboundFees = excludePositiveInboundFees ) } @@ -473,7 +477,13 @@ object Router { // @formatter:off def cltvExpiryDelta: CltvExpiryDelta def relayFees: Relayer.RelayFees - final def fee(amount: MilliSatoshi): MilliSatoshi = nodeFee(relayFees, amount) + def inboundFees_opt: Option[Relayer.InboundFees] + final def fee(amount: MilliSatoshi): MilliSatoshi = { + val outFee = nodeFee(relayFees, amount) + val inFee = inboundFees_opt.map(i => nodeFee(i.feeBase, i.feeProportionalMillionths, amount + outFee)).getOrElse(0 msat) + val totalFee = outFee + inFee + if (totalFee.toLong < 0) 0 msat else totalFee + } def htlcMinimum: MilliSatoshi def htlcMaximum_opt: Option[MilliSatoshi] // @formatter:on @@ -481,17 +491,20 @@ object Router { object HopRelayParams { /** We learnt about this channel from a channel_update. */ - case class FromAnnouncement(channelUpdate: ChannelUpdate) extends HopRelayParams { + case class FromAnnouncement(channelUpdate: ChannelUpdate, updatedInboundFees_opt: Option[Relayer.InboundFees] = None) extends HopRelayParams { override val cltvExpiryDelta = channelUpdate.cltvExpiryDelta override val relayFees = channelUpdate.relayFees + override val inboundFees_opt = updatedInboundFees_opt orElse channelUpdate.inboundFees_opt override val htlcMinimum = channelUpdate.htlcMinimumMsat override val htlcMaximum_opt = Some(channelUpdate.htlcMaximumMsat) + } /** We learnt about this hop from hints in an invoice. */ case class FromHint(extraHop: Invoice.ExtraEdge) extends HopRelayParams { override val cltvExpiryDelta = extraHop.cltvExpiryDelta override val relayFees = extraHop.relayFees + override val inboundFees_opt = None override val htlcMinimum = extraHop.htlcMinimum override val htlcMaximum_opt = extraHop.htlcMaximum_opt } @@ -499,6 +512,7 @@ object Router { def areSame(a: HopRelayParams, b: HopRelayParams, ignoreHtlcSize: Boolean = false): Boolean = a.cltvExpiryDelta == b.cltvExpiryDelta && a.relayFees == b.relayFees && + a.inboundFees_opt == b.inboundFees_opt && (ignoreHtlcSize || (a.htlcMinimum == b.htlcMinimum && a.htlcMaximum_opt == b.htlcMaximum_opt)) } @@ -559,7 +573,9 @@ object Router { heuristics: Either[WeightRatios, HeuristicsConstants], mpp: MultiPartParams, experimentName: String, - includeLocalChannelCost: Boolean) { + includeLocalChannelCost: Boolean, + blip18InboundFees: Boolean, + excludePositiveInboundFees: Boolean) { def getMaxFee(amount: MilliSatoshi): MilliSatoshi = { // The payment fee must satisfy either the flat fee or the proportional fee, not necessarily both. boundaries.maxFeeFlat.max(amount * boundaries.maxFeeProportional) @@ -668,12 +684,14 @@ object Router { def amount: MilliSatoshi def targetNodeId: PublicKey def maxFee_opt: Option[MilliSatoshi] - } - case class PredefinedNodeRoute(amount: MilliSatoshi, nodes: Seq[PublicKey], maxFee_opt: Option[MilliSatoshi] = None) extends PredefinedRoute { + def blip18InboundFees: Boolean + def excludePositiveInboundFees: Boolean + } + case class PredefinedNodeRoute(amount: MilliSatoshi, nodes: Seq[PublicKey], maxFee_opt: Option[MilliSatoshi] = None, blip18InboundFees: Boolean = false, excludePositiveInboundFees: Boolean = false) extends PredefinedRoute { override def isEmpty = nodes.isEmpty override def targetNodeId: PublicKey = nodes.last } - case class PredefinedChannelRoute(amount: MilliSatoshi, targetNodeId: PublicKey, channels: Seq[ShortChannelId], maxFee_opt: Option[MilliSatoshi] = None) extends PredefinedRoute { + case class PredefinedChannelRoute(amount: MilliSatoshi, targetNodeId: PublicKey, channels: Seq[ShortChannelId], maxFee_opt: Option[MilliSatoshi] = None, blip18InboundFees: Boolean = false, excludePositiveInboundFees: Boolean = false) extends PredefinedRoute { override def isEmpty = channels.isEmpty } // @formatter:on diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/LightningMessageTypes.scala b/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/LightningMessageTypes.scala index ace095ca1a..e884ff5151 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/LightningMessageTypes.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/LightningMessageTypes.scala @@ -543,6 +543,9 @@ case class ChannelUpdate(signature: ByteVector64, def toStringShort: String = s"cltvExpiryDelta=$cltvExpiryDelta,feeBase=$feeBaseMsat,feeProportionalMillionths=$feeProportionalMillionths" def relayFees: Relayer.RelayFees = Relayer.RelayFees(feeBase = feeBaseMsat, feeProportionalMillionths = feeProportionalMillionths) + + def inboundFees_opt: Option[Relayer.InboundFees] = + tlvStream.get[ChannelUpdateTlv.Blip18InboundFee].map(blip18 => Relayer.InboundFees(blip18.feeBase, blip18.feeProportionalMillionths)) } object ChannelUpdate { diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/RoutingTlv.scala b/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/RoutingTlv.scala index d157a388b9..4089b043fa 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/RoutingTlv.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/RoutingTlv.scala @@ -53,7 +53,16 @@ object ChannelAnnouncementTlv { sealed trait ChannelUpdateTlv extends Tlv object ChannelUpdateTlv { - val channelUpdateTlvCodec: Codec[TlvStream[ChannelUpdateTlv]] = tlvStream(discriminated[ChannelUpdateTlv].by(varint)) + case class Blip18InboundFee(feeBase: Int, feeProportionalMillionths: Int) extends ChannelUpdateTlv + + private val blip18InboundFeeCodec: Codec[Blip18InboundFee] = tlvField(Codec( + ("feeBase" | int32) :: + ("feeProportionalMillionths" | int32) + ).as[Blip18InboundFee]) + + val channelUpdateTlvCodec: Codec[TlvStream[ChannelUpdateTlv]] = TlvCodecs.tlvStream(discriminated.by(varint) + .typecase(UInt64(55555), blip18InboundFeeCodec) + ) } sealed trait GossipTimestampFilterTlv extends Tlv diff --git a/eclair-core/src/test/scala/fr/acinq/eclair/router/Blip18RouteCalculationSpec.scala b/eclair-core/src/test/scala/fr/acinq/eclair/router/Blip18RouteCalculationSpec.scala new file mode 100644 index 0000000000..68c7e9a41c --- /dev/null +++ b/eclair-core/src/test/scala/fr/acinq/eclair/router/Blip18RouteCalculationSpec.scala @@ -0,0 +1,371 @@ +package fr.acinq.eclair.router + +import fr.acinq.bitcoin.scalacompat.Crypto.PublicKey +import fr.acinq.bitcoin.scalacompat.{Block, Satoshi, SatoshiLong} +import fr.acinq.eclair.payment.IncomingPaymentPacket.{ChannelRelayPacket, FinalPacket, decrypt} +import fr.acinq.eclair.payment.OutgoingPaymentPacket.buildOutgoingPayment +import fr.acinq.eclair.payment.PaymentPacketSpec.{paymentHash, paymentSecret} +import fr.acinq.eclair.payment.relay.Relayer.RelayFees +import fr.acinq.eclair.payment.send.ClearRecipient +import fr.acinq.eclair.router.Graph.GraphStructure.{DirectedGraph, GraphEdge} +import fr.acinq.eclair.router.Graph.WeightRatios +import fr.acinq.eclair.router.RouteCalculation.{findMultiPartRoute, findRoute} +import fr.acinq.eclair.router.Router._ +import fr.acinq.eclair.transactions.Transactions +import fr.acinq.eclair.wire.protocol.PaymentOnion.FinalPayload +import fr.acinq.eclair.wire.protocol._ +import fr.acinq.eclair.{BlockHeight, CltvExpiry, CltvExpiryDelta, Features, MilliSatoshi, MilliSatoshiLong, RealShortChannelId, ShortChannelId, TestConstants, TimestampSecond, TimestampSecondLong, randomBytes32, randomKey} +import org.scalatest.ParallelTestExecution +import org.scalatest.funsuite.AnyFunSuite + +import scala.util.{Failure, Success} + +class Blip18RouteCalculationSpec extends AnyFunSuite with ParallelTestExecution { + + import Blip18RouteCalculationSpec._ + + val (priv_a, priv_b, priv_c, priv_d, priv_e, priv_f) = (randomKey(), randomKey(), randomKey(), randomKey(), randomKey(), randomKey()) + val (a, b, c, d, e, f) = (priv_a.publicKey, priv_b.publicKey, priv_c.publicKey, priv_d.publicKey, priv_e.publicKey, priv_f.publicKey) + + test("test findRoute with Blip18 enabled") { + // extracted from the LND code base + val g = DirectedGraph(Seq( + makeEdge(10L, a, b, minHtlc = 2 msat), + makeEdge(10L, b, a, minHtlc = 2 msat, inboundFeeBase_opt = Some(-5000 msat), inboundFeeProportionalMillionth_opt = Some(-60_000)), + + makeEdge(11L, b, c, 1000 msat, 50_000, minHtlc = 2 msat), + makeEdge(11L, c, b, minHtlc = 2 msat, inboundFeeBase_opt = Some(5000 msat), inboundFeeProportionalMillionth_opt = Some(0)), + + makeEdge(12L, c, d, 0 msat, 50_000, minHtlc = 2 msat), + makeEdge(12L, d, c, minHtlc = 2 msat, inboundFeeBase_opt = Some(-8000 msat), inboundFeeProportionalMillionth_opt = Some(-50_000)), + + makeEdge(13L, d, e, 9000 msat, 100_000, minHtlc = 2 msat), + makeEdge(13L, e, d, minHtlc = 2 msat, inboundFeeBase_opt = Some(2000 msat), inboundFeeProportionalMillionth_opt = Some(80_000)), + )) + + val Success(route :: Nil) = findRoute(g, a, e, 100_000 msat, 100_000 msat, numRoutes = 1, routeParams = DEFAULT_ROUTE_PARAMS, currentBlockHeight = BlockHeight(400000)) + + assert(route.channelFee(false) == 15_302.msat) + + val recipient = ClearRecipient(e, Features.empty, 100_000 msat, CltvExpiry(400018), paymentSecret) + val Right(payment) = buildOutgoingPayment(TestConstants.emptyOrigin, paymentHash, route, recipient, 1.0) + + assert(payment.outgoingChannel == ShortChannelId(10L)) + assert(payment.cmd.amount == 115_302.msat) + + val packet_b = payment.cmd.onion + + val add_b = UpdateAddHtlc(randomBytes32(), 0, 100_000 msat, paymentHash, CltvExpiry(400018), packet_b, None, 1.0, None) + val Right(relay_b@ChannelRelayPacket(_, payload_b, packet_c)) = decrypt(add_b, priv_b, Features.empty) + assert(payload_b.outgoing.contains(ShortChannelId(11L))) + assert(relay_b.amountToForward == 115_302.msat) + assert(relay_b.relayFeeMsat == -15_302.msat) + + val add_c = UpdateAddHtlc(randomBytes32(), 1, 100_000 msat, paymentHash, CltvExpiry(400018), packet_c, None, 1.0, None) + val Right(relay_c@ChannelRelayPacket(_, payload_c, packet_d)) = decrypt(add_c, priv_c, Features.empty) + assert(payload_c.outgoing.contains(ShortChannelId(12L))) + assert(relay_c.amountToForward == 105_050.msat) + assert(relay_c.relayFeeMsat == -5050.msat) + + val add_d = UpdateAddHtlc(randomBytes32(), 2, 100_000 msat, paymentHash, CltvExpiry(400018), packet_d, None, 1.0, None) + val Right(relay_d@ChannelRelayPacket(_, payload_d, packet_e)) = decrypt(add_d, priv_d, Features.empty) + assert(payload_d.outgoing.contains(ShortChannelId(13L))) + assert(relay_d.amountToForward == 100_000.msat) + assert(relay_d.relayFeeMsat == 0.msat) + + val add_e = UpdateAddHtlc(randomBytes32(), 2, 100_000 msat, paymentHash, CltvExpiry(400018), packet_e, None, 1.0, None) + val Right(FinalPacket(_, payload_e)) = decrypt(add_e, priv_e, Features.empty) + assert(payload_e.isInstanceOf[FinalPayload.Standard]) + assert(payload_e.amount == 100_000.msat) + assert(payload_e.totalAmount == 100_000.msat) + } + + test("test findRoute with Blip18 disabled") { + // extracted from the LND code base + val g = DirectedGraph(Seq( + makeEdge(10L, a, b, minHtlc = 2 msat), + makeEdge(10L, b, a, minHtlc = 2 msat, inboundFeeBase_opt = Some(-5000 msat), inboundFeeProportionalMillionth_opt = Some(-60_000)), + + makeEdge(11L, b, c, 1000 msat, 50_000, minHtlc = 2 msat), + makeEdge(11L, c, b, minHtlc = 2 msat, inboundFeeBase_opt = Some(5000 msat), inboundFeeProportionalMillionth_opt = Some(0)), + + makeEdge(12L, c, d, 0 msat, 50_000, minHtlc = 2 msat), + makeEdge(12L, d, c, minHtlc = 2 msat, inboundFeeBase_opt = Some(-8000 msat), inboundFeeProportionalMillionth_opt = Some(-50_000)), + + makeEdge(13L, d, e, 9000 msat, 100_000, minHtlc = 2 msat), + makeEdge(13L, e, d, minHtlc = 2 msat, inboundFeeBase_opt = Some(2000 msat), inboundFeeProportionalMillionth_opt = Some(80_000)), + )) + + val Success(route :: Nil) = findRoute(g, a, e, 100_000 msat, 100_000 msat, numRoutes = 1, routeParams = DEFAULT_ROUTE_PARAMS.copy(blip18InboundFees = false), currentBlockHeight = BlockHeight(400000)) + + assert(route.channelFee(false) == 32_197.msat) + + val recipient = ClearRecipient(e, Features.empty, 100_000 msat, CltvExpiry(400018), paymentSecret) + val Right(payment) = buildOutgoingPayment(TestConstants.emptyOrigin, paymentHash, route, recipient, 1.0) + + assert(payment.outgoingChannel == ShortChannelId(10L)) + assert(payment.cmd.amount == 132_197.msat) + + val packet_b = payment.cmd.onion + + val add_b = UpdateAddHtlc(randomBytes32(), 0, 100_000 msat, paymentHash, CltvExpiry(400018), packet_b, None, 1.0, None) + val Right(relay_b@ChannelRelayPacket(_, payload_b, packet_c)) = decrypt(add_b, priv_b, Features.empty) + assert(payload_b.outgoing.contains(ShortChannelId(11L))) + assert(relay_b.amountToForward == 124_950.msat) + assert(relay_b.relayFeeMsat == -24_950.msat) + + val add_c = UpdateAddHtlc(randomBytes32(), 1, 100_000 msat, paymentHash, CltvExpiry(400018), packet_c, None, 1.0, None) + val Right(relay_c@ChannelRelayPacket(_, payload_c, packet_d)) = decrypt(add_c, priv_c, Features.empty) + assert(payload_c.outgoing.contains(ShortChannelId(12L))) + assert(relay_c.amountToForward == 119_000.msat) + assert(relay_c.relayFeeMsat == -19000.msat) + + val add_d = UpdateAddHtlc(randomBytes32(), 2, 100_000 msat, paymentHash, CltvExpiry(400018), packet_d, None, 1.0, None) + val Right(relay_d@ChannelRelayPacket(_, payload_d, packet_e)) = decrypt(add_d, priv_d, Features.empty) + assert(payload_d.outgoing.contains(ShortChannelId(13L))) + assert(relay_d.amountToForward == 100_000.msat) + assert(relay_d.relayFeeMsat == 0.msat) + + val add_e = UpdateAddHtlc(randomBytes32(), 2, 100_000 msat, paymentHash, CltvExpiry(400018), packet_e, None, 1.0, None) + val Right(FinalPacket(_, payload_e)) = decrypt(add_e, priv_e, Features.empty) + assert(payload_e.isInstanceOf[FinalPayload.Standard]) + assert(payload_e.amount == 100_000.msat) + assert(payload_e.totalAmount == 100_000.msat) + } + + test("test findMultiPartRoute with Blip18 enabled") { + // extracted from the LND code base + val g = DirectedGraph(Seq( + makeEdge(10L, a, b, minHtlc = 2 msat), + makeEdge(10L, b, a, minHtlc = 2 msat, inboundFeeBase_opt = Some(-5000 msat), inboundFeeProportionalMillionth_opt = Some(-60_000)), + + makeEdge(11L, b, c, 1000 msat, 50_000, minHtlc = 2 msat), + makeEdge(11L, c, b, minHtlc = 2 msat, inboundFeeBase_opt = Some(5000 msat), inboundFeeProportionalMillionth_opt = Some(0)), + + makeEdge(12L, c, d, 0 msat, 50_000, minHtlc = 2 msat), + makeEdge(12L, d, c, minHtlc = 2 msat, inboundFeeBase_opt = Some(-8000 msat), inboundFeeProportionalMillionth_opt = Some(-50_000)), + + makeEdge(13L, d, e, 9000 msat, 100_000, minHtlc = 2 msat), + makeEdge(13L, e, d, minHtlc = 2 msat, inboundFeeBase_opt = Some(2000 msat), inboundFeeProportionalMillionth_opt = Some(80_000)), + )) + + val Success(route :: Nil) = findMultiPartRoute(g, a, e, 100_000 msat, 100_000 msat, routeParams = DEFAULT_ROUTE_PARAMS, currentBlockHeight = BlockHeight(400000)) + + assert(route.channelFee(false) == 15_302.msat) + + val recipient = ClearRecipient(e, Features.empty, 100_000 msat, CltvExpiry(400018), paymentSecret) + val Right(payment) = buildOutgoingPayment(TestConstants.emptyOrigin, paymentHash, route, recipient, 1.0) + + assert(payment.outgoingChannel == ShortChannelId(10L)) + assert(payment.cmd.amount == 115_302.msat) + + val packet_b = payment.cmd.onion + + val add_b = UpdateAddHtlc(randomBytes32(), 0, 100_000 msat, paymentHash, CltvExpiry(400018), packet_b, None, 1.0, None) + val Right(relay_b@ChannelRelayPacket(_, payload_b, packet_c)) = decrypt(add_b, priv_b, Features.empty) + assert(payload_b.outgoing.contains(ShortChannelId(11L))) + assert(relay_b.amountToForward == 115_302.msat) + assert(relay_b.relayFeeMsat == -15_302.msat) + + val add_c = UpdateAddHtlc(randomBytes32(), 1, 100_000 msat, paymentHash, CltvExpiry(400018), packet_c, None, 1.0, None) + val Right(relay_c@ChannelRelayPacket(_, payload_c, packet_d)) = decrypt(add_c, priv_c, Features.empty) + assert(payload_c.outgoing.contains(ShortChannelId(12L))) + assert(relay_c.amountToForward == 105_050.msat) + assert(relay_c.relayFeeMsat == -5050.msat) + + val add_d = UpdateAddHtlc(randomBytes32(), 2, 100_000 msat, paymentHash, CltvExpiry(400018), packet_d, None, 1.0, None) + val Right(relay_d@ChannelRelayPacket(_, payload_d, packet_e)) = decrypt(add_d, priv_d, Features.empty) + assert(payload_d.outgoing.contains(ShortChannelId(13L))) + assert(relay_d.amountToForward == 100_000.msat) + assert(relay_d.relayFeeMsat == 0.msat) + + val add_e = UpdateAddHtlc(randomBytes32(), 2, 100_000 msat, paymentHash, CltvExpiry(400018), packet_e, None, 1.0, None) + val Right(FinalPacket(_, payload_e)) = decrypt(add_e, priv_e, Features.empty) + assert(payload_e.isInstanceOf[FinalPayload.Standard]) + assert(payload_e.amount == 100_000.msat) + assert(payload_e.totalAmount == 100_000.msat) + } + + test("test findMultiPartRoute with Blip18 disabled") { + // extracted from the LND code base + val g = DirectedGraph(Seq( + makeEdge(10L, a, b, minHtlc = 2 msat), + makeEdge(10L, b, a, minHtlc = 2 msat, inboundFeeBase_opt = Some(-5000 msat), inboundFeeProportionalMillionth_opt = Some(-60_000)), + + makeEdge(11L, b, c, 1000 msat, 50_000, minHtlc = 2 msat), + makeEdge(11L, c, b, minHtlc = 2 msat, inboundFeeBase_opt = Some(5000 msat), inboundFeeProportionalMillionth_opt = Some(0)), + + makeEdge(12L, c, d, 0 msat, 50_000, minHtlc = 2 msat), + makeEdge(12L, d, c, minHtlc = 2 msat, inboundFeeBase_opt = Some(-8000 msat), inboundFeeProportionalMillionth_opt = Some(-50_000)), + + makeEdge(13L, d, e, 9000 msat, 100_000, minHtlc = 2 msat), + makeEdge(13L, e, d, minHtlc = 2 msat, inboundFeeBase_opt = Some(2000 msat), inboundFeeProportionalMillionth_opt = Some(80_000)), + )) + + val Success(route :: Nil) = findMultiPartRoute(g, a, e, 100_000 msat, 100_000 msat, routeParams = DEFAULT_ROUTE_PARAMS.copy(blip18InboundFees = false), currentBlockHeight = BlockHeight(400000)) + + assert(route.channelFee(false) == 32_197.msat) + + val recipient = ClearRecipient(e, Features.empty, 100_000 msat, CltvExpiry(400018), paymentSecret) + val Right(payment) = buildOutgoingPayment(TestConstants.emptyOrigin, paymentHash, route, recipient, 1.0) + + assert(payment.outgoingChannel == ShortChannelId(10L)) + assert(payment.cmd.amount == 132_197.msat) + + val packet_b = payment.cmd.onion + + val add_b = UpdateAddHtlc(randomBytes32(), 0, 100_000 msat, paymentHash, CltvExpiry(400018), packet_b, None, 1.0, None) + val Right(relay_b@ChannelRelayPacket(_, payload_b, packet_c)) = decrypt(add_b, priv_b, Features.empty) + assert(payload_b.outgoing.contains(ShortChannelId(11L))) + assert(relay_b.amountToForward == 124_950.msat) + assert(relay_b.relayFeeMsat == -24_950.msat) + + val add_c = UpdateAddHtlc(randomBytes32(), 1, 100_000 msat, paymentHash, CltvExpiry(400018), packet_c, None, 1.0, None) + val Right(relay_c@ChannelRelayPacket(_, payload_c, packet_d)) = decrypt(add_c, priv_c, Features.empty) + assert(payload_c.outgoing.contains(ShortChannelId(12L))) + assert(relay_c.amountToForward == 119_000.msat) + assert(relay_c.relayFeeMsat == -19000.msat) + + val add_d = UpdateAddHtlc(randomBytes32(), 2, 100_000 msat, paymentHash, CltvExpiry(400018), packet_d, None, 1.0, None) + val Right(relay_d@ChannelRelayPacket(_, payload_d, packet_e)) = decrypt(add_d, priv_d, Features.empty) + assert(payload_d.outgoing.contains(ShortChannelId(13L))) + assert(relay_d.amountToForward == 100_000.msat) + assert(relay_d.relayFeeMsat == 0.msat) + + val add_e = UpdateAddHtlc(randomBytes32(), 2, 100_000 msat, paymentHash, CltvExpiry(400018), packet_e, None, 1.0, None) + val Right(FinalPacket(_, payload_e)) = decrypt(add_e, priv_e, Features.empty) + assert(payload_e.isInstanceOf[FinalPayload.Standard]) + assert(payload_e.amount == 100_000.msat) + assert(payload_e.totalAmount == 100_000.msat) + } + + test("calculate Blip18 simple route with a positive inbound fees channel") { + // channels with positive (greater than 0) inbound fees should be automatically excluded from path finding + val ROUTE_PARAMS = DEFAULT_ROUTE_PARAMS.copy(excludePositiveInboundFees = true) + + { + val g = DirectedGraph(List( + makeEdge(1L, a, b, 1 msat, 10, cltvDelta = CltvExpiryDelta(1), balance_opt = Some(DEFAULT_AMOUNT_MSAT * 2)), + makeEdge(2L, b, c, 2 msat, 20, cltvDelta = CltvExpiryDelta(1)), + makeEdge(2L, c, b, 2 msat, 20, cltvDelta = CltvExpiryDelta(1), inboundFeeBase_opt = Some(1 msat), inboundFeeProportionalMillionth_opt = Some(10)), + makeEdge(3L, c, d, 1 msat, 10, cltvDelta = CltvExpiryDelta(1)), + makeEdge(4L, d, e, 1 msat, 10, cltvDelta = CltvExpiryDelta(1)) + )) + + val res = findRoute(g, a, e, DEFAULT_AMOUNT_MSAT, DEFAULT_MAX_FEE, numRoutes = 1, routeParams = ROUTE_PARAMS, currentBlockHeight = BlockHeight(400000)) + assert(res == Failure(RouteNotFound)) + } + { + val g = DirectedGraph(List( + makeEdge(1L, a, b, 1 msat, 10, cltvDelta = CltvExpiryDelta(1), balance_opt = Some(DEFAULT_AMOUNT_MSAT * 2)), + makeEdge(2L, b, c, 2 msat, 20, cltvDelta = CltvExpiryDelta(1)), + makeEdge(2L, c, b, 2 msat, 20, cltvDelta = CltvExpiryDelta(1), inboundFeeBase_opt = Some(1 msat), inboundFeeProportionalMillionth_opt = Some(0)), + makeEdge(3L, c, d, 1 msat, 10, cltvDelta = CltvExpiryDelta(1)), + makeEdge(4L, d, e, 1 msat, 10, cltvDelta = CltvExpiryDelta(1)) + )) + + val res = findRoute(g, a, e, DEFAULT_AMOUNT_MSAT, DEFAULT_MAX_FEE, numRoutes = 1, routeParams = ROUTE_PARAMS, currentBlockHeight = BlockHeight(400000)) + assert(res == Failure(RouteNotFound)) + } + { + val g = DirectedGraph(List( + makeEdge(1L, a, b, 1 msat, 10, cltvDelta = CltvExpiryDelta(1), balance_opt = Some(DEFAULT_AMOUNT_MSAT * 2)), + makeEdge(2L, b, c, 2 msat, 20, cltvDelta = CltvExpiryDelta(1)), + makeEdge(2L, c, b, 2 msat, 20, cltvDelta = CltvExpiryDelta(1), inboundFeeBase_opt = Some(0 msat), inboundFeeProportionalMillionth_opt = Some(10)), + makeEdge(3L, c, d, 1 msat, 10, cltvDelta = CltvExpiryDelta(1)), + makeEdge(4L, d, e, 1 msat, 10, cltvDelta = CltvExpiryDelta(1)) + )) + + val res = findRoute(g, a, e, DEFAULT_AMOUNT_MSAT, DEFAULT_MAX_FEE, numRoutes = 1, routeParams = ROUTE_PARAMS, currentBlockHeight = BlockHeight(400000)) + assert(res == Failure(RouteNotFound)) + } + { + val g = DirectedGraph(List( + makeEdge(1L, a, b, 1 msat, 10, cltvDelta = CltvExpiryDelta(1), balance_opt = Some(DEFAULT_AMOUNT_MSAT * 2)), + makeEdge(2L, b, c, 2 msat, 20, cltvDelta = CltvExpiryDelta(1)), + makeEdge(2L, c, b, 2 msat, 20, cltvDelta = CltvExpiryDelta(1), inboundFeeBase_opt = Some(1 msat), inboundFeeProportionalMillionth_opt = Some(-10)), + makeEdge(3L, c, d, 1 msat, 10, cltvDelta = CltvExpiryDelta(1)), + makeEdge(4L, d, e, 1 msat, 10, cltvDelta = CltvExpiryDelta(1)) + )) + + val res = findRoute(g, a, e, DEFAULT_AMOUNT_MSAT, DEFAULT_MAX_FEE, numRoutes = 1, routeParams = ROUTE_PARAMS, currentBlockHeight = BlockHeight(400000)) + assert(res == Failure(RouteNotFound)) + } + { + val g = DirectedGraph(List( + makeEdge(1L, a, b, 1 msat, 10, cltvDelta = CltvExpiryDelta(1), balance_opt = Some(DEFAULT_AMOUNT_MSAT * 2)), + makeEdge(2L, b, c, 2 msat, 20, cltvDelta = CltvExpiryDelta(1)), + makeEdge(2L, c, b, 2 msat, 20, cltvDelta = CltvExpiryDelta(1), inboundFeeBase_opt = Some(-1 msat), inboundFeeProportionalMillionth_opt = Some(10)), + makeEdge(3L, c, d, 1 msat, 10, cltvDelta = CltvExpiryDelta(1)), + makeEdge(4L, d, e, 1 msat, 10, cltvDelta = CltvExpiryDelta(1)) + )) + + val res = findRoute(g, a, e, DEFAULT_AMOUNT_MSAT, DEFAULT_MAX_FEE, numRoutes = 1, routeParams = ROUTE_PARAMS, currentBlockHeight = BlockHeight(400000)) + assert(res == Failure(RouteNotFound)) + } + } + +} + +object Blip18RouteCalculationSpec { + + val DEFAULT_AMOUNT_MSAT = 10_000_000 msat + val DEFAULT_MAX_FEE = 100_000 msat + val DEFAULT_EXPIRY = CltvExpiry(TestConstants.defaultBlockHeight) + val DEFAULT_CAPACITY = 100_000 sat + + val NO_WEIGHT_RATIOS: WeightRatios = WeightRatios(1, 0, 0, 0, RelayFees(0 msat, 0)) + val DEFAULT_ROUTE_PARAMS = PathFindingConf( + randomize = false, + boundaries = SearchBoundaries(21000 msat, 0.03, 6, CltvExpiryDelta(2016)), + Left(NO_WEIGHT_RATIOS), + MultiPartParams(1000 msat, 10), + experimentName = "my-test-experiment", + experimentPercentage = 100, + blip18InboundFees = true).getDefaultRouteParams + + val DUMMY_SIG = Transactions.PlaceHolderSig + + def makeChannel(shortChannelId: Long, nodeIdA: PublicKey, nodeIdB: PublicKey): ChannelAnnouncement = { + val (nodeId1, nodeId2) = if (Announcements.isNode1(nodeIdA, nodeIdB)) (nodeIdA, nodeIdB) else (nodeIdB, nodeIdA) + ChannelAnnouncement(DUMMY_SIG, DUMMY_SIG, DUMMY_SIG, DUMMY_SIG, Features.empty, Block.RegtestGenesisBlock.hash, RealShortChannelId(shortChannelId), nodeId1, nodeId2, randomKey().publicKey, randomKey().publicKey) + } + + def makeEdge(shortChannelId: Long, + nodeId1: PublicKey, + nodeId2: PublicKey, + feeBase: MilliSatoshi = 0 msat, + feeProportionalMillionth: Int = 0, + minHtlc: MilliSatoshi = DEFAULT_AMOUNT_MSAT, + maxHtlc: Option[MilliSatoshi] = None, + cltvDelta: CltvExpiryDelta = CltvExpiryDelta(0), + capacity: Satoshi = DEFAULT_CAPACITY, + balance_opt: Option[MilliSatoshi] = None, + inboundFeeBase_opt: Option[MilliSatoshi] = None, + inboundFeeProportionalMillionth_opt: Option[Int] = None): GraphEdge = { + val update = makeUpdateShort(ShortChannelId(shortChannelId), nodeId1, nodeId2, feeBase, feeProportionalMillionth, minHtlc, maxHtlc, cltvDelta, inboundFeeBase_opt = inboundFeeBase_opt, inboundFeeProportionalMillionth_opt = inboundFeeProportionalMillionth_opt) + GraphEdge(ChannelDesc(RealShortChannelId(shortChannelId), nodeId1, nodeId2), HopRelayParams.FromAnnouncement(update), capacity, balance_opt) + } + + def makeUpdateShort(shortChannelId: ShortChannelId, nodeId1: PublicKey, nodeId2: PublicKey, feeBase: MilliSatoshi, feeProportionalMillionth: Int, minHtlc: MilliSatoshi = DEFAULT_AMOUNT_MSAT, maxHtlc: Option[MilliSatoshi] = None, cltvDelta: CltvExpiryDelta = CltvExpiryDelta(0), timestamp: TimestampSecond = 0 unixsec, inboundFeeBase_opt: Option[MilliSatoshi] = None, inboundFeeProportionalMillionth_opt: Option[Int] = None): ChannelUpdate = { + val tlvStream: TlvStream[ChannelUpdateTlv] = if (inboundFeeBase_opt.isDefined && inboundFeeProportionalMillionth_opt.isDefined) { + TlvStream(ChannelUpdateTlv.Blip18InboundFee(inboundFeeBase_opt.get.toLong.toInt, inboundFeeProportionalMillionth_opt.get)) + } else { + TlvStream.empty + } + ChannelUpdate( + signature = DUMMY_SIG, + chainHash = Block.RegtestGenesisBlock.hash, + shortChannelId = shortChannelId, + timestamp = timestamp, + messageFlags = ChannelUpdate.MessageFlags(dontForward = false), + channelFlags = ChannelUpdate.ChannelFlags(isEnabled = true, isNode1 = Announcements.isNode1(nodeId1, nodeId2)), + cltvExpiryDelta = cltvDelta, + htlcMinimumMsat = minHtlc, + feeBaseMsat = feeBase, + feeProportionalMillionths = feeProportionalMillionth, + htlcMaximumMsat = maxHtlc.getOrElse(500_000_000 msat), + tlvStream = tlvStream + ) + } +} diff --git a/eclair-core/src/test/scala/fr/acinq/eclair/router/RouteCalculationSpec.scala b/eclair-core/src/test/scala/fr/acinq/eclair/router/RouteCalculationSpec.scala index edec7c97a9..73284bf52c 100644 --- a/eclair-core/src/test/scala/fr/acinq/eclair/router/RouteCalculationSpec.scala +++ b/eclair-core/src/test/scala/fr/acinq/eclair/router/RouteCalculationSpec.scala @@ -552,7 +552,7 @@ class RouteCalculationSpec extends AnyFunSuite with ParallelTestExecution { ) val publicChannels = channels.map { case (shortChannelId, announcement) => - val HopRelayParams.FromAnnouncement(update) = edges.find(_.desc.shortChannelId == shortChannelId).get.params + val HopRelayParams.FromAnnouncement(update, _) = edges.find(_.desc.shortChannelId == shortChannelId).get.params val (update_1_opt, update_2_opt) = if (update.channelFlags.isNode1) (Some(update), None) else (None, Some(update)) val pc = PublicChannel(announcement, TxId(ByteVector32.Zeroes), Satoshi(1000), update_1_opt, update_2_opt, None) (shortChannelId, pc) diff --git a/eclair-node/src/main/scala/fr/acinq/eclair/api/handlers/Payment.scala b/eclair-node/src/main/scala/fr/acinq/eclair/api/handlers/Payment.scala index e0528dcc4b..ec1f618a51 100644 --- a/eclair-node/src/main/scala/fr/acinq/eclair/api/handlers/Payment.scala +++ b/eclair-node/src/main/scala/fr/acinq/eclair/api/handlers/Payment.scala @@ -56,11 +56,11 @@ trait Payment { val sendToRoute: Route = postRequest("sendtoroute") { implicit t => withRoute { hops => formFields(amountMsatFormParam, "recipientAmountMsat".as[MilliSatoshi].?, invoiceFormParam, "externalId".?, "parentId".as[UUID].?, - "trampolineSecret".as[ByteVector32].?, "trampolineFeesMsat".as[MilliSatoshi].?, "trampolineCltvExpiry".as[Int].?, maxFeeMsatFormParam.?) { - (amountMsat, recipientAmountMsat_opt, invoice, externalId_opt, parentId_opt, trampolineSecret_opt, trampolineFeesMsat_opt, trampolineCltvExpiry_opt, maxFee_opt) => { + "trampolineSecret".as[ByteVector32].?, "trampolineFeesMsat".as[MilliSatoshi].?, "trampolineCltvExpiry".as[Int].?, maxFeeMsatFormParam.?, "blip18InboundFees".as[Boolean].?, "excludePositiveInboundFees".as[Boolean].?) { + (amountMsat, recipientAmountMsat_opt, invoice, externalId_opt, parentId_opt, trampolineSecret_opt, trampolineFeesMsat_opt, trampolineCltvExpiry_opt, maxFee_opt, blip18InboundFees_opt, excludePositiveInboundFees_opt) => { val route = hops match { - case Left(shortChannelIds) => PredefinedChannelRoute(amountMsat, invoice.nodeId, shortChannelIds, maxFee_opt) - case Right(nodeIds) => PredefinedNodeRoute(amountMsat, nodeIds, maxFee_opt) + case Left(shortChannelIds) => PredefinedChannelRoute(amountMsat, invoice.nodeId, shortChannelIds, maxFee_opt, blip18InboundFees_opt.getOrElse(false), excludePositiveInboundFees_opt.getOrElse(false)) + case Right(nodeIds) => PredefinedNodeRoute(amountMsat, nodeIds, maxFee_opt, blip18InboundFees_opt.getOrElse(false), excludePositiveInboundFees_opt.getOrElse(false)) } complete(eclairApi.sendToRoute( recipientAmountMsat_opt, externalId_opt, parentId_opt, invoice, route, trampolineSecret_opt, trampolineFeesMsat_opt, trampolineCltvExpiry_opt.map(CltvExpiryDelta)) From 5f9e17d44ea937f78f937b72da41d0610270b03b Mon Sep 17 00:00:00 2001 From: rorp Date: Fri, 25 Oct 2024 14:08:44 -0400 Subject: [PATCH 2/3] Fix bugs --- .../main/scala/fr/acinq/eclair/router/Graph.scala | 10 ++++++++-- .../fr/acinq/eclair/router/RouteCalculation.scala | 12 +++++------- .../main/scala/fr/acinq/eclair/router/Router.scala | 4 +--- .../eclair/wire/protocol/LightningMessageTypes.scala | 2 +- .../eclair/router/Blip18RouteCalculationSpec.scala | 10 ++++++++++ 5 files changed, 25 insertions(+), 13 deletions(-) diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/router/Graph.scala b/eclair-core/src/main/scala/fr/acinq/eclair/router/Graph.scala index 461f33519d..842c791fbc 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/router/Graph.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/router/Graph.scala @@ -21,7 +21,8 @@ import fr.acinq.bitcoin.scalacompat.{Btc, BtcDouble, MilliBtc, Satoshi} import fr.acinq.eclair._ import fr.acinq.eclair.payment.Invoice import fr.acinq.eclair.payment.relay.Relayer.RelayFees -import fr.acinq.eclair.router.Graph.GraphStructure.{GraphEdge, DirectedGraph} +import fr.acinq.eclair.router.Graph.GraphStructure.{DirectedGraph, GraphEdge} +import fr.acinq.eclair.router.Router.HopRelayParams import fr.acinq.eclair.router.Router._ import fr.acinq.eclair.wire.protocol.{ChannelUpdate, NodeAnnouncement} @@ -254,7 +255,7 @@ object Graph { current.weight.amount >= edge.params.htlcMinimum && !ignoredEdges.contains(edge.desc) && !ignoredVertices.contains(neighbor) && - (!excludePositiveInboundFees || g.getBackEdge(edge).forall(e => e.params.inboundFees_opt.forall(i => i.feeBase.toLong <= 0 && i.feeProportionalMillionths <= 0)))) { + (!excludePositiveInboundFees || g.getBackEdge(edge).flatMap(_.getChannelUpdate).flatMap(_.blip18InboundFees_opt).forall(i => i.feeBase.toLong <= 0 && i.feeProportionalMillionths <= 0))) { // NB: this contains the amount (including fees) that will need to be sent to `neighbor`, but the amount that // will be relayed through that edge is the one in `currentWeight`. val neighborWeight = addEdgeWeight(sourceNode, edge, current.weight, currentBlockHeight, wr, includeLocalChannelCost) @@ -598,6 +599,11 @@ object Graph { ).flatten.min.max(0 msat) def fee(amount: MilliSatoshi): MilliSatoshi = params.fee(amount) + + def getChannelUpdate: Option[ChannelUpdate] = params match { + case HopRelayParams.FromAnnouncement(update, _) => Some(update) + case _ => None + } } object GraphEdge { diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/router/RouteCalculation.scala b/eclair-core/src/main/scala/fr/acinq/eclair/router/RouteCalculation.scala index 0ffa4f301e..ec26867988 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/router/RouteCalculation.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/router/RouteCalculation.scala @@ -22,14 +22,12 @@ import com.softwaremill.quicklens.ModifyPimp import fr.acinq.bitcoin.scalacompat.Crypto.PublicKey import fr.acinq.eclair.Logs.LogCategory import fr.acinq.eclair._ -import fr.acinq.eclair.message.SendingMessage import fr.acinq.eclair.payment.send._ import fr.acinq.eclair.router.Graph.GraphStructure.DirectedGraph.graphEdgeToHop import fr.acinq.eclair.router.Graph.GraphStructure.{DirectedGraph, GraphEdge} import fr.acinq.eclair.router.Graph.{InfiniteLoop, MessagePath, NegativeProbability, RichWeight} import fr.acinq.eclair.router.Monitoring.{Metrics, Tags} import fr.acinq.eclair.router.Router._ -import fr.acinq.eclair.wire.protocol.ChannelUpdateTlv.Blip18InboundFee import kamon.tag.TagSet import scala.annotation.tailrec @@ -350,13 +348,13 @@ object RouteCalculation { val hops = routeHops.reverse val updatedHops = routeHops.head :: hops.zip(hops.tail).foldLeft(List.empty[ChannelHop]) { (hops, x) => val (curr, prev) = x - val maybeEdge = g.getBackEdge(ChannelDesc(prev.shortChannelId, prev.nodeId, prev.nextNodeId)) + val backEdge_opt = g.getBackEdge(ChannelDesc(prev.shortChannelId, prev.nodeId, prev.nextNodeId)) val hop = curr.copy(params = curr.params match { case hopParams: HopRelayParams.FromAnnouncement => - maybeEdge match { - case Some(backEdge) => hopParams.copy(updatedInboundFees_opt = backEdge.params.inboundFees_opt) - case _ => hopParams - } + backEdge_opt + .flatMap(_.getChannelUpdate) + .map(u => hopParams.copy(inboundFees_opt = u.blip18InboundFees_opt)) + .getOrElse(hopParams) case hopParams => hopParams }) diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/router/Router.scala b/eclair-core/src/main/scala/fr/acinq/eclair/router/Router.scala index 94b48b14ac..6d3a66f2d3 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/router/Router.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/router/Router.scala @@ -491,13 +491,11 @@ object Router { object HopRelayParams { /** We learnt about this channel from a channel_update. */ - case class FromAnnouncement(channelUpdate: ChannelUpdate, updatedInboundFees_opt: Option[Relayer.InboundFees] = None) extends HopRelayParams { + case class FromAnnouncement(channelUpdate: ChannelUpdate, inboundFees_opt: Option[Relayer.InboundFees] = None) extends HopRelayParams { override val cltvExpiryDelta = channelUpdate.cltvExpiryDelta override val relayFees = channelUpdate.relayFees - override val inboundFees_opt = updatedInboundFees_opt orElse channelUpdate.inboundFees_opt override val htlcMinimum = channelUpdate.htlcMinimumMsat override val htlcMaximum_opt = Some(channelUpdate.htlcMaximumMsat) - } /** We learnt about this hop from hints in an invoice. */ diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/LightningMessageTypes.scala b/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/LightningMessageTypes.scala index e884ff5151..b8e0005e38 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/LightningMessageTypes.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/LightningMessageTypes.scala @@ -544,7 +544,7 @@ case class ChannelUpdate(signature: ByteVector64, def relayFees: Relayer.RelayFees = Relayer.RelayFees(feeBase = feeBaseMsat, feeProportionalMillionths = feeProportionalMillionths) - def inboundFees_opt: Option[Relayer.InboundFees] = + def blip18InboundFees_opt: Option[Relayer.InboundFees] = tlvStream.get[ChannelUpdateTlv.Blip18InboundFee].map(blip18 => Relayer.InboundFees(blip18.feeBase, blip18.feeProportionalMillionths)) } diff --git a/eclair-core/src/test/scala/fr/acinq/eclair/router/Blip18RouteCalculationSpec.scala b/eclair-core/src/test/scala/fr/acinq/eclair/router/Blip18RouteCalculationSpec.scala index 68c7e9a41c..d621d0bbb8 100644 --- a/eclair-core/src/test/scala/fr/acinq/eclair/router/Blip18RouteCalculationSpec.scala +++ b/eclair-core/src/test/scala/fr/acinq/eclair/router/Blip18RouteCalculationSpec.scala @@ -27,6 +27,16 @@ class Blip18RouteCalculationSpec extends AnyFunSuite with ParallelTestExecution val (priv_a, priv_b, priv_c, priv_d, priv_e, priv_f) = (randomKey(), randomKey(), randomKey(), randomKey(), randomKey(), randomKey()) val (a, b, c, d, e, f) = (priv_a.publicKey, priv_b.publicKey, priv_c.publicKey, priv_d.publicKey, priv_e.publicKey, priv_f.publicKey) + test("find a direct route") { + val g = DirectedGraph(Seq( + makeEdge(10L, a, b, minHtlc = 2 msat, feeBase = 0 msat, feeProportionalMillionth = 120, inboundFeeBase_opt = Some(0.msat), inboundFeeProportionalMillionth_opt = Some(-71)), + )) + + val Success(route :: Nil) = findRoute(g, a, b, 10_000_000 msat, 10_000_000 msat, numRoutes = 1, routeParams = DEFAULT_ROUTE_PARAMS.copy(includeLocalChannelCost = true), currentBlockHeight = BlockHeight(400000)) + + assert(route.channelFee(true) == 1200.msat) + } + test("test findRoute with Blip18 enabled") { // extracted from the LND code base val g = DirectedGraph(Seq( From 799e5fd3b819834ba95b2c49edc16dbdf99ebb30 Mon Sep 17 00:00:00 2001 From: rorp Date: Sun, 8 Jun 2025 21:04:45 -0700 Subject: [PATCH 3/3] bLIP-18 inbound routing fees --- .gitignore | 2 + docs/release-notes/eclair-vnext.md | 84 +++++++++++++++++ .../main/scala/fr/acinq/eclair/Eclair.scala | 22 ++++- .../fr/acinq/eclair/channel/ChannelData.scala | 2 +- .../fr/acinq/eclair/channel/Helpers.scala | 6 +- .../fr/acinq/eclair/channel/fsm/Channel.scala | 20 ++-- .../channel/fsm/CommonFundingHandlers.scala | 5 +- .../scala/fr/acinq/eclair/db/Databases.scala | 8 +- .../fr/acinq/eclair/db/DualDatabases.scala | 18 +++- .../fr/acinq/eclair/db/InboundFeesDb.scala | 13 +++ .../acinq/eclair/db/pg/PgInboundFeesDb.scala | 70 ++++++++++++++ .../db/sqlite/SqliteInboundFeesDb.scala | 61 ++++++++++++ .../main/scala/fr/acinq/eclair/package.scala | 15 ++- .../eclair/payment/relay/ChannelRelay.scala | 94 ++++++++++++------- .../acinq/eclair/payment/relay/Relayer.scala | 9 ++ .../payment/send/BlindedPathsResolver.scala | 2 +- .../acinq/eclair/router/Announcements.scala | 15 +-- .../eclair/router/RouteCalculation.scala | 6 +- .../scala/fr/acinq/eclair/router/Router.scala | 7 +- .../eclair/wire/protocol/RoutingTlv.scala | 5 + .../fr/acinq/eclair/EclairImplSpec.scala | 13 ++- .../scala/fr/acinq/eclair/TestDatabases.scala | 5 +- .../fr/acinq/eclair/db/DbMigrationSpec.scala | 3 +- .../acinq/eclair/db/InboundFeesDbSpec.scala | 45 +++++++++ .../payment/relay/ChannelRelayerSpec.scala | 21 ++++- .../eclair/router/AnnouncementsSpec.scala | 4 + .../fr/acinq/eclair/api/handlers/Fees.scala | 16 +++- 27 files changed, 484 insertions(+), 87 deletions(-) create mode 100644 docs/release-notes/eclair-vnext.md create mode 100644 eclair-core/src/main/scala/fr/acinq/eclair/db/InboundFeesDb.scala create mode 100644 eclair-core/src/main/scala/fr/acinq/eclair/db/pg/PgInboundFeesDb.scala create mode 100644 eclair-core/src/main/scala/fr/acinq/eclair/db/sqlite/SqliteInboundFeesDb.scala create mode 100644 eclair-core/src/test/scala/fr/acinq/eclair/db/InboundFeesDbSpec.scala diff --git a/.gitignore b/.gitignore index f72ed6206a..a25470c558 100644 --- a/.gitignore +++ b/.gitignore @@ -26,5 +26,7 @@ project/target DeleteMe*.* *~ jdbcUrlFile_*.tmp +.metals/ +.vscode/ .DS_Store diff --git a/docs/release-notes/eclair-vnext.md b/docs/release-notes/eclair-vnext.md new file mode 100644 index 0000000000..f270f90792 --- /dev/null +++ b/docs/release-notes/eclair-vnext.md @@ -0,0 +1,84 @@ +# Eclair vnext + + + +## Major changes + + + +### bLIP-18 Inbound Routing Fees + +Eclair now supports [bLIP-18 inbound routing fees](https://github.com/lightning/blips/pull/18) which proposes an optional +TLV for channel updates that allows node operators to set (and optionally advertise) inbound routing fee discounts, enabling +more flexible fee policies and incentivizing desired incoming traffic. + +#### Configuration + +| Configuration Parameter | Default Value | Description | +|----------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| `eclair.router.path-finding.default.blip18-inbound-fees` | `false` | enables support for bLIP-18 inbound routing fees | +| `eclair.router.path-finding.default.exclude-channels-with-positive-inbound-fees` | `false` | enables exclusion of channels with positive inbound fees from path finding, helping to prevent `FeeInsufficient` errors and ensure more reliable routing | + +The routing logic considers inbound fees during route selection if enabled. New logic is added to exclude channels with +positive inbound fees from route finding when configured. The relay and route calculation logic now computes total fees +as the sum of the regular (outbound) and inbound fees when applicable. + +The wire protocol is updated to include the new TLV (0x55555) type for bLIP-18 inbound fees in ChannelUpdate messages. +Code that (de)serializes channel updates now handles these new fields. + +New database tables and migration updates for storing inbound fee information per peer. + +### API changes + + + +- `updaterelayfee` now accepts optional `--inboundFeeBaseMsat` and `--inboundFeeProportionalMillionths` parameters. If omitted, existing inbound fees will be preserved. + +### Miscellaneous improvements and bug fixes + + + +## Verifying signatures + +You will need `gpg` and our release signing key E04E48E72C205463. Note that you can get it: + +- from our website: https://acinq.co/pgp/drouinf2.asc +- from github user @sstone, a committer on eclair: https://api.github.com/users/sstone/gpg_keys + +To import our signing key: + +```sh +$ gpg --import drouinf2.asc +``` + +To verify the release file checksums and signatures: + +```sh +$ gpg -d SHA256SUMS.asc > SHA256SUMS.stripped +$ sha256sum -c SHA256SUMS.stripped +``` + +## Building + +Eclair builds are deterministic. To reproduce our builds, please use the following environment (*): + +- Ubuntu 24.04.1 +- Adoptium OpenJDK 21.0.6 + +Use the following command to generate the eclair-node package: + +```sh +./mvnw clean install -DskipTests +``` + +That should generate `eclair-node/target/eclair-node--XXXXXXX-bin.zip` with sha256 checksums that match the one we provide and sign in `SHA256SUMS.asc` + +(*) You may be able to build the exact same artefacts with other operating systems or versions of JDK 21, we have not tried everything. + +## Upgrading + +This release is fully compatible with previous eclair versions. You don't need to close your channels, just stop eclair, upgrade and restart. + +## Changelog + + diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/Eclair.scala b/eclair-core/src/main/scala/fr/acinq/eclair/Eclair.scala index da2d0c8e60..ea39a7269e 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/Eclair.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/Eclair.scala @@ -44,7 +44,7 @@ import fr.acinq.eclair.message.{OnionMessages, Postman} import fr.acinq.eclair.payment._ import fr.acinq.eclair.payment.offer.{OfferCreator, OfferManager} import fr.acinq.eclair.payment.receive.MultiPartHandler.ReceiveStandardPayment -import fr.acinq.eclair.payment.relay.Relayer.{ChannelBalance, GetOutgoingChannels, OutgoingChannels, RelayFees} +import fr.acinq.eclair.payment.relay.Relayer.{ChannelBalance, GetOutgoingChannels, InboundFees, OutgoingChannels, RelayFees} import fr.acinq.eclair.payment.send.PaymentInitiator._ import fr.acinq.eclair.payment.send.{ClearRecipient, OfferPayment, PaymentIdentifier} import fr.acinq.eclair.router.Router @@ -114,6 +114,8 @@ trait Eclair { def updateRelayFee(nodes: List[PublicKey], feeBase: MilliSatoshi, feeProportionalMillionths: Long)(implicit timeout: Timeout): Future[Map[ApiTypes.ChannelIdentifier, Either[Throwable, CommandResponse[CMD_UPDATE_RELAY_FEE]]]] + def updateRelayFee(nodes: List[PublicKey], feeBase: MilliSatoshi, feeProportionalMillionths: Long, inboundFeeBase_opt: Option[MilliSatoshi], inboundFeeProportional_opt: Option[Long])(implicit timeout: Timeout): Future[Map[ApiTypes.ChannelIdentifier, Either[Throwable, CommandResponse[CMD_UPDATE_RELAY_FEE]]]] + def channelsInfo(toRemoteNode_opt: Option[PublicKey])(implicit timeout: Timeout): Future[Iterable[RES_GET_CHANNEL_INFO]] def channelInfo(channel: ApiTypes.ChannelIdentifier)(implicit timeout: Timeout): Future[CommandResponse[CMD_GET_CHANNEL_INFO]] @@ -308,11 +310,21 @@ class EclairImpl(val appKit: Kit) extends Eclair with Logging with SpendFromChan sendToChannelsTyped(channels, cmdBuilder = CMD_BUMP_FORCE_CLOSE_FEE(_, confirmationTarget)) } - override def updateRelayFee(nodes: List[PublicKey], feeBaseMsat: MilliSatoshi, feeProportionalMillionths: Long)(implicit timeout: Timeout): Future[Map[ApiTypes.ChannelIdentifier, Either[Throwable, CommandResponse[CMD_UPDATE_RELAY_FEE]]]] = { - for (nodeId <- nodes) { - appKit.nodeParams.db.peers.addOrUpdateRelayFees(nodeId, RelayFees(feeBaseMsat, feeProportionalMillionths)) + override def updateRelayFee(nodes: List[PublicKey], feeBaseMsat: MilliSatoshi, feeProportionalMillionths: Long)(implicit timeout: Timeout): Future[Map[ApiTypes.ChannelIdentifier, Either[Throwable, CommandResponse[CMD_UPDATE_RELAY_FEE]]]] = + updateRelayFee(nodes, feeBaseMsat, feeProportionalMillionths, None, None) + + override def updateRelayFee(nodes: List[PublicKey], feeBaseMsat: MilliSatoshi, feeProportionalMillionths: Long, inboundFeeBase_opt: Option[MilliSatoshi], inboundFeeProportional_opt: Option[Long])(implicit timeout: Timeout): Future[Map[ApiTypes.ChannelIdentifier, Either[Throwable, CommandResponse[CMD_UPDATE_RELAY_FEE]]]] = { + if ((inboundFeeBase_opt.isDefined || inboundFeeProportional_opt.isDefined) && !appKit.nodeParams.routerConf.blip18InboundFees) { + Future.failed(new IllegalArgumentException("Cannot specify inbound fees when bLIP-18 support is disabled")) + } else { + for (nodeId <- nodes) { + appKit.nodeParams.db.peers.addOrUpdateRelayFees(nodeId, RelayFees(feeBaseMsat, feeProportionalMillionths)) + InboundFees.fromOptions(inboundFeeBase_opt, inboundFeeProportional_opt).foreach { inboundFees => + appKit.nodeParams.db.inboundFees.addOrUpdateInboundFees(nodeId, inboundFees) + } + } + sendToNodes(nodes, CMD_UPDATE_RELAY_FEE(ActorRef.noSender, feeBaseMsat, feeProportionalMillionths, inboundFeeBase_opt, inboundFeeProportional_opt)) } - sendToNodes(nodes, CMD_UPDATE_RELAY_FEE(ActorRef.noSender, feeBaseMsat, feeProportionalMillionths)) } override def peers()(implicit timeout: Timeout): Future[Iterable[PeerInfo]] = for { diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/channel/ChannelData.scala b/eclair-core/src/main/scala/fr/acinq/eclair/channel/ChannelData.scala index b3b125597e..fdc204c61e 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/channel/ChannelData.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/channel/ChannelData.scala @@ -242,7 +242,7 @@ final case class CMD_SPLICE(replyTo: akka.actor.typed.ActorRef[CommandResponse[C val spliceOutputs: List[TxOut] = spliceOut_opt.toList.map(s => TxOut(s.amount, s.scriptPubKey)) } final case class CMD_BUMP_FUNDING_FEE(replyTo: akka.actor.typed.ActorRef[CommandResponse[ChannelFundingCommand]], targetFeerate: FeeratePerKw, fundingFeeBudget: Satoshi, lockTime: Long, requestFunding_opt: Option[LiquidityAds.RequestFunding]) extends ChannelFundingCommand -final case class CMD_UPDATE_RELAY_FEE(replyTo: ActorRef, feeBase: MilliSatoshi, feeProportionalMillionths: Long) extends HasReplyToCommand +final case class CMD_UPDATE_RELAY_FEE(replyTo: ActorRef, feeBase: MilliSatoshi, feeProportionalMillionths: Long, inboundFeeBase_opt: Option[MilliSatoshi] = None, inboundFeeProportionalMillionths_opt: Option[Long]= None) extends HasReplyToCommand final case class CMD_GET_CHANNEL_STATE(replyTo: ActorRef) extends HasReplyToCommand final case class CMD_GET_CHANNEL_DATA(replyTo: ActorRef) extends HasReplyToCommand final case class CMD_GET_CHANNEL_INFO(replyTo: akka.actor.typed.ActorRef[RES_GET_CHANNEL_INFO]) extends Command diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/channel/Helpers.scala b/eclair-core/src/main/scala/fr/acinq/eclair/channel/Helpers.scala index 7cdd1981f3..5c3c41e20e 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/channel/Helpers.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/channel/Helpers.scala @@ -29,7 +29,7 @@ import fr.acinq.eclair.channel.fsm.Channel.REFRESH_CHANNEL_UPDATE_INTERVAL import fr.acinq.eclair.crypto.keymanager.ChannelKeyManager import fr.acinq.eclair.crypto.{Generators, ShaChain} import fr.acinq.eclair.db.ChannelsDb -import fr.acinq.eclair.payment.relay.Relayer.RelayFees +import fr.acinq.eclair.payment.relay.Relayer.{InboundFees, RelayFees} import fr.acinq.eclair.router.Announcements import fr.acinq.eclair.transactions.DirectedHtlc._ import fr.acinq.eclair.transactions.Scripts._ @@ -351,9 +351,9 @@ object Helpers { commitments.params.maxHtlcAmount } - def getRelayFees(nodeParams: NodeParams, remoteNodeId: PublicKey, announceChannel: Boolean): RelayFees = { + def getRelayFees(nodeParams: NodeParams, remoteNodeId: PublicKey, announceChannel: Boolean): (RelayFees, Option[InboundFees]) = { val defaultFees = nodeParams.relayParams.defaultFees(announceChannel) - nodeParams.db.peers.getRelayFees(remoteNodeId).getOrElse(defaultFees) + (nodeParams.db.peers.getRelayFees(remoteNodeId).getOrElse(defaultFees), nodeParams.db.inboundFees.getInboundFees(remoteNodeId)) } object Funding { diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/channel/fsm/Channel.scala b/eclair-core/src/main/scala/fr/acinq/eclair/channel/fsm/Channel.scala index 34ac08c7ff..c47af23ff6 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/channel/fsm/Channel.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/channel/fsm/Channel.scala @@ -46,6 +46,7 @@ import fr.acinq.eclair.db.PendingCommandsDb import fr.acinq.eclair.io.Peer import fr.acinq.eclair.io.Peer.LiquidityPurchaseSigned import fr.acinq.eclair.payment.relay.Relayer +import fr.acinq.eclair.payment.relay.Relayer.InboundFees import fr.acinq.eclair.payment.{Bolt11Invoice, PaymentSettlingOnChain} import fr.acinq.eclair.router.Announcements import fr.acinq.eclair.transactions.Transactions.ClosingTx @@ -390,12 +391,13 @@ class Channel(val nodeParams: NodeParams, val wallet: OnChainChannelFunder with case normal: DATA_NORMAL => context.system.eventStream.publish(ShortChannelIdAssigned(self, normal.channelId, normal.lastAnnouncement_opt, normal.aliases, remoteNodeId)) // we check the configuration because the values for channel_update may have changed while eclair was down - val fees = getRelayFees(nodeParams, remoteNodeId, normal.commitments.announceChannel) + val (fees, inboundFees_opt) = getRelayFees(nodeParams, remoteNodeId, normal.commitments.announceChannel) if (fees.feeBase != normal.channelUpdate.feeBaseMsat || fees.feeProportionalMillionths != normal.channelUpdate.feeProportionalMillionths || + inboundFees_opt != normal.channelUpdate.blip18InboundFees_opt || nodeParams.channelConf.expiryDelta != normal.channelUpdate.cltvExpiryDelta) { log.debug("refreshing channel_update due to configuration changes") - self ! CMD_UPDATE_RELAY_FEE(ActorRef.noSender, fees.feeBase, fees.feeProportionalMillionths) + self ! CMD_UPDATE_RELAY_FEE(ActorRef.noSender, fees.feeBase, fees.feeProportionalMillionths, inboundFees_opt.map(_.feeBase), inboundFees_opt.map(_.feeProportionalMillionths)) } // we need to periodically re-send channel updates, otherwise channel will be considered stale and get pruned by network // we take into account the date of the last update so that we don't send superfluous updates when we restart the app @@ -825,7 +827,7 @@ class Channel(val nodeParams: NodeParams, val wallet: OnChainChannelFunder with log.info("announcing channelId={} on the network with shortChannelId={} for fundingTxIndex={}", d.channelId, localAnnSigs.shortChannelId, c.fundingTxIndex) // We generate a new channel_update because we can now use the scid of the announced funding transaction. val scidForChannelUpdate = Helpers.scidForChannelUpdate(Some(channelAnn), d.aliases.localAlias) - val channelUpdate = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate, d.commitments.params, d.channelUpdate.relayFees, Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = true) + val channelUpdate = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate, d.commitments.params, d.channelUpdate.relayFees, Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = true, d.channelUpdate.blip18InboundFees_opt) context.system.eventStream.publish(ShortChannelIdAssigned(self, d.channelId, Some(channelAnn), d.aliases, remoteNodeId)) // We use goto() instead of stay() because we want to fire transitions. goto(NORMAL) using d.copy(lastAnnouncement_opt = Some(channelAnn), channelUpdate = channelUpdate) storing() @@ -847,7 +849,7 @@ class Channel(val nodeParams: NodeParams, val wallet: OnChainChannelFunder with } case Event(c: CMD_UPDATE_RELAY_FEE, d: DATA_NORMAL) => - val channelUpdate1 = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate(d), d.commitments.params, Relayer.RelayFees(c.feeBase, c.feeProportionalMillionths), Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = true) + val channelUpdate1 = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate(d), d.commitments.params, Relayer.RelayFees(c.feeBase, c.feeProportionalMillionths), Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = true, InboundFees.fromOptions(c.inboundFeeBase_opt, c.inboundFeeProportionalMillionths_opt)) log.debug(s"updating relay fees: prev={} next={}", d.channelUpdate.toStringShort, channelUpdate1.toStringShort) val replyTo = if (c.replyTo == ActorRef.noSender) sender() else c.replyTo replyTo ! RES_SUCCESS(c, d.channelId) @@ -856,7 +858,7 @@ class Channel(val nodeParams: NodeParams, val wallet: OnChainChannelFunder with case Event(BroadcastChannelUpdate(reason), d: DATA_NORMAL) => val age = TimestampSecond.now() - d.channelUpdate.timestamp - val channelUpdate1 = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate(d), d.commitments.params, d.channelUpdate.relayFees, Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = true) + val channelUpdate1 = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate(d), d.commitments.params, d.channelUpdate.relayFees, Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = true, d.channelUpdate.blip18InboundFees_opt) reason match { case Reconnected if d.commitments.announceChannel && Announcements.areSame(channelUpdate1, d.channelUpdate) && age < REFRESH_CHANNEL_UPDATE_INTERVAL => // we already sent an identical channel_update not long ago (flapping protection in case we keep being disconnected/reconnected) @@ -1447,7 +1449,7 @@ class Channel(val nodeParams: NodeParams, val wallet: OnChainChannelFunder with // if we have pending unsigned htlcs, then we cancel them and generate an update with the disabled flag set, that will be returned to the sender in a temporary channel failure if (d.commitments.changes.localChanges.proposed.collectFirst { case add: UpdateAddHtlc => add }.isDefined) { log.debug("updating channel_update announcement (reason=disabled)") - val channelUpdate1 = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate(d), d.commitments.params, d.channelUpdate.relayFees, Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = false) + val channelUpdate1 = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate(d), d.commitments.params, d.channelUpdate.relayFees, Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = false, d.channelUpdate.blip18InboundFees_opt) // NB: the htlcs stay in the commitments.localChange, they will be cleaned up after reconnection d.commitments.changes.localChanges.proposed.collect { case add: UpdateAddHtlc => relayer ! RES_ADD_SETTLED(d.commitments.originChannels(add.id), add, HtlcResult.DisconnectedBeforeSigned(channelUpdate1)) @@ -2941,7 +2943,7 @@ class Channel(val nodeParams: NodeParams, val wallet: OnChainChannelFunder with log.debug("emitting channel down event") if (d.lastAnnouncement_opt.nonEmpty) { // We tell the rest of the network that this channel shouldn't be used anymore. - val disabledUpdate = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, Helpers.scidForChannelUpdate(d), d.commitments.params, d.channelUpdate.relayFees, Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = false) + val disabledUpdate = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, Helpers.scidForChannelUpdate(d), d.commitments.params, d.channelUpdate.relayFees, Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = false, d.channelUpdate.blip18InboundFees_opt) context.system.eventStream.publish(LocalChannelUpdate(self, d.channelId, d.aliases, remoteNodeId, d.lastAnnouncedCommitment_opt, disabledUpdate, d.commitments)) } val lcd = LocalChannelDown(self, d.channelId, d.commitments.all.flatMap(_.shortChannelId_opt), d.aliases, remoteNodeId) @@ -3134,7 +3136,7 @@ class Channel(val nodeParams: NodeParams, val wallet: OnChainChannelFunder with if (d.channelUpdate.channelFlags.isEnabled) { // if the channel isn't disabled we generate a new channel_update log.debug("updating channel_update announcement (reason=disabled)") - val channelUpdate1 = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate(d), d.commitments.params, d.channelUpdate.relayFees, Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = false) + val channelUpdate1 = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate(d), d.commitments.params, d.channelUpdate.relayFees, Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = false, d.channelUpdate.blip18InboundFees_opt) // then we update the state and replay the request self forward c // we use goto() to fire transitions @@ -3147,7 +3149,7 @@ class Channel(val nodeParams: NodeParams, val wallet: OnChainChannelFunder with } private def handleUpdateRelayFeeDisconnected(c: CMD_UPDATE_RELAY_FEE, d: DATA_NORMAL) = { - val channelUpdate1 = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate(d), d.commitments.params, Relayer.RelayFees(c.feeBase, c.feeProportionalMillionths), Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = false) + val channelUpdate1 = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate(d), d.commitments.params, Relayer.RelayFees(c.feeBase, c.feeProportionalMillionths), Helpers.maxHtlcAmount(nodeParams, d.commitments), enable = false, InboundFees.fromOptions(c.inboundFeeBase_opt, c.inboundFeeProportionalMillionths_opt)) log.debug(s"updating relay fees: prev={} next={}", d.channelUpdate.toStringShort, channelUpdate1.toStringShort) val replyTo = if (c.replyTo == ActorRef.noSender) sender() else c.replyTo replyTo ! RES_SUCCESS(c, d.channelId) diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/channel/fsm/CommonFundingHandlers.scala b/eclair-core/src/main/scala/fr/acinq/eclair/channel/fsm/CommonFundingHandlers.scala index 087a458e99..72e59ef82d 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/channel/fsm/CommonFundingHandlers.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/channel/fsm/CommonFundingHandlers.scala @@ -17,7 +17,6 @@ package fr.acinq.eclair.channel.fsm import akka.actor.typed.scaladsl.adapter.{TypedActorRefOps, actorRefAdapter} -import com.softwaremill.quicklens.ModifyPimp import fr.acinq.bitcoin.ScriptFlags import fr.acinq.bitcoin.scalacompat.{ByteVector32, Transaction, TxId} import fr.acinq.eclair.blockchain.bitcoind.ZmqWatcher._ @@ -139,8 +138,8 @@ trait CommonFundingHandlers extends CommonHandlers { // We create a channel_update early so that we can use it to send payments through this channel, but it won't be propagated to other nodes since the channel is not yet announced. val scidForChannelUpdate = Helpers.scidForChannelUpdate(channelAnnouncement_opt = None, aliases1.localAlias) log.info("using shortChannelId={} for initial channel_update", scidForChannelUpdate) - val relayFees = getRelayFees(nodeParams, remoteNodeId, commitments.announceChannel) - val initialChannelUpdate = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate, commitments.params, relayFees, Helpers.maxHtlcAmount(nodeParams, commitments), enable = true) + val (relayFees, inboundFees_opt) = getRelayFees(nodeParams, remoteNodeId, commitments.announceChannel) + val initialChannelUpdate = Announcements.makeChannelUpdate(nodeParams, remoteNodeId, scidForChannelUpdate, commitments.params, relayFees, Helpers.maxHtlcAmount(nodeParams, commitments), enable = true, inboundFees_opt) // We need to periodically re-send channel updates, otherwise channel will be considered stale and get pruned by network. context.system.scheduler.scheduleWithFixedDelay(initialDelay = REFRESH_CHANNEL_UPDATE_INTERVAL, delay = REFRESH_CHANNEL_UPDATE_INTERVAL, receiver = self, message = BroadcastChannelUpdate(PeriodicRefresh)) val commitments1 = commitments.copy( diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/db/Databases.scala b/eclair-core/src/main/scala/fr/acinq/eclair/db/Databases.scala index c7f929f572..d123adea14 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/db/Databases.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/db/Databases.scala @@ -46,6 +46,7 @@ trait Databases { def offers: OffersDb def pendingCommands: PendingCommandsDb def liquidity: LiquidityDb + def inboundFees: InboundFeesDb //@formatter:on } @@ -69,6 +70,7 @@ object Databases extends Logging { payments: SqlitePaymentsDb, offers: SqliteOffersDb, pendingCommands: SqlitePendingCommandsDb, + inboundFees: SqliteInboundFeesDb, private val backupConnection: Connection) extends Databases with FileBackup { override def backup(backupFile: File): Unit = SqliteUtils.using(backupConnection.createStatement()) { statement => { @@ -78,7 +80,7 @@ object Databases extends Logging { } object SqliteDatabases { - def apply(auditJdbc: Connection, networkJdbc: Connection, eclairJdbc: Connection, jdbcUrlFile_opt: Option[File]): SqliteDatabases = { + def apply(auditJdbc: Connection, networkJdbc: Connection, eclairJdbc: Connection, inboundFeesJdbc: Connection, jdbcUrlFile_opt: Option[File]): SqliteDatabases = { jdbcUrlFile_opt.foreach(checkIfDatabaseUrlIsUnchanged("sqlite", _)) SqliteDatabases( network = new SqliteNetworkDb(networkJdbc), @@ -89,6 +91,7 @@ object Databases extends Logging { payments = new SqlitePaymentsDb(eclairJdbc), offers = new SqliteOffersDb(eclairJdbc), pendingCommands = new SqlitePendingCommandsDb(eclairJdbc), + inboundFees = new SqliteInboundFeesDb(inboundFeesJdbc), backupConnection = eclairJdbc ) } @@ -102,6 +105,7 @@ object Databases extends Logging { payments: PgPaymentsDb, offers: PgOffersDb, pendingCommands: PgPendingCommandsDb, + inboundFees: PgInboundFeesDb, dataSource: HikariDataSource, lock: PgLock) extends Databases with ExclusiveLock { override def obtainExclusiveLock(): Unit = lock.obtainExclusiveLock(dataSource) @@ -163,6 +167,7 @@ object Databases extends Logging { payments = new PgPaymentsDb, offers = new PgOffersDb, pendingCommands = new PgPendingCommandsDb, + inboundFees = new PgInboundFeesDb, dataSource = ds, lock = lock) @@ -310,6 +315,7 @@ object Databases extends Logging { eclairJdbc = SqliteUtils.openSqliteFile(dbdir, "eclair.sqlite", exclusiveLock = true, journalMode = "wal", syncFlag = "full"), // there should only be one process writing to this file networkJdbc = SqliteUtils.openSqliteFile(dbdir, "network.sqlite", exclusiveLock = false, journalMode = "wal", syncFlag = "normal"), // we don't need strong durability guarantees on the network db auditJdbc = SqliteUtils.openSqliteFile(dbdir, "audit.sqlite", exclusiveLock = false, journalMode = "wal", syncFlag = "full"), + inboundFeesJdbc = SqliteUtils.openSqliteFile(dbdir, "inboundfees.sqlite", exclusiveLock = false, journalMode = "wal", syncFlag = "full"), jdbcUrlFile_opt = jdbcUrlFile_opt ) } diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/db/DualDatabases.scala b/eclair-core/src/main/scala/fr/acinq/eclair/db/DualDatabases.scala index ee7ce61966..552af8ba7d 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/db/DualDatabases.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/db/DualDatabases.scala @@ -10,7 +10,7 @@ import fr.acinq.eclair.db.DbEventHandler.ChannelEvent import fr.acinq.eclair.db.DualDatabases.runAsync import fr.acinq.eclair.payment._ import fr.acinq.eclair.payment.relay.OnTheFlyFunding -import fr.acinq.eclair.payment.relay.Relayer.RelayFees +import fr.acinq.eclair.payment.relay.Relayer.{InboundFees, RelayFees} import fr.acinq.eclair.router.Router import fr.acinq.eclair.wire.protocol._ import fr.acinq.eclair.{CltvExpiry, Features, InitFeature, MilliSatoshi, Paginated, RealShortChannelId, ShortChannelId, TimestampMilli, TimestampSecond} @@ -39,6 +39,7 @@ case class DualDatabases(primary: Databases, secondary: Databases) extends Datab override val offers: OffersDb = DualOffersDb(primary.offers, secondary.offers) override val pendingCommands: PendingCommandsDb = DualPendingCommandsDb(primary.pendingCommands, secondary.pendingCommands) override val liquidity: LiquidityDb = DualLiquidityDb(primary.liquidity, secondary.liquidity) + override val inboundFees: InboundFeesDb = DualInboundFeesDb(primary.inboundFees, secondary.inboundFees) /** if one of the database supports file backup, we use it */ override def backup(backupFile: File): Unit = (primary, secondary) match { @@ -521,3 +522,18 @@ case class DualLiquidityDb(primary: LiquidityDb, secondary: LiquidityDb) extends } } + + +case class DualInboundFeesDb(primary: InboundFeesDb, secondary: InboundFeesDb) extends InboundFeesDb { + private implicit val ec: ExecutionContext = ExecutionContext.fromExecutor(Executors.newSingleThreadExecutor(new ThreadFactoryBuilder().setNameFormat("db-liquidity").build())) + + override def addOrUpdateInboundFees(nodeId: PublicKey, fees: InboundFees): Unit = { + runAsync(secondary.addOrUpdateInboundFees(nodeId, fees)) + primary.addOrUpdateInboundFees(nodeId, fees) + } + + override def getInboundFees(nodeId: PublicKey): Option[InboundFees] = { + runAsync(secondary.getInboundFees(nodeId)) + primary.getInboundFees(nodeId) + } +} diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/db/InboundFeesDb.scala b/eclair-core/src/main/scala/fr/acinq/eclair/db/InboundFeesDb.scala new file mode 100644 index 0000000000..e97d49f7d3 --- /dev/null +++ b/eclair-core/src/main/scala/fr/acinq/eclair/db/InboundFeesDb.scala @@ -0,0 +1,13 @@ +package fr.acinq.eclair.db + +import fr.acinq.bitcoin.scalacompat.Crypto.PublicKey +import fr.acinq.eclair.payment.relay.Relayer.InboundFees + +/** The PeersDb contains information about our direct peers, with whom we have or had channels. */ +trait InboundFeesDb { + + def addOrUpdateInboundFees(nodeId: PublicKey, fees: InboundFees): Unit + + def getInboundFees(nodeId: PublicKey): Option[InboundFees] + +} diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/db/pg/PgInboundFeesDb.scala b/eclair-core/src/main/scala/fr/acinq/eclair/db/pg/PgInboundFeesDb.scala new file mode 100644 index 0000000000..bcbef5111f --- /dev/null +++ b/eclair-core/src/main/scala/fr/acinq/eclair/db/pg/PgInboundFeesDb.scala @@ -0,0 +1,70 @@ +package fr.acinq.eclair.db.pg + +import fr.acinq.bitcoin.scalacompat.Crypto +import fr.acinq.eclair.MilliSatoshi +import fr.acinq.eclair.db.InboundFeesDb +import fr.acinq.eclair.db.Monitoring.Metrics.withMetrics +import fr.acinq.eclair.db.Monitoring.Tags.DbBackends +import fr.acinq.eclair.db.pg.PgUtils.PgLock +import fr.acinq.eclair.db.pg.PgUtils.PgLock.NoLock.withLock +import fr.acinq.eclair.payment.relay.Relayer.InboundFees +import grizzled.slf4j.Logging + +import javax.sql.DataSource + +object PgInboundFeesDb { + val DB_NAME = "inboundfees" + val CURRENT_VERSION = 1 +} + +class PgInboundFeesDb(implicit ds: DataSource, lock: PgLock) extends InboundFeesDb with Logging { + + import PgUtils._ + import ExtendedResultSet._ + import PgInboundFeesDb._ + + inTransaction { pg => + using(pg.createStatement()) { statement => + getVersion(statement, DB_NAME) match { + case None => + statement.executeUpdate("CREATE SCHEMA inboundfees") + statement.executeUpdate("CREATE TABLE inboundfees.inbound_fees (node_id TEXT NOT NULL PRIMARY KEY, fee_base_msat BIGINT NOT NULL, fee_proportional_millionths BIGINT NOT NULL)") + case Some(CURRENT_VERSION) => () // table is up-to-date, nothing to do + case Some(unknownVersion) => throw new RuntimeException(s"Unknown version of DB $DB_NAME found, version=$unknownVersion") + } + setVersion(statement, DB_NAME, CURRENT_VERSION) + } + } + + override def addOrUpdateInboundFees(nodeId: Crypto.PublicKey, fees: InboundFees): Unit = withMetrics("peers/add-or-update-relay-fees", DbBackends.Postgres) { + withLock { pg => + using(pg.prepareStatement( + """ + INSERT INTO inboundfees.inbound_fees (node_id, fee_base_msat, fee_proportional_millionths) + VALUES (?, ?, ?) + ON CONFLICT (node_id) + DO UPDATE SET fee_base_msat = EXCLUDED.fee_base_msat, fee_proportional_millionths = EXCLUDED.fee_proportional_millionths + """)) { statement => + statement.setString(1, nodeId.value.toHex) + statement.setLong(2, fees.feeBase.toLong) + statement.setLong(3, fees.feeProportionalMillionths) + statement.executeUpdate() + } + } + } + + override def getInboundFees(nodeId: Crypto.PublicKey): Option[InboundFees] = withMetrics("peers/get-relay-fees", DbBackends.Postgres) { + withLock { pg => + using(pg.prepareStatement("SELECT fee_base_msat, fee_proportional_millionths FROM inboundfees.inbound_fees WHERE node_id=?")) { statement => + statement.setString(1, nodeId.value.toHex) + statement.executeQuery() + .headOption + .map(rs => + InboundFees(MilliSatoshi(rs.getLong("fee_base_msat")), rs.getLong("fee_proportional_millionths")) + ) + } + } + } + +} + diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/db/sqlite/SqliteInboundFeesDb.scala b/eclair-core/src/main/scala/fr/acinq/eclair/db/sqlite/SqliteInboundFeesDb.scala new file mode 100644 index 0000000000..90c12e8c75 --- /dev/null +++ b/eclair-core/src/main/scala/fr/acinq/eclair/db/sqlite/SqliteInboundFeesDb.scala @@ -0,0 +1,61 @@ +package fr.acinq.eclair.db.sqlite + +import fr.acinq.bitcoin.scalacompat.Crypto +import fr.acinq.eclair.MilliSatoshi +import fr.acinq.eclair.db.InboundFeesDb +import fr.acinq.eclair.db.sqlite.SqliteUtils.{getVersion, setVersion, using} +import fr.acinq.eclair.payment.relay.Relayer +import fr.acinq.eclair.payment.relay.Relayer.{InboundFees, RelayFees} +import grizzled.slf4j.Logging + +import java.sql.Connection + +object SqliteInboundFeesDb { + val DB_NAME = "inboundfees" + val CURRENT_VERSION = 1 +} + +class SqliteInboundFeesDb(val sqlite: Connection) extends InboundFeesDb with Logging { + + import SqliteInboundFeesDb._ + import SqliteUtils.ExtendedResultSet._ + + using(sqlite.createStatement(), inTransaction = true) { statement => + getVersion(statement, DB_NAME) match { + case None => + statement.executeUpdate("CREATE TABLE inbound_fees (node_id BLOB NOT NULL PRIMARY KEY, fee_base_msat INTEGER NOT NULL, fee_proportional_millionths INTEGER NOT NULL)") + case Some(CURRENT_VERSION) => () // table is up-to-date, nothing to do + case Some(unknownVersion) => throw new RuntimeException(s"Unknown version of DB $DB_NAME found, version=$unknownVersion") + } + setVersion(statement, DB_NAME, CURRENT_VERSION) + } + + override def addOrUpdateInboundFees(nodeId: Crypto.PublicKey, fees: Relayer.InboundFees): Unit = { + using(sqlite.prepareStatement("UPDATE inbound_fees SET fee_base_msat=?, fee_proportional_millionths=? WHERE node_id=?")) { update => + update.setLong(1, fees.feeBase.toLong) + update.setLong(2, fees.feeProportionalMillionths) + update.setBytes(3, nodeId.value.toArray) + if (update.executeUpdate() == 0) { + using(sqlite.prepareStatement("INSERT INTO inbound_fees VALUES (?, ?, ?)")) { statement => + statement.setBytes(1, nodeId.value.toArray) + statement.setLong(2, fees.feeBase.toLong) + statement.setLong(3, fees.feeProportionalMillionths) + statement.executeUpdate() + } + } + } + } + + override def getInboundFees(nodeId: Crypto.PublicKey): Option[Relayer.InboundFees] = { + using(sqlite.prepareStatement("SELECT fee_base_msat, fee_proportional_millionths FROM inbound_fees WHERE node_id=?")) { statement => + statement.setBytes(1, nodeId.value.toArray) + statement.executeQuery() + .headOption + .map(rs => + InboundFees(MilliSatoshi(rs.getLong("fee_base_msat")), rs.getLong("fee_proportional_millionths")) + ) + } + + } + +} diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/package.scala b/eclair-core/src/main/scala/fr/acinq/eclair/package.scala index 810a5527f0..ac41e02ffe 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/package.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/package.scala @@ -20,7 +20,7 @@ import fr.acinq.bitcoin.scalacompat.Crypto.PrivateKey import fr.acinq.bitcoin.scalacompat.KotlinUtils._ import fr.acinq.bitcoin.scalacompat._ import fr.acinq.eclair.crypto.StrongRandom -import fr.acinq.eclair.payment.relay.Relayer.RelayFees +import fr.acinq.eclair.payment.relay.Relayer.{InboundFees, RelayFees} import scodec.Attempt import scodec.bits.{BitVector, ByteVector} @@ -71,6 +71,19 @@ package object eclair { def nodeFee(relayFees: RelayFees, paymentAmount: MilliSatoshi): MilliSatoshi = nodeFee(relayFees.feeBase, relayFees.feeProportionalMillionths, paymentAmount) + def totalFee(amount: MilliSatoshi, baseFee: MilliSatoshi, proportionalFee: Long, inboundBaseFee_opt: Option[MilliSatoshi], inboundProportionalFee_opt: Option[Long]): MilliSatoshi = { + val outFee = nodeFee(baseFee, proportionalFee, amount) + val inFee = (for { + inboundBaseFee <- inboundBaseFee_opt + inboundProportionalFee <- inboundProportionalFee_opt + } yield nodeFee(inboundBaseFee, inboundProportionalFee, amount + outFee)).getOrElse(0 msat) + val totalFee = outFee + inFee + if (totalFee.toLong < 0) 0 msat else totalFee + } + + def totalFee(amount: MilliSatoshi, relayFees: RelayFees, inboundFees_opt: Option[InboundFees]): MilliSatoshi = + totalFee(amount, relayFees.feeBase, relayFees.feeProportionalMillionths, inboundFees_opt.map(_.feeBase), inboundFees_opt.map(_.feeProportionalMillionths)) + /** * @param baseFee fixed fee * @param proportionalFee proportional fee (millionths) diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/ChannelRelay.scala b/eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/ChannelRelay.scala index ca459e92d6..45b2a16450 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/ChannelRelay.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/ChannelRelay.scala @@ -34,12 +34,12 @@ import fr.acinq.eclair.payment.{ChannelPaymentRelayed, IncomingPaymentPacket} import fr.acinq.eclair.wire.protocol.FailureMessageCodecs.createBadOnionFailure import fr.acinq.eclair.wire.protocol.PaymentOnion.IntermediatePayload import fr.acinq.eclair.wire.protocol._ -import fr.acinq.eclair.{EncodedNodeId, Features, InitFeature, Logs, NodeParams, TimestampMilli, TimestampSecond, channel, nodeFee} +import fr.acinq.eclair.{EncodedNodeId, Features, InitFeature, Logs, NodeParams, TimestampMilli, TimestampSecond, channel, totalFee} import java.util.UUID import java.util.concurrent.TimeUnit import scala.concurrent.duration.DurationLong -import scala.util.Random +import scala.util.{Random, Try, Success, Failure} object ChannelRelay { @@ -50,6 +50,8 @@ object ChannelRelay { private case class WrappedForwardFailure(failure: Register.ForwardFailure[CMD_ADD_HTLC]) extends Command private case class WrappedAddResponse(res: CommandResponse[CMD_ADD_HTLC]) extends Command private case class WrappedOnTheFlyFundingResponse(result: Peer.ProposeOnTheFlyFundingResponse) extends Command + private case class WrappedChannelInfo(result: RES_GET_CHANNEL_INFO) extends Command + private case class WrappedChannelInfoFailure(failure: Register.ForwardFailure[CMD_GET_CHANNEL_INFO]) extends Command // @formatter:on // @formatter:off @@ -126,6 +128,8 @@ class ChannelRelay private(nodeParams: NodeParams, private val addResponseAdapter = context.messageAdapter[CommandResponse[CMD_ADD_HTLC]](WrappedAddResponse) private val forwardNodeIdFailureAdapter = context.messageAdapter[Register.ForwardNodeIdFailure[Peer.ProposeOnTheFlyFunding]](_ => WrappedOnTheFlyFundingResponse(Peer.ProposeOnTheFlyFundingResponse.NotAvailable("peer not found"))) private val onTheFlyFundingResponseAdapter = context.messageAdapter[Peer.ProposeOnTheFlyFundingResponse](WrappedOnTheFlyFundingResponse) + private val channelInfoAdapter = context.messageAdapter[RES_GET_CHANNEL_INFO](WrappedChannelInfo) + private val channelInfoFailureAdapter = context.messageAdapter[Register.ForwardFailure[CMD_GET_CHANNEL_INFO]](WrappedChannelInfoFailure) private val nextPathKey_opt = r.payload match { case payload: IntermediatePayload.ChannelRelay.Blinded => Some(payload.nextPathKey) @@ -173,29 +177,52 @@ class ChannelRelay private(nodeParams: NodeParams, } } - def relay(remoteFeatures_opt: Option[Features[InitFeature]], previousFailures: Seq[PreviouslyTried]): Behavior[Command] = { + def relay(remoteFeatures_opt: Option[Features[InitFeature]], previousFailures: Seq[PreviouslyTried], inboundChannelUpdate_opt: Option[Either[Unit, ChannelUpdate]] = None): Behavior[Command] = { Behaviors.receiveMessagePartial { case DoRelay => - if (previousFailures.isEmpty) { - val nextNodeId_opt = channels.headOption.map(_._2.nextNodeId) - context.log.info("relaying htlc #{} from channelId={} to requestedShortChannelId={} nextNode={}", r.add.id, r.add.channelId, requestedShortChannelId_opt, nextNodeId_opt.getOrElse("")) + if (nodeParams.routerConf.blip18InboundFees && inboundChannelUpdate_opt.isEmpty) { + register ! Register.Forward(channelInfoFailureAdapter, r.add.channelId, CMD_GET_CHANNEL_INFO(channelInfoAdapter)) + waitForInboundChannelInfo(remoteFeatures_opt, previousFailures) + } else { + if (previousFailures.isEmpty) { + val nextNodeId_opt = channels.headOption.map(_._2.nextNodeId) + context.log.info("relaying htlc #{} from channelId={} to requestedShortChannelId={} nextNode={}", r.add.id, r.add.channelId, requestedShortChannelId_opt, nextNodeId_opt.getOrElse("")) + } + context.log.debug("attempting relay previousAttempts={}", previousFailures.size) + handleRelay(remoteFeatures_opt, previousFailures, inboundChannelUpdate_opt.flatMap(_.toOption)) match { + case RelayFailure(cmdFail) => + Metrics.recordPaymentRelayFailed(Tags.FailureType(cmdFail), Tags.RelayType.Channel) + context.log.info("rejecting htlc reason={}", cmdFail.reason) + safeSendAndStop(r.add.channelId, cmdFail) + case RelayNeedsFunding(nextNodeId, cmdFail) => + // Note that in the channel relay case, we don't have any outgoing onion shared secrets. + val cmd = Peer.ProposeOnTheFlyFunding(onTheFlyFundingResponseAdapter, r.amountToForward, r.add.paymentHash, r.outgoingCltv, r.nextPacket, Nil, nextPathKey_opt, upstream) + register ! Register.ForwardNodeId(forwardNodeIdFailureAdapter, nextNodeId, cmd) + waitForOnTheFlyFundingResponse(cmdFail) + case RelaySuccess(selectedChannelId, cmdAdd) => + context.log.info("forwarding htlc #{} from channelId={} to channelId={}", r.add.id, r.add.channelId, selectedChannelId) + register ! Register.Forward(forwardFailureAdapter, selectedChannelId, cmdAdd) + waitForAddResponse(selectedChannelId, remoteFeatures_opt, previousFailures) + } } - context.log.debug("attempting relay previousAttempts={}", previousFailures.size) - handleRelay(remoteFeatures_opt, previousFailures) match { - case RelayFailure(cmdFail) => - Metrics.recordPaymentRelayFailed(Tags.FailureType(cmdFail), Tags.RelayType.Channel) - context.log.info("rejecting htlc reason={}", cmdFail.reason) - safeSendAndStop(r.add.channelId, cmdFail) - case RelayNeedsFunding(nextNodeId, cmdFail) => - // Note that in the channel relay case, we don't have any outgoing onion shared secrets. - val cmd = Peer.ProposeOnTheFlyFunding(onTheFlyFundingResponseAdapter, r.amountToForward, r.add.paymentHash, r.outgoingCltv, r.nextPacket, Nil, nextPathKey_opt, upstream) - register ! Register.ForwardNodeId(forwardNodeIdFailureAdapter, nextNodeId, cmd) - waitForOnTheFlyFundingResponse(cmdFail) - case RelaySuccess(selectedChannelId, cmdAdd) => - context.log.info("forwarding htlc #{} from channelId={} to channelId={}", r.add.id, r.add.channelId, selectedChannelId) - register ! Register.Forward(forwardFailureAdapter, selectedChannelId, cmdAdd) - waitForAddResponse(selectedChannelId, remoteFeatures_opt, previousFailures) + } + } + + private def waitForInboundChannelInfo(remoteFeatures_opt: Option[Features[InitFeature]], previousFailures: Seq[PreviouslyTried]): Behavior[Command] = { + Behaviors.receiveMessagePartial { + case WrappedChannelInfo(res) => + val inboundChannelUpdate_opt = res.data match { + case d: DATA_NORMAL => Some(Right(d.channelUpdate)) + case _ => + context.log.error("Cannot get channel info for {}: invalid channel state {}", res.channelId, res.state) + Some(Left(())) } + context.self ! DoRelay + relay(remoteFeatures_opt, previousFailures, inboundChannelUpdate_opt) + case WrappedChannelInfoFailure(failure) => + context.log.error("Cannot get channel info for {}", failure.fwd.channelId) + context.self ! DoRelay + relay(remoteFeatures_opt, previousFailures, Some(Left(()))) } } @@ -282,10 +309,10 @@ class ChannelRelay private(nodeParams: NodeParams, * - a CMD_FAIL_HTLC to be sent back upstream * - a CMD_ADD_HTLC to propagate downstream */ - private def handleRelay(remoteFeatures_opt: Option[Features[InitFeature]], previousFailures: Seq[PreviouslyTried]): RelayResult = { + private def handleRelay(remoteFeatures_opt: Option[Features[InitFeature]], previousFailures: Seq[PreviouslyTried], inboundChannelUpdate_opt: Option[ChannelUpdate]): RelayResult = { val alreadyTried = previousFailures.map(_.channelId) - selectPreferredChannel(alreadyTried) match { - case Some(outgoingChannel) => relayOrFail(outgoingChannel) + selectPreferredChannel(alreadyTried, inboundChannelUpdate_opt) match { + case Some(outgoingChannel) => relayOrFail(outgoingChannel, inboundChannelUpdate_opt) case None => // No more channels to try. val cmdFail = if (previousFailures.nonEmpty) { @@ -300,7 +327,7 @@ class ChannelRelay private(nodeParams: NodeParams, CMD_FAIL_HTLC(r.add.id, FailureReason.LocalFailure(UnknownNextPeer()), commit = true) } walletNodeId_opt match { - case Some(walletNodeId) if shouldAttemptOnTheFlyFunding(remoteFeatures_opt, previousFailures) => RelayNeedsFunding(walletNodeId, cmdFail) + case Some(walletNodeId) if shouldAttemptOnTheFlyFunding(remoteFeatures_opt, previousFailures, inboundChannelUpdate_opt) => RelayNeedsFunding(walletNodeId, cmdFail) case _ => RelayFailure(cmdFail) } } @@ -312,7 +339,7 @@ class ChannelRelay private(nodeParams: NodeParams, * * If no suitable channel is found we default to the originally requested channel. */ - private def selectPreferredChannel(alreadyTried: Seq[ByteVector32]): Option[OutgoingChannel] = { + private def selectPreferredChannel(alreadyTried: Seq[ByteVector32], inboundChannelUpdate_opt: Option[ChannelUpdate]): Option[OutgoingChannel] = { context.log.debug("selecting next channel with requestedShortChannelId={}", requestedShortChannelId_opt) // we filter out channels that we have already tried val candidateChannels: Map[ByteVector32, OutgoingChannel] = channels -- alreadyTried @@ -320,7 +347,7 @@ class ChannelRelay private(nodeParams: NodeParams, candidateChannels .values .map { channel => - val relayResult = relayOrFail(channel) + val relayResult = relayOrFail(channel, inboundChannelUpdate_opt) context.log.debug("candidate channel: channelId={} availableForSend={} capacity={} channelUpdate={} result={}", channel.channelId, channel.commitments.availableBalanceForSend, @@ -369,9 +396,9 @@ class ChannelRelay private(nodeParams: NodeParams, * channel, because some parameters don't match with our settings for that channel. In that case we directly fail the * htlc. */ - private def relayOrFail(outgoingChannel: OutgoingChannelParams): RelayResult = { + private def relayOrFail(outgoingChannel: OutgoingChannelParams, inboundChannelUpdate_opt: Option[ChannelUpdate]): RelayResult = { val update = outgoingChannel.channelUpdate - validateRelayParams(outgoingChannel) match { + validateRelayParams(outgoingChannel, inboundChannelUpdate_opt) match { case Some(fail) => RelayFailure(fail) case None if !update.channelFlags.isEnabled => @@ -382,14 +409,15 @@ class ChannelRelay private(nodeParams: NodeParams, } } - private def validateRelayParams(outgoingChannel: OutgoingChannelParams): Option[CMD_FAIL_HTLC] = { + private def validateRelayParams(outgoingChannel: OutgoingChannelParams, inboundChannelUpdate_opt: Option[ChannelUpdate]): Option[CMD_FAIL_HTLC] = { val update = outgoingChannel.channelUpdate // If our current channel update was recently created, we accept payments that used our previous channel update. val allowPreviousUpdate = TimestampSecond.now() - update.timestamp <= nodeParams.relayParams.enforcementDelay val prevUpdate_opt = if (allowPreviousUpdate) outgoingChannel.prevChannelUpdate else None val htlcMinimumOk = update.htlcMinimumMsat <= r.amountToForward || prevUpdate_opt.exists(_.htlcMinimumMsat <= r.amountToForward) val expiryDeltaOk = update.cltvExpiryDelta <= r.expiryDelta || prevUpdate_opt.exists(_.cltvExpiryDelta <= r.expiryDelta) - val feesOk = nodeFee(update.relayFees, r.amountToForward) <= r.relayFeeMsat || prevUpdate_opt.exists(u => nodeFee(u.relayFees, r.amountToForward) <= r.relayFeeMsat) + val feesOk = totalFee(r.amountToForward, update.relayFees, inboundChannelUpdate_opt.flatMap(_.blip18InboundFees_opt)) <= r.relayFeeMsat || + prevUpdate_opt.exists(u => totalFee(r.amountToForward, u.relayFees, inboundChannelUpdate_opt.flatMap(_.blip18InboundFees_opt)) <= r.relayFeeMsat) if (!htlcMinimumOk) { Some(CMD_FAIL_HTLC(r.add.id, FailureReason.LocalFailure(AmountBelowMinimum(r.amountToForward, Some(update))), commit = true)) } else if (!expiryDeltaOk) { @@ -402,7 +430,7 @@ class ChannelRelay private(nodeParams: NodeParams, } /** If we fail to relay a payment, we may want to attempt on-the-fly funding. */ - private def shouldAttemptOnTheFlyFunding(remoteFeatures_opt: Option[Features[InitFeature]], previousFailures: Seq[PreviouslyTried]): Boolean = { + private def shouldAttemptOnTheFlyFunding(remoteFeatures_opt: Option[Features[InitFeature]], previousFailures: Seq[PreviouslyTried], inboundChannelUpdate_opt: Option[ChannelUpdate]): Boolean = { val featureOk = Features.canUseFeature(nodeParams.features.initFeatures(), remoteFeatures_opt.getOrElse(Features.empty), Features.OnTheFlyFunding) // If we have a channel with the next node, we only want to perform on-the-fly funding for liquidity issues. val liquidityIssue = previousFailures.forall { @@ -411,7 +439,7 @@ class ChannelRelay private(nodeParams: NodeParams, } // If we have a channel with the next peer, but we skipped it because the sender is using invalid relay parameters, // we don't want to perform on-the-fly funding: the sender should send a valid payment first. - val relayParamsOk = channels.values.forall(c => validateRelayParams(c).isEmpty) + val relayParamsOk = channels.values.forall(c => validateRelayParams(c, inboundChannelUpdate_opt).isEmpty) featureOk && liquidityIssue && relayParamsOk } diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/Relayer.scala b/eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/Relayer.scala index ba594d8f17..4d7762bf2b 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/Relayer.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/Relayer.scala @@ -29,6 +29,7 @@ import fr.acinq.eclair.channel._ import fr.acinq.eclair.db.PendingCommandsDb import fr.acinq.eclair.payment._ import fr.acinq.eclair.wire.protocol._ +import fr.acinq.eclair._ import fr.acinq.eclair.{CltvExpiryDelta, Logs, MilliSatoshi, NodeParams, RealShortChannelId} import grizzled.slf4j.Logging @@ -141,6 +142,14 @@ object Relayer extends Logging { def apply(feeBaseInt32: Int, feeProportionalMillionthsInt32: Int): InboundFees = { InboundFees(MilliSatoshi(feeBaseInt32), feeProportionalMillionthsInt32) } + + def fromOptions(inboundFeeBase_opt: Option[MilliSatoshi], inboundFeeProportionalMillionths_opt: Option[Long]): Option[InboundFees] = { + if (inboundFeeBase_opt.isEmpty && inboundFeeProportionalMillionths_opt.isEmpty) { + None + } else { + Some(InboundFees(inboundFeeBase_opt.getOrElse(0.msat), inboundFeeProportionalMillionths_opt.getOrElse(0L))) + } + } } case class AsyncPaymentsParams(holdTimeoutBlocks: Int, cancelSafetyBeforeTimeout: CltvExpiryDelta) diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/payment/send/BlindedPathsResolver.scala b/eclair-core/src/main/scala/fr/acinq/eclair/payment/send/BlindedPathsResolver.scala index df284bf46f..14b6add3c0 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/payment/send/BlindedPathsResolver.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/payment/send/BlindedPathsResolver.scala @@ -161,7 +161,7 @@ private class BlindedPathsResolver(nodeParams: NodeParams, resolved: Seq[ResolvedPath]): Behavior[Command] = { // Note that we default to private fees if we don't have a channel yet with that node. // The announceChannel parameter is ignored if we already have a channel. - val relayFees = getRelayFees(nodeParams, nextNodeId.publicKey, announceChannel = false) + val (relayFees, inboundFees_opt) = getRelayFees(nodeParams, nextNodeId.publicKey, announceChannel = false) val shouldRelay = paymentRelayData.paymentRelay.feeBase >= relayFees.feeBase && paymentRelayData.paymentRelay.feeProportionalMillionths >= relayFees.feeProportionalMillionths && paymentRelayData.paymentRelay.cltvExpiryDelta >= nodeParams.channelConf.expiryDelta diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/router/Announcements.scala b/eclair-core/src/main/scala/fr/acinq/eclair/router/Announcements.scala index 80aee61d55..9b78140391 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/router/Announcements.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/router/Announcements.scala @@ -19,7 +19,8 @@ package fr.acinq.eclair.router import fr.acinq.bitcoin.scalacompat.Crypto.{PrivateKey, PublicKey, sha256, verifySignature} import fr.acinq.bitcoin.scalacompat.{BlockHash, ByteVector64, Crypto, LexicographicalOrdering} import fr.acinq.eclair.channel.ChannelParams -import fr.acinq.eclair.payment.relay.Relayer.RelayFees +import fr.acinq.eclair.payment.relay.Relayer.{InboundFees, RelayFees} +import fr.acinq.eclair.wire.protocol.ChannelUpdateTlv.Blip18InboundFee import fr.acinq.eclair.wire.protocol._ import fr.acinq.eclair.{CltvExpiryDelta, Feature, Features, MilliSatoshi, NodeFeature, NodeParams, RealShortChannelId, ShortChannelId, TimestampSecond, TimestampSecondLong, serializationResult} import scodec.bits.ByteVector @@ -122,14 +123,15 @@ object Announcements { u1.htlcMinimumMsat == u2.htlcMinimumMsat && u1.htlcMaximumMsat == u2.htlcMaximumMsat - def makeChannelUpdate(nodeParams: NodeParams, remoteNodeId: PublicKey, scid: ShortChannelId, params: ChannelParams, relayFees: RelayFees, maxHtlcAmount: MilliSatoshi, enable: Boolean): ChannelUpdate = { - makeChannelUpdate(nodeParams.chainHash, nodeParams.privateKey, remoteNodeId, scid, nodeParams.channelConf.expiryDelta, params.remoteParams.htlcMinimum, relayFees.feeBase, relayFees.feeProportionalMillionths, maxHtlcAmount, isPrivate = !params.announceChannel, enable) + def makeChannelUpdate(nodeParams: NodeParams, remoteNodeId: PublicKey, scid: ShortChannelId, params: ChannelParams, relayFees: RelayFees, maxHtlcAmount: MilliSatoshi, enable: Boolean, inboundFees_opt: Option[InboundFees]): ChannelUpdate = { + makeChannelUpdate(nodeParams.chainHash, nodeParams.privateKey, remoteNodeId, scid, nodeParams.channelConf.expiryDelta, params.remoteParams.htlcMinimum, relayFees.feeBase, relayFees.feeProportionalMillionths, maxHtlcAmount, isPrivate = !params.announceChannel, enable, inboundFees_opt = inboundFees_opt) } - def makeChannelUpdate(chainHash: BlockHash, nodeSecret: PrivateKey, remoteNodeId: PublicKey, shortChannelId: ShortChannelId, cltvExpiryDelta: CltvExpiryDelta, htlcMinimumMsat: MilliSatoshi, feeBaseMsat: MilliSatoshi, feeProportionalMillionths: Long, htlcMaximumMsat: MilliSatoshi, isPrivate: Boolean = false, enable: Boolean = true, timestamp: TimestampSecond = TimestampSecond.now()): ChannelUpdate = { + def makeChannelUpdate(chainHash: BlockHash, nodeSecret: PrivateKey, remoteNodeId: PublicKey, shortChannelId: ShortChannelId, cltvExpiryDelta: CltvExpiryDelta, htlcMinimumMsat: MilliSatoshi, feeBaseMsat: MilliSatoshi, feeProportionalMillionths: Long, htlcMaximumMsat: MilliSatoshi, isPrivate: Boolean = false, enable: Boolean = true, timestamp: TimestampSecond = TimestampSecond.now(), inboundFees_opt: Option[InboundFees] = None): ChannelUpdate = { val messageFlags = ChannelUpdate.MessageFlags(isPrivate) val channelFlags = ChannelUpdate.ChannelFlags(isNode1 = isNode1(nodeSecret.publicKey, remoteNodeId), isEnabled = enable) - val witness = channelUpdateWitnessEncode(chainHash, shortChannelId, timestamp, messageFlags, channelFlags, cltvExpiryDelta, htlcMinimumMsat, feeBaseMsat, feeProportionalMillionths, htlcMaximumMsat, TlvStream.empty) + val tlvStream = inboundFees_opt.map(fees => TlvStream[ChannelUpdateTlv](Blip18InboundFee(fees))).getOrElse(TlvStream.empty) + val witness = channelUpdateWitnessEncode(chainHash, shortChannelId, timestamp, messageFlags, channelFlags, cltvExpiryDelta, htlcMinimumMsat, feeBaseMsat, feeProportionalMillionths, htlcMaximumMsat, tlvStream) val sig = Crypto.sign(witness, nodeSecret) ChannelUpdate( signature = sig, @@ -142,7 +144,8 @@ object Announcements { htlcMinimumMsat = htlcMinimumMsat, feeBaseMsat = feeBaseMsat, feeProportionalMillionths = feeProportionalMillionths, - htlcMaximumMsat = htlcMaximumMsat + htlcMaximumMsat = htlcMaximumMsat, + tlvStream = tlvStream ) } diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/router/RouteCalculation.scala b/eclair-core/src/main/scala/fr/acinq/eclair/router/RouteCalculation.scala index b8d6e7702e..fce5eb765f 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/router/RouteCalculation.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/router/RouteCalculation.scala @@ -101,11 +101,9 @@ object RouteCalculation { // some nodes in the supplied route aren't connected in our graph fr.replyTo ! PaymentRouteNotFound(new IllegalArgumentException("Not all the nodes in the supplied route are connected with public channels")) } - case pcr@PredefinedChannelRoute(amount, targetNodeId, shortChannelIds, maxFee_opt) => - log.info(s"$pcr") + case PredefinedChannelRoute(amount, targetNodeId, shortChannelIds, maxFee_opt) => val (end, hops) = shortChannelIds.foldLeft((localNodeId, Seq.empty[ChannelHop])) { case ((currentNode, previousHops), shortChannelId) => - log.info(s"d.resolve($shortChannelId)=${d.resolve(shortChannelId)}") val channelDesc_opt = d.resolve(shortChannelId) match { case Some(c: PublicChannel) => currentNode match { case c.nodeId1 => Some(ChannelDesc(shortChannelId, c.nodeId1, c.nodeId2)) @@ -119,13 +117,11 @@ object RouteCalculation { } case None => extraEdges.find(e => e.desc.shortChannelId == shortChannelId && e.desc.a == currentNode).map(_.desc) } - log.info(s"$channelDesc_opt") channelDesc_opt.flatMap(c => g.getEdge(c)) match { case Some(edge) => (edge.desc.b, previousHops :+ ChannelHop(getEdgeRelayScid(d, localNodeId, edge), edge.desc.a, edge.desc.b, edge.params)) case None => (currentNode, previousHops) } } - log.info(s"$end $hops") if (end != targetNodeId || hops.length != shortChannelIds.length) { fr.replyTo ! PaymentRouteNotFound(new IllegalArgumentException("The sequence of channels provided cannot be used to build a route to the target node")) } else { diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/router/Router.scala b/eclair-core/src/main/scala/fr/acinq/eclair/router/Router.scala index 2751613222..5069258f75 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/router/Router.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/router/Router.scala @@ -495,12 +495,7 @@ object Router { def cltvExpiryDelta: CltvExpiryDelta def relayFees: Relayer.RelayFees def inboundFees_opt: Option[Relayer.InboundFees] - final def fee(amount: MilliSatoshi): MilliSatoshi = { - val outFee = nodeFee(relayFees, amount) - val inFee = inboundFees_opt.map(i => nodeFee(i.feeBase, i.feeProportionalMillionths, amount + outFee)).getOrElse(0 msat) - val totalFee = outFee + inFee - if (totalFee.toLong < 0) 0 msat else totalFee - } + final def fee(amount: MilliSatoshi): MilliSatoshi = totalFee(amount, relayFees, inboundFees_opt) def htlcMinimum: MilliSatoshi def htlcMaximum_opt: Option[MilliSatoshi] // @formatter:on diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/RoutingTlv.scala b/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/RoutingTlv.scala index 4089b043fa..326dbd0084 100644 --- a/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/RoutingTlv.scala +++ b/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/RoutingTlv.scala @@ -16,6 +16,7 @@ package fr.acinq.eclair.wire.protocol +import fr.acinq.eclair.payment.relay.Relayer.InboundFees import fr.acinq.eclair.wire.protocol.CommonCodecs.{timestampSecond, varint, varintoverflow} import fr.acinq.eclair.wire.protocol.TlvCodecs.{tlvField, tlvStream} import fr.acinq.eclair.{TimestampSecond, UInt64} @@ -55,6 +56,10 @@ sealed trait ChannelUpdateTlv extends Tlv object ChannelUpdateTlv { case class Blip18InboundFee(feeBase: Int, feeProportionalMillionths: Int) extends ChannelUpdateTlv + object Blip18InboundFee { + def apply(fees: InboundFees): Blip18InboundFee = Blip18InboundFee(fees.feeBase.toLong.toInt, fees.feeProportionalMillionths.toInt) + } + private val blip18InboundFeeCodec: Codec[Blip18InboundFee] = tlvField(Codec( ("feeBase" | int32) :: ("feeProportionalMillionths" | int32) diff --git a/eclair-core/src/test/scala/fr/acinq/eclair/EclairImplSpec.scala b/eclair-core/src/test/scala/fr/acinq/eclair/EclairImplSpec.scala index b449d431e3..ea40123192 100644 --- a/eclair-core/src/test/scala/fr/acinq/eclair/EclairImplSpec.scala +++ b/eclair-core/src/test/scala/fr/acinq/eclair/EclairImplSpec.scala @@ -33,7 +33,7 @@ import fr.acinq.eclair.io.Peer import fr.acinq.eclair.io.Peer.OpenChannel import fr.acinq.eclair.payment.receive.MultiPartHandler.ReceiveStandardPayment import fr.acinq.eclair.payment.receive.PaymentHandler -import fr.acinq.eclair.payment.relay.Relayer.{GetOutgoingChannels, RelayFees} +import fr.acinq.eclair.payment.relay.Relayer.{GetOutgoingChannels, InboundFees, RelayFees} import fr.acinq.eclair.payment.send.PaymentIdentifier import fr.acinq.eclair.payment.send.PaymentInitiator._ import fr.acinq.eclair.payment.{Bolt11Invoice, Invoice, PaymentFailed} @@ -658,9 +658,11 @@ class EclairImplSpec extends TestKitBaseClass with FixtureAnyFunSuiteLike with I import f._ val peersDb = mock[PeersDb] + val inboundFeesDb = mock[InboundFeesDb] val databases = mock[Databases] databases.peers returns peersDb + databases.inboundFees returns inboundFeesDb val kitWithMockDb = kit.copy(nodeParams = kit.nodeParams.copy(db = databases)) val eclair = new EclairImpl(kitWithMockDb) @@ -672,7 +674,7 @@ class EclairImplSpec extends TestKitBaseClass with FixtureAnyFunSuiteLike with I val b1 = randomBytes32() val map = Map(a1 -> a, a2 -> a, b1 -> b) - eclair.updateRelayFee(List(a, b), 999 msat, 1234).pipeTo(sender.ref) + eclair.updateRelayFee(List(a, b), 999 msat, 1234, Some(1 msat), Some(2)).pipeTo(sender.ref) register.expectMsg(Register.GetChannelsTo) register.reply(map) @@ -686,13 +688,16 @@ class EclairImplSpec extends TestKitBaseClass with FixtureAnyFunSuiteLike with I register.expectNoMessage() assert(sender.expectMsgType[Map[ChannelIdentifier, Either[Throwable, CommandResponse[CMD_UPDATE_RELAY_FEE]]]] == Map( - Left(a1) -> Right(RES_SUCCESS(CMD_UPDATE_RELAY_FEE(ActorRef.noSender, 999 msat, 1234), a1)), - Left(a2) -> Right(RES_FAILURE(CMD_UPDATE_RELAY_FEE(ActorRef.noSender, 999 msat, 1234), CommandUnavailableInThisState(a2, "CMD_UPDATE_RELAY_FEE", channel.CLOSING))), + Left(a1) -> Right(RES_SUCCESS(CMD_UPDATE_RELAY_FEE(ActorRef.noSender, 999 msat, 1234, Some(1 msat), Some(2)), a1)), + Left(a2) -> Right(RES_FAILURE(CMD_UPDATE_RELAY_FEE(ActorRef.noSender, 999 msat, 1234, Some(1 msat), Some(2)), CommandUnavailableInThisState(a2, "CMD_UPDATE_RELAY_FEE", channel.CLOSING))), Left(b1) -> Left(ChannelNotFound(Left(b1))) )) peersDb.addOrUpdateRelayFees(a, RelayFees(999 msat, 1234)).wasCalled(once) peersDb.addOrUpdateRelayFees(b, RelayFees(999 msat, 1234)).wasCalled(once) + + inboundFeesDb.addOrUpdateInboundFees(a, InboundFees(1 msat, 2)).wasCalled(once) + inboundFeesDb.addOrUpdateInboundFees(b, InboundFees(1 msat, 2)).wasCalled(once) } test("channelBalances asks for all channels, usableBalances only for enabled ones") { f => diff --git a/eclair-core/src/test/scala/fr/acinq/eclair/TestDatabases.scala b/eclair-core/src/test/scala/fr/acinq/eclair/TestDatabases.scala index dbb4775563..1f780a06b8 100644 --- a/eclair-core/src/test/scala/fr/acinq/eclair/TestDatabases.scala +++ b/eclair-core/src/test/scala/fr/acinq/eclair/TestDatabases.scala @@ -36,6 +36,7 @@ sealed trait TestDatabases extends Databases { override def offers: OffersDb = db.offers override def pendingCommands: PendingCommandsDb = db.pendingCommands override def liquidity: LiquidityDb = db.liquidity + override def inboundFees: InboundFeesDb = db.inboundFees def close(): Unit // @formatter:on } @@ -46,7 +47,7 @@ object TestDatabases { def inMemoryDb(): Databases = { val connection = sqliteInMemory() - val dbs = Databases.SqliteDatabases(connection, connection, connection, jdbcUrlFile_opt = None) + val dbs = Databases.SqliteDatabases(connection, connection, connection, connection, jdbcUrlFile_opt = None) dbs.copy(channels = new SqliteChannelsDbWithValidation(dbs.channels)) } @@ -102,7 +103,7 @@ object TestDatabases { override lazy val db: Databases = { val jdbcUrlFile: File = new File(TestUtils.BUILD_DIRECTORY, s"jdbcUrlFile_${UUID.randomUUID()}.tmp") jdbcUrlFile.deleteOnExit() - val dbs = Databases.SqliteDatabases(connection, connection, connection, jdbcUrlFile_opt = Some(jdbcUrlFile)) + val dbs = Databases.SqliteDatabases(connection, connection, connection, connection, jdbcUrlFile_opt = Some(jdbcUrlFile)) dbs.copy(channels = new SqliteChannelsDbWithValidation(dbs.channels)) } override def close(): Unit = connection.close() diff --git a/eclair-core/src/test/scala/fr/acinq/eclair/db/DbMigrationSpec.scala b/eclair-core/src/test/scala/fr/acinq/eclair/db/DbMigrationSpec.scala index a88168418b..1fd9f62311 100644 --- a/eclair-core/src/test/scala/fr/acinq/eclair/db/DbMigrationSpec.scala +++ b/eclair-core/src/test/scala/fr/acinq/eclair/db/DbMigrationSpec.scala @@ -32,7 +32,7 @@ class DbMigrationSpec extends AnyFunSuite { new PgChannelsDb()(postgresDatasource, PgLock.NoLock) new PgPendingCommandsDb()(postgresDatasource, PgLock.NoLock) - new PgPeersDb()(postgresDatasource, PgLock.NoLock) + new PgInboundFeesDb()(postgresDatasource, PgLock.NoLock) new PgPaymentsDb()(postgresDatasource, PgLock.NoLock) PgUtils.inTransaction { postgres => @@ -83,6 +83,7 @@ class DbMigrationSpec extends AnyFunSuite { auditJdbc = loadSqlite("migration\\audit.sqlite", readOnly = false), eclairJdbc = loadSqlite("migration\\eclair.sqlite", readOnly = false), networkJdbc = loadSqlite("migration\\network.sqlite", readOnly = false), + inboundFeesJdbc = loadSqlite("migration\\inboundfees.sqlite", readOnly = false), jdbcUrlFile_opt = None ) val postgres = { diff --git a/eclair-core/src/test/scala/fr/acinq/eclair/db/InboundFeesDbSpec.scala b/eclair-core/src/test/scala/fr/acinq/eclair/db/InboundFeesDbSpec.scala new file mode 100644 index 0000000000..a896ed0d47 --- /dev/null +++ b/eclair-core/src/test/scala/fr/acinq/eclair/db/InboundFeesDbSpec.scala @@ -0,0 +1,45 @@ +package fr.acinq.eclair.db + +import fr.acinq.eclair.TestDatabases.{TestPgDatabases, TestSqliteDatabases} +import fr.acinq.eclair._ +import fr.acinq.eclair.db.pg.PgInboundFeesDb +import fr.acinq.eclair.db.sqlite.SqliteInboundFeesDb +import fr.acinq.eclair.payment.relay.Relayer.InboundFees +import org.scalatest.funsuite.AnyFunSuite + +class InboundFeesDbSpec extends AnyFunSuite { + + import fr.acinq.eclair.TestDatabases.forAllDbs + + test("init database two times in a row") { + forAllDbs { + case sqlite: TestSqliteDatabases => + new SqliteInboundFeesDb(sqlite.connection) + new SqliteInboundFeesDb(sqlite.connection) + case pg: TestPgDatabases => + new PgInboundFeesDb()(pg.datasource, pg.lock) + new PgInboundFeesDb()(pg.datasource, pg.lock) + } + } + + test("add and update inbound fees") { + forAllDbs { dbs => + val db = dbs.inboundFees + + val a = randomKey().publicKey + val b = randomKey().publicKey + + assert(db.getInboundFees(a).isEmpty) + assert(db.getInboundFees(b).isEmpty) + db.addOrUpdateInboundFees(a, InboundFees(1 msat, 123)) + assert(db.getInboundFees(a).contains(InboundFees(1 msat, 123))) + assert(db.getInboundFees(b).isEmpty) + db.addOrUpdateInboundFees(a, InboundFees(2 msat, 456)) + assert(db.getInboundFees(a).contains(InboundFees(2 msat, 456))) + assert(db.getInboundFees(b).isEmpty) + db.addOrUpdateInboundFees(b, InboundFees(3 msat, 789)) + assert(db.getInboundFees(a).contains(InboundFees(2 msat, 456))) + assert(db.getInboundFees(b).contains(InboundFees(3 msat, 789))) + } + } +} diff --git a/eclair-core/src/test/scala/fr/acinq/eclair/payment/relay/ChannelRelayerSpec.scala b/eclair-core/src/test/scala/fr/acinq/eclair/payment/relay/ChannelRelayerSpec.scala index eca6dea134..f02ac0d894 100644 --- a/eclair-core/src/test/scala/fr/acinq/eclair/payment/relay/ChannelRelayerSpec.scala +++ b/eclair-core/src/test/scala/fr/acinq/eclair/payment/relay/ChannelRelayerSpec.scala @@ -34,9 +34,11 @@ import fr.acinq.eclair.crypto.Sphinx import fr.acinq.eclair.io.{Peer, PeerReadyManager, Switchboard} import fr.acinq.eclair.payment.IncomingPaymentPacket.ChannelRelayPacket import fr.acinq.eclair.payment.relay.ChannelRelayer._ +import fr.acinq.eclair.payment.relay.Relayer.InboundFees import fr.acinq.eclair.payment.{ChannelPaymentRelayed, IncomingPaymentPacket, PaymentPacketSpec} import fr.acinq.eclair.router.Announcements import fr.acinq.eclair.wire.protocol.BlindedRouteData.PaymentRelayData +import fr.acinq.eclair.wire.protocol.ChannelUpdateTlv.Blip18InboundFee import fr.acinq.eclair.wire.protocol.PaymentOnion.IntermediatePayload import fr.acinq.eclair.wire.protocol.PaymentOnion.IntermediatePayload.ChannelRelay import fr.acinq.eclair.wire.protocol._ @@ -513,6 +515,20 @@ class ChannelRelayerSpec extends ScalaTestWithActorTestKit(ConfigFactory.load("a expectFwdFail(register, r.add.channelId, CMD_FAIL_HTLC(r.add.id, FailureReason.LocalFailure(FeeInsufficient(r.add.amountMsat, Some(u3.channelUpdate))), commit = true)) } + test("relay that would fail (fee insufficient) when inbound fees are set") { f => + import f._ + + val payload = ChannelRelay.Standard(realScid1, outgoingAmount, outgoingExpiry) + val r = createValidIncomingPacket(payload) + val u = createLocalUpdate(channelId1, inboundFees_opt = Some(InboundFees(10000 msat, 100000))) + + channelRelayer ! WrappedLocalChannelUpdate(u) + channelRelayer ! Relay(r, TestConstants.Alice.nodeParams.nodeId) + + expectFwdFail(register, r.add.channelId, CMD_FAIL_HTLC(r.add.id, FailureReason.LocalFailure(FeeInsufficient(r.add.amountMsat, Some(u.channelUpdate))), commit = true)) + } + + test("fail to relay when there is a local error") { f => import f._ @@ -835,11 +851,12 @@ object ChannelRelayerSpec { ShortIdAliases(localAlias, remoteAlias_opt = None) } - def createLocalUpdate(channelId: ByteVector32, channelUpdateScid_opt: Option[ShortChannelId] = None, balance: MilliSatoshi = 100_000_000 msat, capacity: Satoshi = 5_000_000 sat, enabled: Boolean = true, htlcMinimum: MilliSatoshi = 0 msat, timestamp: TimestampSecond = 0 unixsec, feeBaseMsat: MilliSatoshi = 1000 msat, feeProportionalMillionths: Long = 100, optionScidAlias: Boolean = false): LocalChannelUpdate = { + def createLocalUpdate(channelId: ByteVector32, channelUpdateScid_opt: Option[ShortChannelId] = None, balance: MilliSatoshi = 100_000_000 msat, capacity: Satoshi = 5_000_000 sat, enabled: Boolean = true, htlcMinimum: MilliSatoshi = 0 msat, timestamp: TimestampSecond = 0 unixsec, feeBaseMsat: MilliSatoshi = 1000 msat, feeProportionalMillionths: Long = 100, optionScidAlias: Boolean = false, inboundFees_opt: Option[InboundFees] = None): LocalChannelUpdate = { val aliases = createAliases(channelId) val realScid = channelIds.collectFirst { case (realScid: RealShortChannelId, cid) if cid == channelId => realScid }.get val channelUpdateScid = channelUpdateScid_opt.getOrElse(realScid) - val update = ChannelUpdate(ByteVector64(randomBytes(64)), Block.RegtestGenesisBlock.hash, channelUpdateScid, timestamp, ChannelUpdate.MessageFlags(dontForward = false), ChannelUpdate.ChannelFlags(isNode1 = true, isEnabled = enabled), CltvExpiryDelta(100), htlcMinimum, feeBaseMsat, feeProportionalMillionths, capacity.toMilliSatoshi) + val tlvStream = inboundFees_opt.map(fees => TlvStream[ChannelUpdateTlv](Blip18InboundFee(fees))).getOrElse(TlvStream.empty) + val update = ChannelUpdate(ByteVector64(randomBytes(64)), Block.RegtestGenesisBlock.hash, channelUpdateScid, timestamp, ChannelUpdate.MessageFlags(dontForward = false), ChannelUpdate.ChannelFlags(isNode1 = true, isEnabled = enabled), CltvExpiryDelta(100), htlcMinimum, feeBaseMsat, feeProportionalMillionths, capacity.toMilliSatoshi, tlvStream) val features: Set[PermanentChannelFeature] = Set( if (optionScidAlias) Some(ScidAlias) else None, ).flatten diff --git a/eclair-core/src/test/scala/fr/acinq/eclair/router/AnnouncementsSpec.scala b/eclair-core/src/test/scala/fr/acinq/eclair/router/AnnouncementsSpec.scala index d336ed4993..f68f4ee09e 100644 --- a/eclair-core/src/test/scala/fr/acinq/eclair/router/AnnouncementsSpec.scala +++ b/eclair-core/src/test/scala/fr/acinq/eclair/router/AnnouncementsSpec.scala @@ -21,6 +21,7 @@ import fr.acinq.bitcoin.scalacompat.Crypto.{PrivateKey, PublicKey} import fr.acinq.eclair.TestConstants.Alice import fr.acinq.eclair.RealShortChannelId import fr.acinq.eclair._ +import fr.acinq.eclair.payment.relay.Relayer.InboundFees import fr.acinq.eclair.router.Announcements._ import fr.acinq.eclair.wire.protocol.ChannelUpdate.ChannelFlags import fr.acinq.eclair.wire.protocol.LightningMessageCodecs.nodeAnnouncementCodec @@ -135,6 +136,9 @@ class AnnouncementsSpec extends AnyFunSuite { val ann = makeChannelUpdate(Block.RegtestGenesisBlock.hash, Alice.nodeParams.privateKey, randomKey().publicKey, ShortChannelId(45561L), Alice.nodeParams.channelConf.expiryDelta, Alice.nodeParams.channelConf.htlcMinimum, Alice.nodeParams.relayParams.publicChannelFees.feeBase, Alice.nodeParams.relayParams.publicChannelFees.feeProportionalMillionths, 500000000 msat) assert(checkSig(ann, Alice.nodeParams.nodeId)) assert(!checkSig(ann, randomKey().publicKey)) + val annInboundFees = makeChannelUpdate(Block.RegtestGenesisBlock.hash, Alice.nodeParams.privateKey, randomKey().publicKey, ShortChannelId(45561L), Alice.nodeParams.channelConf.expiryDelta, Alice.nodeParams.channelConf.htlcMinimum, Alice.nodeParams.relayParams.publicChannelFees.feeBase, Alice.nodeParams.relayParams.publicChannelFees.feeProportionalMillionths, 500000000 msat, inboundFees_opt = Some(InboundFees(1 msat, 1))) + assert(checkSig(annInboundFees, Alice.nodeParams.nodeId)) + assert(!checkSig(annInboundFees.copy(tlvStream = TlvStream.empty), Alice.nodeParams.nodeId)) } test("check flags") { diff --git a/eclair-node/src/main/scala/fr/acinq/eclair/api/handlers/Fees.scala b/eclair-node/src/main/scala/fr/acinq/eclair/api/handlers/Fees.scala index d83f8a6409..ba2144cd51 100644 --- a/eclair-node/src/main/scala/fr/acinq/eclair/api/handlers/Fees.scala +++ b/eclair-node/src/main/scala/fr/acinq/eclair/api/handlers/Fees.scala @@ -16,7 +16,7 @@ package fr.acinq.eclair.api.handlers -import akka.http.scaladsl.server.Route +import akka.http.scaladsl.server.{MalformedFormFieldRejection, Route} import fr.acinq.eclair.MilliSatoshi import fr.acinq.eclair.api.Service import fr.acinq.eclair.api.directives.EclairDirectives @@ -35,8 +35,18 @@ trait Fees { val updateRelayFee: Route = postRequest("updaterelayfee") { implicit t => withNodesIdentifier { nodes => - formFields("feeBaseMsat".as[MilliSatoshi], "feeProportionalMillionths".as[Long]) { (feeBase, feeProportional) => - complete(eclairApi.updateRelayFee(nodes, feeBase, feeProportional)) + formFields("feeBaseMsat".as[MilliSatoshi], "feeProportionalMillionths".as[Long], "inboundFeeBaseMsat".as[MilliSatoshi]?, "inboundFeeProportionalMillionths".as[Long]?) { (feeBase, feeProportional, inboundFeeBase_opt, inboundFeeProportional_opt) => + if (inboundFeeBase_opt.isEmpty && inboundFeeProportional_opt.isDefined) { + reject(MalformedFormFieldRejection("inboundFeeBaseMsat", "inbound fee base is required")) + } else if (inboundFeeBase_opt.isDefined && inboundFeeProportional_opt.isEmpty) { + reject(MalformedFormFieldRejection("inboundFeeProportionalMillionths", "inbound fee proportional millionths is required")) + } else if (!inboundFeeBase_opt.forall(value => value.toLong >= Int.MinValue && value.toLong <= 0)) { + reject(MalformedFormFieldRejection("inboundFeeBaseMsat", s"inbound fee base must be must be in the range from ${Int.MinValue} to 0")) + } else if (!inboundFeeProportional_opt.forall(value => value >= Int.MinValue && value <= 0)) { + reject(MalformedFormFieldRejection("inboundFeeProportionalMillionths", s"inbound fee proportional millionths must be in the range from ${Int.MinValue} to 0")) + } else { + complete(eclairApi.updateRelayFee(nodes, feeBase, feeProportional, inboundFeeBase_opt, inboundFeeProportional_opt)) + } } } }