deposit integration test

Author: CAGS295

devenv/integration/bin/test

@@ -9,7 +9,7 @@ project_name() {
     echo "$filter"
 }
 
-filters=("package(romeo)")
+filters=("test(deposit)")
 filter_union=""
 ids=()
 projects=()

romeo/Cargo.toml

@@ -26,3 +26,4 @@ rs_merkle.workspace = true
 
 [dev-dependencies]
 reqwest = { workspace = true, features = ["json", "blocking"] }
+sbtc-cli = { path = "../sbtc-cli" }

romeo/tests/bitcoin_client_integration.rs

@@ -4,17 +4,22 @@ use reqwest::blocking::Client;
 use serde_json::json;
 use url::Url;
 
+pub fn project_name() -> String {
+	env::var("PROJECT_NAME").unwrap()
+}
+
 pub fn bitcoin_url() -> Url {
-	let base = env::var("PROJECT_NAME").unwrap();
-	Url::parse(&format!("http://{base}-bitcoin-1")).unwrap()
+	let base = project_name();
+	Url::parse(&format!("http://{base}-bitcoin-1:18443")).unwrap()
+}
+
+pub fn electrs_url() -> Url {
+	let base = project_name();
+	Url::parse(&format!("http://{base}-electrs-1:60401")).unwrap()
 }
 
 pub fn generate_blocks(blocks: u64, ctx: Client) {
-	let endpoint = {
-		let mut endpoint = bitcoin_url();
-		endpoint.set_port(Some(18443)).unwrap();
-		endpoint
-	};
+	let endpoint = bitcoin_url();
 	let user = "devnet";
 	let password = "devnet";
 	let body = json!({

romeo/tests/deposit_integration.rs

@@ -0,0 +1,44 @@
+use anyhow::Result;
+use bdk::bitcoin::psbt::serialize::Serialize;
+use sbtc_cli::commands::{
+	broadcast::{broadcast_tx, BroadcastArgs},
+	deposit::{build_deposit_tx, DepositArgs},
+	utils,
+};
+use serde_json::to_string_pretty;
+
+mod bitcoin_client_integration;
+use bitcoin_client_integration::electrs_url;
+
+const DEPLOYER_P2TR_ADDRESS: &str =
+	"bcrt1pte5zmd7qzj4hdu45lh9mmdm0nwq3z35pwnxmzkwld6y0a8g83nnqhj6vc0";
+const ALICE_P2WPKH_WIF: &str =
+	"cNcXK2r8bNdWJQymtAW8tGS7QHNtFFvG5CdXqhhT752u29WspXRM";
+const STX_ADDRESS: &str = "ST2ST2H80NP5C9SPR4ENJ1Z9CDM9PKAJVPYWPQZ50";
+
+#[test]
+fn deposit() -> Result<()> {
+	let electrum_url = electrs_url();
+	let amount = 10_000;
+
+	let args = DepositArgs {
+		node_url: electrum_url.clone(),
+		wif: ALICE_P2WPKH_WIF.into(),
+		network: bdk::bitcoin::Network::Regtest,
+		recipient: STX_ADDRESS.into(),
+		amount,
+		dkg_wallet: DEPLOYER_P2TR_ADDRESS.into(),
+	};
+
+	let tx = build_deposit_tx(&args)?;
+
+	broadcast_tx(&BroadcastArgs {
+		node_url: electrum_url,
+		tx: to_string_pretty(&utils::TransactionData {
+			id: tx.txid().to_string(),
+			hex: hex::encode(tx.serialize()),
+		})?,
+	})?;
+
+	Ok(())
+}

sbtc-cli/src/commands/broadcast.rs

@@ -10,10 +10,10 @@ use url::Url;
 #[derive(Parser, Debug, Clone)]
 pub struct BroadcastArgs {
 	/// Where to broadcast the transaction
-	node_url: Url,
+	pub node_url: Url,
 
 	/// The transaction to broadcast
-	tx: String,
+	pub tx: String,
 }
 
 pub fn broadcast_tx(broadcast: &BroadcastArgs) -> anyhow::Result<()> {

sbtc-cli/src/commands/deposit.rs

@@ -1,9 +1,9 @@
-use std::{io::stdout, str::FromStr};
+use std::str::FromStr;
 
 use bdk::{
 	bitcoin::{
-		psbt::serialize::Serialize, Address as BitcoinAddress,
-		Network as BitcoinNetwork, PrivateKey,
+		Address as BitcoinAddress, Network as BitcoinNetwork, PrivateKey,
+		Transaction,
 	},
 	blockchain::{
 		ConfigurableBlockchain, ElectrumBlockchain, ElectrumBlockchainConfig,
@@ -17,36 +17,34 @@ use sbtc_core::operations::op_return::deposit::build_deposit_transaction;
 use stacks_core::address::StacksAddress;
 use url::Url;
 
-use crate::commands::utils;
-
 #[derive(Parser, Debug, Clone)]
 pub struct DepositArgs {
 	/// Where to broadcast the transaction
 	#[clap(short('u'), long)]
-	node_url: Url,
+	pub node_url: Url,
 
 	/// Bitcoin WIF of the P2wPKH address
 	#[clap(short, long)]
-	wif: String,
+	pub wif: String,
 
 	/// Bitcoin network where the deposit will be broadcasted to
 	#[clap(short, long)]
-	network: BitcoinNetwork,
+	pub network: BitcoinNetwork,
 
 	/// Stacks address that will receive sBTC
 	#[clap(short, long)]
-	recipient: String,
+	pub recipient: String,
 
 	/// The amount of sats to send
 	#[clap(short, long)]
-	amount: u64,
+	pub amount: u64,
 
 	/// Dkg wallet address
 	#[clap(short, long)]
-	dkg_wallet: String,
+	pub dkg_wallet: String,
 }
 
-pub fn build_deposit_tx(deposit: &DepositArgs) -> anyhow::Result<()> {
+pub fn build_deposit_tx(deposit: &DepositArgs) -> anyhow::Result<Transaction> {
 	let private_key = PrivateKey::from_wif(&deposit.wif)?;
 
 	let blockchain =
@@ -72,21 +70,12 @@ pub fn build_deposit_tx(deposit: &DepositArgs) -> anyhow::Result<()> {
 		StacksAddress::try_from(deposit.recipient.as_str())?;
 	let dkg_address = BitcoinAddress::from_str(&deposit.dkg_wallet)?;
 
-	let tx = build_deposit_transaction(
+	build_deposit_transaction(
 		wallet,
 		recipient_address.into(),
 		dkg_address,
 		deposit.amount,
 		deposit.network,
-	)?;
-
-	serde_json::to_writer_pretty(
-		stdout(),
-		&utils::TransactionData {
-			id: tx.txid().to_string(),
-			hex: hex::encode(tx.serialize()),
-		},
-	)?;
-
-	Ok(())
+	)
+	.map_err(|e| e.into())
 }

sbtc-cli/src/lib.rs

@@ -0,0 +1 @@
+pub mod commands;

sbtc-cli/src/main.rs

@@ -5,18 +5,18 @@
 //!
 //! It also allows you to generate credentials needed to generate transactions
 //! and interact with the Bitcoin and Stacks networks.
+use std::io::stdout;
 
+use bdk::bitcoin::psbt::serialize::Serialize;
 use clap::{Parser, Subcommand};
-
-use crate::commands::{
+use sbtc_cli::commands::{
 	broadcast::{broadcast_tx, BroadcastArgs},
 	deposit::{build_deposit_tx, DepositArgs},
 	generate::{generate, GenerateArgs},
+	utils,
 	withdraw::{build_withdrawal_tx, WithdrawalArgs},
 };
 
-mod commands;
-
 #[derive(Parser)]
 struct Cli {
 	#[command(subcommand)]
@@ -35,7 +35,17 @@ fn main() -> Result<(), anyhow::Error> {
 	let args = Cli::parse();
 
 	match args.command {
-		Command::Deposit(deposit_args) => build_deposit_tx(&deposit_args),
+		Command::Deposit(deposit_args) => build_deposit_tx(&deposit_args)
+			.and_then(|t| {
+				serde_json::to_writer_pretty(
+					stdout(),
+					&utils::TransactionData {
+						id: t.txid().to_string(),
+						hex: hex::encode(t.serialize()),
+					},
+				)?;
+				Ok(())
+			}),
 		Command::Withdraw(withdrawal_args) => {
 			build_withdrawal_tx(&withdrawal_args)
 		}