Merge #327: Add testmempoolaccept test and update structs

7401356 Run the formatter (jamillambert)
5f9d6f5 Add testmempoolaccept test and update structs (jamillambert)
60dbb35 Fix rounding error in btc_per_kb (Jamil Lambert, PhD)

Pull request description:

  `testmempoolaccept` is untested and missing return fields added in versions after v17.

  The helper function `btc_per_kb` returned a `TooPreciseError` with 1e-5 `btc_per_kb` which should work. Due to the imprecise representation of 1e-5 in binary in f64, and when divided by 1000 and converting to sats results in 0.9999999999999998 not 1.0. Rounding is not possible since it will remove all occurances of `TooPreciseError`.

  - Update `btc_per_kb` to do the division by 1000 after creating the `Amount` in sats.
  - Add a test for `testmempoolaccept` and redefine the struct, model and into_model functions for changes in the RPC for all versions up to 29.
  - Run the formatter

ACKs for top commit:
  tcharding:
    ACK 7401356

Tree-SHA512: 8d8c26bab040458e786620843e1305e19d79c612c930fd20afd307a68b750598d5142d44d696b46afd6ba94e6b877962a22faf393bf81a8a630d6cf62eaa4e5b

Author: tcharding

integration_test/tests/raw_transactions.rs

@@ -382,8 +382,34 @@ fn raw_transactions__submit_package__modelled() {
 }
 
 #[test]
-#[cfg(feature = "TODO")]
-fn raw_transactions__test_mempool_accept__modelled() {}
+fn raw_transactions__test_mempool_accept__modelled() {
+    let node = Node::with_wallet(Wallet::Default, &[]);
+    node.fund_wallet();
+    let tx = create_a_raw_transaction(&node);
+
+    // Sign (but don't broadcast).
+    let signed: SignRawTransaction = node
+        .client
+        .sign_raw_transaction_with_wallet(&tx)
+        .expect("signrawtransactionwithwallet");
+    let signed_model: mtype::SignRawTransaction = signed
+        .into_model()
+        .expect("SignRawTransaction into model");
+    let signed_tx = signed_model.tx;
+
+    // Call testmempoolaccept with the valid (not yet broadcast) transaction.
+    let json: TestMempoolAccept = node
+        .client
+        .test_mempool_accept(&[signed_tx.clone()])
+        .expect("testmempoolaccept");
+    let model: mtype::TestMempoolAccept = json
+        .into_model()
+        .expect("TestMempoolAccept into model");
+    assert_eq!(model.results.len(), 1);
+    let res = &model.results[0];
+    assert_eq!(res.txid, signed_tx.compute_txid());
+    assert!(res.allowed, "fresh signed tx should be allowed");
+}
 
 #[test]
 #[cfg(not(feature = "v17"))]    // utxoupdatepsbt was added in v0.18.

types/src/lib.rs

@@ -89,11 +89,11 @@ impl std::error::Error for NumericError {}
 
 /// Converts `fee_rate` in BTC/kB to `FeeRate`.
 fn btc_per_kb(btc_per_kb: f64) -> Result<Option<FeeRate>, ParseAmountError> {
-    let btc_per_byte = btc_per_kb / 1000_f64;
-    let sats_per_byte = Amount::from_btc(btc_per_byte)?;
+    let sats_per_kb = Amount::from_btc(btc_per_kb)?;
+    let sats_per_byte = sats_per_kb.to_sat() / 1000;
 
     // Virtual bytes equal bytes before segwit.
-    let rate = FeeRate::from_sat_per_vb(sats_per_byte.to_sat());
+    let rate = FeeRate::from_sat_per_vb(sats_per_byte);
 
     Ok(rate)
 }

types/src/model/mod.rs

