Use psbt to fund transactions

eclair-core/pom.xml

@@ -188,6 +188,11 @@
  <version>4.1.42.Final</version>
  </dependency>
  <!-- BITCOIN -->
+ <dependency>
+ <groupId>fr.acinq.bitcoin</groupId>
+ <artifactId>bitcoin-kmp-jvm</artifactId>
+ <version>0.8.2</version>
+ </dependency>
  <dependency>
  <groupId>fr.acinq</groupId>
  <artifactId>bitcoin-lib_${scala.version.short}</artifactId>

eclair-core/src/main/scala/fr/acinq/eclair/Setup.scala

@@ -251,7 +251,7 @@ class Setup(val datadir: File,
  })
  _ <- feeratesRetrieved.future
 
- bitcoinClient = new BitcoinCoreClient(new BatchingBitcoinJsonRPCClient(bitcoin))
+ bitcoinClient = new BitcoinCoreClient(nodeParams.chainHash, new BatchingBitcoinJsonRPCClient(bitcoin))
  watcher = {
  system.actorOf(SimpleSupervisor.props(Props(new ZMQActor(config.getString("bitcoind.zmqblock"), ZMQActor.Topics.HashBlock, Some(zmqBlockConnected))), "zmqblock", SupervisorStrategy.Restart))
  system.actorOf(SimpleSupervisor.props(Props(new ZMQActor(config.getString("bitcoind.zmqtx"), ZMQActor.Topics.RawTx, Some(zmqTxConnected))), "zmqtx", SupervisorStrategy.Restart))

eclair-core/src/main/scala/fr/acinq/eclair/blockchain/OnChainWallet.scala

@@ -16,7 +16,9 @@
 
 package fr.acinq.eclair.blockchain
 
+import fr.acinq.bitcoin.psbt.Psbt
 import fr.acinq.bitcoinscala.Crypto.PublicKey
+import fr.acinq.bitcoinscala.DeterministicWallet.ExtendedPublicKey
 import fr.acinq.bitcoinscala.{Satoshi, Transaction}
 import fr.acinq.eclair.blockchain.fee.FeeratePerKw
 import scodec.bits.ByteVector
@@ -33,7 +35,7 @@ trait OnChainChannelFunder {
  import OnChainWallet.MakeFundingTxResponse
 
  /** Create a channel funding transaction with the provided pubkeyScript. */
- def makeFundingTx(pubkeyScript: ByteVector, amount: Satoshi, feeRatePerKw: FeeratePerKw)(implicit ec: ExecutionContext): Future[MakeFundingTxResponse]
+ def makeFundingTx(localFundingKey: ExtendedPublicKey, remoteFundingKey: PublicKey, amount: Satoshi, feeRatePerKw: FeeratePerKw)(implicit ec: ExecutionContext): Future[MakeFundingTxResponse]
 
  /**
  * Committing *must* include publishing the transaction on the network.
@@ -95,6 +97,6 @@ object OnChainWallet {
 
  final case class OnChainBalance(confirmed: Satoshi, unconfirmed: Satoshi)
 
- final case class MakeFundingTxResponse(fundingTx: Transaction, fundingTxOutputIndex: Int, fee: Satoshi)
+ final case class MakeFundingTxResponse(psbt: Psbt, fundingTxOutputIndex: Int, fee: Satoshi)
 
 }

eclair-core/src/main/scala/fr/acinq/eclair/blockchain/bitcoind/rpc/BitcoinCoreClient.scala

@@ -16,24 +16,27 @@
 
 package fr.acinq.eclair.blockchain.bitcoind.rpc
 
+import fr.acinq.bitcoin.psbt._
+import fr.acinq.bitcoin.{Bech32, Block, SigHash}
 import fr.acinq.bitcoinscala.Crypto.PublicKey
-import fr.acinq.bitcoin.{Bech32, Block}
+import fr.acinq.bitcoinscala.DeterministicWallet.ExtendedPublicKey
 import fr.acinq.bitcoinscala._
 import fr.acinq.eclair.ShortChannelId.coordinates
 import fr.acinq.eclair.{TimestampSecond, TxCoordinates}
 import fr.acinq.eclair.blockchain.OnChainWallet
 import fr.acinq.eclair.blockchain.OnChainWallet.{MakeFundingTxResponse, OnChainBalance}
 import fr.acinq.eclair.blockchain.bitcoind.ZmqWatcher.{GetTxWithMetaResponse, UtxoStatus, ValidateResult}
 import fr.acinq.eclair.blockchain.fee.{FeeratePerKB, FeeratePerKw}
-import fr.acinq.eclair.transactions.Transactions
+import fr.acinq.eclair.transactions.{Scripts, Transactions}
 import fr.acinq.eclair.wire.protocol.ChannelAnnouncement
 import grizzled.slf4j.Logging
 import org.json4s.Formats
 import org.json4s.JsonAST._
 import scodec.bits.ByteVector
 
+import java.util.Base64
 import scala.concurrent.{ExecutionContext, Future}
-import scala.jdk.CollectionConverters.ListHasAsScala
+import scala.jdk.CollectionConverters.{ListHasAsScala, MapHasAsJava, SeqHasAsJava}
 import scala.util.{Failure, Success, Try}
 
 /**
@@ -43,7 +46,7 @@ import scala.util.{Failure, Success, Try}
 /**
  * The Bitcoin Core client provides some high-level utility methods to interact with Bitcoin Core.
  */
-class BitcoinCoreClient(val rpcClient: BitcoinJsonRPCClient) extends OnChainWallet with Logging {
+class BitcoinCoreClient(val chainHash: ByteVector32, val rpcClient: BitcoinJsonRPCClient) extends OnChainWallet with Logging {
 
  import BitcoinCoreClient._
 
@@ -188,25 +191,92 @@ class BitcoinCoreClient(val rpcClient: BitcoinJsonRPCClient) extends OnChainWall
  })
  }
 
- def makeFundingTx(pubkeyScript: ByteVector, amount: Satoshi, targetFeerate: FeeratePerKw)(implicit ec: ExecutionContext): Future[MakeFundingTxResponse] = {
- val partialFundingTx = Transaction(
- version = 2,
- txIn = Seq.empty[TxIn],
- txOut = TxOut(amount, pubkeyScript) :: Nil,
- lockTime = 0)
+ def fundPsbt(inputs: Seq[FundPsbtInput], outputs: Seq[(String, Satoshi)], locktime: Long, options: FundPsbtOptions)(implicit ec: ExecutionContext): Future[FundPsbtResponse] = {
+ rpcClient.invoke("walletcreatefundedpsbt", inputs.toArray, outputs.map { case (a, b) => a -> b.toBtc.toBigDecimal }, locktime, options).map(json => {
+ val JString(base64) = json \ "psbt"
+ val JInt(changePos) = json \ "changepos"
+ val JDecimal(fee) = json \ "fee"
+ val bin = Base64.getDecoder.decode(base64)
+ val psbt = Psbt.read(bin).getRight
+ val changePos_opt = if (changePos >= 0) Some(changePos.intValue) else None
+ FundPsbtResponse(psbt, toSatoshi(fee), changePos_opt)
+ })
+ }
+
+ def fundPsbt(outputs: Seq[(String, Satoshi)], locktime: Long, options: FundPsbtOptions)(implicit ec: ExecutionContext): Future[FundPsbtResponse] =
+ fundPsbt(Seq(), outputs, locktime, options)
+
+ def processPsbt(psbt: Psbt, sign: Boolean = true, sighashType: Int = SigHash.SIGHASH_ALL)(implicit ec: ExecutionContext): Future[ProcessPsbtResponse] = {
+ val sighashStrings = Map(
+ SigHash.SIGHASH_ALL -> "ALL",
+ SigHash.SIGHASH_NONE -> "NONE",
+ SigHash.SIGHASH_SINGLE -> "SINGLE",
+ (SigHash.SIGHASH_ALL | SigHash.SIGHASH_ANYONECANPAY) -> "ALL|ANYONECANPAY",
+ (SigHash.SIGHASH_NONE | SigHash.SIGHASH_ANYONECANPAY) -> "NONE|ANYONECANPAY",
+ (SigHash.SIGHASH_SINGLE | SigHash.SIGHASH_ANYONECANPAY) -> "SINGLE|ANYONECANPAY")
+ val sighash = sighashStrings.getOrElse(sighashType, throw new IllegalArgumentException(s"invalid sighash flag ${sighashType}"))
+ rpcClient.invoke("walletprocesspsbt", Base64.getEncoder.encodeToString(Psbt.write(psbt).toByteArray), sign, sighash).map(json => {
+ val JString(base64) = json \ "psbt"
+ val JBool(complete) = json \ "complete"
+ val psbt = Psbt.read(Base64.getDecoder.decode(base64)).getRight
+ ProcessPsbtResponse(psbt, complete)
+ })
+ }
+
+ private def signPsbtOrUnlock(psbt: Psbt)(implicit ec: ExecutionContext): Future[ProcessPsbtResponse] = {
+ val f = for {
+ ProcessPsbtResponse(psbt1, complete) <- processPsbt(psbt)
+ _ = if (!complete) throw JsonRPCError(Error(0, "cannot sign psbt"))
+ } yield ProcessPsbtResponse(psbt1, complete)
+ // if signature fails (e.g. because wallet is encrypted) we need to unlock the utxos
+ f.recoverWith { case _ =>
+ unlockOutpoints(psbt.getGlobal.getTx.txIn.asScala.toSeq.map(_.outPoint).map(KotlinUtils.kmp2scala))
+ .recover { case t: Throwable => // no-op, just add a log in case of failure
+ logger.warn(s"Cannot unlock failed transaction's UTXOs txid=${psbt.getGlobal.getTx.txid}", t)
+ t
+ }
+ .flatMap(_ => f) // return signTransaction error
+ .recoverWith { case _ => f } // return signTransaction error
+ }
+ }
+
+ override def makeFundingTx(localFundingKey: ExtendedPublicKey, remoteFundingKey: PublicKey, amount: Satoshi, feeRatePerKw: FeeratePerKw)(implicit ec: ExecutionContext): Future[MakeFundingTxResponse] = {
+ logger.info(s"funding psbt with local_funding_key=$localFundingKey and remote_funding_key=$remoteFundingKey")
+ val fundingPubkeyScript = Script.write(Script.pay2wsh(Scripts.multiSig2of2(localFundingKey.publicKey, remoteFundingKey)))
+ val Some(fundingAddress) = computeScriptAddress(chainHash, fundingPubkeyScript)
+
+ def updatePsbt(psbt: Psbt, changepos_opt: Option[Int], ourbip32path: Seq[Long]): Psbt = {
+ val outputIndex = changepos_opt match {
+ case None => 0
+ case Some(changePos) => 1 - changePos
+ }
+ psbt.updateWitnessOutput(outputIndex, null, null, Map(
+ KotlinUtils.scala2kmp(localFundingKey.publicKey) -> new KeyPathWithMaster(localFundingKey.parent, DeterministicWallet.KeyPath(ourbip32path).keyPath),
+ KotlinUtils.scala2kmp(remoteFundingKey) -> new KeyPathWithMaster(0L, DeterministicWallet.KeyPath("1/2/3/4").keyPath)
+ ).asJava
+ ).getRight
+ }
+
  for {
- feerate <- mempoolMinFee().map(minFee => FeeratePerKw(minFee).max(targetFeerate))
- // we ask bitcoin core to add inputs to the funding tx, and use the specified change address
- fundTxResponse <- fundTransaction(partialFundingTx, FundTransactionOptions(feerate, lockUtxos = true))
+ // we ask bitcoin core to create and fund the funding tx
+ feerate <- mempoolMinFee().map(minFee => FeeratePerKw(minFee).max(feeRatePerKw))
+ FundPsbtResponse(psbt, fee, changePos_opt) <- fundPsbt(Seq(fundingAddress -> amount), 0, FundPsbtOptions(feerate, lockUtxos = true, changePosition = Some(1)))
+ ourbip32path = localFundingKey.path.path.drop(2)
+ _ = logger.info(s"funded psbt = $psbt")
+ psbt1 = updatePsbt(psbt, changePos_opt, ourbip32path)
  // now let's sign the funding tx
- SignTransactionResponse(fundingTx, true) <- signTransactionOrUnlock(fundTxResponse.tx)
+ ProcessPsbtResponse(signedPsbt, complete) <- signPsbtOrUnlock(psbt1)
+ _ = logger.info(s"psbt signing complete = $complete")
+ extracted = signedPsbt.extract()
+ _ = if (extracted.isLeft) logger.error(s"psbt failure $extracted")
+ fundingTx = extracted.getRight
  // there will probably be a change output, so we need to find which output is ours
- outputIndex <- Transactions.findPubKeyScriptIndex(fundingTx, pubkeyScript) match {
+ outputIndex <- Transactions.findPubKeyScriptIndex(KotlinUtils.kmp2scala(fundingTx), fundingPubkeyScript) match {
  case Right(outputIndex) => Future.successful(outputIndex)
  case Left(skipped) => Future.failed(new RuntimeException(skipped.toString))
  }
- _ = logger.debug(s"created funding txid=${fundingTx.txid} outputIndex=$outputIndex fee=${fundTxResponse.fee}")
- } yield MakeFundingTxResponse(fundingTx, outputIndex, fundTxResponse.fee)
+ _ = logger.debug(s"created funding txid=${fundingTx.txid} outputIndex=$outputIndex fee=${fee}")
+ } yield MakeFundingTxResponse(signedPsbt, outputIndex, fee)
  }
 
  def commit(tx: Transaction)(implicit ec: ExecutionContext): Future[Boolean] = publishTransaction(tx).transformWith {
@@ -445,6 +515,22 @@ object BitcoinCoreClient {
  val amountIn: Satoshi = fee + tx.txOut.map(_.amount).sum
  }
 
+ case class FundPsbtInput(txid: ByteVector32, vout: Int, sequence_opt: Option[Long] = None)
+
+ case class FundPsbtOptions(feeRate: BigDecimal, replaceable: Boolean, lockUnspents: Boolean, changePosition: Option[Int], add_inputs: Boolean)
+
+ object FundPsbtOptions {
+ def apply(feerate: FeeratePerKw, replaceable: Boolean = true, lockUtxos: Boolean = false, changePosition: Option[Int] = None, add_inputs: Boolean = true): FundPsbtOptions = {
+ FundPsbtOptions(BigDecimal(FeeratePerKB(feerate).toLong).bigDecimal.scaleByPowerOfTen(-8), replaceable, lockUtxos, changePosition, add_inputs)
+ }
+ }
+
+ case class FundPsbtResponse(psbt: Psbt, fee: Satoshi, changePosition: Option[Int]) {
+ val amountIn: Satoshi = Option(psbt.computeFees()).map(KotlinUtils.kmp2scala).get + psbt.getGlobal.getTx.txOut.asScala.map(_.amount).map(KotlinUtils.kmp2scala).sum
+ }
+
+ case class ProcessPsbtResponse(psbt: Psbt, complete: Boolean)
+
  case class PreviousTx(txid: ByteVector32, vout: Long, scriptPubKey: String, redeemScript: String, witnessScript: String, amount: BigDecimal)
 
  object PreviousTx {

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

@@ -22,7 +22,7 @@ import akka.actor.{Actor, ActorContext, ActorRef, FSM, OneForOneStrategy, Possib
 import akka.event.Logging.MDC
 import akka.pattern.pipe
 import fr.acinq.bitcoinscala.Crypto.{PrivateKey, PublicKey}
-import fr.acinq.bitcoinscala.{ByteVector32, OutPoint, Satoshi, SatoshiLong, Script, Transaction}
+import fr.acinq.bitcoinscala.{ByteVector32, KotlinUtils, OutPoint, Satoshi, SatoshiLong, Script, Transaction}
 import fr.acinq.bitcoin.ScriptFlags
 import fr.acinq.eclair.Logs.LogCategory
 import fr.acinq.eclair.NotificationsLogger.NotifyNodeOperator
@@ -420,8 +420,7 @@ class Channel(val nodeParams: NodeParams, val wallet: OnChainChannelFunder, remo
  shutdownScript = remoteShutdownScript)
  log.debug("remote params: {}", remoteParams)
  val localFundingPubkey = keyManager.fundingPublicKey(localParams.fundingKeyPath)
- val fundingPubkeyScript = Script.write(Script.pay2wsh(Scripts.multiSig2of2(localFundingPubkey.publicKey, remoteParams.fundingPubKey)))
- wallet.makeFundingTx(fundingPubkeyScript, fundingSatoshis, fundingTxFeeratePerKw).pipeTo(self)
+ wallet.makeFundingTx(localFundingPubkey, remoteParams.fundingPubKey, fundingSatoshis, fundingTxFeeratePerKw).pipeTo(self)
  goto(WAIT_FOR_FUNDING_INTERNAL) using DATA_WAIT_FOR_FUNDING_INTERNAL(temporaryChannelId, localParams, remoteParams, fundingSatoshis, pushMsat, initialFeeratePerKw, accept.firstPerCommitmentPoint, channelConfig, channelFeatures, open)
  }
 
@@ -443,7 +442,8 @@ class Channel(val nodeParams: NodeParams, val wallet: OnChainChannelFunder, remo
  })
 
  when(WAIT_FOR_FUNDING_INTERNAL)(handleExceptions {
- case Event(MakeFundingTxResponse(fundingTx, fundingTxOutputIndex, fundingTxFee), d@DATA_WAIT_FOR_FUNDING_INTERNAL(temporaryChannelId, localParams, remoteParams, fundingAmount, pushMsat, initialFeeratePerKw, remoteFirstPerCommitmentPoint, channelConfig, channelFeatures, open)) =>
+ case Event(MakeFundingTxResponse(psbt, fundingTxOutputIndex, fundingTxFee), d@DATA_WAIT_FOR_FUNDING_INTERNAL(temporaryChannelId, localParams, remoteParams, fundingAmount, pushMsat, initialFeeratePerKw, remoteFirstPerCommitmentPoint, channelConfig, channelFeatures, open)) =>
+ val fundingTx = KotlinUtils.kmp2scala(psbt.extract().getRight)
  // let's create the first commitment tx that spends the yet uncommitted funding tx
  Funding.makeFirstCommitTxs(keyManager, channelConfig, channelFeatures, temporaryChannelId, localParams, remoteParams, fundingAmount, pushMsat, initialFeeratePerKw, fundingTx.hash, fundingTxOutputIndex, remoteFirstPerCommitmentPoint) match {
  case Left(ex) => handleLocalError(ex, d, None)
@@ -1586,10 +1586,10 @@ class Channel(val nodeParams: NodeParams, val wallet: OnChainChannelFunder, remo
  log.info("shutting down")
  stop(FSM.Normal)
 
- case Event(MakeFundingTxResponse(fundingTx, _, _), _) =>
+ case Event(MakeFundingTxResponse(psbt, _, _), _) =>
  // this may happen if connection is lost, or remote sends an error while we were waiting for the funding tx to be created by our wallet
  // in that case we rollback the tx
- wallet.rollback(fundingTx)
+ wallet.rollback(KotlinUtils.kmp2scala(psbt.extract().getRight))
  stay()
 
  case Event(INPUT_DISCONNECTED, _) => stay() // we are disconnected, but it doesn't matter anymore