grin-wallet/controller/tests/mwixnet.rs

// Copyright 2024 The Grin Developers
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Test a wallet sending to self, then creation of comsig request
#[macro_use]
extern crate log;
extern crate grin_wallet_controller as wallet;
extern crate grin_wallet_impls as impls;

use grin_core as core;
use grin_core::core::FeeFields;
use grin_util as util;
use grin_util::secp::key::SecretKey;
use std::path::PathBuf;

use grin_wallet_libwallet as libwallet;
use impls::test_framework::{self, LocalWalletClient};
use libwallet::{
	mwixnet::{MixnetReqCreationParams, MwixnetServerPublicKey, MAX_MWIXNET_HOPS},
	InitTxArgs, OutputStatus, TxLogEntryType,
};
use std::sync::atomic::Ordering;
use std::thread;
use std::time::Duration;

#[macro_use]
mod common;
use common::{clean_output_dir, create_wallet_proxy, setup};

/// self send impl
fn mwixnet_test_impl(test_dir: &'static str) -> Result<(), libwallet::Error> {
	// Create a new proxy to simulate server and wallet responses
	let mut wallet_proxy = create_wallet_proxy(test_dir);
	let chain = wallet_proxy.chain.clone();
	let stopper = wallet_proxy.running.clone();

	// Create a new wallet test client, and set its queues to communicate with the
	// proxy
	create_wallet_and_add!(
		client1,
		wallet1,
		mask1_i,
		test_dir,
		"wallet1",
		None,
		&mut wallet_proxy,
		true,
		api1
	);
	let mask1 = mask1_i.as_ref();

	// Set the wallet proxy listener running
	thread::spawn(move || {
		if let Err(e) = wallet_proxy.run() {
			error!("Wallet Proxy error: {}", e);
		}
	});

	// few values to keep things shorter
	let reward = core::consensus::REWARD;

	// add some accounts
	api1.create_account_path(mask1, "mining")?;
	api1.create_account_path(mask1, "listener")?;

	// Get some mining done
	{
		wallet_inst!(wallet1, w);
		w.set_account_by_name("mining")?;
	}
	let mut bh = 10u64;
	let _ =
		test_framework::award_blocks_to_wallet(&chain, wallet1.clone(), mask1, bh as usize, false);

	// Should have 5 in account1 (5 spendable), 5 in account (2 spendable)
	let (wallet1_refreshed, wallet1_info) = api1.retrieve_summary_info(mask1, true, 1)?;
	assert!(wallet1_refreshed);
	assert_eq!(wallet1_info.last_confirmed_height, bh);
	assert_eq!(wallet1_info.total, bh * reward);
	// send to send
	let args = InitTxArgs {
		src_acct_name: Some("mining".to_owned()),
		amount: reward * 2,
		minimum_confirmations: 2,
		max_outputs: 500,
		num_change_outputs: 1,
		selection_strategy_is_use_all: true,
		..Default::default()
	};
	let mut slate = api1.init_send_tx(mask1, args)?;
	api1.tx_lock_outputs(mask1, &slate)?;
	// Send directly to self
	wallet::controller::foreign_single_use(
		wallet1.clone(),
		PathBuf::from(test_dir),
		mask1_i.clone(),
		|api| {
			slate = api.receive_tx(&slate, Some("listener"), None)?;
			Ok(())
		},
	)?;
	slate = api1.finalize_tx(mask1, &slate)?;
	api1.post_tx(mask1, &slate, false)?; // mines a block
	bh += 1;

	let _ = test_framework::award_blocks_to_wallet(&chain, wallet1.clone(), mask1, 3, false);
	bh += 3;

	// Check total in mining account
	let (wallet1_refreshed, wallet1_info) = api1.retrieve_summary_info(mask1, true, 1)?;
	assert!(wallet1_refreshed);
	assert_eq!(wallet1_info.last_confirmed_height, bh);
	assert_eq!(wallet1_info.total, bh * reward - reward * 2);

	// Check total in 'listener' account
	{
		wallet_inst!(wallet1, w);
		w.set_account_by_name("listener")?;
	}
	let (wallet1_refreshed, wallet1_info) = api1.retrieve_summary_info(mask1, true, 1)?;
	assert!(wallet1_refreshed);
	assert_eq!(wallet1_info.last_confirmed_height, bh);
	assert_eq!(wallet1_info.total, 2 * reward);

	// Recipient wallet creates a mwixnet request from the last output
	let secp_locked = util::static_secp_instance();
	let secp = secp_locked.lock();
	let server_pubkey_str_1 = "97444ae673bb92c713c1a2f7b8882ffbfc1c67401a280a775dce1a8651584332";
	let server_pubkey_str_2 = "0c9414341f2140ed34a5a12a6479bf5a6404820d001ab81d9d3e8cc38f049b4e";
	let server_pubkey_str_3 = "b58ece97d60e71bb7e53218400b0d67bfe6a3cb7d3b4a67a44f8fb7c525cbca5";
	let server_key_1 =
		SecretKey::from_slice(&secp, &grin_util::from_hex(server_pubkey_str_1).unwrap())?;
	let server_key_2 =
		SecretKey::from_slice(&secp, &grin_util::from_hex(server_pubkey_str_2).unwrap())?;
	let server_key_3 =
		SecretKey::from_slice(&secp, &grin_util::from_hex(server_pubkey_str_3).unwrap())?;
	let params = MixnetReqCreationParams {
		server_keys: vec![
			MwixnetServerPublicKey::from_secret(&server_key_1),
			MwixnetServerPublicKey::from_secret(&server_key_2),
			MwixnetServerPublicKey::from_secret(&server_key_3),
		],
		fee_per_hop: None,
	};
	let outputs = api1.retrieve_outputs(mask1, false, false, None)?;
	// get last output
	let last_output = outputs.1[outputs.1.len() - 1].clone();

	// Store the output with an MMR index, like a restored output
	let mmr_index = Some(chain.get_output_pos(&last_output.commit).unwrap());
	{
		wallet_inst!(wallet1, w);
		let mut batch = w.batch(mask1)?;
		let mut output = last_output.output.clone();
		batch.delete(&output.key_id, &output.mmr_index)?;
		output.mmr_index = mmr_index;
		batch.save(output)?;
		batch.commit()?;
	}

	let empty_params = MixnetReqCreationParams {
		server_keys: vec![],
		fee_per_hop: params.fee_per_hop,
	};
	assert!(api1
		.create_mwixnet_req(mask1, &empty_params, &last_output.commit, true)
		.is_err());

	let too_many_params = MixnetReqCreationParams {
		server_keys: vec![params.server_keys[0]; MAX_MWIXNET_HOPS + 1],
		fee_per_hop: params.fee_per_hop,
	};
	assert!(api1
		.create_mwixnet_req(mask1, &too_many_params, &last_output.commit, true)
		.is_err());

	let oversized_fee_params = MixnetReqCreationParams {
		server_keys: params.server_keys[..2].to_vec(),
		fee_per_hop: Some(1 << 39),
	};
	assert_eq!(
		api1.create_mwixnet_req(mask1, &oversized_fee_params, &last_output.commit, true)
			.unwrap_err(),
		libwallet::Error::Fee("mwixnet total fee exceeds FeeFields limit".to_string())
	);

	for fee in [0, 12_499_999] {
		let invalid_params = MixnetReqCreationParams {
			server_keys: params.server_keys.clone(),
			fee_per_hop: Some(fee),
		};
		assert_eq!(
			api1.create_mwixnet_req(mask1, &invalid_params, &last_output.commit, true)
				.unwrap_err(),
			libwallet::Error::Fee("mwixnet fee is below the swap minimum 0.0125".to_string())
		);
	}
	let custom_params = MixnetReqCreationParams {
		server_keys: params.server_keys.clone(),
		fee_per_hop: Some(25_000_000),
	};
	let custom = api1.create_mwixnet_req(mask1, &custom_params, &last_output.commit, false)?;
	let mut onion = custom.request.onion;
	for server_key in [&server_key_1, &server_key_2, &server_key_3] {
		let peeled = onion.peel_layer(server_key).unwrap();
		assert_eq!(peeled.payload.fee, FeeFields::try_from(25_000_000u64)?);
		onion = peeled.onion;
	}

	drop(secp);

	// Failed refresh must not create or lock a swap
	let tx_count = api1.retrieve_txs(mask1, false, None, None, None)?.1.len();
	let (disconnected, receiver) = std::sync::mpsc::channel();
	drop(receiver);
	let original_proxy = std::mem::replace(&mut *client1.proxy_tx.lock(), disconnected);
	let mut api1 = api1;
	let result = wallet::command::mwixnet(
		&mut api1,
		mask1,
		wallet::command::MwixnetArgs {
			server: "mza3u6vkqodqc6kjjapfbcjrg7hgpkuw6nyq5xvfjqp5jm2lfeaocwqd.onion".try_into()?,
			output: wallet::command::MwixnetOutput::Commitment(last_output.commit),
			minimum_confirmations: 1,
			params: MixnetReqCreationParams {
				server_keys: params.server_keys.clone(),
				fee_per_hop: None,
			},
		},
	);
	*client1.proxy_tx.lock() = original_proxy;
	assert!(result
		.unwrap_err()
		.to_string()
		.contains("Could not refresh wallet outputs"));
	assert_eq!(
		api1.retrieve_txs(mask1, false, None, None, None)?.1.len(),
		tx_count
	);
	let outputs = api1.retrieve_outputs(mask1, false, false, None)?.1;
	assert_eq!(
		outputs
			.iter()
			.find(|o| o.commit == last_output.commit)
			.unwrap()
			.output
			.status,
		OutputStatus::Unspent
	);

	let creation = api1.create_mwixnet_req(mask1, &params, &last_output.commit, true)?;
	let creation_tx_id = creation.tx_id.unwrap();
	let fee_per_hop = 12_500_000;
	let mut onion = creation.request.onion.clone();
	for server_key in [&server_key_1, &server_key_2, &server_key_3] {
		let peeled = onion
			.peel_layer(server_key)
			.map_err(|e| libwallet::Error::GenericError(e.to_string()))?;
		assert_eq!(peeled.payload.fee, FeeFields::try_from(fee_per_hop)?);
		onion = peeled.onion;
	}

	println!("MWIXNET REQ: {:?}", creation.request);

	// Check the input lock and expected output are tracked together.
	let outputs = api1.retrieve_outputs(mask1, false, false, None)?;
	let input = outputs
		.1
		.iter()
		.find(|o| o.commit == last_output.commit)
		.unwrap();
	assert_eq!(input.output.status, OutputStatus::Locked);
	assert_eq!(input.output.mmr_index, mmr_index);
	let total_fee = fee_per_hop * params.server_keys.len() as u64;
	let expected_amount = last_output.output.value - total_fee;
	let expected_output = outputs
		.1
		.iter()
		.find(|o| o.output.status == OutputStatus::Unconfirmed && o.output.value == expected_amount)
		.unwrap();
	assert_eq!(
		input.output.tx_log_entry,
		expected_output.output.tx_log_entry
	);

	let txs = api1.retrieve_txs(mask1, false, None, None, None)?.1;
	let tx = txs.last().unwrap();
	assert_eq!(creation_tx_id, tx.id);
	assert_eq!(tx.tx_type, TxLogEntryType::TxSent);
	assert_eq!(tx.amount_debited, last_output.output.value);
	assert_eq!(tx.amount_credited, expected_amount);
	assert_eq!(tx.num_inputs, 1);
	assert_eq!(tx.num_outputs, 1);
	assert_eq!(tx.fee, Some(FeeFields::try_from(total_fee)?));

	assert!(api1
		.create_mwixnet_req(mask1, &params, &last_output.commit, false)
		.is_err());

	// let logging finish
	stopper.store(false, Ordering::Relaxed);
	thread::sleep(Duration::from_millis(1000));
	Ok(())
}

#[test]
fn mwixnet_comsig_test() {
	let test_dir = "test_output/mwixnet";
	setup(test_dir);
	if let Err(e) = mwixnet_test_impl(test_dir) {
		panic!("Libwallet Error: {}", e);
	}
	clean_output_dir(test_dir);
}