init deposit 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/tests/bitcoin_client_integration.rs

@@ -18,7 +18,11 @@ pub fn electrs_url() -> Url {
 	Url::parse(&format!("tcp://{base}-electrs-1:60401")).unwrap()
 }
 
-pub fn generate_blocks(blocks: u64, ctx: &Client, address: &str) {
+pub fn generate_blocks(
+	blocks: u64,
+	ctx: &Client,
+	address: &str,
+) -> Vec<String> {
 	let endpoint = bitcoin_url();
 	let user = "devnet";
 	let password = "devnet";
@@ -41,6 +45,7 @@ pub fn generate_blocks(blocks: u64, ctx: &Client, address: &str) {
 		.unwrap();
 
 	assert_eq!(response_json["error"], serde_json::Value::Null);
+	serde_json::from_value(response_json["result"].clone()).expect("block_ids")
 }
 
 #[test]

romeo/tests/deposit_integration.rs

@@ -0,0 +1,104 @@
+use std::{thread::sleep, time::Duration};
+
+use anyhow::Result;
+use bdk::bitcoin::psbt::serialize::Serialize;
+use reqwest::blocking::Client;
+use sbtc_cli::commands::{
+	broadcast::{broadcast_tx, BroadcastArgs},
+	deposit::{build_deposit_tx, DepositArgs},
+};
+
+mod bitcoin_client_integration;
+
+use bitcoin_client_integration::{electrs_url, generate_blocks};
+
+const WALLET_0_P2TR_ADDRESS: &str =
+	"bcrt1pte5zmd7qzj4hdu45lh9mmdm0nwq3z35pwnxmzkwld6y0a8g83nnqhj6vc0";
+const WALLET_0_P2WPKH_ADDRESS: &str =
+	"bcrt1q3tj2fr9scwmcw3rq5m6jslva65f2rqjxfrjz47";
+const WALLET_0_P2WPKH_WIF: &str =
+	"cTyHitzs3VRnNxrpwxo3fXTTe569wHNUs57tQM7Z1FrzUDNB5mqm";
+const WALLET_1_P2WPKH_WIF: &str =
+	"cNcXK2r8bNdWJQymtAW8tGS7QHNtFFvG5CdXqhhT752u29WspXRM";
+const WALLET_1_STX_ADDRESS: &str = "ST2ST2H80NP5C9SPR4ENJ1Z9CDM9PKAJVPYWPQZ50";
+const WALLET_1_P2WPKH_ADDRESS: &str =
+	"bcrt1q3zl64vadtuh3vnsuhdgv6pm93n82ye8q6cr4ch";
+
+use bdk::{
+	bitcoin::PrivateKey,
+	blockchain::{
+		ConfigurableBlockchain, ElectrumBlockchain, ElectrumBlockchainConfig,
+	},
+	database::MemoryDatabase,
+	template::P2Wpkh,
+	SyncOptions, Wallet,
+};
+
+#[test]
+fn broadcast_deposit() -> Result<()> {
+	let client = Client::new();
+	{
+		generate_blocks(1, &client, WALLET_0_P2WPKH_ADDRESS);
+		generate_blocks(1, &client, WALLET_1_P2WPKH_ADDRESS);
+		// pads blocks to get rewards.
+		generate_blocks(200, &client, WALLET_0_P2WPKH_ADDRESS);
+	};
+
+	let electrum_url = electrs_url();
+
+	// suboptimal, replace once we have better events.
+	{
+		let blockchain =
+			ElectrumBlockchain::from_config(&ElectrumBlockchainConfig {
+				url: electrum_url.clone().into(),
+				socks5: None,
+				retry: 3,
+				timeout: Some(10),
+				stop_gap: 10,
+				validate_domain: false,
+			})
+			.unwrap();
+
+		let private_key = PrivateKey::from_wif(WALLET_0_P2WPKH_WIF)?;
+
+		let wallet = Wallet::new(
+			P2Wpkh(private_key),
+			Some(P2Wpkh(private_key)),
+			bdk::bitcoin::Network::Regtest,
+			MemoryDatabase::default(),
+		)
+		.unwrap();
+
+		loop {
+			wallet.sync(&blockchain, SyncOptions::default()).unwrap();
+			let balance = wallet.get_balance().unwrap();
+			if balance.confirmed != 0 {
+				break;
+			}
+			sleep(Duration::from_millis(1_000));
+		}
+	}
+
+	let amount = 10_000;
+
+	let tx = {
+		let args = DepositArgs {
+			node_url: electrum_url.clone(),
+			wif: WALLET_1_P2WPKH_WIF.into(),
+			network: bdk::bitcoin::Network::Regtest,
+			recipient: WALLET_1_STX_ADDRESS.into(),
+			amount,
+			sbtc_wallet: WALLET_0_P2TR_ADDRESS.into(),
+		};
+
+		build_deposit_tx(&args).unwrap()
+	};
+
+	broadcast_tx(&BroadcastArgs {
+		node_url: electrum_url,
+		tx: hex::encode(tx.serialize()),
+	})
+	.unwrap();
+
+	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::utils::PrincipalData;
 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,
 
 	/// Bitcoin address of the sbtc wallet
 	#[clap(short, long)]
-	sbtc_wallet: String,
+	pub sbtc_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 =
@@ -71,21 +69,12 @@ pub fn build_deposit_tx(deposit: &DepositArgs) -> anyhow::Result<()> {
 	let stx_recipient = PrincipalData::try_from(deposit.recipient.to_string())?;
 	let sbtc_wallet_address = BitcoinAddress::from_str(&deposit.sbtc_wallet)?;
 
-	let tx = build_deposit_transaction(
+	build_deposit_transaction(
 		wallet,
 		stx_recipient,
 		sbtc_wallet_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/main.rs

@@ -5,12 +5,15 @@
 //!
 //! 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 sbtc_cli::commands::{
 	broadcast::{broadcast_tx, BroadcastArgs},
 	deposit::{build_deposit_tx, DepositArgs},
 	generate::{generate, GenerateArgs},
+	utils,
 	withdraw::{build_withdrawal_tx, WithdrawalArgs},
 };
 
@@ -32,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)
 		}