Merge pull request #20 from tcharding/02-01-release-beta

Release tracking PR: `v0.1.0-beta.0`
tcharding · Feb 2, 2024 · 5bbcff6 · 5bbcff6
2 parents 470babb + 8ab46ea
commit 5bbcff6
Show file tree

Hide file tree

Showing 11 changed files with 44 additions and 38 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,6 @@
+# 0.1.0-beta.0 - 2024-02-02
+
+The initial beta release. The aim of this release is to make the new PSBT v2 API available for beta
+testing. Currently we expose the v0 API pretty much as it is in `rust-bitcoin` and `rust-miniscript`.
+
+Enjoy!
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,12 +1,12 @@
 [package]
-name = "psbt"
-version = "0.1.0"
+name = "psbt-v2"
+version = "0.1.0-beta.0"
 authors = ["Tobin C. Harding <[email protected]>"]
 license = "CC0-1.0"
 repository = "https://github.com/tcharding/rust-psbt/"
 description = "Partially Signed Bitcoin Transaction, v0 and v2"
 categories = ["cryptography::cryptocurrencies"]
-keywords = [ "crypto", "bitcoin" ]
+keywords = [ "bitcoin", "psbt", "bip-174", "bip-370" ]
 readme = "README.md"
 edition = "2021"
 rust-version = "1.56.1"

diff --git a/examples/v0.rs b/examples/v0.rs
@@ -8,15 +8,15 @@
 
 use std::collections::BTreeMap;
 
