2015-05-27 12:08:46 +00:00
|
|
|
// Copyright (c) 2012-2015, The CryptoNote developers, The Bytecoin developers
|
2014-08-13 10:38:35 +00:00
|
|
|
//
|
|
|
|
// This file is part of Bytecoin.
|
|
|
|
//
|
|
|
|
// Bytecoin is free software: you can redistribute it and/or modify
|
|
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
|
|
|
// Bytecoin is distributed in the hope that it will be useful,
|
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
// GNU Lesser General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
|
|
// along with Bytecoin. If not, see <http://www.gnu.org/licenses/>.
|
2014-04-07 15:02:15 +00:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <limits>
|
|
|
|
#include <string>
|
|
|
|
#include <vector>
|
2015-07-30 15:22:07 +00:00
|
|
|
#include "CryptoNote.h"
|
2014-04-07 15:02:15 +00:00
|
|
|
|
2014-04-09 12:14:35 +00:00
|
|
|
namespace CryptoNote {
|
2014-04-07 15:02:15 +00:00
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
const size_t WALLET_INVALID_TRANSACTION_ID = std::numeric_limits<size_t>::max();
|
|
|
|
const size_t WALLET_INVALID_TRANSFER_ID = std::numeric_limits<size_t>::max();
|
|
|
|
const uint32_t WALLET_UNCONFIRMED_TRANSACTION_HEIGHT = std::numeric_limits<uint32_t>::max();
|
2014-04-07 15:02:15 +00:00
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
enum class WalletTransactionState : uint8_t {
|
|
|
|
SUCCEEDED = 0,
|
|
|
|
FAILED,
|
|
|
|
CANCELLED
|
2014-04-07 15:02:15 +00:00
|
|
|
};
|
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
enum WalletEventType {
|
|
|
|
TRANSACTION_CREATED,
|
|
|
|
TRANSACTION_UPDATED,
|
|
|
|
BALANCE_UNLOCKED
|
|
|
|
};
|
2015-04-06 16:13:07 +00:00
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
struct WalletTransactionCreatedData {
|
|
|
|
size_t transactionIndex;
|
2015-04-06 16:13:07 +00:00
|
|
|
};
|
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
struct WalletTransactionUpdatedData {
|
|
|
|
size_t transactionIndex;
|
2015-04-06 16:13:07 +00:00
|
|
|
};
|
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
struct WalletEvent {
|
|
|
|
WalletEventType type;
|
|
|
|
union {
|
|
|
|
WalletTransactionCreatedData transactionCreated;
|
|
|
|
WalletTransactionUpdatedData transactionUpdated;
|
|
|
|
};
|
|
|
|
};
|
2015-04-06 16:13:07 +00:00
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
struct WalletTransaction {
|
|
|
|
WalletTransactionState state;
|
|
|
|
uint64_t timestamp;
|
|
|
|
uint32_t blockHeight;
|
|
|
|
Crypto::Hash hash;
|
|
|
|
int64_t totalAmount;
|
|
|
|
uint64_t fee;
|
|
|
|
uint64_t creationTime;
|
|
|
|
uint64_t unlockTime;
|
|
|
|
std::string extra;
|
2014-04-07 15:02:15 +00:00
|
|
|
};
|
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
struct WalletTransfer {
|
|
|
|
std::string address;
|
|
|
|
int64_t amount;
|
2014-04-07 15:02:15 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
class IWallet {
|
|
|
|
public:
|
2015-07-30 15:22:07 +00:00
|
|
|
virtual ~IWallet() {}
|
2014-04-07 15:02:15 +00:00
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
virtual void initialize(const std::string& password) = 0;
|
|
|
|
virtual void load(std::istream& source, const std::string& password) = 0;
|
2014-04-07 15:02:15 +00:00
|
|
|
virtual void shutdown() = 0;
|
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
virtual void changePassword(const std::string& oldPassword, const std::string& newPassword) = 0;
|
|
|
|
virtual void save(std::ostream& destination, bool saveDetails = true, bool saveCache = true) = 0;
|
2014-04-07 15:02:15 +00:00
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
virtual size_t getAddressCount() const = 0;
|
|
|
|
virtual std::string getAddress(size_t index) const = 0;
|
|
|
|
virtual std::string createAddress() = 0;
|
|
|
|
virtual std::string createAddress(const KeyPair& spendKey) = 0;
|
|
|
|
virtual void deleteAddress(const std::string& address) = 0;
|
2014-04-07 15:02:15 +00:00
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
virtual uint64_t getActualBalance() const = 0;
|
|
|
|
virtual uint64_t getActualBalance(const std::string& address) const = 0;
|
|
|
|
virtual uint64_t getPendingBalance() const = 0;
|
|
|
|
virtual uint64_t getPendingBalance(const std::string& address) const = 0;
|
2014-04-07 15:02:15 +00:00
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
virtual size_t getTransactionCount() const = 0;
|
|
|
|
virtual WalletTransaction getTransaction(size_t transactionIndex) const = 0;
|
|
|
|
virtual size_t getTransactionTransferCount(size_t transactionIndex) const = 0;
|
|
|
|
virtual WalletTransfer getTransactionTransfer(size_t transactionIndex, size_t transferIndex) const = 0;
|
2014-04-07 15:02:15 +00:00
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
virtual size_t transfer(const WalletTransfer& destination, uint64_t fee, uint64_t mixIn = 0, const std::string& extra = "", uint64_t unlockTimestamp = 0) = 0;
|
|
|
|
virtual size_t transfer(const std::vector<WalletTransfer>& destinations, uint64_t fee, uint64_t mixIn = 0, const std::string& extra = "", uint64_t unlockTimestamp = 0) = 0;
|
|
|
|
virtual size_t transfer(const std::string& sourceAddress, const WalletTransfer& destination, uint64_t fee, uint64_t mixIn = 0, const std::string& extra = "", uint64_t unlockTimestamp = 0) = 0;
|
|
|
|
virtual size_t transfer(const std::string& sourceAddress, const std::vector<WalletTransfer>& destinations, uint64_t fee, uint64_t mixIn = 0, const std::string& extra = "", uint64_t unlockTimestamp = 0) = 0;
|
2014-04-07 15:02:15 +00:00
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
virtual void start() = 0;
|
|
|
|
virtual void stop() = 0;
|
2015-04-06 16:13:07 +00:00
|
|
|
|
2015-07-30 15:22:07 +00:00
|
|
|
//blocks until an event occured
|
|
|
|
virtual WalletEvent getEvent() = 0;
|
2014-04-07 15:02:15 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
}
|