Add --dry-run-flag (ordinals#1265)

src/subcommand/preview.rs

@@ -79,6 +79,7 @@ impl Preview {
             file,
             no_backup: true,
             satpoint: None,
+            dry_run: false,
           },
         )),
       }

src/subcommand/wallet/inscribe.rs

@@ -21,6 +21,7 @@ struct Output {
   commit: Txid,
   inscription: InscriptionId,
   reveal: Txid,
+  fees: u64,
 }
 
 #[derive(Debug, Parser)]
@@ -37,6 +38,8 @@ pub(crate) struct Inscribe {
   pub(crate) file: PathBuf,
   #[clap(long, help = "Do not back up recovery key.")]
   pub(crate) no_backup: bool,
+  #[clap(long, help = "Don't sign or broadcast transactions.")]
+  pub(crate) dry_run: bool,
 }
 
 impl Inscribe {
@@ -48,7 +51,7 @@ impl Inscribe {
     let index = Index::open(&options)?;
     index.update()?;
 
-    let utxos = get_unspent_outputs(&options)?;
+    let mut utxos = get_unspent_outputs(&options)?;
 
     let inscriptions = index.get_inscriptions(None)?;
 
@@ -62,37 +65,63 @@ impl Inscribe {
         inscription,
         inscriptions,
         options.chain().network(),
-        utxos,
+        utxos.clone(),
         commit_tx_change,
         reveal_tx_destination,
         self.fee_rate,
       )?;
 
-    if !self.no_backup {
-      Inscribe::backup_recovery_key(&client, recovery_key_pair, options.chain().network())?;
-    }
+    utxos.insert(
+      reveal_tx.input[0].previous_output,
+      Amount::from_sat(unsigned_commit_tx.output[0].value),
+    );
+
+    let fees =
+      Self::calculate_fee(&unsigned_commit_tx, &utxos) + Self::calculate_fee(&reveal_tx, &utxos);
 
-    let signed_raw_commit_tx = client
-      .sign_raw_transaction_with_wallet(&unsigned_commit_tx, None, None)?
-      .hex;
+    if self.dry_run {
+      print_json(Output {
+        commit: unsigned_commit_tx.txid(),
+        reveal: reveal_tx.txid(),
+        inscription: reveal_tx.txid().into(),
+        fees,
+      })?;
+    } else {
+      if !self.no_backup {
+        Inscribe::backup_recovery_key(&client, recovery_key_pair, options.chain().network())?;
+      }
 
-    let commit = client
-      .send_raw_transaction(&signed_raw_commit_tx)
-      .context("Failed to send commit transaction")?;
+      let signed_raw_commit_tx = client
+        .sign_raw_transaction_with_wallet(&unsigned_commit_tx, None, None)?
+        .hex;
 
-    let reveal = client
-      .send_raw_transaction(&reveal_tx)
-      .context("Failed to send reveal transaction")?;
+      let commit = client
+        .send_raw_transaction(&signed_raw_commit_tx)
+        .context("Failed to send commit transaction")?;
 
-    print_json(Output {
-      commit,
-      reveal,
-      inscription: reveal.into(),
-    })?;
+      let reveal = client
+        .send_raw_transaction(&reveal_tx)
+        .context("Failed to send reveal transaction")?;
+
+      print_json(Output {
+        commit,
+        reveal,
+        inscription: reveal.into(),
+        fees,
+      })?;
+    };
 
     Ok(())
   }
 
+  fn calculate_fee(tx: &Transaction, utxos: &BTreeMap<OutPoint, Amount>) -> u64 {
+    tx.input
+      .iter()
+      .map(|txin| utxos.get(&txin.previous_output).unwrap().to_sat())
+      .sum::<u64>()
+      - tx.output.iter().map(|txout| txout.value).sum::<u64>()
+  }
+
   fn create_inscription_transactions(
     satpoint: Option<SatPoint>,
     inscription: Inscription,

tests/lib.rs

@@ -43,6 +43,7 @@ struct Inscribe {
   commit: Txid,
   inscription: String,
   reveal: Txid,
+  fees: u64,
 }
 
 fn inscribe(rpc_server: &test_bitcoincore_rpc::Handle) -> Inscribe {

tests/wallet/inscribe.rs

@@ -243,3 +243,46 @@ fn inscribe_with_wallet_named_foo() {
     .rpc_server(&rpc_server)
     .output::<Inscribe>();
 }
+
+#[test]
+fn inscribe_with_dry_run_flag() {
+  let rpc_server = test_bitcoincore_rpc::spawn();
+  create_wallet(&rpc_server);
+  rpc_server.mine_blocks(1);
+
+  CommandBuilder::new("wallet inscribe --dry-run degenerate.png")
+    .write("degenerate.png", [1; 520])
+    .rpc_server(&rpc_server)
+    .output::<Inscribe>();
+
+  assert!(rpc_server.mempool().is_empty());
+
+  CommandBuilder::new("wallet inscribe degenerate.png")
+    .write("degenerate.png", [1; 520])
+    .rpc_server(&rpc_server)
+    .output::<Inscribe>();
+
+  assert_eq!(rpc_server.mempool().len(), 2);
+}
+
+#[test]
+fn inscribe_with_dry_run_flag_fees_inscrease() {
+  let rpc_server = test_bitcoincore_rpc::spawn();
+  create_wallet(&rpc_server);
+  rpc_server.mine_blocks(1);
+
+  let total_fee_dry_run = CommandBuilder::new("wallet inscribe --dry-run degenerate.png")
+    .write("degenerate.png", [1; 520])
+    .rpc_server(&rpc_server)
+    .output::<Inscribe>()
+    .fees;
+
+  let total_fee_normal =
+    CommandBuilder::new("wallet inscribe --dry-run degenerate.png --fee-rate 1.1")
+      .write("degenerate.png", [1; 520])
+      .rpc_server(&rpc_server)
+      .output::<Inscribe>()
+      .fees;
+
+  assert!(total_fee_dry_run < total_fee_normal);
+}