sysio::wallet::soft_wallet Class Reference

#include <wallet.hpp>

Inheritance diagram for sysio::wallet::soft_wallet:

Collaboration diagram for sysio::wallet::soft_wallet:

Public Member Functions
	soft_wallet (const wallet_data &initial_data)
	~soft_wallet ()
bool	copy_wallet_file (string destination_filename)
string	get_wallet_filename () const
private_key_type	get_private_key (public_key_type pubkey) const override
pair< public_key_type, private_key_type >	get_private_key_from_password (string account, string role, string password) const
bool	is_new () const
bool	is_locked () const override
void	lock () override
void	unlock (string password) override
void	check_password (string password) override
void	set_password (string password) override
map< public_key_type, private_key_type >	list_keys () override
flat_set< public_key_type >	list_public_keys () override
bool	load_wallet_file (string wallet_filename="")
void	save_wallet_file (string wallet_filename="")
void	set_wallet_filename (string wallet_filename)
bool	import_key (string wif_key) override
bool	remove_key (string key) override
string	create_key (string key_type) override
std::optional< signature_type >	try_sign_digest (const digest_type digest, const public_key_type public_key) override
void	encrypt_keys ()
Public Member Functions inherited from sysio::wallet::wallet_api
virtual	~wallet_api ()

Public Attributes
std::shared_ptr< detail::soft_wallet_impl >	my

Detailed Description

This wallet assumes it is connected to the database server with a high-bandwidth, low-latency connection and performs minimal caching.

Definition at line 29 of file wallet.hpp.

Constructor & Destructor Documentation

soft_wallet()

sysio::wallet::soft_wallet::soft_wallet

(

const wallet_data &

initial_data

)

Definition at line 266 of file wallet.cpp.

   : my(new detail::soft_wallet_impl(*this, initial_data))
{}

~soft_wallet()

sysio::wallet::soft_wallet::~soft_wallet

(

)

Definition at line 270 of file wallet.cpp.

{}

Member Function Documentation

check_password()

void sysio::wallet::soft_wallet::check_password ( string password )

overridevirtual

Checks the password of the wallet

Validates the password on a wallet even if the wallet is already unlocked, throws if bad password given.

Parameters

password

the password previously set with set_password()

Implements sysio::wallet::wallet_api.

Definition at line 363 of file wallet.cpp.

{ try {
   FC_ASSERT(password.size() > 0);
   auto pw = fc::sha512::hash(password.c_str(), password.size());
   vector<char> decrypted = fc::aes_decrypt(pw, my->_wallet.cipher_keys);
   auto pk = fc::raw::unpack<plain_keys>(decrypted);
   FC_ASSERT(pk.checksum == pw);
} SYS_RETHROW_EXCEPTIONS(chain::wallet_invalid_password_exception,
                          "Invalid password for wallet: \"${wallet_name}\"", ("wallet_name", get_wallet_filename())) }

Here is the call graph for this function:

copy_wallet_file()

bool sysio::wallet::soft_wallet::copy_wallet_file

(

string

destination_filename

)

Definition at line 272 of file wallet.cpp.

{
   return my->copy_wallet_file(destination_filename);
}

create_key()

string sysio::wallet::soft_wallet::create_key ( string key_type )

overridevirtual

Creates a key within the wallet to be used to sign transactions by an account.

example: create_key K1

Parameters

key_type

the key type to create. May be empty to allow wallet to pick appropriate/"best" key type

Implements sysio::wallet::wallet_api.

Definition at line 306 of file wallet.cpp.

{
   SYS_ASSERT(!is_locked(), wallet_locked_exception, "Unable to create key on a locked wallet");
 
   string ret = my->create_key(key_type);
   save_wallet_file();
   return ret;
}

Here is the call graph for this function:

encrypt_keys()

void sysio::wallet::soft_wallet::encrypt_keys

(

)

Definition at line 335 of file wallet.cpp.

{
   my->encrypt_keys();
}

Here is the caller graph for this function:

get_private_key()

private_key_type sysio::wallet::soft_wallet::get_private_key ( public_key_type pubkey ) const

overridevirtual

Get the WIF private key corresponding to a public key. The private key must already be in the wallet.

Implements sysio::wallet::wallet_api.

Definition at line 394 of file wallet.cpp.

{
   return my->get_private_key( pubkey );
}

get_private_key_from_password()

