sysio::wallet_plugin Class Reference

#include <wallet_plugin.hpp>

Inheritance diagram for sysio::wallet_plugin:

Collaboration diagram for sysio::wallet_plugin:

Public Member Functions
	wallet_plugin ()
	wallet_plugin (const wallet_plugin &)=delete
	wallet_plugin (wallet_plugin &&)=delete
wallet_plugin &	operator= (const wallet_plugin &)=delete
wallet_plugin &	operator= (wallet_plugin &&)=delete
virtual	~wallet_plugin () override=default
virtual void	set_program_options (options_description &cli, options_description &cfg) override
void	plugin_initialize (const variables_map &options)
void	plugin_startup ()
void	plugin_shutdown ()
wallet_manager &	get_wallet_manager ()
Public Member Functions inherited from appbase::plugin< wallet_plugin >
	plugin ()
virtual	~plugin ()
virtual state	get_state () const override
virtual const std::string &	name () const override
virtual void	register_dependencies ()
virtual void	initialize (const variables_map &options) override
virtual void	handle_sighup () override
virtual void	startup () override
virtual void	shutdown () override
Public Member Functions inherited from appbase::abstract_plugin
virtual	~abstract_plugin ()

Additional Inherited Members
Public Types inherited from appbase::abstract_plugin
enum	state { registered , initialized , started , stopped }
Protected Member Functions inherited from appbase::plugin< wallet_plugin >
	plugin (const string &name)

Detailed Description

Definition at line 17 of file wallet_plugin.hpp.

Constructor & Destructor Documentation

wallet_plugin() [1/3]

sysio::wallet_plugin::wallet_plugin

(

)

Definition at line 16 of file wallet_plugin.cpp.

{}

wallet_plugin() [2/3]

sysio::wallet_plugin::wallet_plugin ( const wallet_plugin & )

delete

wallet_plugin() [3/3]

sysio::wallet_plugin::wallet_plugin ( wallet_plugin && )

delete

~wallet_plugin()

virtual sysio::wallet_plugin::~wallet_plugin ( )

overridevirtualdefault

Member Function Documentation

get_wallet_manager()

wallet_manager & sysio::wallet_plugin::get_wallet_manager

(

)

Definition at line 18 of file wallet_plugin.cpp.

                                                  {
   return *wallet_manager_ptr;
}

operator=() [1/2]

wallet_plugin & sysio::wallet_plugin::operator= ( const wallet_plugin & )

delete

operator=() [2/2]

wallet_plugin & sysio::wallet_plugin::operator= ( wallet_plugin && )

delete

plugin_initialize()

void sysio::wallet_plugin::plugin_initialize

(

const variables_map &

options

)

Definition at line 37 of file wallet_plugin.cpp.

                                                                  {
   ilog("initializing wallet plugin");
   try {
      wallet_manager_ptr = std::make_unique<wallet_manager>();
 
      if (options.count("wallet-dir")) {
         auto dir = options.at("wallet-dir").as<boost::filesystem::path>();
         if (dir.is_relative())
            dir = app().data_dir() / dir;
         if( !bfs::exists(dir) )
            bfs::create_directories(dir);
         wallet_manager_ptr->set_dir(dir);
      }
      if (options.count("unlock-timeout")) {
         auto timeout = options.at("unlock-timeout").as<int64_t>();
         SYS_ASSERT(timeout > 0, chain::invalid_lock_timeout_exception, "Please specify a positive timeout ${t}", ("t", timeout));
         std::chrono::seconds t(timeout);
         wallet_manager_ptr->set_timeout(t);
      }
      if (options.count("yubihsm-authkey")) {
         uint16_t key = options.at("yubihsm-authkey").as<uint16_t>();
         string connector_endpoint = "http://localhost:12345";
         if(options.count("yubihsm-url"))
            connector_endpoint = options.at("yubihsm-url").as<string>();
         try {
            wallet_manager_ptr->own_and_use_wallet("YubiHSM", make_unique<yubihsm_wallet>(connector_endpoint, key));
         }FC_LOG_AND_RETHROW()
      }
   } FC_LOG_AND_RETHROW()
}

Here is the call graph for this function:

plugin_shutdown()

void sysio::wallet_plugin::plugin_shutdown ( )

inline

Definition at line 31 of file wallet_plugin.hpp.

{}

plugin_startup()

void sysio::wallet_plugin::plugin_startup ( )

inline

Definition at line 30 of file wallet_plugin.hpp.

{}

set_program_options()

void sysio::wallet_plugin::set_program_options ( options_description & cli, options_description & cfg )

overridevirtual

Implements appbase::abstract_plugin.

Definition at line 22 of file wallet_plugin.cpp.

                                                                                          {
   cfg.add_options()
         ("wallet-dir", bpo::value<boost::filesystem::path>()->default_value("."),
          "The path of the wallet files (absolute path or relative to application data dir)")
         ("unlock-timeout", bpo::value<int64_t>()->default_value(900),
          "Timeout for unlocked wallet in seconds (default 900 (15 minutes)). "
          "Wallets will automatically lock after specified number of seconds of inactivity. "
          "Activity is defined as any wallet command e.g. list-wallets.")
         ("yubihsm-url", bpo::value<string>()->value_name("URL"),
          "Override default URL of http://localhost:12345 for connecting to yubihsm-connector")
         ("yubihsm-authkey", bpo::value<uint16_t>()->value_name("key_num"),
          "Enables YubiHSM support using given Authkey")
         ;
}

---

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

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