feat: deep clean sn_transfers, reduce exposition, remove dead code

BREAKING CHANGE: sn_transfers type API exposision changes

sn_cli/src/main.rs

@@ -29,7 +29,7 @@ use sn_client::Client;
 #[cfg(feature = "metrics")]
 use sn_logging::{init_logging, metrics::init_metrics, LogFormat};
 use sn_peers_acquisition::parse_peers_args;
-use sn_transfers::wallet::bls_secret_from_hex;
+use sn_transfers::bls_secret_from_hex;
 use std::path::PathBuf;
 use tracing::Level;
 

sn_cli/src/subcommands/register.rs

@@ -11,7 +11,7 @@ use clap::Subcommand;
 use color_eyre::{eyre::WrapErr, Result, Section};
 use sn_client::{Client, ClientRegister, Error as ClientError, WalletClient};
 use sn_protocol::storage::RegisterAddress;
-use sn_transfers::wallet::LocalWallet;
+use sn_transfers::LocalWallet;
 use std::path::Path;
 use xor_name::XorName;
 

sn_cli/src/subcommands/wallet.rs

@@ -9,8 +9,8 @@
 use clap::Parser;
 use color_eyre::{eyre::eyre, Result};
 use sn_client::{Client, Files, WalletClient};
-use sn_transfers::wallet::{parse_main_pubkey, LocalWallet};
 use sn_transfers::NanoTokens;