pair< public_key_type, private_key_type > sysio::wallet::soft_wallet::get_private_key_from_password	(	string	account,
		string	role,
		string	password ) const

Parameters

role	- active | owner | posting | memo

Definition at line 403 of file wallet.cpp.

                                                                                                                                     {
   auto seed = account + role + password;
   SYS_ASSERT( seed.size(), wallet_exception, "seed should not be empty" );
   auto secret = fc::sha256::hash( seed.c_str(), seed.size() );
   auto priv = private_key_type::regenerate<fc::ecc::private_key_shim>( secret );
   return std::make_pair(  priv.get_public_key(), priv );
}

Here is the call graph for this function:

get_wallet_filename()

string sysio::wallet::soft_wallet::get_wallet_filename

(

)

const

Returns the current wallet filename.

This is the filename that will be used when automatically saving the wallet.

See also

set_wallet_filename()

Returns

the wallet filename

Definition at line 277 of file wallet.cpp.

{
   return my->get_wallet_filename();
}

Here is the caller graph for this function:

import_key()

bool sysio::wallet::soft_wallet::import_key ( string wif_key )

overridevirtual

Imports a WIF Private Key into the wallet to be used to sign transactions by an account.

example: import_key 5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3

Parameters

wif_key

the WIF Private Key to import

Implements sysio::wallet::wallet_api.

Definition at line 282 of file wallet.cpp.

{
   SYS_ASSERT(!is_locked(), wallet_locked_exception, "Unable to import key on a locked wallet");
 
   if( my->import_key(wif_key) )
   {
      save_wallet_file();
      return true;
   }
   return false;
}

Here is the call graph for this function:

is_locked()

bool sysio::wallet::soft_wallet::is_locked ( ) const

overridevirtual

Checks whether the wallet is locked (is unable to use its private keys).

This state can be changed by calling lock() or unlock().

Returns

true if the wallet is locked

Implements sysio::wallet::wallet_api.

Definition at line 325 of file wallet.cpp.

{
   return my->is_locked();
}

Here is the caller graph for this function:

is_new()

bool sysio::wallet::soft_wallet::is_new

(

)

const

Checks whether the wallet has just been created and has not yet had a password set.

Calling set_password will transition the wallet to the locked state.

Returns

true if the wallet is new

Definition at line 330 of file wallet.cpp.

{
   return my->_wallet.cipher_keys.size() == 0;
}

Here is the caller graph for this function:

list_keys()

map< public_key_type, private_key_type > sysio::wallet::soft_wallet::list_keys ( )

overridevirtual

Dumps all private keys owned by the wallet.

The keys are printed in WIF format. You can import these keys into another wallet using import_key()

Returns

a map containing the private keys, indexed by their public key

Implements sysio::wallet::wallet_api.

Definition at line 381 of file wallet.cpp.

{
   SYS_ASSERT(!is_locked(), wallet_locked_exception, "Unable to list public keys of a locked wallet");
   return my->_keys;
}

Here is the call graph for this function:

list_public_keys()

flat_set< public_key_type > sysio::wallet::soft_wallet::list_public_keys ( )

overridevirtual

Dumps all public keys owned by the wallet.

Returns

a vector containing the public keys

Implements sysio::wallet::wallet_api.

Definition at line 387 of file wallet.cpp.

                                                        {
   SYS_ASSERT(!is_locked(), wallet_locked_exception, "Unable to list private keys of a locked wallet");
   flat_set<public_key_type> keys;
   boost::copy(my->_keys | boost::adaptors::map_keys, std::inserter(keys, keys.end()));
   return keys;
}

Here is the call graph for this function:

load_wallet_file()

bool sysio::wallet::soft_wallet::load_wallet_file

(

string

wallet_filename = ""

)

Loads a specified Graphene wallet.

The current wallet is closed before the new wallet is loaded.

Warning

This does not change the filename that will be used for future wallet writes, so this may cause you to overwrite your original wallet unless you also call set_wallet_filename()

Parameters

wallet_filename

the filename of the wallet JSON file to load. If wallet_filename is empty, it reloads the existing wallet file

Returns

true if the specified wallet is loaded

Definition at line 315 of file wallet.cpp.

{
   return my->load_wallet_file( wallet_filename );
}

lock()

void sysio::wallet::soft_wallet::lock ( )

overridevirtual

Locks the wallet immediately.

Implements sysio::wallet::wallet_api.

