Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extended API for fine-grained payment tracking #867

Closed
wants to merge 9 commits into from
Closed

Extended API for fine-grained payment tracking #867

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a29b5f3
Add payment hash to `HtlcTimeoutTx` in backwards compatible way.
Oct 23, 2018
eb401bd
Record `PaymentSettlingOnChain` and `PaymentLostOnChain` events in a …
Oct 25, 2018
59da1ac
Record sent, received and failed payment infos in AuditDb
Feb 14, 2019
fe33608
Add `sentinfo` and `receivedinfo` API endpoints
Feb 14, 2019
2598e9a
Minor bugfix
Feb 14, 2019
c87239e
Fix NodeParams fields
Feb 15, 2019
fc5006c
Allow to generate payment requests with fallback on-chain addresses
Feb 15, 2019
8d696f1
Make stream parameter implicit
Mar 1, 2019
25a8866
Merge remote-tracking branch 'upstream/master' into extended-api-2
Mar 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions eclair-core/src/main/scala/fr/acinq/eclair/NodeParams.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ case class NodeParams(keyManager: KeyManager,
pendingRelayDb: PendingRelayDb,
paymentsDb: PaymentsDb,
auditDb: AuditDb,
onChainRefundsDb: OnChainRefundsDb,
revocationTimeout: FiniteDuration,
pingInterval: FiniteDuration,
pingTimeout: FiniteDuration,
Expand Down Expand Up @@ -150,6 +151,7 @@ object NodeParams {
val networkDb = new SqliteNetworkDb(sqliteNetwork)

val sqliteAudit = DriverManager.getConnection(s"jdbc:sqlite:${new File(chaindir, "audit.sqlite")}")
val onChainRefundsDb = new SqliteOnChainRefundsDb(sqliteAudit)
val auditDb = new SqliteAuditDb(sqliteAudit)

val color = BinaryData(config.getString("node-color"))
Expand Down Expand Up @@ -179,7 +181,7 @@ object NodeParams {
val p = PublicKey(e.getString("nodeid"))
val gf = BinaryData(e.getString("global-features"))
val lf = BinaryData(e.getString("local-features"))
(p -> (gf, lf))
(p, (gf, lf))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you following intellij recommendations or some automated code modification suggestions? This makes review more difficult are there are lot of unrelated changes.

Can you revert and submit a separate PR for those?

Also by convention I Iike using -> for defining tuples in the context of a Map.

}.toMap

val socksProxy_opt = if (config.getBoolean("socks5.enabled")) {
Expand All @@ -202,7 +204,7 @@ object NodeParams {
NodeParams(
keyManager = keyManager,
alias = nodeAlias,
color = Color(color.data(0), color.data(1), color.data(2)),
color = Color(color.data.head, color.data(1), color.data(2)),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above. For this particular change it hurts readibility more than anything, as previous code was more consistent.

publicAddresses = addresses,
globalFeatures = BinaryData(config.getString("global-features")),
localFeatures = BinaryData(config.getString("local-features")),
Expand All @@ -226,6 +228,7 @@ object NodeParams {
pendingRelayDb = pendingRelayDb,
paymentsDb = paymentsDb,
auditDb = auditDb,
onChainRefundsDb = onChainRefundsDb,
revocationTimeout = FiniteDuration(config.getDuration("revocation-timeout").getSeconds, TimeUnit.SECONDS),
pingInterval = FiniteDuration(config.getDuration("ping-interval").getSeconds, TimeUnit.SECONDS),
pingTimeout = FiniteDuration(config.getDuration("ping-timeout").getSeconds, TimeUnit.SECONDS),
Expand Down
75 changes: 63 additions & 12 deletions eclair-core/src/main/scala/fr/acinq/eclair/api/Service.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ import fr.acinq.eclair.wire.{ChannelAnnouncement, ChannelUpdate, NodeAddress, No
import fr.acinq.eclair.{Kit, ShortChannelId, feerateByte2Kw}
import grizzled.slf4j.Logging
import org.json4s.JsonAST.{JBool, JInt, JString}
import org.json4s.jackson.Serialization
import org.json4s.{JValue, jackson}

import scala.concurrent.duration._
Expand Down Expand Up @@ -231,6 +232,14 @@ trait Service extends Logging {
completeRpcFuture(req.id, (paymentHandler ? ReceivePayment(Some(MilliSatoshi(amountMsat.toLong)), description)).mapTo[PaymentRequest].map(PaymentRequest.write))
case JInt(amountMsat) :: JString(description) :: JInt(expirySeconds) :: Nil =>
completeRpcFuture(req.id, (paymentHandler ? ReceivePayment(Some(MilliSatoshi(amountMsat.toLong)), description, Some(expirySeconds.toLong))).mapTo[PaymentRequest].map(PaymentRequest.write))
case JString(description) :: JInt(expirySeconds) :: JString(fallbackAddress) :: Nil =>
val isFallbackAddressCorrect = Try(fr.acinq.eclair.addressToPublicKeyScript(fallbackAddress, nodeParams.chainHash)).isSuccess
if (!isFallbackAddressCorrect) reject(RpcValidationRejection(req.id, s"invalid fallback address '$fallbackAddress'"))
else completeRpcFuture(req.id, (paymentHandler ? ReceivePayment(None, description, Some(expirySeconds.toLong), Nil, Some(fallbackAddress))).mapTo[PaymentRequest].map(PaymentRequest.write))
case JInt(amountMsat) :: JString(description) :: JInt(expirySeconds) :: JString(fallbackAddress) :: Nil =>
val isFallbackAddressCorrect = Try(fr.acinq.eclair.addressToPublicKeyScript(fallbackAddress, nodeParams.chainHash)).isSuccess
if (!isFallbackAddressCorrect) reject(RpcValidationRejection(req.id, s"invalid fallback address '$fallbackAddress'"))
else completeRpcFuture(req.id, (paymentHandler ? ReceivePayment(Some(MilliSatoshi(amountMsat.toLong)), description, Some(expirySeconds.toLong), Nil, Some(fallbackAddress))).mapTo[PaymentRequest].map(PaymentRequest.write))
case _ => reject(UnknownParamsRejection(req.id, "[description] or [amount, description] or [amount, description, expiryDuration]"))
}

Expand Down Expand Up @@ -300,17 +309,47 @@ trait Service extends Logging {

// check received payments
case "checkpayment" => req.params match {
case JString(identifier) :: Nil => completeRpcFuture(req.id, for {
paymentHash <- Try(PaymentRequest.read(identifier)) match {
case Success(pr) => Future.successful(pr.paymentHash)
case _ => Try(BinaryData(identifier)) match {
case Success(s) => Future.successful(s)
case _ => Future.failed(new IllegalArgumentException("payment identifier must be a payment request or a payment hash"))
case JString(identifier) :: Nil => extractPaymentHash(identifier) match {
case Success(hash) => completeRpcFuture(req.id, (paymentHandler ? CheckPayment(hash)).map(found => new JBool(found.asInstanceOf[Boolean])))
case _ => completeRpcFuture(req.id, Future.failed(new IllegalArgumentException("payment identifier must be a payment request or a payment hash")))
}
case _ => reject(UnknownParamsRejection(req.id, "[paymentHash] or [paymentRequest]"))
}

case "receivedinfo" =>
req.params match {
case JString(identifier) :: Nil =>
extractPaymentHash(identifier) match {
case Success(hash) =>
// We may receive a payment and release a preimage but then a channel breaking may follow.
// Same payment may be reported as lost on chain in local commit and settling on chain in remote commit.
// This means we need to ask for on-chain settling payment first, then check if it has been lost on-chain, and only then check whether it has been received off-chain.
kit.nodeParams.onChainRefundsDb.getSettlingOnChain(hash) orElse kit.nodeParams.onChainRefundsDb.getLostOnChain(hash) orElse kit.nodeParams.auditDb.receivedPaymentInfo(hash) match {
case Some(paymentReceived) => completeRpcFuture(req.id, Future.successful(paymentReceived))
case None => completeRpcFuture(req.id, Future.failed(new IllegalArgumentException("no such payment received yet")))
}
case _ =>
completeRpcFuture(req.id, Future.failed(new IllegalArgumentException("payment identifier must be a payment request or a payment hash")))
}
case _ =>
reject(UnknownParamsRejection(req.id, "[paymentHash] or [paymentRequest]"))
}

case "sentinfo" => req.params match {
case JString(identifier) :: Nil =>
extractPaymentHash(identifier) match {
case Success(hash) =>
// We may send a payment, a channel breaking may follow with `PaymentSettlingOnChain` or `PaymentLostOnChain` following, but then remote peer may fetch a payment on-chain by revealing a preimage
// This means we need to ask if a payment has been received off-chain first, then check whether it is settling on-chain, and only then check if it has been lost on-chain.
kit.nodeParams.auditDb.sentPaymentInfo(hash) orElse kit.nodeParams.onChainRefundsDb.getSettlingOnChain(hash) orElse kit.nodeParams.onChainRefundsDb.getLostOnChain(hash) orElse kit.nodeParams.auditDb.failedPaymentInfo(hash) match {
case Some(paymentSent) => completeRpcFuture(req.id, Future.successful(paymentSent))
case None => completeRpcFuture(req.id, Future.failed(new IllegalArgumentException("no such payment sent yet")))
}
case _ =>
completeRpcFuture(req.id, Future.failed(new IllegalArgumentException("payment identifier must be a payment request or a payment hash")))
}
found <- (paymentHandler ? CheckPayment(paymentHash)).map(found => new JBool(found.asInstanceOf[Boolean]))
} yield found)
case _ => reject(UnknownParamsRejection(req.id, "[paymentHash] or [paymentRequest]"))
case _ =>
reject(UnknownParamsRejection(req.id, "[paymentHash] or [paymentRequest]"))
}

// retrieve audit events
Expand Down Expand Up @@ -352,15 +391,27 @@ trait Service extends Logging {

def getInfoResponse: Future[GetInfoResponse]

private def extractPaymentHash(identifier: String) = Try(PaymentRequest.read(identifier).paymentHash) orElse Try(BinaryData(identifier))

def makeSocketHandler(system: ActorSystem)(implicit materializer: ActorMaterializer): Flow[Message, TextMessage.Strict, NotUsed] = {

// create a flow transforming a queue of string -> string
val (flowInput, flowOutput) = Source.queue[String](10, OverflowStrategy.dropTail).toMat(BroadcastHub.sink[String])(Keep.both).run()

// register an actor that feeds the queue when a payment is received
// register an actor that feeds the queue on payment related events
system.actorOf(Props(new Actor {
override def preStart: Unit = context.system.eventStream.subscribe(self, classOf[PaymentReceived])
def receive: Receive = { case received: PaymentReceived => flowInput.offer(received.paymentHash.toString) }

override def preStart: Unit = {
context.system.eventStream.subscribe(self, classOf[PaymentFailed])
context.system.eventStream.subscribe(self, classOf[PaymentEvent])
}

def receive: Receive = {
case message: PaymentFailed => flowInput.offer(Serialization write message)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The json serialization should probably be part of the flow instead of duplicating Serialization.write(...)

case message: PaymentEvent => flowInput.offer(Serialization write message)
case other => logger.info(s"Unexpected ws message: $other")
}

}))

Flow[Message]
Expand Down
Loading