Inline script_pubkey ScriptBuf extension trait

tcharding · tcharding · commit 25e1d8d23d6c · 2025-07-03T14:02:47.000+10:00
The separation of extension traits into the `script_pubkey` module
does not assist clarity and makes it less ergonomic for users having
to import traits from different locations. We can put these methods on
the `script::ScriptBufExt` and fix both issues.

Once this is done we can remove the `script_pubkey` module entirely.
diff --git a/bitcoin/examples/ecdsa-psbt-simple.rs b/bitcoin/examples/ecdsa-psbt-simple.rs
@@ -24,11 +24,11 @@
 //! The miner's fee will be 10,000 satoshis.
 use std::collections::BTreeMap;
 
-use bitcoin::address::script_pubkey::ScriptBufExt as _;
 use bitcoin::bip32::{ChildNumber, DerivationPath, Fingerprint, IntoDerivationPath, Xpriv, Xpub};
 use bitcoin::key::WPubkeyHash;
 use bitcoin::locktime::absolute;
 use bitcoin::psbt::Input;
+use bitcoin::script::ScriptBufExt as _;
 use bitcoin::secp256k1::{Secp256k1, Signing};
 use bitcoin::witness::WitnessExt as _;
 use bitcoin::{
diff --git a/bitcoin/examples/ecdsa-psbt.rs b/bitcoin/examples/ecdsa-psbt.rs
@@ -31,7 +31,6 @@
 use std::collections::BTreeMap;
 use std::fmt;
 
-use bitcoin::address::script_pubkey::ScriptBufExt as _;
 use bitcoin::bip32::{ChildNumber, DerivationPath, Fingerprint, IntoDerivationPath, Xpriv, Xpub};
 use bitcoin::consensus::encode;
 use bitcoin::consensus_validation::TransactionExt as _;
diff --git a/bitcoin/examples/sighash.rs b/bitcoin/examples/sighash.rs
@@ -1,5 +1,4 @@
-use bitcoin::address::script_pubkey::ScriptBufExt as _;
-use bitcoin::script::ScriptExt as _;
+use bitcoin::script::{ScriptBufExt as _, ScriptExt as _};
 use bitcoin::{
     consensus, ecdsa, sighash, Amount, CompressedPublicKey, Script, ScriptBuf, Transaction,
 };
diff --git a/bitcoin/examples/sign-tx-segwit-v0.rs b/bitcoin/examples/sign-tx-segwit-v0.rs
@@ -2,9 +2,9 @@
 
 //! Demonstrate creating a transaction that spends to and from p2wpkh outputs.
 
-use bitcoin::address::script_pubkey::ScriptBufExt as _;
 use bitcoin::key::WPubkeyHash;
 use bitcoin::locktime::absolute;
+use bitcoin::script::ScriptBufExt as _;
 use bitcoin::secp256k1::{rand, Message, Secp256k1, SecretKey, Signing};
 use bitcoin::sighash::{EcdsaSighashType, SighashCache};
 use bitcoin::witness::WitnessExt as _;
diff --git a/bitcoin/examples/sign-tx-taproot.rs b/bitcoin/examples/sign-tx-taproot.rs
@@ -2,9 +2,9 @@
 
 //! Demonstrate creating a transaction that spends to and from p2tr outputs.
 
-use bitcoin::address::script_pubkey::ScriptBufExt as _;
 use bitcoin::key::{Keypair, TapTweak, TweakedKeypair, UntweakedPublicKey};
 use bitcoin::locktime::absolute;
+use bitcoin::script::ScriptBufExt as _;
 use bitcoin::secp256k1::{rand, Message, Secp256k1, SecretKey, Signing, Verification};
 use bitcoin::sighash::{Prevouts, SighashCache, TapSighashType};
 use bitcoin::witness::WitnessExt as _;
diff --git a/bitcoin/examples/taproot-psbt-simple.rs b/bitcoin/examples/taproot-psbt-simple.rs
@@ -22,11 +22,11 @@
 //! The miner's fee will be 10,000 satoshis.
 use std::collections::BTreeMap;
 
-use bitcoin::address::script_pubkey::ScriptBufExt as _;
 use bitcoin::bip32::{ChildNumber, DerivationPath, Fingerprint, IntoDerivationPath, Xpriv, Xpub};
 use bitcoin::key::UntweakedPublicKey;
 use bitcoin::locktime::absolute;
 use bitcoin::psbt::Input;
+use bitcoin::script::ScriptBufExt as _;
 use bitcoin::secp256k1::{Secp256k1, Signing};
 use bitcoin::witness::WitnessExt as _;
 use bitcoin::{
diff --git a/bitcoin/examples/taproot-psbt.rs b/bitcoin/examples/taproot-psbt.rs
@@ -77,7 +77,6 @@ const UTXO_3: P2trUtxo = P2trUtxo {
 
 use std::collections::BTreeMap;
 
-use bitcoin::address::script_pubkey::ScriptBufExt as _;
 use bitcoin::bip32::{ChildNumber, DerivationPath, Fingerprint, Xpriv, Xpub};
 use bitcoin::consensus::encode;
 use bitcoin::consensus_validation::TransactionExt as _;
diff --git a/bitcoin/src/address/mod.rs b/bitcoin/src/address/mod.rs
@@ -40,7 +40,6 @@
 //! ```
 
 pub mod error;
-pub mod script_pubkey;
 
 use core::fmt;
 use core::marker::PhantomData;
@@ -52,7 +51,6 @@ use hashes::{hash160, HashEngine};
 use internals::array::ArrayExt;
 use secp256k1::{Secp256k1, Verification};
 
-use crate::address::script_pubkey::ScriptBufExt as _;
 use crate::constants::{
     PUBKEY_ADDRESS_PREFIX_MAIN, PUBKEY_ADDRESS_PREFIX_TEST, SCRIPT_ADDRESS_PREFIX_MAIN,
     SCRIPT_ADDRESS_PREFIX_TEST,
@@ -66,8 +64,8 @@ use crate::prelude::{String, ToOwned};
 use crate::script::witness_program::WitnessProgram;
 use crate::script::witness_version::WitnessVersion;
 use crate::script::{
-    self, RedeemScriptSizeError, Script, ScriptBuf, ScriptExt as _, ScriptHash, WScriptHash,
-    WitnessScriptSizeError,
+    self, RedeemScriptSizeError, Script, ScriptBuf, ScriptBufExt as _, ScriptExt as _, ScriptHash,
+    WScriptHash, WitnessScriptSizeError,
 };
 use crate::taproot::TapNodeHash;
 
@@ -714,7 +712,7 @@ impl Address {
             Segwit { ref program, hrp: _ } => {
                 let prog = program.program();
                 let version = program.version();
-                script_pubkey::new_witness_program_unchecked(version, prog)
+                script::new_witness_program_unchecked(version, prog)
             }
         }
     }
@@ -1022,7 +1020,6 @@ mod tests {
     use super::*;
     use crate::network::Network::{Bitcoin, Testnet};
     use crate::network::{params, TestnetVersion};
-    use crate::script::ScriptBufExt as _;
 
     fn roundtrips(addr: &Address, network: Network) {
         assert_eq!(
diff --git a/bitcoin/src/address/script_pubkey.rs b/bitcoin/src/address/script_pubkey.rs
diff --git a/bitcoin/src/blockdata/script/borrowed.rs b/bitcoin/src/blockdata/script/borrowed.rs
@@ -12,15 +12,15 @@ use super::{
     Builder, Instruction, InstructionIndices, Instructions, PushBytes, RedeemScriptSizeError,
     ScriptHash, WScriptHash, WitnessScriptSizeError,
 };
-use crate::address::script_pubkey::ScriptBufExt as _;
 use crate::consensus::{self, Encodable};
 use crate::key::{PublicKey, UntweakedPublicKey, WPubkeyHash};
 use crate::opcodes::all::*;
 use crate::opcodes::{self, Opcode};
 use crate::policy::{DUST_RELAY_TX_FEE, MAX_OP_RETURN_RELAY};
 use crate::prelude::{sink, String, ToString};
+use crate::script::{self, ScriptBufExt as _};
 use crate::taproot::{LeafVersion, TapLeafHash, TapNodeHash};
-use crate::{script, Amount, FeeRate, ScriptBuf};
+use crate::{Amount, FeeRate, ScriptBuf};
 
 #[rustfmt::skip]            // Keep public re-exports separate.
 #[doc(inline)]
diff --git a/bitcoin/src/blockdata/script/mod.rs b/bitcoin/src/blockdata/script/mod.rs
@@ -62,6 +62,7 @@ use core::fmt;
 
 use io::{BufRead, Write};
 
+use self::witness_version::WitnessVersion;
 use crate::consensus::{encode, Decodable, Encodable};
 use crate::internal_macros::impl_asref_push_bytes;
 use crate::key::WPubkeyHash;
@@ -192,6 +193,21 @@ fn opcode_to_verify(opcode: Option<Opcode>) -> Option<Opcode> {
     })
 }
 
+/// Generates P2WSH-type of scriptPubkey with a given [`WitnessVersion`] and the program bytes.
+/// Does not do any checks on version or program length.
+///
+/// Convenience method used by `new_p2a`, `new_p2wpkh`, `new_p2wsh`, `new_p2tr`, and `new_p2tr_tweaked`.
+pub(crate) fn new_witness_program_unchecked<T: AsRef<PushBytes>>(
+    version: WitnessVersion,
+    program: T,
+) -> ScriptBuf {
+    let program = program.as_ref();
+    debug_assert!(program.len() >= 2 && program.len() <= 40);
+    // In SegWit v0, the program must be either 20 bytes (P2WPKH) or 32 bytes (P2WSH) long.
+    debug_assert!(version != WitnessVersion::V0 || program.len() == 20 || program.len() == 32);
+    Builder::new().push_opcode(version.into()).push_slice(program).into_script()
+}
+
 impl Encodable for Script {
     #[inline]
     fn consensus_encode<W: Write + ?Sized>(&self, w: &mut W) -> Result<usize, io::Error> {
diff --git a/bitcoin/src/blockdata/script/owned.rs b/bitcoin/src/blockdata/script/owned.rs
@@ -5,12 +5,20 @@ use core::ops::Deref;
 
 use hex::FromHex as _;
 use internals::ToU64 as _;
+use secp256k1::{Secp256k1, Verification};
 
 use super::{opcode_to_verify, Builder, Instruction, PushBytes, ScriptExtPriv as _};
 use crate::consensus;
+use crate::key::{
+    PubkeyHash, PublicKey, TapTweak, TweakedPublicKey, UntweakedPublicKey, WPubkeyHash,
+};
 use crate::opcodes::all::*;
 use crate::opcodes::{self, Opcode};
 use crate::prelude::Vec;
+use crate::script::witness_program::{WitnessProgram, P2A_PROGRAM};
+use crate::script::witness_version::WitnessVersion;
+use crate::script::{self, ScriptHash, WScriptHash};
+use crate::taproot::TapNodeHash;
 
 #[rustfmt::skip]            // Keep public re-exports separate.
 #[doc(inline)]
@@ -27,6 +35,75 @@ crate::internal_macros::define_extension_trait! {
             Builder::new().push_opcode(OP_RETURN).push_slice(data).into_script()
         }
 
+        /// Generates P2PK-type of scriptPubkey.
+        fn new_p2pk(pubkey: PublicKey) -> Self {
+            Builder::new().push_key(pubkey).push_opcode(OP_CHECKSIG).into_script()
+        }
+
+        /// Generates P2PKH-type of scriptPubkey.
+        fn new_p2pkh(pubkey_hash: PubkeyHash) -> Self {
+            Builder::new()
+                .push_opcode(OP_DUP)
+                .push_opcode(OP_HASH160)
+                .push_slice(pubkey_hash)
+                .push_opcode(OP_EQUALVERIFY)
+                .push_opcode(OP_CHECKSIG)
+                .into_script()
+        }
+
+        /// Generates P2SH-type of scriptPubkey with a given hash of the redeem script.
+        fn new_p2sh(script_hash: ScriptHash) -> Self {
+            Builder::new()
+                .push_opcode(OP_HASH160)
+                .push_slice(script_hash)
+                .push_opcode(OP_EQUAL)
+                .into_script()
+        }
+
+        /// Generates P2WPKH-type of scriptPubkey.
+        fn new_p2wpkh(pubkey_hash: WPubkeyHash) -> Self {
+            // pubkey hash is 20 bytes long, so it's safe to use `new_witness_program_unchecked` (Segwitv0)
+            script::new_witness_program_unchecked(WitnessVersion::V0, pubkey_hash)
+        }
+
+        /// Generates P2WSH-type of scriptPubkey with a given hash of the redeem script.
+        fn new_p2wsh(script_hash: WScriptHash) -> Self {
+            // script hash is 32 bytes long, so it's safe to use `new_witness_program_unchecked` (Segwitv0)
+            script::new_witness_program_unchecked(WitnessVersion::V0, script_hash)
+        }
+
+        /// Generates P2TR for script spending path using an internal public key and some optional
+        /// script tree Merkle root.
+        fn new_p2tr<C: Verification, K: Into<UntweakedPublicKey>>(
+            secp: &Secp256k1<C>,
+            internal_key: K,
+            merkle_root: Option<TapNodeHash>,
+        ) -> Self {
+            let internal_key = internal_key.into();
+            let (output_key, _) = internal_key.tap_tweak(secp, merkle_root);
+            // output key is 32 bytes long, so it's safe to use `new_witness_program_unchecked` (Segwitv1)
+            script::new_witness_program_unchecked(WitnessVersion::V1, output_key.serialize())
+        }
+
+        /// Generates P2TR for key spending path for a known [`TweakedPublicKey`].
+        fn new_p2tr_tweaked(output_key: TweakedPublicKey) -> Self {
+            // output key is 32 bytes long, so it's safe to use `new_witness_program_unchecked` (Segwitv1)
+            script::new_witness_program_unchecked(WitnessVersion::V1, output_key.serialize())
+        }
+
+        /// Generates pay to anchor output.
+        fn new_p2a() -> Self {
+            script::new_witness_program_unchecked(WitnessVersion::V1, P2A_PROGRAM)
+        }
+
+        /// Generates P2WSH-type of scriptPubkey with a given [`WitnessProgram`].
+        fn new_witness_program(witness_program: &WitnessProgram) -> Self {
+            Builder::new()
+                .push_opcode(witness_program.version().into())
+                .push_slice(witness_program.program())
+                .into_script()
+        }
+
         /// Constructs a new [`ScriptBuf`] from a hex string.
         ///
         /// The input string is expected to be consensus encoded i.e., includes the length prefix.
diff --git a/bitcoin/src/blockdata/script/tests.rs b/bitcoin/src/blockdata/script/tests.rs
diff --git a/bitcoin/src/psbt/mod.rs b/bitcoin/src/psbt/mod.rs