-use psbt::bitcoin::hashes::Hash as _;
-use psbt::bitcoin::locktime::absolute;
-use psbt::bitcoin::opcodes::all::OP_CHECKMULTISIG;
-use psbt::bitcoin::secp256k1::{self, rand, SECP256K1};
-use psbt::bitcoin::{
+use psbt_v2::bitcoin::hashes::Hash as _;
+use psbt_v2::bitcoin::locktime::absolute;
+use psbt_v2::bitcoin::opcodes::all::OP_CHECKMULTISIG;
+use psbt_v2::bitcoin::secp256k1::{self, rand, SECP256K1};
+use psbt_v2::bitcoin::{
     script, transaction, Address, Amount, Network, OutPoint, PublicKey, ScriptBuf, Sequence,
     Transaction, TxIn, TxOut, Txid, Witness,
 };
-use psbt::v0::{self, Psbt};
+use psbt_v2::v0::{self, Psbt};
 
 pub const DUMMY_UTXO_AMOUNT: Amount = Amount::from_sat(20_000_000);
 pub const SPEND_AMOUNT: Amount = Amount::from_sat(20_000_000);

diff --git a/examples/v2-separate-creator-constructor.rs b/examples/v2-separate-creator-constructor.rs
@@ -1,8 +1,8 @@
 //! PSBT v2 - Creator a PSBT and hand it around to various different entities to add inputs and outputs.
 
-use psbt::bitcoin::hashes::Hash as _;
-use psbt::bitcoin::{Amount, OutPoint, ScriptBuf, TxOut, Txid};
-use psbt::v2::{
+use psbt_v2::bitcoin::hashes::Hash as _;
+use psbt_v2::bitcoin::{Amount, OutPoint, ScriptBuf, TxOut, Txid};
+use psbt_v2::v2::{
     Constructor, Creator, InputBuilder, InputsOnlyModifiable, OutputBuilder, OutputsOnlyModifiable,
     Psbt,
 };

diff --git a/examples/v2.rs b/examples/v2.rs
@@ -10,15 +10,15 @@
 
 use std::str::FromStr;
 
-use psbt::bitcoin::bip32::{DerivationPath, KeySource, Xpriv, Xpub};
-use psbt::bitcoin::hashes::Hash as _;
-use psbt::bitcoin::locktime::absolute;
-use psbt::bitcoin::opcodes::all::OP_CHECKMULTISIG;
-use psbt::bitcoin::secp256k1::{self, SECP256K1};
-use psbt::bitcoin::{
+use psbt_v2::bitcoin::bip32::{DerivationPath, KeySource, Xpriv, Xpub};
+use psbt_v2::bitcoin::hashes::Hash as _;
+use psbt_v2::bitcoin::locktime::absolute;
+use psbt_v2::bitcoin::opcodes::all::OP_CHECKMULTISIG;
+use psbt_v2::bitcoin::secp256k1::{self, SECP256K1};
+use psbt_v2::bitcoin::{
     script, Address, Amount, Network, OutPoint, PublicKey, ScriptBuf, Sequence, TxOut, Txid,
 };
-use psbt::v2::{
+use psbt_v2::v2::{
     self, Constructor, InputBuilder, Modifiable, Output, OutputBuilder, Psbt, Signer, Updater,
 };
 

diff --git a/src/v0/miniscript/mod.rs b/src/v0/miniscript/mod.rs
@@ -851,7 +851,7 @@ trait PsbtFields {
     // `tap_tree` only appears in Output, so it's returned as an option of a mutable ref
     fn tap_tree(&mut self) -> Option<&mut Option<TapTree>> { None }
 
-    // `tap_scripts` and `tap_merkle_root` only appear in psbt::Input
+    // `tap_scripts` and `tap_merkle_root` only appear in psbt_v2::Input
     fn tap_scripts(&mut self) -> Option<&mut BTreeMap<ControlBlock, (ScriptBuf, LeafVersion)>> {
         None
     }

diff --git a/src/v2/mod.rs b/src/v2/mod.rs
@@ -143,7 +143,7 @@ impl Creator {
     /// # Examples
     ///
     /// ```
-    /// use psbt::v2::{Creator, Constructor, Modifiable};
+    /// use psbt_v2::v2::{Creator, Constructor, Modifiable};
     ///
     /// // Creator role separate from Constructor role.
     /// let psbt = Creator::new()
@@ -170,7 +170,7 @@ impl Creator {
     /// # Examples
     ///
     /// ```
-    /// use psbt::v2::{Creator, Constructor, InputsOnlyModifiable};
+    /// use psbt_v2::v2::{Creator, Constructor, InputsOnlyModifiable};
     ///
     /// // Creator role separate from Constructor role.
     /// let psbt = Creator::new()
@@ -196,7 +196,7 @@ impl Creator {
     /// # Examples
     ///
     /// ```
-    /// use psbt::v2::{Creator, Constructor, OutputsOnlyModifiable};
+    /// use psbt_v2::v2::{Creator, Constructor, OutputsOnlyModifiable};
     ///
     /// // Creator role separate from Constructor role.
     /// let psbt = Creator::new()

diff --git a/tests/bip174-signer-checks.rs b/tests/bip174-signer-checks.rs
@@ -12,7 +12,7 @@ mod util;
 
 use std::str::FromStr;
 
-use psbt::v0;
+use psbt_v2::v0;
 
 #[track_caller]
 fn assert_fails_signer_checks_v0(hex: &str, base64: &str) {

diff --git a/tests/bip174.rs b/tests/bip174.rs
@@ -8,19 +8,19 @@ use std::collections::BTreeMap;
 use std::convert::TryFrom;
 use std::str::FromStr;
 
-use psbt::bitcoin::bip32::{Fingerprint, IntoDerivationPath, KeySource, Xpriv, Xpub};
-use psbt::bitcoin::blockdata::opcodes::OP_0;
-use psbt::bitcoin::blockdata::{script, transaction};
-use psbt::bitcoin::consensus::encode::{deserialize, serialize_hex};
-use psbt::bitcoin::hex::FromHex;
-use psbt::bitcoin::script::PushBytes;
-use psbt::bitcoin::secp256k1::{self, Secp256k1};
-use psbt::bitcoin::{
+use psbt_v2::bitcoin::bip32::{Fingerprint, IntoDerivationPath, KeySource, Xpriv, Xpub};
+use psbt_v2::bitcoin::blockdata::opcodes::OP_0;
+use psbt_v2::bitcoin::blockdata::{script, transaction};
+use psbt_v2::bitcoin::consensus::encode::{deserialize, serialize_hex};
+use psbt_v2::bitcoin::hex::FromHex;
+use psbt_v2::bitcoin::script::PushBytes;
+use psbt_v2::bitcoin::secp256k1::{self, Secp256k1};
+use psbt_v2::bitcoin::{
     absolute, Amount, Denomination, Network, OutPoint, PrivateKey, PublicKey, ScriptBuf, Sequence,
     Transaction, TxIn, TxOut, Witness,
 };
-use psbt::v0::{self, Psbt};
-use psbt::PsbtSighashType;
+use psbt_v2::v0::{self, Psbt};
+use psbt_v2::PsbtSighashType;
 
 const NETWORK: Network = Network::Testnet;
 

diff --git a/tests/bip370-determine-lock-time.rs b/tests/bip370-determine-lock-time.rs
@@ -6,8 +6,8 @@ mod util;
 
 use core::str::FromStr;
 
-use psbt::bitcoin::locktime::absolute;
-use psbt::v2;
+use psbt_v2::bitcoin::locktime::absolute;
+use psbt_v2::v2;
 
 #[track_caller]
 fn assert_determine_lock_time(hex: &str, base64: &str, want: absolute::LockTime) {

diff --git a/tests/util.rs b/tests/util.rs
@@ -4,8 +4,8 @@
 
 use core::str::FromStr;
 
-use psbt::bitcoin::hex::{self, FromHex};
-use psbt::{v0, v2};
+use psbt_v2::bitcoin::hex::{self, FromHex};
+use psbt_v2::{v0, v2};
 
 #[track_caller]
 pub fn hex_psbt_v0(s: &str) -> Result<v0::Psbt, v0::DeserializeError> {