Merge #243: Add missing return fields in v17

e9575cd Run the formatter (Jamil Lambert, PhD)
f6a8124 Add missing gettransaction fields to v17 (Jamil Lambert, PhD)
5da62e7 Add missing decodescript field to v17 (Jamil Lambert, PhD)
60f8e75 Add missing getblocktemplate fields to v17 (Jamil Lambert, PhD)

Pull request description:

  When looking into the fix for #241 some missing fields in the v17 types were found.

  Add the missing fields.

  Remove the now unnecessary change in v29 to `getblocktemplate` since the fields have been there since v17, just undocumented.

ACKs for top commit:
  tcharding:
    ACK e9575cd

Tree-SHA512: e6826e317ebc5d8bb568e765a44e9f4da4b2822280edb446e644f32c24b17d71e8c2bf69fbdf5d42a76e0cedf204083114e6913ca3eb1f8d313a3ef3207e5582

Author: tcharding

types/src/model/mining.rs

@@ -24,6 +24,8 @@ pub struct GetBlockTemplate {
     /// Map of rules name to bit number - identifies the bit number as indicating acceptance and
     /// readiness for the named softfork rule.
     pub version_bits_available: BTreeMap<String, u32>,
+    /// Client side supported features.
+    pub capabilities: Vec<String>,
     /// Bit mask of versionbits the server requires set in submissions.
     pub version_bits_required: u32,
     /// The hash of current highest block.
@@ -37,6 +39,8 @@ pub struct GetBlockTemplate {
     /// Maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis).
     #[serde(with = "bitcoin::amount::serde::as_sat")]
     pub coinbase_value: SignedAmount,
+    /// An id to include with a request to longpoll on an update to this template.
+    pub long_poll_id: Option<String>,
     /// The hash target.
     pub target: Vec<u8>,
     /// The minimum timestamp appropriate for next block time in seconds since epoch (Jan 1 1970 GMT).
@@ -59,6 +63,10 @@ pub struct GetBlockTemplate {
     pub bits: CompactTarget,
     /// The height of the next block,
     pub height: u32,
+    /// Optional signet challenge
+    pub signet_challenge: Option<String>,
+    /// A valid witness commitment for the unmodified block template.
+    pub default_witness_commitment: Option<String>,
 }
 
 /// Contents of non-coinbase transactions that should be included in the next block.

types/src/model/raw_transactions.rs

@@ -101,6 +101,8 @@ pub struct DecodeScript {
     pub addresses: Vec<Address<NetworkUnchecked>>,
     /// Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).
     pub p2sh: Option<Address<NetworkUnchecked>>,
+    /// Address of the P2SH script wrapping this witness redeem script
+    pub p2sh_segwit: Option<String>,
 }
 
 /// Models the result of JSON-RPC method `descriptorprocesspsbt`.

types/src/model/wallet.rs

@@ -286,6 +286,8 @@ pub struct GetTransaction {
     pub fee: Option<SignedAmount>,
     /// The number of confirmations.
     pub confirmations: i64, // Docs do not indicate what negative value means?
+    /// Whether we consider the outputs of this unconfirmed transaction safe to spend.
+    pub trusted: Option<bool>,
     /// The block hash.
     pub block_hash: Option<BlockHash>,
     /// The index of the transaction in the block that includes it.
@@ -294,6 +296,8 @@ pub struct GetTransaction {
     pub block_time: Option<u32>,
     /// The transaction id.
     pub txid: Txid,
+    /// Confirmed transactions that have been detected by the wallet to conflict with this transaction.
+    pub wallet_conflicts: Vec<Txid>,
     /// The transaction time in seconds since epoch (1 Jan 1970 GMT).
     pub time: u32,
     /// The time received in seconds since epoch (1 Jan 1970 GMT).

types/src/v17/mining/into.rs

@@ -39,11 +39,13 @@ impl GetBlockTemplate {
             version,
             rules: self.rules,
             version_bits_available: self.version_bits_available,
+            capabilities: self.capabilities,
             version_bits_required,
             previous_block_hash,
             transactions,
             coinbase_aux: self.coinbase_aux,
             coinbase_value,
+            long_poll_id: self.long_poll_id,
             target,
             min_time: self.min_time,
             mutable: self.mutable,
@@ -54,6 +56,8 @@ impl GetBlockTemplate {
             current_time: self.current_time,
             bits,
             height,
+            signet_challenge: self.signet_challenge,
+            default_witness_commitment: self.default_witness_commitment,
         })
     }
 }

types/src/v17/mining/mod.rs

@@ -53,6 +53,8 @@ pub struct GetBlockTemplate {
     /// readiness for the named softfork rule.
     #[serde(rename = "vbavailable")]
     pub version_bits_available: BTreeMap<String, u32>,
+    /// Client side supported features.
+    pub capabilities: Vec<String>,
     /// Bit mask of versionbits the server requires set in submissions.
     #[serde(rename = "vbrequired")]
     pub version_bits_required: i64,
@@ -69,6 +71,9 @@ pub struct GetBlockTemplate {
     /// Maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis).
     #[serde(rename = "coinbasevalue")]
     pub coinbase_value: i64,
+    /// An id to include with a request to longpoll on an update to this template.
+    #[serde(rename = "longpollid")]
+    pub long_poll_id: Option<String>,
     // This is in the docs but not actually returned (for v0.17 and v0.18 at least).
     // coinbase_txn: ???, // Also I don't know what the JSON object represents: `{ ... }`
     /// The hash target.
@@ -78,7 +83,7 @@ pub struct GetBlockTemplate {
     pub min_time: u32,
     /// List of ways the block template may be changed.
     ///
-    /// A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock'
+    /// A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock'.
     pub mutable: Vec<String>,
     /// A range of valid nonces.
     #[serde(rename = "noncerange")]
@@ -97,8 +102,12 @@ pub struct GetBlockTemplate {
     pub current_time: u64,
     /// Compressed target of next block.
     pub bits: String,
-    /// The height of the next block,
+    /// The height of the next block.
     pub height: i64,
+    /// Optional signet challenge.
+    pub signet_challenge: Option<String>,
+    /// A valid witness commitment for the unmodified block template.
+    pub default_witness_commitment: Option<String>,
 }
 
 /// Contents of non-coinbase transactions that should be included in the next block.

types/src/v17/raw_transactions/into.rs

@@ -307,6 +307,7 @@ impl DecodeScript {
             required_signatures: self.required_signatures,
             addresses,
             p2sh,
+            p2sh_segwit: self.p2sh_segwit,
         })
     }
 }

types/src/v17/raw_transactions/mod.rs

@@ -219,6 +219,9 @@ pub struct DecodeScript {
     pub p2sh: Option<String>,
     /// Segwit data (see `DecodeScriptSegwit` for explanation).
     pub segwit: Option<DecodeScriptSegwit>,
+    /// Address of the P2SH script wrapping this witness redeem script
+    #[serde(rename = "p2sh-segwit")]
+    pub p2sh_segwit: Option<String>,
 }
 
 /// Seemingly undocumented data returned in the `segwit` field of `DecodeScript`.
@@ -238,6 +241,7 @@ pub struct DecodeScriptSegwit {
     /// List of bitcoin addresses.
     pub addresses: Option<Vec<String>>,
     /// Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).
+    #[serde(rename = "p2sh-segwit")]
     pub p2sh_segtwit: Option<String>,
 }
 

types/src/v17/wallet/error.rs

@@ -249,6 +249,8 @@ pub enum GetTransactionError {
     BlockHash(hex::HexToArrayError),
     /// Conversion of the `txid` field failed.
     Txid(hex::HexToArrayError),
+    /// Conversion of the `wallet_conflicts` field failed.
+    WalletConflicts(hex::HexToArrayError),
     /// Conversion of the transaction `hex` field failed.
     Tx(encode::FromHexError),
     /// Conversion of the `details` field failed.
@@ -265,6 +267,8 @@ impl fmt::Display for GetTransactionError {
             E::Fee(ref e) => write_err!(f, "conversion of the `fee` field failed"; e),
             E::BlockHash(ref e) => write_err!(f, "conversion of the `block_hash` field failed"; e),
             E::Txid(ref e) => write_err!(f, "conversion of the `txid` field failed"; e),
+            E::WalletConflicts(ref e) =>
+                write_err!(f, "conversion of the `wallet_conflicts` field failed"; e),
             E::Tx(ref e) => write_err!(f, "conversion of the `hex` field failed"; e),
             E::Details(ref e) => write_err!(f, "conversion of the `details` field failed"; e),
         }
@@ -282,6 +286,7 @@ impl std::error::Error for GetTransactionError {
             E::Fee(ref e) => Some(e),
             E::BlockHash(ref e) => Some(e),
             E::Txid(ref e) => Some(e),
+            E::WalletConflicts(ref e) => Some(e),
             E::Tx(ref e) => Some(e),
             E::Details(ref e) => Some(e),
         }

types/src/v17/wallet/into.rs

@@ -338,6 +338,11 @@ impl GetTransaction {
             self.block_index.map(|idx| crate::to_u32(idx, "block_index")).transpose()?;
 
         let txid = self.txid.parse::<Txid>().map_err(E::Txid)?;
+        let wallet_conflicts = self
+            .wallet_conflicts
+            .into_iter()
+            .map(|s| s.parse::<Txid>().map_err(E::WalletConflicts))
+            .collect::<Result<Vec<_>, _>>()?;
         let tx = encode::deserialize_hex::<Transaction>(&self.hex).map_err(E::Tx)?;
         let details = self
             .details
@@ -349,10 +354,12 @@ impl GetTransaction {
             amount,
             fee,
             confirmations: self.confirmations,
+            trusted: self.trusted,
             block_hash,
             block_index,
             block_time: self.block_time,
             txid,
+            wallet_conflicts,
             time: self.time,
             time_received: self.time_received,
             bip125_replaceable: self.bip125_replaceable.into_model(),

types/src/v17/wallet/mod.rs

@@ -413,6 +413,8 @@ pub struct GetTransaction {
     pub fee: Option<f64>,
     /// The number of confirmations.
     pub confirmations: i64,
+    /// Whether we consider the outputs of this unconfirmed transaction safe to spend.
+    pub trusted: Option<bool>,
     /// The block hash.
     #[serde(rename = "blockhash")]
     // The docs say this field should exist but integration test fail without `Option`.
@@ -426,6 +428,9 @@ pub struct GetTransaction {
     pub block_time: Option<u32>, // Docs are wrong, this is not documented as optional.
     /// The transaction id.
     pub txid: String,
+    /// Confirmed transactions that have been detected by the wallet to conflict with this transaction.
+    #[serde(rename = "walletconflicts")]
+    pub wallet_conflicts: Vec<String>,
     /// The transaction time in seconds since epoch (1 Jan 1970 GMT).
     pub time: u32,
     /// The time received in seconds since epoch (1 Jan 1970 GMT).