Use bitcoin-lib 0.46 (taproot tweak refactor) (#3225)

* Use bitcoin-lib 0.46 (taproot tweak refactor)

* Update eclair-core/src/main/scala/fr/acinq/eclair/transactions/Transactions.scala

Co-authored-by: Bastien Teinturier <31281497+t-bast@users.noreply.github.com>

Author: sstone

.mvn/checksums/checksums-central.sha256

@@ -18,6 +18,7 @@ package fr.acinq.eclair.crypto.keymanager
 
 import com.typesafe.config.ConfigFactory
 import fr.acinq.bitcoin.psbt.Psbt
+import fr.acinq.bitcoin.scalacompat.Crypto.TaprootTweak.KeyPathTweak
 import fr.acinq.bitcoin.scalacompat.DeterministicWallet._
 import fr.acinq.bitcoin.scalacompat.{Block, BlockHash, ByteVector64, Crypto, DeterministicWallet, MnemonicCode, Satoshi, Script, computeBIP84Address}
 import fr.acinq.eclair.TimestampSecond
@@ -225,8 +226,8 @@ class LocalOnChainKeyManager(override val walletName: String, seed: ByteVector,
             } else if (pub != KotlinUtils.scala2kmp(expectedKey.xOnly)) {
               logger.warn(s"public key mismatch (expected=$expectedKey, actual=$pub): bitcoin core may be malicious")
               false
-            } else if (txOut.publicKeyScript != KotlinUtils.scala2kmp(Script.write(Script.pay2tr(expectedKey.xOnly, None)))) {
-              logger.warn(s"script mismatch (expected=${Script.write(Script.pay2tr(expectedKey.xOnly, None))}, actual=${txOut.publicKeyScript}): bitcoin core may be malicious")
+            } else if (txOut.publicKeyScript != KotlinUtils.scala2kmp(Script.write(Script.pay2tr(expectedKey.xOnly, KeyPathTweak)))) {
+              logger.warn(s"script mismatch (expected=${Script.write(Script.pay2tr(expectedKey.xOnly, KeyPathTweak))}, actual=${txOut.publicKeyScript}): bitcoin core may be malicious")
               false
             } else {
               true
@@ -306,7 +307,7 @@ class LocalOnChainKeyManager(override val walletName: String, seed: ByteVector,
     val (pub, keypath) = input.getTaprootDerivationPaths.asScala.toSeq.head
     val priv = fr.acinq.bitcoin.DeterministicWallet.derivePrivateKey(master.priv, keypath.keyPath).getPrivateKey
     require(priv.publicKey().xOnly() == pub, s"derived public key doesn't match (expected=$pub actual=${priv.publicKey().xOnly()}): bitcoin core may be malicious")
-    val expectedScript = Script.write(Script.pay2tr(pub, None))
+    val expectedScript = Script.write(Script.pay2tr(pub, KeyPathTweak))
     require(kmp2scala(input.getWitnessUtxo.publicKeyScript) == expectedScript, s"script mismatch (expected=$expectedScript, actual=${input.getWitnessUtxo.publicKeyScript}): bitcoin core may be malicious")
 
     // No need to update the input, we can directly sign and finalize.

eclair-core/src/main/scala/fr/acinq/eclair/crypto/keymanager/LocalOnChainKeyManager.scala

@@ -345,7 +345,7 @@ object Scripts {
      * The key used matches the key for the matching node's main output.
      */
     def anchor(anchorKey: PublicKey): Seq[ScriptElt] = {
-      Script.pay2tr(anchorKey.xOnly, Some(anchorScriptTree))
+      Script.pay2tr(anchorKey.xOnly, anchorScriptTree)
     }
 
     /**
@@ -389,7 +389,7 @@ object Scripts {
      * Script used for the main balance of the owner of the commitment transaction.
      */
     def toLocal(keys: CommitmentPublicKeys, toSelfDelay: CltvExpiryDelta): Seq[ScriptElt] = {
-      Script.pay2tr(NUMS_POINT.xOnly, Some(toLocalScriptTree(keys, toSelfDelay).scriptTree))
+      Script.pay2tr(NUMS_POINT.xOnly, toLocalScriptTree(keys, toSelfDelay).scriptTree)
     }
 
     /**
@@ -417,7 +417,7 @@ object Scripts {
      * Script used for the main balance of the remote node in our commitment transaction.
      */
     def toRemote(keys: CommitmentPublicKeys): Seq[ScriptElt] = {
-      Script.pay2tr(NUMS_POINT.xOnly, Some(toRemoteScriptTree(keys)))
+      Script.pay2tr(NUMS_POINT.xOnly, toRemoteScriptTree(keys))
     }
 
     /**
@@ -533,7 +533,7 @@ object Scripts {
      * Script used for the output of pre-signed HTLC 2nd-stage transactions.
      */
     def htlcDelayed(keys: CommitmentPublicKeys, toSelfDelay: CltvExpiryDelta): Seq[ScriptElt] = {
-      Script.pay2tr(keys.revocationPublicKey.xOnly, Some(htlcDelayedScriptTree(keys, toSelfDelay)))
+      Script.pay2tr(keys.revocationPublicKey.xOnly, htlcDelayedScriptTree(keys, toSelfDelay))
     }
   }
 }

eclair-core/src/main/scala/fr/acinq/eclair/transactions/Scripts.scala

@@ -18,7 +18,7 @@ package fr.acinq.eclair.transactions
 
 import fr.acinq.bitcoin.SigHash._
 import fr.acinq.bitcoin.SigVersion._
-import fr.acinq.bitcoin.scalacompat.Crypto.{PrivateKey, PublicKey, XonlyPublicKey}
+import fr.acinq.bitcoin.scalacompat.Crypto.{PrivateKey, PublicKey, TaprootTweak, XonlyPublicKey}
 import fr.acinq.bitcoin.scalacompat.KotlinUtils._
 import fr.acinq.bitcoin.scalacompat._
 import fr.acinq.bitcoin.ScriptFlags
@@ -204,7 +204,7 @@ object Transactions {
      * @param scriptTree_opt the script tree must be known if there is one, even when spending via the key path.
      */
     case class TaprootKeyPath(internalKey: XonlyPublicKey, scriptTree_opt: Option[ScriptTree]) extends Taproot {
-      override val pubkeyScript: ByteVector = Script.write(Script.pay2tr(internalKey, scriptTree_opt))
+      override val pubkeyScript: ByteVector = Script.write(Script.pay2tr(internalKey, scriptTree_opt.map(TaprootTweak.ScriptPathTweak(_)).getOrElse(TaprootTweak.KeyPathTweak)))
     }
     /**
      * @param internalKey we need the internal key, even if we don't have the private key, to spend via a script path.
@@ -214,7 +214,7 @@ object Transactions {
     case class TaprootScriptPath(internalKey: XonlyPublicKey, scriptTree: ScriptTree, leafHash: ByteVector32) extends Taproot {
       val leaf: ScriptTree.Leaf = scriptTree.findScript(leafHash).getOrElse(throw new IllegalArgumentException("script tree must contain the provided leaf"))
       val redeemScript: ByteVector = leaf.getScript
-      override val pubkeyScript: ByteVector = Script.write(Script.pay2tr(internalKey, Some(scriptTree)))
+      override val pubkeyScript: ByteVector = Script.write(Script.pay2tr(internalKey, scriptTree))
     }
   }
   // @formatter:on

eclair-core/src/main/scala/fr/acinq/eclair/transactions/Transactions.scala

@@ -17,7 +17,7 @@
 package fr.acinq.eclair.wire.protocol
 
 import fr.acinq.bitcoin.Bech32
-import fr.acinq.bitcoin.scalacompat.Crypto.{PrivateKey, PublicKey, SchnorrTweak, XonlyPublicKey}
+import fr.acinq.bitcoin.scalacompat.Crypto.{PrivateKey, PublicKey, XonlyPublicKey}
 import fr.acinq.bitcoin.scalacompat.{Block, BlockHash, ByteVector32, ByteVector64, Crypto, LexicographicalOrdering}
 import fr.acinq.eclair.crypto.Sphinx.RouteBlinding.BlindedRoute
 import fr.acinq.eclair.wire.protocol.CommonCodecs.varint
@@ -500,7 +500,7 @@ object OfferTypes {
   def signSchnorr(tag: ByteVector, msg: ByteVector32, key: PrivateKey): ByteVector64 = {
     val h = hash(tag, msg)
     // NB: we don't add auxiliary random data to keep signatures deterministic.
-    Crypto.signSchnorr(h, key, SchnorrTweak.NoTweak)
+    Crypto.signSchnorr(h, key, None)
   }
 
   def verifySchnorr(tag: ByteVector, msg: ByteVector32, signature: ByteVector64, publicKey: PublicKey): Boolean = {

eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/OfferTypes.scala

@@ -19,6 +19,7 @@ package fr.acinq.eclair.blockchain
 import fr.acinq.bitcoin.TxIn.SEQUENCE_FINAL
 import fr.acinq.bitcoin.psbt.{KeyPathWithMaster, Psbt, TaprootBip32DerivationPath}
 import fr.acinq.bitcoin.scalacompat.Crypto.PublicKey
+import fr.acinq.bitcoin.scalacompat.Crypto.TaprootTweak.KeyPathTweak
 import fr.acinq.bitcoin.scalacompat.DeterministicWallet.KeyPath
 import fr.acinq.bitcoin.scalacompat.{Block, ByteVector64, KotlinUtils, OutPoint, Satoshi, SatoshiLong, Script, ScriptElt, ScriptWitness, Transaction, TxId, TxIn, TxOut}
 import fr.acinq.eclair.TestUtils.randomTxId
@@ -48,7 +49,7 @@ class DummyOnChainWallet extends OnChainWallet with OnChainAddressCache {
   override def onChainBalance()(implicit ec: ExecutionContext): Future[OnChainBalance] = Future.successful(OnChainBalance(1105 sat, 561 sat))
 
   override def getReceivePublicKeyScript(addressType: Option[AddressType] = None)(implicit ec: ExecutionContext): Future[Seq[ScriptElt]] = Future.successful(addressType match {
-    case Some(AddressType.P2tr) => Script.pay2tr(dummyReceivePubkey.xOnly)
+    case Some(AddressType.P2tr) => Script.pay2tr(dummyReceivePubkey.xOnly, KeyPathTweak)
     case _ => Script.pay2wpkh(dummyReceivePubkey)
   })
 
@@ -90,7 +91,7 @@ class DummyOnChainWallet extends OnChainWallet with OnChainAddressCache {
 
   override def doubleSpent(tx: Transaction)(implicit ec: ExecutionContext): Future[Boolean] = Future.successful(false)
 
-  override def getReceivePublicKeyScript(renew: Boolean): Seq[ScriptElt] = Script.pay2tr(dummyReceivePubkey.xOnly)
+  override def getReceivePublicKeyScript(renew: Boolean): Seq[ScriptElt] = Script.pay2tr(dummyReceivePubkey.xOnly, KeyPathTweak)
 }
 
 class SingleKeyOnChainWallet extends OnChainWallet with OnChainAddressCache {
@@ -104,7 +105,7 @@ class SingleKeyOnChainWallet extends OnChainWallet with OnChainAddressCache {
   private val p2wpkhScript = Script.pay2wpkh(p2wpkhPublicKey)
   private val bip86path = KeyPath("m/86'/1'/0'/0/0")
   private val p2trPublicKey = keyManager.derivePublicKey(bip86path)._1.xOnly
-  private val p2trScript = Script.pay2tr(p2trPublicKey, None)
+  private val p2trScript = Script.pay2tr(p2trPublicKey, KeyPathTweak)
 
   // We create a new dummy input transaction for every funding request.
   var inputs = Seq.empty[Transaction]

eclair-core/src/test/scala/fr/acinq/eclair/blockchain/DummyOnChainWallet.scala

@@ -21,6 +21,7 @@ import akka.pattern.pipe
 import akka.testkit.TestProbe
 import fr.acinq.bitcoin
 import fr.acinq.bitcoin.psbt.{Psbt, UpdateFailure}
+import fr.acinq.bitcoin.scalacompat.Crypto.TaprootTweak.KeyPathTweak
 import fr.acinq.bitcoin.scalacompat.Crypto.{PublicKey, der2compact}
 import fr.acinq.bitcoin.scalacompat.{Block, BlockHash, BlockId, Btc, BtcDouble, Crypto, DeterministicWallet, KotlinUtils, MilliBtcDouble, MnemonicCode, OP_DROP, OP_PUSHDATA, OutPoint, Satoshi, SatoshiLong, Script, ScriptWitness, Transaction, TxId, TxIn, TxOut, addressToPublicKeyScript, computeBIP84Address, computeP2WpkhAddress}
 import fr.acinq.bitcoin.{Bech32, SigHash, SigVersion}
@@ -458,7 +459,7 @@ class BitcoinCoreClientSpec extends TestKitBaseClass with BitcoindService with A
     }
     {
       // When sending to a p2tr, bitcoin core should add a p2tr change output.
-      val pubkeyScript = Script.pay2tr(pubKey.xOnly)
+      val pubkeyScript = Script.pay2tr(pubKey.xOnly, KeyPathTweak)
       val unsignedTx = Transaction(version = 2, Nil, Seq(TxOut(150_000 sat, pubkeyScript)), lockTime = 0)
       bitcoinClient.fundTransaction(unsignedTx, feeRate = FeeratePerByte(3 sat).perKw, changePosition = Some(1)).pipeTo(sender.ref)
       val tx = sender.expectMsgType[FundTransactionResponse].tx

eclair-core/src/test/scala/fr/acinq/eclair/blockchain/bitcoind/BitcoinCoreClientSpec.scala

@@ -1,6 +1,7 @@
 package fr.acinq.eclair.blockchain.bitcoind
 
 import akka.actor.typed.scaladsl.adapter.ClassicActorSystemOps
+import fr.acinq.bitcoin.scalacompat.Crypto.TaprootTweak.KeyPathTweak
 import fr.acinq.bitcoin.scalacompat.{Script, ScriptElt}
 import fr.acinq.eclair.blockchain.OnChainAddressGenerator
 import fr.acinq.eclair.blockchain.bitcoind.rpc.BitcoinCoreClient.AddressType
@@ -14,13 +15,13 @@ import scala.concurrent.{ExecutionContext, Future}
 class OnChainAddressRefresherSpec extends TestKitBaseClass with AnyFunSuiteLike {
 
   test("renew on-chain addresses") {
-    val finalPubkeyScript = new AtomicReference[Seq[ScriptElt]](Script.pay2tr(randomKey().xOnlyPublicKey()))
+    val finalPubkeyScript = new AtomicReference[Seq[ScriptElt]](Script.pay2tr(randomKey().xOnlyPublicKey(), KeyPathTweak))
     val renewedCount = new AtomicInteger(0)
     val generator = new OnChainAddressGenerator {
       override def getReceivePublicKeyScript(addressType: Option[AddressType] = None)(implicit ec: ExecutionContext): Future[Seq[ScriptElt]] = {
         renewedCount.incrementAndGet()
         Future.successful(addressType match {
-          case Some(AddressType.P2tr) => Script.pay2tr(randomKey().xOnlyPublicKey())
+          case Some(AddressType.P2tr) => Script.pay2tr(randomKey().xOnlyPublicKey(), KeyPathTweak)
           case _ => Script.pay2wpkh(randomKey().publicKey)
         })
       }

eclair-core/src/test/scala/fr/acinq/eclair/blockchain/bitcoind/OnChainAddressRefresherSpec.scala

@@ -23,6 +23,7 @@ import akka.testkit.TestProbe
 import com.softwaremill.quicklens.{ModifyPimp, QuicklensAt}
 import fr.acinq.bitcoin.psbt.Psbt
 import fr.acinq.bitcoin.scalacompat.Crypto.PublicKey
+import fr.acinq.bitcoin.scalacompat.Crypto.TaprootTweak.KeyPathTweak
 import fr.acinq.bitcoin.scalacompat.{Block, ByteVector32, ByteVector64, OP_1, OutPoint, Satoshi, SatoshiLong, Script, ScriptWitness, Transaction, TxHash, TxId, TxIn, TxOut, addressToPublicKeyScript}
 import fr.acinq.eclair.TestUtils.randomTxId
 import fr.acinq.eclair.blockchain.OnChainWallet.{FundTransactionResponse, ProcessPsbtResponse}
@@ -77,7 +78,7 @@ class InteractiveTxBuilderSpec extends TestKitBaseClass with AnyFunSuiteLike wit
   }
 
   private def createInput(channelId: ByteVector32, serialId: UInt64, amount: Satoshi): TxAddInput = {
-    val changeScript = Script.write(Script.pay2tr(randomKey().publicKey.xOnly))
+    val changeScript = Script.write(Script.pay2tr(randomKey().publicKey.xOnly, KeyPathTweak))
     val previousTx = Transaction(2, Nil, Seq(TxOut(amount, changeScript), TxOut(amount, changeScript), TxOut(amount, changeScript)), 0)
     TxAddInput(channelId, serialId, Some(previousTx), 1, 0)
   }
@@ -856,8 +857,8 @@ class InteractiveTxBuilderSpec extends TestKitBaseClass with AnyFunSuiteLike wit
       probe.expectMsg(txA1.txId)
 
       // Alice and Bob decide to splice funds out of the channel, and deduce on-chain fees from their new channel contribution.
-      val spliceOutputsA = List(TxOut(50_000 sat, Script.pay2tr(randomKey().xOnlyPublicKey())))
-      val spliceOutputsB = List(TxOut(30_000 sat, Script.pay2tr(randomKey().xOnlyPublicKey())))
+      val spliceOutputsA = List(TxOut(50_000 sat, Script.pay2tr(randomKey().xOnlyPublicKey(), KeyPathTweak)))
+      val spliceOutputsB = List(TxOut(30_000 sat, Script.pay2tr(randomKey().xOnlyPublicKey(), KeyPathTweak)))
       val subtractedFundingA = spliceOutputsA.map(_.amount).sum + 1_000.sat
       val subtractedFundingB = spliceOutputsB.map(_.amount).sum + 500.sat
       val (sharedInputA, sharedInputB) = fixtureParams.sharedInputs(commitmentA1, commitmentB1)
@@ -2558,7 +2559,7 @@ class InteractiveTxBuilderSpec extends TestKitBaseClass with AnyFunSuiteLike wit
       TxAddOutput(params.channelId, UInt64(1), 25_000 sat, Script.write(Script.pay2sh(OP_1 :: Nil))),
       TxAddOutput(params.channelId, UInt64(1), 25_000 sat, Script.write(Script.pay2wpkh(randomKey().publicKey))),
       TxAddOutput(params.channelId, UInt64(1), 25_000 sat, Script.write(Script.pay2wsh(OP_1 :: Nil))),
-      TxAddOutput(params.channelId, UInt64(1), 25_000 sat, Script.write(Script.pay2tr(randomKey().xOnlyPublicKey()))),
+      TxAddOutput(params.channelId, UInt64(1), 25_000 sat, Script.write(Script.pay2tr(randomKey().xOnlyPublicKey(), KeyPathTweak))),
     )
     testCases.foreach { output =>
       val alice = params.spawnTxBuilderAlice(wallet)
@@ -2775,7 +2776,7 @@ class InteractiveTxBuilderSpec extends TestKitBaseClass with AnyFunSuiteLike wit
     bob ! Start(probe.ref)
     // Alice --- tx_add_input --> Bob
     // The input only includes the previous txOut which is only allowed for taproot channels.
-    bob ! ReceiveMessage(TxAddInput(params.channelId, UInt64(0), None, 0, 0, TlvStream(TxAddInputTlv.PrevTxOut(randomTxId(), 100_000 sat, Script.write(Script.pay2tr(randomKey().xOnlyPublicKey()))))))
+    bob ! ReceiveMessage(TxAddInput(params.channelId, UInt64(0), None, 0, 0, TlvStream(TxAddInputTlv.PrevTxOut(randomTxId(), 100_000 sat, Script.write(Script.pay2tr(randomKey().xOnlyPublicKey(), KeyPathTweak))))))
     assert(probe.expectMsgType[RemoteFailure].cause == PreviousTxMissing(params.channelId, UInt64(0)))
   }
 

eclair-core/src/test/scala/fr/acinq/eclair/channel/InteractiveTxBuilderSpec.scala

@@ -1,6 +1,7 @@
 package fr.acinq.eclair.crypto.keymanager
 
 import fr.acinq.bitcoin.psbt.{KeyPathWithMaster, Psbt, TaprootBip32DerivationPath}
+import fr.acinq.bitcoin.scalacompat.Crypto.TaprootTweak.KeyPathTweak
 import fr.acinq.bitcoin.scalacompat.{Block, DeterministicWallet, MnemonicCode, OutPoint, Satoshi, Script, ScriptElt, Transaction, TxIn, TxOut}
 import fr.acinq.bitcoin.{ScriptFlags, SigHash}
 import fr.acinq.eclair.{TimestampSecond, randomBytes32}
@@ -130,9 +131,9 @@ class LocalOnChainKeyManagerSpec extends AnyFunSuite {
     def getPublicKey(index: Long) = DeterministicWallet.derivePublicKey(mainPub, index).publicKey.xOnly
 
     val utxos = Seq(
-      Transaction(version = 2, txIn = Nil, txOut = TxOut(Satoshi(1_000_000), Script.pay2tr(getPublicKey(0), None)) :: Nil, lockTime = 0),
-      Transaction(version = 2, txIn = Nil, txOut = TxOut(Satoshi(1_100_000), Script.pay2tr(getPublicKey(1), None)) :: Nil, lockTime = 0),
-      Transaction(version = 2, txIn = Nil, txOut = TxOut(Satoshi(1_200_000), Script.pay2tr(getPublicKey(2), None)) :: Nil, lockTime = 0),
+      Transaction(version = 2, txIn = Nil, txOut = TxOut(Satoshi(1_000_000), Script.pay2tr(getPublicKey(0), KeyPathTweak)) :: Nil, lockTime = 0),
+      Transaction(version = 2, txIn = Nil, txOut = TxOut(Satoshi(1_100_000), Script.pay2tr(getPublicKey(1), KeyPathTweak)) :: Nil, lockTime = 0),
+      Transaction(version = 2, txIn = Nil, txOut = TxOut(Satoshi(1_200_000), Script.pay2tr(getPublicKey(2), KeyPathTweak)) :: Nil, lockTime = 0),
     )
     val bip32paths = Seq(
       new TaprootBip32DerivationPath(java.util.List.of(), 0, new fr.acinq.bitcoin.KeyPath("m/86'/1'/0'/0/0")),
@@ -142,7 +143,7 @@ class LocalOnChainKeyManagerSpec extends AnyFunSuite {
 
     val tx = Transaction(version = 2,
       txIn = utxos.map(tx => TxIn(OutPoint(tx, 0), Nil, fr.acinq.bitcoin.TxIn.SEQUENCE_FINAL)),
-      txOut = TxOut(Satoshi(1000_000), Script.pay2tr(getPublicKey(0), None)) :: Nil, lockTime = 0)
+      txOut = TxOut(Satoshi(1000_000), Script.pay2tr(getPublicKey(0), KeyPathTweak)) :: Nil, lockTime = 0)
 
     val Right(psbt) = for {
       p0 <- new Psbt(tx).updateWitnessInput(OutPoint(utxos(0), 0), utxos(0).txOut(0), null, null, null, java.util.Map.of(), null, getPublicKey(0), java.util.Map.of(getPublicKey(0), bip32paths(0)))