TransactionInfo / TransactionHistory APIs design

This commit is contained in:
Ilya Kitaev 2016-04-19 12:25:03 +03:00
parent 1774d9574b
commit 4e1c2dc365
2 changed files with 197 additions and 139 deletions

View file

@ -65,11 +65,58 @@ using namespace std;
using namespace cryptonote; using namespace cryptonote;
Wallet::~Wallet() {} Wallet::~Wallet() {}
PendingTransaction::~PendingTransaction() {} PendingTransaction::~PendingTransaction() {}
class WalletImpl;
///////////////////////// Wallet implementation ///////////////////////////////
class WalletImpl : public Wallet
{
public:
WalletImpl(bool testnet = false);
~WalletImpl();
bool create(const std::string &path, const std::string &password,
const std::string &language);
bool open(const std::string &path, const std::string &password);
bool recover(const std::string &path, const std::string &seed);
bool close();
std::string seed() const;
std::string getSeedLanguage() const;
void setSeedLanguage(const std::string &arg);
// void setListener(Listener *) {}
int status() const;
std::string errorString() const;
bool setPassword(const std::string &password);
std::string address() const;
bool store(const std::string &path);
bool init(const std::string &daemon_address, uint64_t upper_transaction_size_limit);
bool connectToDaemon();
uint64_t balance() const;
uint64_t unlockedBalance() const;
bool refresh();
PendingTransaction * createTransaction(const std::string &dst_addr, uint64_t amount);
virtual void disposeTransaction(PendingTransaction * t);
virtual TransactionHistory * history() const;
private:
void clearStatus();
private:
friend class TransactionImpl;
tools::wallet2 * m_wallet;
int m_status;
std::string m_errorString;
std::string m_password;
};
/////////////////////////////////////////////////////////////////////////////////
string Wallet::displayAmount(uint64_t amount)
{
return cryptonote::print_money(amount);
}
///////////////////////// Transaction implementation /////////////////////////// ///////////////////////// Transaction implementation ///////////////////////////
@ -95,55 +142,119 @@ private:
std::vector<tools::wallet2::pending_tx> m_pending_tx; std::vector<tools::wallet2::pending_tx> m_pending_tx;
}; };
TransactionImpl::TransactionImpl(WalletImpl *wallet)
: m_wallet(wallet)
/////////////////////////////////////////////////////////////////////////////////
string Wallet::displayAmount(uint64_t amount)
{ {
return cryptonote::print_money(amount);
}
TransactionImpl::~TransactionImpl()
{
}
int TransactionImpl::status() const
{
return m_status;
}
string TransactionImpl::errorString() const
{
return m_errorString;
}
bool TransactionImpl::commit()
{
LOG_PRINT_L0("m_pending_tx size: " << m_pending_tx.size());
assert(m_pending_tx.size() == 1);
try {
while (!m_pending_tx.empty()) {
auto & ptx = m_pending_tx.back();
m_wallet->m_wallet->commit_tx(ptx);
// success_msg_writer(true) << tr("Money successfully sent, transaction ") << get_transaction_hash(ptx.tx);
// if no exception, remove element from vector
m_pending_tx.pop_back();
} // TODO: extract method;
} catch (const tools::error::daemon_busy&) {
// TODO: make it translatable with "tr"?
m_errorString = tr("daemon is busy. Please try again later.");
m_status = Status_Error;
} catch (const tools::error::no_connection_to_daemon&) {
m_errorString = tr("no connection to daemon. Please make sure daemon is running.");
m_status = Status_Error;
} catch (const tools::error::tx_rejected& e) {
std::ostringstream writer(m_errorString);
writer << (boost::format(tr("transaction %s was rejected by daemon with status: ")) % get_transaction_hash(e.tx())) << e.status();
m_status = Status_Error;
} catch (std::exception &e) {
m_errorString = string(tr("Unknown exception: ")) + e.what();
m_status = Status_Error;
} catch (...) {
m_errorString = tr("Unhandled exception");
LOG_ERROR(m_errorString);
m_status = Status_Error;
}
return m_status == Status_Ok;
}
uint64_t TransactionImpl::amount() const
{
uint64_t result = 0;
for (const auto &ptx : m_pending_tx) {
for (const auto &dest : ptx.dests) {
result += dest.amount;
}
}
return result;
}
uint64_t TransactionImpl::dust() const
{
uint32_t result = 0;
for (const auto & ptx : m_pending_tx) {
result += ptx.dust;
}
return result;
}
uint64_t TransactionImpl::fee() const
{
uint32_t result = 0;
for (const auto ptx : m_pending_tx) {
result += ptx.fee;
}
return result;
}
///////////////////////// TransactionInfo implementation ////////////////////////
class TransactionInfoImpl : public TransactionInfo
{
public:
TransactionInfoImpl();
~TransactionInfoImpl();
virtual bool isHold() const;
};
TransactionInfoImpl::TransactionInfoImpl()
{
}
TransactionInfoImpl::~TransactionInfoImpl()
{
}
bool TransactionInfoImpl::isHold() const
{
return false;
} }
///////////////////////// Wallet implementation ////////////////////////////////
class WalletImpl : public Wallet
{
public:
WalletImpl(bool testnet = false);
~WalletImpl();
bool create(const std::string &path, const std::string &password,
const std::string &language);
bool open(const std::string &path, const std::string &password);
bool recover(const std::string &path, const std::string &seed);
bool close();
std::string seed() const;
std::string getSeedLanguage() const;
void setSeedLanguage(const std::string &arg);
void setListener(Listener *) {}
int status() const;
std::string errorString() const;
bool setPassword(const std::string &password);
std::string address() const;
bool store(const std::string &path);
bool init(const std::string &daemon_address, uint64_t upper_transaction_size_limit);
bool connectToDaemon();
uint64_t balance() const;
uint64_t unlockedBalance() const;
bool refresh();
PendingTransaction * createTransaction(const std::string &dst_addr, uint64_t amount);
virtual void disposeTransaction(PendingTransaction * t);
private:
void clearStatus();
private:
friend class TransactionImpl;
tools::wallet2 * m_wallet;
int m_status;
std::string m_errorString;
std::string m_password;
};
WalletImpl::WalletImpl(bool testnet) WalletImpl::WalletImpl(bool testnet)
:m_wallet(nullptr), m_status(Wallet::Status_Ok) :m_wallet(nullptr), m_status(Wallet::Status_Ok)
@ -477,6 +588,11 @@ void WalletImpl::disposeTransaction(PendingTransaction *t)
delete t; delete t;
} }
TransactionHistory *WalletImpl::history() const
{
return nullptr;
}
bool WalletImpl::connectToDaemon() bool WalletImpl::connectToDaemon()
{ {
bool result = m_wallet->check_connection(); bool result = m_wallet->check_connection();
@ -496,92 +612,6 @@ void WalletImpl::clearStatus()
TransactionImpl::TransactionImpl(WalletImpl *wallet)
: m_wallet(wallet)
{
}
TransactionImpl::~TransactionImpl()
{
}
int TransactionImpl::status() const
{
return m_status;
}
string TransactionImpl::errorString() const
{
return m_errorString;
}
bool TransactionImpl::commit()
{
LOG_PRINT_L0("m_pending_tx size: " << m_pending_tx.size());
assert(m_pending_tx.size() == 1);
try {
while (!m_pending_tx.empty()) {
auto & ptx = m_pending_tx.back();
m_wallet->m_wallet->commit_tx(ptx);
// success_msg_writer(true) << tr("Money successfully sent, transaction ") << get_transaction_hash(ptx.tx);
// if no exception, remove element from vector
m_pending_tx.pop_back();
} // TODO: extract method;
} catch (const tools::error::daemon_busy&) {
// TODO: make it translatable with "tr"?
m_errorString = tr("daemon is busy. Please try again later.");
m_status = Status_Error;
} catch (const tools::error::no_connection_to_daemon&) {
m_errorString = tr("no connection to daemon. Please make sure daemon is running.");
m_status = Status_Error;
} catch (const tools::error::tx_rejected& e) {
std::ostringstream writer(m_errorString);
writer << (boost::format(tr("transaction %s was rejected by daemon with status: ")) % get_transaction_hash(e.tx())) << e.status();
m_status = Status_Error;
} catch (std::exception &e) {
m_errorString = string(tr("Unknown exception: ")) + e.what();
m_status = Status_Error;
} catch (...) {
m_errorString = tr("Unhandled exception");
LOG_ERROR(m_errorString);
m_status = Status_Error;
}
return m_status == Status_Ok;
}
uint64_t TransactionImpl::amount() const
{
uint64_t result = 0;
for (const auto &ptx : m_pending_tx) {
for (const auto &dest : ptx.dests) {
result += dest.amount;
}
}
return result;
}
uint64_t TransactionImpl::dust() const
{
uint32_t result = 0;
for (const auto & ptx : m_pending_tx) {
result += ptx.dust;
}
return result;
}
uint64_t TransactionImpl::fee() const
{
uint32_t result = 0;
for (const auto ptx : m_pending_tx) {
result += ptx.fee;
}
return result;
}
///////////////////////// WalletManager implementation ///////////////////////// ///////////////////////// WalletManager implementation /////////////////////////
@ -671,4 +701,6 @@ WalletManager *WalletManagerFactory::getWalletManager()
} }