Definition at line 340 of file wallet.cpp.

{ try {
   SYS_ASSERT( !is_locked(), wallet_locked_exception, "Unable to lock a locked wallet" );
   encrypt_keys();
   for( auto key : my->_keys )
      key.second = private_key_type();
 
   my->_keys.clear();
   my->_checksum = fc::sha512();
} FC_CAPTURE_AND_RETHROW() }

Here is the call graph for this function:

Here is the caller graph for this function:

remove_key()

bool sysio::wallet::soft_wallet::remove_key ( string key )

overridevirtual

Removes a key from the wallet.

example: remove_key SYS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV

Parameters

key	the Public Key to remove

Implements sysio::wallet::wallet_api.

Definition at line 294 of file wallet.cpp.

{
   SYS_ASSERT(!is_locked(), wallet_locked_exception, "Unable to remove key from a locked wallet");
 
   if( my->remove_key(key) )
   {
      save_wallet_file();
      return true;
   }
   return false;
}

Here is the call graph for this function:

save_wallet_file()

void sysio::wallet::soft_wallet::save_wallet_file

(

string

wallet_filename = ""

)

Saves the current wallet to the given filename.

Warning

This does not change the wallet filename that will be used for future writes, so think of this function as 'Save a Copy As...' instead of 'Save As...'. Use set_wallet_filename() to make the filename persist.

Parameters

wallet_filename

the filename of the new wallet JSON file to create or overwrite. If wallet_filename is empty, save to the current filename.

Definition at line 320 of file wallet.cpp.

{
   my->save_wallet_file( wallet_filename );
}

Here is the caller graph for this function:

set_password()

void sysio::wallet::soft_wallet::set_password ( string password )

overridevirtual

Sets a new password on the wallet.

The wallet must be either 'new' or 'unlocked' to execute this command.

Implements sysio::wallet::wallet_api.

Definition at line 373 of file wallet.cpp.

{
   if( !is_new() )
      SYS_ASSERT( !is_locked(), wallet_locked_exception, "The wallet must be unlocked before the password can be set" );
   my->_checksum = fc::sha512::hash( password.c_str(), password.size() );
   lock();
}

Here is the call graph for this function:

set_wallet_filename()

void sysio::wallet::soft_wallet::set_wallet_filename

(

string

wallet_filename

)

Sets the wallet filename used for future writes.

This does not trigger a save, it only changes the default filename that will be used the next time a save is triggered.

Parameters

wallet_filename

the new filename to use for future saves

Definition at line 411 of file wallet.cpp.

{
   my->_wallet_filename = wallet_filename;
}

try_sign_digest()

std::optional< signature_type > sysio::wallet::soft_wallet::try_sign_digest ( const digest_type digest, const public_key_type public_key )

overridevirtual

Returns a signature given the digest and public_key, if this wallet can sign via that public key

Implements sysio::wallet::wallet_api.

Definition at line 399 of file wallet.cpp.

                                                                                                                     {
   return my->try_sign_digest(digest, public_key);
}

Here is the call graph for this function:

unlock()

void sysio::wallet::soft_wallet::unlock ( string password )

overridevirtual

Unlocks the wallet.

The wallet remain unlocked until the lock is called or the program exits.

Parameters

password

the password previously set with set_password()

Implements sysio::wallet::wallet_api.

Definition at line 351 of file wallet.cpp.

{ try {
   FC_ASSERT(password.size() > 0);
   auto pw = fc::sha512::hash(password.c_str(), password.size());
   vector<char> decrypted = fc::aes_decrypt(pw, my->_wallet.cipher_keys);
   auto pk = fc::raw::unpack<plain_keys>(decrypted);
   FC_ASSERT(pk.checksum == pw);
   my->_keys = std::move(pk.keys);
   my->_checksum = pk.checksum;
} SYS_RETHROW_EXCEPTIONS(chain::wallet_invalid_password_exception,
                          "Invalid password for wallet: \"${wallet_name}\"", ("wallet_name", get_wallet_filename())) }

Here is the call graph for this function:

Member Data Documentation

my

std::shared_ptr<detail::soft_wallet_impl> sysio::wallet::soft_wallet::my

Definition at line 182 of file wallet.hpp.

---

The documentation for this class was generated from the following files:

• plugins/wallet_plugin/include/sysio/wallet_plugin/wallet.hpp
• plugins/wallet_plugin/wallet.cpp