@@ -42,9 +42,9 @@ pub use self::{
         AnalyzePsbt, AnalyzePsbtInput, AnalyzePsbtInputMissing, CombinePsbt, CombineRawTransaction,
         ConvertToPsbt, CreatePsbt, CreateRawTransaction, DecodePsbt, DecodeRawTransaction,
         DecodeScript, DescriptorProcessPsbt, FinalizePsbt, FundRawTransaction, GetRawTransaction,
-        GetRawTransactionVerbose, JoinPsbts, MempoolAcceptance, SendRawTransaction, SignFail,
-        SignRawTransaction, SubmitPackage, SubmitPackageTxResult, SubmitPackageTxResultFees,
-        TestMempoolAccept, UtxoUpdatePsbt,
+        GetRawTransactionVerbose, JoinPsbts, MempoolAcceptance, MempoolAcceptanceFees,
+        SendRawTransaction, SignFail, SignRawTransaction, SubmitPackage, SubmitPackageTxResult,
+        SubmitPackageTxResultFees, TestMempoolAccept, UtxoUpdatePsbt,
     },
     util::{
         CreateMultisig, DeriveAddresses, DeriveAddressesMultipath, EstimateSmartFee,

types/src/model/raw_transactions.rs

@@ -272,16 +272,37 @@ pub struct TestMempoolAccept {
     pub results: Vec<MempoolAcceptance>,
 }
 
-/// Represents a single mempool acceptance test result.
+/// Models a single mempool acceptance test result. Returned as part of `testmempoolaccept`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct MempoolAcceptance {
     /// The transaction ID.
     pub txid: Txid,
+    /// The transaction witness hash in hex.
+    pub wtxid: Option<Wtxid>,
     /// If the mempool allows this transaction to be inserted.
     pub allowed: bool,
+    /// Virtual transaction size as defined in BIP 141 (only present when 'allowed' is true).
+    pub vsize: Option<u32>,
+    /// Transaction fee in BTC (only present if 'allowed' is true).
+    pub fees: Option<MempoolAcceptanceFees>,
     /// Rejection string (only present when 'allowed' is false).
     pub reject_reason: Option<String>,
+    /// Rejection details (only present when 'allowed' is false and rejection details exist)
+    pub reject_details: Option<String>,
+}
+
+/// Models the fees field. Returned as part of `testmempoolaccept`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct MempoolAcceptanceFees {
+    /// Transaction fee in BTC.
+    pub base: Amount,
+    /// The effective feerate in BTC per KvB. May differ from the base feerate if, for example, there
+    /// are modified fees from `prioritisetransaction` or a package feerate was used.
+    pub effective_feerate: Option<FeeRate>,
+    /// Transactions whose fees and vsizes are included in `effective_feerate`.
+    pub effective_includes: Option<Vec<Wtxid>>,
 }
 
 /// Models the result of JSON-RPC method `utxoupdatepsbt;`.

types/src/v17/mod.rs

@@ -128,7 +128,7 @@
 //! | sendrawtransaction                 | version + model |                                        |
 //! | signrawtransaction                 | version + model |                                        |
 //! | signrawtransactionwithkey          | version + model |                                        |
-//! | testmempoolaccept                  | version + model | UNTESTED                               |
+//! | testmempoolaccept                  | version + model |                                        |
 //!
 //! </details>
 //!

types/src/v17/raw_transactions/into.rs

@@ -449,7 +449,7 @@ impl SignFail {
 impl TestMempoolAccept {
     /// Converts version specific type to a version nonspecific, more strongly typed type.
     pub fn into_model(self) -> Result<model::TestMempoolAccept, hex::HexToArrayError> {
-        let results = self.results.into_iter().map(|r| r.into_model()).collect::<Result<_, _>>()?;
+        let results = self.0.into_iter().map(|r| r.into_model()).collect::<Result<_, _>>()?;
 
         Ok(model::TestMempoolAccept { results })
     }
@@ -462,8 +462,12 @@ impl MempoolAcceptance {
 
         Ok(model::MempoolAcceptance {
             txid,
+            wtxid: None, // v22 and later only.
             allowed: self.allowed,
+            vsize: None, // v21 and later only.
+            fees: None,  // v21 and later only.
             reject_reason: self.reject_reason,
+            reject_details: None, // v29 and later only.
         })
     }
 }

types/src/v17/raw_transactions/mod.rs

@@ -451,14 +451,9 @@ pub struct SignFail {
 /// > 2. allowhighfees    (boolean, optional, default=false) Allow high fees
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
-pub struct TestMempoolAccept {
-    /// Array of test results for each raw transaction in the input array.
-    ///
-    /// Length is exactly one for now.
-    pub results: Vec<MempoolAcceptance>,
-}
+pub struct TestMempoolAccept(pub Vec<MempoolAcceptance>);
 
-/// Represents a single mempool acceptance test result.
+/// Represents a single mempool acceptance test result, returned as part of `testmempoolaccept`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct MempoolAcceptance {

types/src/v18/mod.rs

@@ -132,7 +132,7 @@
 //! | joinpsbts                          | version + model | UNTESTED                               |
 //! | sendrawtransaction                 | version + model |                                        |
 //! | signrawtransactionwithkey          | version + model |                                        |
-//! | testmempoolaccept                  | version + model | UNTESTED                               |
+//! | testmempoolaccept                  | version + model |                                        |
 //! | utxoupdatepsbt                     | version + model | UNTESTED                               |
 //!
 //! </details>

types/src/v19/mod.rs

@@ -132,7 +132,7 @@
 //! | joinpsbts                          | version + model | UNTESTED                               |
 //! | sendrawtransaction                 | version + model |                                        |
 //! | signrawtransactionwithkey          | version + model |                                        |
-//! | testmempoolaccept                  | version + model | UNTESTED                               |
+//! | testmempoolaccept                  | version + model |                                        |
 //! | utxoupdatepsbt                     | version + model | UNTESTED                               |
 //!
 //! </details>

types/src/v20/mod.rs

@@ -133,7 +133,7 @@
 //! | joinpsbts                          | version + model | UNTESTED                               |
 //! | sendrawtransaction                 | version + model |                                        |
 //! | signrawtransactionwithkey          | version + model |                                        |
-//! | testmempoolaccept                  | version + model | UNTESTED                               |
+//! | testmempoolaccept                  | version + model |                                        |
 //! | utxoupdatepsbt                     | version + model | UNTESTED                               |
 //!
 //! </details>