View file

@ -32,12 +32,13 @@
#include <string> #include <string>
#include <vector>
// Public interface for libwallet library // Public interface for libwallet library
namespace Bitmonero { namespace Bitmonero {
/** /**
* @brief Transaction interface * @brief Transaction-like interface for sending money
*/ */
struct PendingTransaction struct PendingTransaction
{ {
@ -54,6 +55,35 @@ struct PendingTransaction
virtual uint64_t fee() const = 0; virtual uint64_t fee() const = 0;
}; };
struct TransactionInfo;
struct TransactionHistory
{
virtual int count() const;
virtual TransactionInfo * transaction(int index) const = 0;
virtual TransactionInfo * transaction(const std::string &id) const = 0;
virtual std::vector<TransactionInfo*> getAll() const = 0;
};
/**
* @brief The TransactionInfo - interface for displaying transaction information
*/
struct TransactionInfo
{
enum Direction {
Direction_In,
Direction_Out
};
virtual bool isHold() const = 0;
virtual bool isFailed() const = 0;
virtual uint64_t amount() const = 0;
virtual uint64_t fee() const = 0;
virtual std::string address() const = 0;
virtual int direction() const = 0;
// TODO
};
/** /**
* @brief Interface for wallet operations. * @brief Interface for wallet operations.
* TODO: check if /include/IWallet.h is still actual * TODO: check if /include/IWallet.h is still actual
@ -66,12 +96,11 @@ struct Wallet
Status_Error Status_Error
}; };
virtual ~Wallet() = 0; virtual ~Wallet() = 0;
virtual std::string seed() const = 0; virtual std::string seed() const = 0;
virtual std::string getSeedLanguage() const = 0; virtual std::string getSeedLanguage() const = 0;
virtual void setSeedLanguage(const std::string &arg) = 0; virtual void setSeedLanguage(const std::string &arg) = 0;
virtual void setListener(Listener * listener) = 0; // virtual void setListener(Listener * listener) = 0;
//! returns wallet status (Status_Ok | Status_Error) //! returns wallet status (Status_Ok | Status_Error)
virtual int status() const = 0; virtual int status() const = 0;
//! in case error status, returns error string //! in case error status, returns error string
@ -89,10 +118,7 @@ struct Wallet
virtual bool refresh() = 0; virtual bool refresh() = 0;
virtual PendingTransaction * createTransaction(const std::string &dst_addr, uint64_t amount) = 0; virtual PendingTransaction * createTransaction(const std::string &dst_addr, uint64_t amount) = 0;
virtual void disposeTransaction(PendingTransaction * t) = 0; virtual void disposeTransaction(PendingTransaction * t) = 0;
// TODO virtual TransactionHistory * history() const = 0;
virtual void getPayments() const;
}; };
/** /**