[WIP] Invoiced Transactions API Support (#90)

* basic invoiced tx working

* rustfmt

* teardown

* rustfmt

* rename, new struct for invoice args, begin to add new functions to RPC apis

* rustfmt

* add fns to rpc api

* rustfmt

* owner api functions RPC documentation in place

* rustfmt

* doctests for new invoicing functions

* rustfmt

* test fixes

* update documentation and doctests

* rustfmt

* invoice testing verification of tx log output

* rustfmt

controller/tests/accounts.rs

@@ -189,7 +189,7 @@ fn accounts_test_impl(test_dir: &str) -> Result<(), libwallet::Error> {
 			selection_strategy_is_use_all: true,
 			..Default::default()
 		};
-		let mut slate = api.initiate_tx(args)?;
+		let mut slate = api.init_send_tx(args)?;
 		slate = client1.send_tx_slate_direct("wallet2", &slate)?;
 		api.tx_lock_outputs(&slate)?;
 		slate = api.finalize_tx(&slate)?;

controller/tests/check.rs

@@ -187,7 +187,7 @@ fn check_repair_impl(test_dir: &str) -> Result<(), libwallet::Error> {
 			selection_strategy_is_use_all: true,
 			..Default::default()
 		};
-		let mut slate = api.initiate_tx(args)?;
+		let mut slate = api.init_send_tx(args)?;
 		// output tx file
 		let file_adapter = FileWalletCommAdapter::new();
 		let send_file = format!("{}/part_tx_1.tx", test_dir);

controller/tests/file.rs

@@ -117,7 +117,7 @@ fn file_exchange_test_impl(test_dir: &str) -> Result<(), libwallet::Error> {
 			message: Some(message.to_owned()),
 			..Default::default()
 		};
-		let mut slate = api.initiate_tx(args)?;
+		let mut slate = api.init_send_tx(args)?;
 		// output tx file
 		let file_adapter = FileWalletCommAdapter::new();
 		file_adapter.send_tx_async(&send_file, &mut slate)?;

controller/tests/invoice.rs

@@ -0,0 +1,187 @@
+// Copyright 2018 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
+#[macro_use]
+extern crate log;
+extern crate grin_wallet_controller as wallet;
+extern crate grin_wallet_impls as impls;
+
+use grin_wallet_util::grin_core as core;
+use grin_wallet_util::grin_keychain as keychain;
+use grin_wallet_util::grin_util as util;
+
+use self::core::global;
+use self::core::global::ChainTypes;
+use self::keychain::ExtKeychain;
+use grin_wallet_libwallet as libwallet;
+use impls::test_framework::{self, LocalWalletClient, WalletProxy};
+use libwallet::{InitTxArgs, IssueInvoiceTxArgs, Slate};
+use std::fs;
+use std::thread;
+use std::time::Duration;
+
+fn clean_output_dir(test_dir: &str) {
+	let _ = fs::remove_dir_all(test_dir);
+}
+
+fn setup(test_dir: &str) {
+	util::init_test_logger();
+	clean_output_dir(test_dir);
+	global::set_mining_mode(ChainTypes::AutomatedTesting);
+}
+
+fn teardown(test_dir: &str) {
+	clean_output_dir(test_dir);
+}
+
+/// self send impl
+fn invoice_tx_impl(test_dir: &str) -> Result<(), libwallet::Error> {
+	{
+		setup(test_dir);
+		// Create a new proxy to simulate server and wallet responses
+		let mut wallet_proxy: WalletProxy<LocalWalletClient, ExtKeychain> =
+			WalletProxy::new(test_dir);
+		let chain = wallet_proxy.chain.clone();
+
+		// Create a new wallet test client, and set its queues to communicate with the proxy
+		let client1 = LocalWalletClient::new("wallet1", wallet_proxy.tx.clone());
+		let wallet1 =
+			test_framework::create_wallet(&format!("{}/wallet1", test_dir), client1.clone(), None);
+		wallet_proxy.add_wallet("wallet1", client1.get_send_instance(), wallet1.clone());
+
+		// wallet 2, will be recipient
+		let client2 = LocalWalletClient::new("wallet2", wallet_proxy.tx.clone());
+		let wallet2 =
+			test_framework::create_wallet(&format!("{}/wallet2", test_dir), client2.clone(), None);
+		wallet_proxy.add_wallet("wallet2", client2.get_send_instance(), wallet2.clone());
+
+		// 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
+		wallet::controller::owner_single_use(wallet1.clone(), |api| {
+			api.create_account_path("mining")?;
+			api.create_account_path("listener")?;
+			Ok(())
+		})?;
+
+		// Get some mining done
+		{
+			let mut w = wallet1.lock();
+			w.set_parent_key_id_by_name("mining")?;
+		}
+		let mut bh = 10u64;
+		let _ = test_framework::award_blocks_to_wallet(&chain, wallet1.clone(), bh as usize, false);
+
+		// Sanity check wallet 1 contents
+		wallet::controller::owner_single_use(wallet1.clone(), |api| {
+			let (wallet1_refreshed, wallet1_info) = api.retrieve_summary_info(true, 1)?;
+			assert!(wallet1_refreshed);
+			assert_eq!(wallet1_info.last_confirmed_height, bh);
+			assert_eq!(wallet1_info.total, bh * reward);
+			Ok(())
+		})?;
+
+		let mut slate = Slate::blank(2);
+
+		wallet::controller::owner_single_use(wallet2.clone(), |api| {
+			// Wallet 2 inititates an invoice transaction, requesting payment
+			let args = IssueInvoiceTxArgs {
+				amount: reward * 2,
+				..Default::default()
+			};
+			slate = api.issue_invoice_tx(args)?;
+			Ok(())
+		})?;
+
+		wallet::controller::owner_single_use(wallet1.clone(), |api| {
+			// Wallet 1 receives the invoice transaction
+			let args = InitTxArgs {
+				src_acct_name: None,
+				amount: slate.amount,
+				minimum_confirmations: 2,
+				max_outputs: 500,
+				num_change_outputs: 1,
+				selection_strategy_is_use_all: true,
+				..Default::default()
+			};
+			slate = api.process_invoice_tx(&slate, args)?;
+			Ok(())
+		})?;
+
+		// wallet 2 finalizes and posts
+		wallet::controller::foreign_single_use(wallet2.clone(), |api| {
+			// Wallet 2 receives the invoice transaction
+			slate = api.finalize_invoice_tx(&slate)?;
+			Ok(())
+		})?;
+
+		// wallet 1 posts so wallet 2 doesn't get the mined amount
+		wallet::controller::owner_single_use(wallet1.clone(), |api| {
+			api.post_tx(&slate.tx, false)?;
+			Ok(())
+		})?;
+		bh += 1;
+
+		let _ = test_framework::award_blocks_to_wallet(&chain, wallet1.clone(), 3, false);
+		bh += 3;
+
+		// Check transaction log for wallet 2
+		wallet::controller::owner_single_use(wallet2.clone(), |api| {
+			let (_, wallet2_info) = api.retrieve_summary_info(true, 1)?;
+			let (refreshed, txs) = api.retrieve_txs(true, None, None)?;
+			assert!(refreshed);
+			assert!(txs.len() == 1);
+			println!(
+				"last confirmed height: {}, bh: {}",
+				wallet2_info.last_confirmed_height, bh
+			);
+			assert!(refreshed);
+			assert_eq!(wallet2_info.amount_currently_spendable, slate.amount);
+			Ok(())
+		})?;
+
+		// let logging finish
+		thread::sleep(Duration::from_millis(200));
+
+		// Check transaction log for wallet 1, ensure only 1 entry
+		// exists
+		wallet::controller::owner_single_use(wallet1.clone(), |api| {
+			let (_, wallet1_info) = api.retrieve_summary_info(true, 1)?;
+			let (refreshed, txs) = api.retrieve_txs(true, None, None)?;
+			assert!(refreshed);
+			assert_eq!(txs.len() as u64, bh + 1);
+			println!(
+				"Wallet 1: last confirmed height: {}, bh: {}",
+				wallet1_info.last_confirmed_height, bh
+			);
+			Ok(())
+		})?;
+	}
+	teardown(test_dir);
+	Ok(())
+}
+
+#[test]
+fn wallet_invoice_tx() -> Result<(), libwallet::Error> {
+	let test_dir = "test_output/invoice_tx";
+	invoice_tx_impl(test_dir)
+}

controller/tests/repost.rs

@@ -112,7 +112,7 @@ fn file_repost_test_impl(test_dir: &str) -> Result<(), libwallet::Error> {
 			selection_strategy_is_use_all: true,
 			..Default::default()
 		};
-		let mut slate = api.initiate_tx(args)?;
+		let mut slate = api.init_send_tx(args)?;
 		// output tx file
 		let file_adapter = FileWalletCommAdapter::new();
 		file_adapter.send_tx_async(&send_file, &mut slate)?;
@@ -209,7 +209,7 @@ fn file_repost_test_impl(test_dir: &str) -> Result<(), libwallet::Error> {
 			selection_strategy_is_use_all: true,
 			..Default::default()
 		};
-		let slate_i = sender_api.initiate_tx(args)?;
+		let slate_i = sender_api.init_send_tx(args)?;
 		slate = client1.send_tx_slate_direct("wallet2", &slate_i)?;
 		sender_api.tx_lock_outputs(&slate)?;
 		slate = sender_api.finalize_tx(&mut slate)?;

controller/tests/restore.rs

@@ -245,7 +245,7 @@ fn setup_restore(test_dir: &str) -> Result<(), libwallet::Error> {
 			selection_strategy_is_use_all: true,
 			..Default::default()
 		};
-		let slate_i = sender_api.initiate_tx(args)?;
+		let slate_i = sender_api.init_send_tx(args)?;
 		slate = client1.send_tx_slate_direct("wallet2", &slate_i)?;
 		sender_api.tx_lock_outputs(&slate)?;
 		slate = sender_api.finalize_tx(&slate)?;
@@ -268,7 +268,7 @@ fn setup_restore(test_dir: &str) -> Result<(), libwallet::Error> {
 			selection_strategy_is_use_all: true,
 			..Default::default()
 		};
-		let slate_i = sender_api.initiate_tx(args)?;
+		let slate_i = sender_api.init_send_tx(args)?;
 		slate = client1.send_tx_slate_direct("wallet3", &slate_i)?;
 		sender_api.tx_lock_outputs(&slate)?;
 		slate = sender_api.finalize_tx(&slate)?;
@@ -291,7 +291,7 @@ fn setup_restore(test_dir: &str) -> Result<(), libwallet::Error> {
 			selection_strategy_is_use_all: true,
 			..Default::default()
 		};
-		let slate_i = sender_api.initiate_tx(args)?;
+		let slate_i = sender_api.init_send_tx(args)?;
 		slate = client3.send_tx_slate_direct("wallet2", &slate_i)?;
 		sender_api.tx_lock_outputs(&slate)?;
 		slate = sender_api.finalize_tx(&slate)?;
@@ -320,7 +320,7 @@ fn setup_restore(test_dir: &str) -> Result<(), libwallet::Error> {
 			selection_strategy_is_use_all: true,
 			..Default::default()
 		};
-		let slate_i = sender_api.initiate_tx(args)?;
+		let slate_i = sender_api.init_send_tx(args)?;
 		slate = client3.send_tx_slate_direct("wallet2", &slate_i)?;
 		sender_api.tx_lock_outputs(&slate)?;
 		slate = sender_api.finalize_tx(&slate)?;

controller/tests/self_send.rs

@@ -96,7 +96,7 @@ fn self_send_test_impl(test_dir: &str) -> Result<(), libwallet::Error> {
 			selection_strategy_is_use_all: true,
 			..Default::default()
 		};
-		let mut slate = api.initiate_tx(args)?;
+		let mut slate = api.init_send_tx(args)?;
 		api.tx_lock_outputs(&slate)?;
 		// Send directly to self
 		wallet::controller::foreign_single_use(wallet1.clone(), |api| {

controller/tests/transaction.rs

@@ -73,8 +73,8 @@ fn basic_transaction_api(test_dir: &str) -> Result<(), libwallet::Error> {
 
 	// few values to keep things shorter
 	let reward = core::consensus::REWARD;
-	let cm = global::coinbase_maturity(); // assume all testing precedes soft fork height
-									  // mine a few blocks
+	let cm = global::coinbase_maturity();
+	// mine a few blocks
 	let _ = test_framework::award_blocks_to_wallet(&chain, wallet1.clone(), 10, false);
 
 	// Check wallet 1 contents are as expected
@@ -108,7 +108,7 @@ fn basic_transaction_api(test_dir: &str) -> Result<(), libwallet::Error> {
 			selection_strategy_is_use_all: true,
 			..Default::default()
 		};
-		let slate_i = sender_api.initiate_tx(args)?;
+		let slate_i = sender_api.init_send_tx(args)?;
 
 		// Check we are creating a tx with the expected lock_height of 0.
 		// We will check this produces a Plain kernel later.
@@ -261,7 +261,7 @@ fn basic_transaction_api(test_dir: &str) -> Result<(), libwallet::Error> {
 			estimate_only: Some(true),
 			..Default::default()
 		};
-		let est = sender_api.initiate_tx(init_args)?;
+		let est = sender_api.init_send_tx(init_args)?;
 		assert_eq!(est.amount, 600_000_000_000);
 		assert_eq!(est.fee, 4_000_000);
 
@@ -275,7 +275,7 @@ fn basic_transaction_api(test_dir: &str) -> Result<(), libwallet::Error> {
 			estimate_only: Some(true),
 			..Default::default()
 		};
-		let est = sender_api.initiate_tx(init_args)?;
+		let est = sender_api.init_send_tx(init_args)?;
 		assert_eq!(est.amount, 180_000_000_000);
 		assert_eq!(est.fee, 6_000_000);
 
@@ -295,7 +295,7 @@ fn basic_transaction_api(test_dir: &str) -> Result<(), libwallet::Error> {
 			selection_strategy_is_use_all: true,
 			..Default::default()
 		};
-		let slate_i = sender_api.initiate_tx(args)?;
+		let slate_i = sender_api.init_send_tx(args)?;
 		slate = client1.send_tx_slate_direct("wallet2", &slate_i)?;
 		sender_api.tx_lock_outputs(&slate)?;
 		slate = sender_api.finalize_tx(&slate)?;
@@ -395,7 +395,7 @@ fn tx_rollback(test_dir: &str) -> Result<(), libwallet::Error> {
 			..Default::default()
 		};
 
-		let slate_i = sender_api.initiate_tx(args)?;
+		let slate_i = sender_api.init_send_tx(args)?;
 		slate = client1.send_tx_slate_direct("wallet2", &slate_i)?;
 		sender_api.tx_lock_outputs(&slate)?;
 		slate = sender_api.finalize_tx(&slate)?;