Refactor crate names, API Crate refactor

.travis.yml

@@ -52,7 +52,7 @@ env:
 matrix:
   include:
     - os: linux
-      env: CI_JOB="test"        CI_JOB_ARGS="config libwallet apiwallet"
+      env: CI_JOB="test"        CI_JOB_ARGS="config libwallet api"
     - os: linux
       env: CI_JOB="test"        CI_JOB_ARGS="refwallet ."
     - os: linux

Cargo.toml

@@ -16,7 +16,7 @@ name = "grin-wallet"
 path = "src/bin/grin-wallet.rs"
 
 [workspace]
-members = ["apiwallet", "config", "libwallet", "refwallet"]
+members = ["api", "config", "libwallet", "refwallet"]
 exclude = ["integration"]
 
 [dependencies]
@@ -29,9 +29,9 @@ prettytable-rs = "0.7"
 log = "0.4"
 linefeed = "0.5"
 
-grin_apiwallet = { path = "./apiwallet", version = "1.1.0" }
-grin_libwallet = { path = "./libwallet", version = "1.1.0" }
-grin_refwallet = { path = "./refwallet", version = "1.1.0" }
+grin_wallet_api = { path = "./api", version = "1.1.0" }
+grin_wallet_libwallet = { path = "./libwallet", version = "1.1.0" }
+grin_wallet_refwallet = { path = "./refwallet", version = "1.1.0" }
 grin_wallet_config = { path = "./config", version = "1.1.0" }
 
 grin_core = { git = "https://github.com/mimblewimble/grin", branch = "milestone/1.1.0" }

apiwallet/Cargo.toml → api/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "grin_apiwallet"
+name = "grin_wallet_api"
 version = "1.1.0"
 authors = ["Grin Developers <[email protected]>"]
 description = "Grin Wallet API"
@@ -17,7 +17,7 @@ log = "0.4"
 uuid = { version = "0.6", features = ["serde", "v4"] }
 easy-jsonrpc = "0.4.1"
 
-grin_libwallet = { path = "../libwallet", version = "1.1.0" }
+grin_wallet_libwallet = { path = "../libwallet", version = "1.1.0" }
 grin_wallet_config = { path = "../config", version = "1.1.0" }
 
 grin_core = { git = "https://github.com/mimblewimble/grin", branch = "milestone/1.1.0" }
@@ -28,6 +28,6 @@ grin_api = { git = "https://github.com/mimblewimble/grin", branch = "milestone/1
 grin_store = { git = "https://github.com/mimblewimble/grin", branch = "milestone/1.1.0" }
 
 [dev-dependencies]
-grin_refwallet = { path = "../refwallet", version = "1.1.0" }
+grin_wallet_refwallet = { path = "../refwallet", version = "1.1.0" }
 serde_json = "1"
 tempfile = "3.0.7"

api/src/foreign.rs

@@ -0,0 +1,129 @@
+// 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.
+
+//! Main interface into all wallet API functions.
+//! Wallet APIs are split into two seperate blocks of functionality
+//! called the 'Owner' and 'Foreign' APIs:
+//!
+//! * The 'Foreign' API contains methods that other wallets will
+//! use to interact with the owner's wallet. This API can be exposed
+//! to the outside world, with the consideration as to how that can
+//! be done securely up to the implementor.
+//!
+//! Methods in both APIs are intended to be 'single use', that is to say each
+//! method will 'open' the wallet (load the keychain with its master seed), perform
+//! its operation, then 'close' the wallet (unloading references to the keychain and master
+//! seed).
+
+use crate::keychain::Keychain;
+use crate::libwallet::internal::{tx, updater};
+use crate::libwallet::slate::Slate;
+use crate::libwallet::types::{BlockFees, CbData, NodeClient, TxLogEntryType, WalletBackend};
+use crate::libwallet::{Error, ErrorKind};
+use crate::util::secp::{ContextFlag, Secp256k1};
+use crate::util::Mutex;
+use std::marker::PhantomData;
+use std::sync::Arc;
+
+const USER_MESSAGE_MAX_LEN: usize = 256;
+
+/// Wrapper around external API functions, intended to communicate
+/// with other parties
+pub struct Foreign<W: ?Sized, C, K>
+where
+	W: WalletBackend<C, K>,
+	C: NodeClient,
+	K: Keychain,
+{
+	/// Wallet, contains its keychain (TODO: Split these up into 2 traits
+	/// perhaps)
+	pub wallet: Arc<Mutex<W>>,
+	phantom: PhantomData<K>,
+	phantom_c: PhantomData<C>,
+}
+
+impl<'a, W: ?Sized, C, K> Foreign<W, C, K>
+where
+	W: WalletBackend<C, K>,
+	C: NodeClient,
+	K: Keychain,
+{
+	/// Create new API instance
+	pub fn new(wallet_in: Arc<Mutex<W>>) -> Box<Self> {
+		Box::new(Foreign {
+			wallet: wallet_in,
+			phantom: PhantomData,
+			phantom_c: PhantomData,
+		})
+	}
+
+	/// Build a new (potential) coinbase transaction in the wallet
+	pub fn build_coinbase(&self, block_fees: &BlockFees) -> Result<CbData, Error> {
+		let mut w = self.wallet.lock();
+		w.open_with_credentials()?;
+		let res = updater::build_coinbase(&mut *w, block_fees);
+		w.close()?;
+		res
+	}
+
+	/// Verifies all messages in the slate match their public keys
+	pub fn verify_slate_messages(&self, slate: &Slate) -> Result<(), Error> {
+		let secp = Secp256k1::with_caps(ContextFlag::VerifyOnly);
+		slate.verify_messages(&secp)?;
+		Ok(())
+	}
+
+	/// Receive a transaction from a sender
+	pub fn receive_tx(
+		&self,
+		slate: &mut Slate,
+		dest_acct_name: Option<&str>,
+		message: Option<String>,
+	) -> Result<(), Error> {
+		let mut w = self.wallet.lock();
+		w.open_with_credentials()?;
+		let parent_key_id = match dest_acct_name {
+			Some(d) => {
+				let pm = w.get_acct_path(d.to_owned())?;
+				match pm {
+					Some(p) => p.path,
+					None => w.parent_key_id(),
+				}
+			}
+			None => w.parent_key_id(),
+		};
+		// Don't do this multiple times
+		let tx = updater::retrieve_txs(&mut *w, None, Some(slate.id), Some(&parent_key_id), false)?;
+		for t in &tx {
+			if t.tx_type == TxLogEntryType::TxReceived {
+				return Err(ErrorKind::TransactionAlreadyReceived(slate.id.to_string()).into());
+			}
+		}
+
+		let message = match message {
+			Some(mut m) => {
+				m.truncate(USER_MESSAGE_MAX_LEN);
+				Some(m)
+			}
+			None => None,
+		};
+
+		let (_, mut create_fn) =
+			tx::add_output_to_slate(&mut *w, slate, &parent_key_id, 1, message)?;
+		create_fn(&mut *w, &slate.tx, PhantomData, PhantomData)?;
+		tx::update_message(&mut *w, slate)?;
+		w.close()?;
+		Ok(())
+	}
+}