+use sn_transfers::{parse_main_pubkey, LocalWallet};
 use std::{
     io::Read,
     path::{Path, PathBuf},

sn_client/src/api.rs

@@ -31,7 +31,7 @@ use sn_protocol::{
 use sn_transfers::{MainPubkey, NanoTokens, SignedSpend, UniquePubkey};
 
 use sn_registers::SignedRegister;
-use sn_transfers::{transfers::SpendRequest, wallet::Transfer};
+use sn_transfers::{SpendRequest, Transfer};
 use std::time::Duration;
 use tokio::{sync::OwnedSemaphorePermit, task::spawn};
 use tracing::trace;

sn_client/src/error.rs

@@ -18,7 +18,7 @@ use thiserror::Error;
 #[allow(missing_docs)]
 pub enum Error {
     #[error("Genesis error {0}")]
-    GenesisError(#[from] sn_transfers::genesis::Error),
+    GenesisError(#[from] sn_transfers::GenesisError),
 
     /// Could not acquire a Semaphore permit.
     #[error("Could not acquire a Semaphore permit.")]
@@ -29,7 +29,7 @@ pub enum Error {
     NoNetworkConcurrencyLimiterFound,
 
     #[error("Transfer Error {0}.")]
-    Transfers(#[from] sn_transfers::wallet::Error),
+    Transfers(#[from] sn_transfers::WalletError),
 
     #[error("Network Error {0}.")]
     Network(#[from] sn_networking::Error),

sn_client/src/faucet/mod.rs

@@ -1,8 +1,8 @@
 use super::{wallet::send, Result};
 use crate::Client;
 
-use sn_transfers::genesis::{create_faucet_wallet, load_genesis_wallet};
-use sn_transfers::wallet::LocalWallet;
+use sn_transfers::LocalWallet;
+use sn_transfers::{create_faucet_wallet, load_genesis_wallet};
 use sn_transfers::{CashNote, MainPubkey, NanoTokens};
 
 /// Returns a cash_note with the requested number of tokens, for use by E2E test instances.

sn_client/src/file_apis.rs

@@ -21,7 +21,7 @@ use sn_protocol::{
     storage::{Chunk, ChunkAddress},
     NetworkAddress, PrettyPrintRecordKey,
 };
-use sn_transfers::wallet::LocalWallet;
+use sn_transfers::LocalWallet;
 
 use std::{
     fs::{self, create_dir_all, File},

sn_client/src/register.rs

@@ -19,7 +19,7 @@ use sn_protocol::{
 use sn_registers::{
     Entry, EntryHash, Permissions, Register, RegisterAddress, SignedRegister, User,
 };
-use sn_transfers::wallet::Transfer;
+use sn_transfers::Transfer;
 
 use std::collections::{BTreeSet, LinkedList};
 use xor_name::XorName;

sn_client/src/wallet.rs

@@ -6,17 +6,14 @@
 // KIND, either express or implied. Please review the Licences for the specific language governing
 // permissions and limitations relating to use of the SAFE Network Software.
 
-use sn_transfers::{transfers::SpendRequest, wallet::Transfer};
+use sn_transfers::{SpendRequest, Transfer};
 use xor_name::XorName;
 
 use super::Client;
 
 use sn_protocol::NetworkAddress;
-use sn_transfers::{
-    transfers::TransferOutputs,
-    wallet::{Error, LocalWallet, Result},
-};
 use sn_transfers::{CashNote, MainPubkey, NanoTokens};
+use sn_transfers::{LocalWallet, OfflineTransfer, WalletError, WalletResult};
 
 use futures::future::join_all;
 use std::{
@@ -40,7 +37,7 @@ impl WalletClient {
     }
 
     /// Stores the wallet to disk.
-    pub fn store_local_wallet(&self) -> Result<()> {
+    pub fn store_local_wallet(&self) -> WalletResult<()> {
         self.wallet.store()
     }
 
@@ -59,13 +56,13 @@ impl WalletClient {
     }
 
     /// Get the payment transfers for a given network address
-    pub fn get_payment_transfers(&self, address: &NetworkAddress) -> Result<Vec<Transfer>> {
+    pub fn get_payment_transfers(&self, address: &NetworkAddress) -> WalletResult<Vec<Transfer>> {
         match &address.as_xorname() {
             Some(xorname) => {
                 let cash_notes = self.wallet.get_payment_cash_notes(xorname);
                 Transfer::transfers_from_cash_notes(cash_notes)
             }
-            None => Err(Error::InvalidAddressType),
+            None => Err(WalletError::InvalidAddressType),
         }
     }
 
@@ -76,7 +73,7 @@ impl WalletClient {
         amount: NanoTokens,
         to: MainPubkey,
         verify_store: bool,
-    ) -> Result<CashNote> {
+    ) -> WalletResult<CashNote> {
         let created_cash_notes = self.wallet.local_send(vec![(amount, to)], None)?;
 
         // send to network
@@ -94,7 +91,7 @@ impl WalletClient {
         // return created CashNotes even if network part failed???
         match &created_cash_notes[..] {
             [info, ..] => Ok(info.clone()),
-            [] => Err(Error::CouldNotSendMoney(
+            [] => Err(WalletError::CouldNotSendMoney(
                 "No CashNotes were returned from the wallet.".into(),
             )),
         }
@@ -104,13 +101,12 @@ impl WalletClient {
     /// Returns a Vec of proofs
     pub async fn get_store_cost_at_address(
         &self,
-
         address: &NetworkAddress,
-    ) -> Result<Vec<(MainPubkey, NanoTokens)>> {
+    ) -> WalletResult<Vec<(MainPubkey, NanoTokens)>> {
         self.client
             .get_store_costs_at_address(address)
             .await
-            .map_err(|error| Error::CouldNotSendMoney(error.to_string()))
+            .map_err(|error| WalletError::CouldNotSendMoney(error.to_string()))
     }
 
     /// Send tokens to nodes closest to the data we want to make storage payment for.
@@ -122,7 +118,7 @@ impl WalletClient {
         &mut self,
         content_addrs: impl Iterator<Item = NetworkAddress>,
         verify_store: bool,
-    ) -> Result<NanoTokens> {
+    ) -> WalletResult<NanoTokens> {
         let mut total_cost = NanoTokens::zero();
 
         let mut payment_map = BTreeMap::default();
@@ -135,7 +131,7 @@ impl WalletClient {
                 let costs = client
                     .get_store_costs_at_address(&content_addr)
                     .await
-                    .map_err(|error| Error::CouldNotSendMoney(error.to_string()));
+                    .map_err(|error| WalletError::CouldNotSendMoney(error.to_string()));
                 (content_addr, costs)
             });
         }
@@ -186,7 +182,7 @@ impl WalletClient {
         &mut self,
         all_data_payments: BTreeMap<XorName, Vec<(MainPubkey, NanoTokens)>>,
         verify_store: bool,
-    ) -> Result<NanoTokens> {
+    ) -> WalletResult<NanoTokens> {
         // TODO:
         // Check for any existing payment CashNotes, and use them if they exist, only topping up if needs be
         let num_of_payments = all_data_payments.len();
@@ -198,7 +194,7 @@ impl WalletClient {
                 if let Some(new_cost) = total_cost.checked_add(*cost) {
                     total_cost = new_cost;
                 } else {
-                    return Err(Error::TotalPriceTooHigh);
+                    return Err(WalletError::TotalPriceTooHigh);
                 }
             }
         }
@@ -263,7 +259,7 @@ impl Client {
         &self,
         spend_requests: &BTreeSet<SpendRequest>,
         verify_store: bool,
-    ) -> Result<()> {
+    ) -> WalletResult<()> {
         let mut tasks = Vec::new();
 
         for spend_request in spend_requests {
@@ -275,15 +271,15 @@ impl Client {
         }
 
         for spend_attempt_result in join_all(tasks).await {
-            spend_attempt_result.map_err(|err| Error::CouldNotSendMoney(err.to_string()))?;
+            spend_attempt_result.map_err(|err| WalletError::CouldNotSendMoney(err.to_string()))?;
         }
 
         Ok(())
     }
 
     /// Send a spend request to the network.
     /// This does _not_ verify the spend has been put to the network correctly
-    pub async fn send_without_verify(&self, transfer: TransferOutputs) -> Result<()> {
+    pub async fn send_without_verify(&self, transfer: OfflineTransfer) -> WalletResult<()> {
         let mut tasks = Vec::new();
         for spend_request in &transfer.all_spend_requests {
             trace!(
@@ -294,13 +290,13 @@ impl Client {
         }
 
         for spend_attempt_result in join_all(tasks).await {
-            spend_attempt_result.map_err(|err| Error::CouldNotSendMoney(err.to_string()))?;
+            spend_attempt_result.map_err(|err| WalletError::CouldNotSendMoney(err.to_string()))?;
         }
 
         Ok(())
     }
 
-    pub async fn verify(&self, cash_note: &CashNote) -> Result<()> {
+    pub async fn verify(&self, cash_note: &CashNote) -> WalletResult<()> {
         // We need to get all the spends in the cash_note from the network,
         // and compare them to the spends in the cash_note, to know if the
         // transfer is considered valid in the network.
@@ -312,7 +308,7 @@ impl Client {
         let mut received_spends = std::collections::BTreeSet::new();
         for result in join_all(tasks).await {
             let network_valid_spend =
-                result.map_err(|err| Error::CouldNotVerifyTransfer(err.to_string()))?;
+                result.map_err(|err| WalletError::CouldNotVerifyTransfer(err.to_string()))?;
             let _ = received_spends.insert(network_valid_spend);
         }
 
@@ -321,7 +317,7 @@ impl Client {
         if received_spends == cash_note.signed_spends {
             return Ok(());
         }
-        Err(Error::CouldNotVerifyTransfer(
+        Err(WalletError::CouldNotVerifyTransfer(
             "The spends in network were not the same as the ones in the CashNote. The parents of this CashNote are probably double spends.".into(),
         ))
     }
@@ -335,7 +331,7 @@ pub async fn send(
     to: MainPubkey,
     client: &Client,
     verify_store: bool,
-) -> Result<CashNote> {
+) -> WalletResult<CashNote> {
     if amount.as_nano() == 0 {
         panic!("Amount must be more than zero.");
     }
@@ -373,7 +369,7 @@ pub async fn send(
         .expect("Created cash_note shall be successfully stored.");
 
     if did_error {
-        return Err(Error::UnconfirmedTxAfterRetries);
+        return Err(WalletError::UnconfirmedTxAfterRetries);
     }
 
     Ok(new_cash_note)

sn_networking/src/transfers.rs

@@ -15,8 +15,8 @@ use sn_protocol::{
     storage::{try_deserialize_record, RecordHeader, RecordKind, SpendAddress},
     NetworkAddress, PrettyPrintRecordKey,
 };
-use sn_transfers::wallet::{LocalWallet, Transfer};
 use sn_transfers::{CashNote, DerivationIndex, SignedSpend, Transaction, UniquePubkey};
+use sn_transfers::{LocalWallet, Transfer};
 use tokio::task::JoinSet;
 
 impl Network {

sn_node/examples/registers.rs

@@ -8,7 +8,7 @@
 
 use sn_client::{Client, Error, WalletClient};
 use sn_registers::RegisterAddress;
-use sn_transfers::wallet::LocalWallet;
+use sn_transfers::LocalWallet;
 use xor_name::XorName;
 
 use bls::SecretKey;

sn_node/src/api.rs

@@ -20,7 +20,7 @@ use sn_protocol::{
     messages::{Cmd, CmdResponse, Query, QueryResponse, Request, Response},
     NetworkAddress, PrettyPrintRecordKey,
 };
-use sn_transfers::wallet::LocalWallet;
+use sn_transfers::LocalWallet;
 use sn_transfers::MainSecretKey;
 use std::{
     collections::HashSet,

sn_node/src/bin/faucet/main.rs

@@ -14,7 +14,7 @@ use faucet_server::run_faucet_server;
 use sn_client::{get_tokens_from_faucet, load_faucet_wallet_from_genesis_wallet, Client};
 use sn_logging::{init_logging, LogFormat, LogOutputDest};
 use sn_peers_acquisition::{parse_peers_args, PeersArgs};
-use sn_transfers::{wallet::parse_main_pubkey, NanoTokens};
+use sn_transfers::{parse_main_pubkey, NanoTokens};
 use std::path::PathBuf;
 use tracing::info;
 use tracing_core::Level;

sn_node/src/error.rs

@@ -8,7 +8,7 @@
 
 use sn_networking::Error as NetworkError;
 use sn_protocol::error::Error as ProtocolError;
-use sn_transfers::wallet::Error as RewardsWalletError;
+use sn_transfers::WalletError;
 use thiserror::Error;
 
 pub(super) type Result<T, E = Error> = std::result::Result<T, E>;
@@ -27,5 +27,5 @@ pub enum Error {
     NodeEventParsingFailed,
 
     #[error("Node's rewards wallet error {0}")]
-    RewardsWallet(#[from] RewardsWalletError),
+    RewardsWallet(#[from] WalletError),
 }

sn_node/src/put_validation.rs

@@ -20,10 +20,7 @@ use sn_protocol::{
     NetworkAddress, PrettyPrintRecordKey,
 };
 use sn_registers::SignedRegister;
-use sn_transfers::{
-    genesis::{is_genesis_parent_tx, GENESIS_CASHNOTE},
-    wallet::{LocalWallet, Transfer},
-};
+use sn_transfers::{is_genesis_parent_tx, LocalWallet, Transfer, GENESIS_CASHNOTE};
 use sn_transfers::{CashNote, NanoTokens, SignedSpend, UniquePubkey};
 use std::collections::{BTreeSet, HashSet};
 

sn_node/src/spends.rs

@@ -11,7 +11,7 @@ use sn_protocol::{
     error::{Error, Result},
     storage::SpendAddress,
 };
-use sn_transfers::genesis::{is_genesis_parent_tx, GENESIS_CASHNOTE};
+use sn_transfers::{is_genesis_parent_tx, GENESIS_CASHNOTE};
 use sn_transfers::{SignedSpend, UniquePubkey};
 use std::{
     collections::{BTreeSet, HashSet},

sn_node/tests/common/mod.rs

@@ -18,7 +18,7 @@ use self_encryption::MIN_ENCRYPTABLE_BYTES;
 use sn_client::{load_faucet_wallet_from_genesis_wallet, send, Client, Files};
 use sn_peers_acquisition::parse_peer_addr;
 use sn_protocol::storage::ChunkAddress;
-use sn_transfers::wallet::LocalWallet;
+use sn_transfers::LocalWallet;
 
 use bytes::Bytes;
 use eyre::{eyre, Result};

sn_node/tests/data_with_churn.rs

@@ -22,7 +22,7 @@ use sn_protocol::{
     storage::{Chunk, ChunkAddress, RegisterAddress, SpendAddress},
     NetworkAddress,
 };
-use sn_transfers::wallet::LocalWallet;
+use sn_transfers::LocalWallet;
 use sn_transfers::{CashNote, MainSecretKey, NanoTokens};
 use std::{
     collections::{BTreeMap, VecDeque},

sn_node/tests/nodes_rewards.rs

@@ -15,7 +15,7 @@ use sn_protocol::{
     storage::{ChunkAddress, RegisterAddress},
     NetworkAddress,
 };
-use sn_transfers::wallet::LocalWallet;
+use sn_transfers::LocalWallet;
 use sn_transfers::NanoTokens;
 use xor_name::XorName;
 

sn_node/tests/sequential_transfers.rs

@@ -12,7 +12,7 @@ use common::{get_client_and_wallet, get_wallet, init_logging};
 
 use sn_client::send;
 
-use sn_transfers::transfers::create_offline_transfer;
+use sn_transfers::create_offline_transfer;
 use sn_transfers::{rng, Hash, NanoTokens, UniquePubkey};
 
 use assert_fs::TempDir;

sn_node/tests/verify_data_location.rs

@@ -25,7 +25,7 @@ use sn_client::{Client, Files, WalletClient};
 use sn_logging::{init_logging, LogFormat, LogOutputDest};
 use sn_networking::{sort_peers_by_key, CLOSE_GROUP_SIZE};
 use sn_protocol::{storage::ChunkAddress, NetworkAddress, PrettyPrintRecordKey};
-use sn_transfers::wallet::LocalWallet;
+use sn_transfers::LocalWallet;
 use std::{
     collections::{BTreeSet, HashMap, HashSet},
     fs::File,