Merge pull request #524 from jamillambert/0226-scriptpubkey-capitalization

Use consistent capitalization for (Script)PubKey

Author: tcharding

types/src/lib.rs

@@ -174,11 +174,11 @@ pub fn compact_size_decode(slice: &mut &[u8]) -> u64 {
 ///
 /// This is used by methods in the blockchain section and in the raw transaction section (i.e raw
 /// transaction and psbt methods). The shape changed in Core v22 but the new shape is fully
-/// backwards compatible so we only provide it not a v0.17 specific type. The `mtype::ScriptPubkey`
+/// backwards compatible so we only provide it not a v0.17 specific type. The `mtype::ScriptPubKey`
 /// mirrors this design (but with concrete `rust-bitcoin` types).
 #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
 #[cfg_attr(feature = "serde-deny-unknown-fields", serde(deny_unknown_fields))]
-pub struct ScriptPubkey {
+pub struct ScriptPubKey {
     /// Script assembly.
     pub asm: String,
     /// Inferred descriptor for the output. v23 and later only.
@@ -204,9 +204,9 @@ pub struct ScriptPubkey {
     pub addresses: Option<Vec<String>>,
 }
 
-/// Error when converting a `ScriptPubkey` type into the model type.
+/// Error when converting a `ScriptPubKey` type into the model type.
 #[derive(Debug)]
-pub enum ScriptPubkeyError {
+pub enum ScriptPubKeyError {
     /// Conversion of the `hex` field failed.
     Hex(hex::HexToBytesError),
     /// Conversion of the `address` field failed.
@@ -215,7 +215,7 @@ pub enum ScriptPubkeyError {
     Addresses(address::ParseError),
 }
 
-impl fmt::Display for ScriptPubkeyError {
+impl fmt::Display for ScriptPubKeyError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match *self {
             Self::Hex(ref e) => write_err!(f, "conversion of the `hex` field failed"; e),
@@ -227,7 +227,7 @@ impl fmt::Display for ScriptPubkeyError {
 }
 
 #[cfg(feature = "std")]
-impl std::error::Error for ScriptPubkeyError {
+impl std::error::Error for ScriptPubKeyError {
     fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
         match *self {
             Self::Hex(ref e) => Some(e),
@@ -237,7 +237,7 @@ impl std::error::Error for ScriptPubkeyError {
     }
 }
 
-impl ScriptPubkey {
+impl ScriptPubKey {
     fn script_buf(&self) -> Result<ScriptBuf, hex::HexToBytesError> {
         ScriptBuf::from_hex(&self.hex)
     }
@@ -247,8 +247,8 @@ impl ScriptPubkey {
     }
 
     /// Converts version specific type to a version nonspecific, more strongly typed type.
-    pub fn into_model(self) -> Result<model::ScriptPubkey, ScriptPubkeyError> {
-        use ScriptPubkeyError as E;
+    pub fn into_model(self) -> Result<model::ScriptPubKey, ScriptPubKeyError> {
+        use ScriptPubKeyError as E;
 
         let script_pubkey = ScriptBuf::from_hex(&self.hex).map_err(E::Hex)?;
 
@@ -264,7 +264,7 @@ impl ScriptPubkey {
             })
             .transpose()?;
 
-        Ok(model::ScriptPubkey {
+        Ok(model::ScriptPubKey {
             script_pubkey,
             required_signatures: self.required_signatures,
             address,

types/src/model/blockchain.rs

@@ -15,7 +15,7 @@ use bitcoin::{
 };
 use serde::{Deserialize, Serialize};
 
-use super::{GetRawTransactionVerbose, ScriptPubkey};
+use super::{GetRawTransactionVerbose, ScriptPubKey};
 
 /// Models the result of JSON-RPC method `dumptxoutset`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
@@ -202,7 +202,7 @@ pub struct GetBlockVerboseThreePrevout {
     /// The value in BTC.
     pub value: Amount,
     /// The script pubkey.
-    pub script_pubkey: ScriptPubkey,
+    pub script_pubkey: ScriptPubKey,
 }
 
 /// Models the result of JSON-RPC method `getblockchaininfo`.
@@ -636,7 +636,7 @@ pub struct SpendActivity {
     /// The vout of the prevout.
     pub prevout_vout: u32,
     /// The prev scriptPubKey.
-    pub prevout_spk: ScriptPubkey,
+    pub prevout_spk: ScriptPubKey,
 }
 
 /// Models a 'receive' activity event. Part of `getdescriptoractivity`
@@ -653,7 +653,7 @@ pub struct ReceiveActivity {
     /// The vout of the receiving output.
     pub vout: u32,
     /// The ScriptPubKey.
-    pub output_spk: ScriptPubkey,
+    pub output_spk: ScriptPubKey,
 }
 
 /// Models the result of JSON-RPC method `getdifficulty`.

types/src/model/mod.rs

@@ -85,7 +85,7 @@ pub use self::{
 /// transaction and psbt methods).
 #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
 #[cfg_attr(feature = "serde-deny-unknown-fields", serde(deny_unknown_fields))]
-pub struct ScriptPubkey {
+pub struct ScriptPubKey {
     /// The script_pubkey parsed from hex.
     pub script_pubkey: ScriptBuf,
     /// Number of required signatures - deprecated in Core v22.

types/src/model/raw_transactions.rs

@@ -91,7 +91,7 @@ pub struct DecodeRawTransaction(pub Transaction);
 /// Models the result of JSON-RPC method `decodescript`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 pub struct DecodeScript {
-    /// The `scriptPubkey`.
+    /// The `scriptPubKey`.
     pub script_pubkey: Option<ScriptBuf>,
     /// Inferred descriptor for the script. v23 and later only.
     pub descriptor: Option<String>,

types/src/model/wallet.rs

@@ -171,10 +171,10 @@ pub struct GetAddressInfo {
 pub enum ScriptType {
     /// Non-standard output script type.
     NonStandard,
-    /// Pubkey output script.
-    Pubkey,
-    /// Pubkey hash output script.
-    PubkeyHash,
+    /// PubKey output script.
+    PubKey,
+    /// PubKey hash output script.
+    PubKeyHash,
     /// Script hash output script.
     ScriptHash,
     /// Multisig output script.

types/src/psbt/error.rs

@@ -92,14 +92,14 @@ pub enum RawTransactionOutputError {
     /// Conversion of the output `value` field failed.
     Value(amount::ParseAmountError),
     /// Conversion of the output `script_pubkey` field failed.
-    ScriptPubkey(hex::HexToBytesError),
+    ScriptPubKey(hex::HexToBytesError),
 }
 
 impl fmt::Display for RawTransactionOutputError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match *self {
             Self::Value(ref e) => write_err!(f, "conversion of the output `value` field failed"; e),
-            Self::ScriptPubkey(ref e) =>
+            Self::ScriptPubKey(ref e) =>
                 write_err!(f, "conversion of the output `script_pubkey` field failed"; e),
         }
     }
@@ -110,7 +110,7 @@ impl std::error::Error for RawTransactionOutputError {
     fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
         match *self {
             Self::Value(ref e) => Some(e),
-            Self::ScriptPubkey(ref e) => Some(e),
+            Self::ScriptPubKey(ref e) => Some(e),
         }
     }
 }
@@ -121,14 +121,14 @@ pub enum WitnessUtxoError {
     /// Conversion of the `amount` field failed.
     Amount(ParseAmountError),
     /// Conversion of the `script_pubkey` field failed.
-    ScriptPubkey(hex::HexToBytesError),
+    ScriptPubKey(hex::HexToBytesError),
 }
 
 impl fmt::Display for WitnessUtxoError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match *self {
             Self::Amount(ref e) => write_err!(f, "conversion of the `amount` field failed"; e),
-            Self::ScriptPubkey(ref e) =>
+            Self::ScriptPubKey(ref e) =>
                 write_err!(f, "conversion of the `script_pubkey` field failed"; e),
         }
     }
@@ -139,7 +139,7 @@ impl std::error::Error for WitnessUtxoError {
     fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
         match *self {
             Self::Amount(ref e) => Some(e),
-            Self::ScriptPubkey(ref e) => Some(e),
+            Self::ScriptPubKey(ref e) => Some(e),
         }
     }
 }
@@ -178,7 +178,7 @@ impl std::error::Error for PartialSignatureError {
 #[derive(Debug)]
 pub enum Bip32DerivError {
     /// Conversion of the pubkey failed.
-    Pubkey(key::ParsePublicKeyError),
+    PubKey(key::ParsePublicKeyError),
     /// Conversion of the `master_fingerprint` field failed.
     MasterFingerprint(hex::HexToArrayError),
     /// Conversion of the `path` field failed.
@@ -188,7 +188,7 @@ pub enum Bip32DerivError {
 impl fmt::Display for Bip32DerivError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match *self {
-            Self::Pubkey(ref e) => write_err!(f, "conversion of the pubkey failed"; e),
+            Self::PubKey(ref e) => write_err!(f, "conversion of the pubkey failed"; e),
             Self::MasterFingerprint(ref e) =>
                 write_err!(f, "conversion of the `master_fingerprint` field failed"; e),
             Self::Path(ref e) => write_err!(f, "conversion of the `path` field failed"; e),
@@ -200,7 +200,7 @@ impl fmt::Display for Bip32DerivError {
 impl std::error::Error for Bip32DerivError {
     fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
         match *self {
-            Self::Pubkey(ref e) => Some(e),
+            Self::PubKey(ref e) => Some(e),
             Self::MasterFingerprint(ref e) => Some(e),
             Self::Path(ref e) => Some(e),
         }

types/src/psbt/mod.rs

@@ -15,7 +15,7 @@ pub use self::error::{
     Bip32DerivError, PartialSignatureError, RawTransactionError, RawTransactionInputError,
     RawTransactionOutputError, WitnessUtxoError,
 };
-use crate::{ScriptPubkey, ScriptSig};
+use crate::{ScriptPubKey, ScriptSig};
 
 /// Represents a bitcoin transaction.
 ///
@@ -147,7 +147,7 @@ pub struct RawTransactionOutput {
     pub index: u64,
     /// The script pubkey.
     #[serde(rename = "scriptPubKey")]
-    pub script_pubkey: ScriptPubkey,
+    pub script_pubkey: ScriptPubKey,
 }
 
 impl RawTransactionOutput {
@@ -156,7 +156,7 @@ impl RawTransactionOutput {
         use RawTransactionOutputError as E;
 
         let value = Amount::from_btc(self.value).map_err(E::Value)?;
-        let script_pubkey = self.script_pubkey.script_buf().map_err(E::ScriptPubkey)?;
+        let script_pubkey = self.script_pubkey.script_buf().map_err(E::ScriptPubKey)?;
 
         Ok(TxOut { value, script_pubkey })
     }
@@ -171,7 +171,7 @@ pub struct WitnessUtxo {
     pub amount: f64,
     /// The scriptPubKey.
     #[serde(rename = "scriptPubKey")]
-    pub script_pubkey: ScriptPubkey,
+    pub script_pubkey: ScriptPubKey,
 }
 
 impl WitnessUtxo {
@@ -180,7 +180,7 @@ impl WitnessUtxo {
         use WitnessUtxoError as E;
 
         let value = Amount::from_btc(self.amount).map_err(E::Amount)?;
-        let script_pubkey = self.script_pubkey.script_buf().map_err(E::ScriptPubkey)?;
+        let script_pubkey = self.script_pubkey.script_buf().map_err(E::ScriptPubKey)?;
 
         Ok(TxOut { value, script_pubkey })
     }
@@ -295,7 +295,7 @@ pub fn map_into_bip32_derivation(
 
     let mut map = BTreeMap::default();
     for (k, v) in hash_map.iter() {
-        let pubkey = k.parse::<PublicKey>().map_err(E::Pubkey)?;
+        let pubkey = k.parse::<PublicKey>().map_err(E::PubKey)?;
         let fingerprint =
             Fingerprint::from_hex(&v.master_fingerprint).map_err(E::MasterFingerprint)?;
         let path = v.path.parse::<DerivationPath>().map_err(E::Path)?;
@@ -314,7 +314,7 @@ pub fn vec_into_bip32_derivation(
 
     let mut map = BTreeMap::default();
     for deriv in v.iter() {
-        let pubkey = deriv.pubkey.parse::<PublicKey>().map_err(E::Pubkey)?;
+        let pubkey = deriv.pubkey.parse::<PublicKey>().map_err(E::PubKey)?;
         let fingerprint =
             Fingerprint::from_hex(&deriv.master_fingerprint).map_err(E::MasterFingerprint)?;
         let path = deriv.path.parse::<DerivationPath>().map_err(E::Path)?;

types/src/v17/blockchain/error.rs

@@ -443,7 +443,7 @@ impl From<ParseAmountError> for GetMempoolInfoError {
 /// Error when converting a `GetTxOut` type into the model type.
 ///
 /// Note that variants in this type are not named in the usual fashion. The `ScriptBuf` and
-/// `Address` variants are named after the functions on [`crate::ScriptPubkey`].
+/// `Address` variants are named after the functions on [`crate::ScriptPubKey`].
 #[derive(Debug)]
 pub enum GetTxOutError {
     /// Conversion of numeric type to expected type failed.
@@ -452,9 +452,9 @@ pub enum GetTxOutError {
     BestBlock(hex::HexToArrayError),
     /// Conversion of the transaction `value` field failed.
     Value(amount::ParseAmountError),
-    /// Conversion of the `ScriptPubkey` hex to a `ScriptBuf` failed.
+    /// Conversion of the `ScriptPubKey` hex to a `ScriptBuf` failed.
     ScriptBuf(hex::HexToBytesError),
-    /// Conversion of the `ScriptPubkey` `address` field failed.
+    /// Conversion of the `ScriptPubKey` `address` field failed.
     Address(address::ParseError),
 }
 
@@ -466,9 +466,9 @@ impl fmt::Display for GetTxOutError {
                 write_err!(f, "conversion of the `beast_block` field failed"; e),
             Self::Value(ref e) => write_err!(f, "conversion of the `value` field failed"; e),
             Self::ScriptBuf(ref e) =>
-                write_err!(f, "conversion of the `ScriptPubkey` hex to a `ScriptBuf` failed"; e),
+                write_err!(f, "conversion of the `ScriptPubKey` hex to a `ScriptBuf` failed"; e),
             Self::Address(ref e) =>
-                write_err!(f, "conversion of the `ScriptPubkey` `address` field failed"; e),
+                write_err!(f, "conversion of the `ScriptPubKey` `address` field failed"; e),
         }
     }
 }

types/src/v17/blockchain/mod.rs

@@ -13,7 +13,7 @@ use serde::{Deserialize, Serialize};
 
 // TODO: Remove wildcard, use explicit types.
 pub use self::error::*;
-use crate::{model, ScriptPubkey};
+use crate::{model, ScriptPubKey};
 
 /// Result of JSON-RPC method `getbestblockhash`.
 ///
@@ -628,7 +628,7 @@ pub struct GetTxOut {
     pub value: f64,
     /// The script pubkey.
     #[serde(rename = "scriptPubKey")]
-    pub script_pubkey: ScriptPubkey,
+    pub script_pubkey: ScriptPubKey,
     /// Coinbase or not.
     pub coinbase: bool,
 }

types/src/v17/util/error.rs

@@ -40,7 +40,7 @@ pub enum ValidateAddressError {
     /// Conversion of the `address` field failed.
     Address(address::ParseError),
     /// Conversion of the `script_pubkey` field failed.
-    ScriptPubkey(hex::HexToBytesError),
+    ScriptPubKey(hex::HexToBytesError),
     /// The `witness_version` field's value was too big for a u8.
     WitnessVersionValue(i64),
     /// Conversion of the `witness_version` field failed.
@@ -55,7 +55,7 @@ impl fmt::Display for ValidateAddressError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match *self {
             Self::Address(ref e) => write!(f, "conversion of the `address` field failed: {}", e),
-            Self::ScriptPubkey(ref e) =>
+            Self::ScriptPubKey(ref e) =>
                 write!(f, "conversion of the `script_pubkey` field failed: {}", e),
             Self::WitnessVersionValue(v) => write!(f, "invalid witness version number: {}", v),
             Self::WitnessVersion(ref e) =>
@@ -76,7 +76,7 @@ impl std::error::Error for ValidateAddressError {
     fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
         match *self {
             Self::Address(ref e) => Some(e),
-            Self::ScriptPubkey(ref e) => Some(e),
+            Self::ScriptPubKey(ref e) => Some(e),
             Self::WitnessVersionValue(_) => None,
             Self::WitnessVersion(ref e) => Some(e),
             Self::WitnessProgramBytes(ref e) => Some(e),