Struct sn_transfers::HotWallet

pub struct HotWallet { /* private fields */ }

A hot-wallet.

Implementations

impl HotWallet

pub fn api(&self) -> &WalletApi

pub fn lock(&self) -> Result<File>

Locks the wallet and returns exclusive access to the wallet This lock prevents any other process from locking the wallet dir, effectively acts as a mutex for the wallet

pub fn store_cash_notes_to_disk<'a, T>(&self, cash_notes: T) -> Result<()>

where T: IntoIterator<Item = &'a CashNote>,

Stores the given cash_notes to the created cash_notes dir in the wallet dir. These can then be sent to the recipients out of band, over any channel preferred.

pub fn remove_cash_notes_from_disk<'a, T>(&self, cash_notes: T) -> Result<()>

where T: IntoIterator<Item = &'a UniquePubkey>,

Removes the given cash_notes from the created cash_notes dir in the wallet dir.

pub fn store_unconfirmed_spend_requests(&mut self) -> Result<()>

Store unconfirmed_spend_requests to disk.

pub fn mark_notes_as_spent<'a, T>(&mut self, unique_pubkeys: T)

where T: IntoIterator<Item = &'a UniquePubkey>,

Remove referenced CashNotes from available_cash_notes

pub fn unconfirmed_spend_requests_exist(&self) -> bool

pub fn try_load_cash_notes(&mut self) -> Result<()>

Try to load any new cash_notes from the cash_notes dir in the wallet dir.

pub fn load_from_main_key( root_dir: &Path, main_key: MainSecretKey ) -> Result<Self>

Loads a serialized wallet from a path and given main key.

pub fn create_from_key(root_dir: &Path, key: MainSecretKey) -> Result<Self>

Creates a serialized wallet for a path and main key. This will overwrite any existing wallet, unlike load_from_main_key

pub fn load_from(root_dir: &Path) -> Result<Self>

Loads a serialized wallet from a path.

pub fn try_load_from(root_dir: &Path) -> Result<Self>

Tries to loads a serialized wallet from a path, bailing out if it doesn’t exist.

pub fn load_from_path( wallet_dir: &Path, main_key: Option<MainSecretKey> ) -> Result<Self>

Loads a serialized wallet from a given path, no additional element will be added to the provided path and strictly taken as the wallet files location.

pub fn address(&self) -> MainPubkey

pub fn unconfirmed_spend_requests(&self) -> &BTreeSet<SignedSpend>

pub fn stash(root_dir: &Path) -> Result<PathBuf>

Moves all files for the current wallet, including keys and cashnotes to directory root_dir/wallet_ADDRESS

pub fn unstash(root_dir: &Path, addr_hex: &str) -> Result<()>

Moves a previously stashed wallet to the root wallet directory.

pub fn remove(root_dir: &Path) -> Result<()>

Removes all files for the current wallet, including keys and cashnotes

pub fn clear_specific_spend_request(&mut self, unique_pub_key: UniquePubkey)

To remove a specific spend from the requests, if eg, we see one spend is bad

pub fn clear_confirmed_spend_requests(&mut self)

Once spends are verified we can clear them and clean up

pub fn balance(&self) -> NanoTokens

pub fn sign( &self, spends: impl IntoIterator<Item = (Spend, DerivationIndex)> ) -> BTreeSet<SignedSpend>

pub fn available_cash_notes( &mut self ) -> Result<(Vec<(CashNote, Option<DerivedSecretKey>)>, File)>

Returns all available cash_notes and an exclusive access to the wallet so no concurrent processes can get available cash_notes while we’re modifying the wallet once the updated wallet is stored to disk it is safe to drop the WalletExclusiveAccess

pub fn remove_payment_for_xorname(&self, name: &XorName)

Remove the payment_details of the given XorName from disk.

pub fn build_unsigned_transaction( &mut self, to: Vec<(String, NanoTokens, MainPubkey)>, reason_hash: Option<Hash> ) -> Result<UnsignedTransfer>

pub fn local_send( &mut self, to: Vec<(String, NanoTokens, MainPubkey)>, reason_hash: Option<Hash> ) -> Result<Vec<CashNote>>

Make a transfer and return all created cash_notes

pub fn prepare_signed_transfer( &mut self, signed_spends: BTreeSet<SignedSpend>, tx: Transaction, change_id: UniquePubkey, output_details: BTreeMap<UniquePubkey, CashNoteOutputDetails> ) -> Result<Vec<CashNote>>

Prepare a signed transaction in local wallet and return all created cash_notes

pub fn local_send_storage_payment( &mut self, price_map: &BTreeMap<XorName, (MainPubkey, PaymentQuote, Vec<u8>)> ) -> Result<(NanoTokens, NanoTokens)>

Performs a payment for each content address. Includes payment of network royalties. Returns the amount paid for storage, including the network royalties fee paid.

pub fn deposit(&mut self, received_cash_notes: &Vec<CashNote>) -> Result<()>

Deposit the given cash_notes on the wallet (without storing them to disk).

pub fn deposit_and_store_to_disk( &mut self, received_cash_notes: &Vec<CashNote> ) -> Result<()>

Store the given cash_notes to the cash_notes dir in the wallet dir. Update and store the updated wallet to disk This function locks the wallet to prevent concurrent processes from writing to it

pub fn unwrap_transfer( &self, transfer: &Transfer ) -> Result<Vec<CashNoteRedemption>>

pub fn derive_key(&self, derivation_index: &DerivationIndex) -> DerivedSecretKey