Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 52 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
- name: Install dependencies
run: |
sudo apt update
sudo apt install -y build-essential cmake pkg-config libssl-dev libzmq3-dev libunbound-dev libsodium-dev libunwind8-dev liblzma-dev libreadline6-dev libexpat1-dev libpgm-dev qttools5-dev-tools libhidapi-dev libusb-1.0-0-dev libprotobuf-dev protobuf-compiler libudev-dev libboost-chrono-dev libboost-date-time-dev libboost-filesystem-dev libboost-locale-dev libboost-program-options-dev libboost-regex-dev libboost-serialization-dev libboost-system-dev libboost-thread-dev python3 ccache doxygen graphviz git curl autoconf libtool gperf nettle-dev libevent-dev debhelper python3-all python3-pip python3-pybind11 python3-pytest python3-pytest-rerunfailures python3-pytest-cov lcov
sudo apt install -y build-essential cmake pkg-config libssl-dev libzmq3-dev libunbound-dev libsodium-dev libunwind8-dev liblzma-dev libreadline6-dev libexpat1-dev libpgm-dev qttools5-dev-tools libhidapi-dev libusb-1.0-0-dev libprotobuf-dev protobuf-compiler libudev-dev libboost-chrono-dev libboost-date-time-dev libboost-filesystem-dev libboost-locale-dev libboost-program-options-dev libboost-regex-dev libboost-serialization-dev libboost-system-dev libboost-thread-dev python3 ccache doxygen graphviz git curl autoconf libtool gperf nettle-dev libevent-dev debhelper python3-all python3-pip python3-pybind11 python3-pytest python3-pytest-rerunfailures python3-pytest-cov lcov python3-scikit-build-core
pip3 install pybind11-stubgen pytest --break-system-packages

- name: Install expat
Expand Down Expand Up @@ -140,7 +140,7 @@ jobs:
- name: Install pytest
shell: bash
run: |
python -m pip install pytest pytest-rerunfailures typing_extensions
python -m pip install pytest pytest-rerunfailures typing_extensions scikit-build-core

- name: Setup MSYS2 MINGW64
uses: msys2/setup-msys2@v2
Expand Down Expand Up @@ -243,3 +243,53 @@ jobs:
PATH: "${{ github.workspace }}/dist:/usr/bin:$PATH"
run: |
python -m pytest -m unit

macos:
runs-on: macos-15
name: macos (pytest)

steps:
- uses: actions/checkout@v4

- name: Install dependencies
run: |
HOMEBREW_NO_AUTO_UPDATE=1 brew install python boost@1.85 hidapi openssl zmq libpgm miniupnpc expat libunwind-headers protobuf unbound
brew unlink boost || true
brew link boost@1.85 --force
pip3 install pybind11==2.13.6 pybind11-stubgen pytest pytest-cov setuptools wheel scikit-build-core --break-system-packages

- name: Clone monero-cpp (regtest)
run: |
cd external
rm -rf monero-cpp
git clone -b regtest-env --single-branch --recurse-submodules https://github.com/everoddandeven/monero-cpp.git
cd ..

- name: Build monero
run: |
cd external/monero-cpp/external/monero-project
mkdir -p build/release
cd build/release
cmake -DSTATIC=ON -DBUILD_64=ON -DCMAKE_BUILD_TYPE=Release ../../
make -j3 wallet cryptonote_protocol
cd ../../../../../../

- name: Install monero-cpp
run: |
cd external/monero-cpp
mkdir -p build
cd build
cmake ..
cmake --build .
make -j3
cp libmonero-cpp.dylib /opt/homebrew/lib/
cd ../../../

- name: Install monero-python
run: |
mkdir -p build
pip3 install --no-build-isolation -vvv . --break-system-packages

- name: Run unit tests
run: |
pytest -m unit
10 changes: 8 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,15 @@ set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

find_package(Python3 REQUIRED COMPONENTS Interpreter Development.Module)

find_package(pybind11 REQUIRED)

set(Boost_NO_BOOST_CMAKE 1)
set(Boost_USE_MULTITHREADED ON)
find_package(Boost REQUIRED COMPONENTS system thread serialization filesystem)

find_package(OpenSSL REQUIRED)

set(SOURCES
src/cpp/common/py_monero_common.cpp
src/cpp/daemon/py_monero_daemon_model.cpp
Expand Down Expand Up @@ -59,8 +63,8 @@ target_link_libraries(monero PRIVATE
Boost::serialization
Boost::filesystem

ssl
crypto
OpenSSL::SSL
OpenSSL::Crypto
)

if (WIN32)
Expand All @@ -70,3 +74,5 @@ if (WIN32)
bcrypt
)
endif()

install(TARGETS monero DESTINATION .)
27 changes: 25 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
[project]
name = "monero"
version = "0.0.1"
description = "Python bindings for monero-cpp"
authors = [
{ name = "everoddandeven", email = "everoddandeven@protonmail.com" }
]
license = { text = "MIT" }
readme = "README.md"
requires-python = ">=3.8"
dependencies = [
"pybind11>=2.12"
]

[build-system]
requires = ["setuptools>=61", "pybind11>=2.12"]
build-backend = "setuptools.build_meta"
requires = [
"scikit-build-core>=0.5",
"pybind11>=2.12",
"cmake>=3.20",
"ninja"
]
build-backend = "scikit_build_core.build"

[tool.scikit-build]
cmake.verbose = true
cmake.build-type = "Release"
59 changes: 3 additions & 56 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,56 +1,5 @@
import pybind11
import sys
import os

from setuptools import setup
from pathlib import Path
from pybind11.setup_helpers import Pybind11Extension, build_ext

coverage = os.environ.get("COVERAGE") == "1"
this_dir = Path(__file__).parent.resolve()
extra_compile_args: list[str] = ['/std:c++17'] if sys.platform == "win32" else ['-std=c++17']
extra_link_args: list[str] = []

if coverage:
extra_compile_args += ['-O0', '-g', '--coverage']
extra_link_args += ['--coverage']

ext_modules = [
Pybind11Extension(
'monero',
[
'src/cpp/common/py_monero_common.cpp',
'src/cpp/daemon/py_monero_daemon_model.cpp',
'src/cpp/daemon/py_monero_daemon_rpc.cpp',
'src/cpp/wallet/py_monero_wallet_model.cpp',
'src/cpp/wallet/py_monero_wallet.cpp',
'src/cpp/wallet/py_monero_wallet_rpc.cpp',
'src/cpp/utils/py_monero_utils.cpp',
'src/cpp/py_monero.cpp'
],
include_dirs=[
pybind11.get_include(),
str(this_dir / 'external' / 'monero-cpp' / 'src'),
str(this_dir / 'external' / 'monero-cpp' / 'external' / 'monero-project' / 'src'),
str(this_dir / 'external' / 'monero-cpp' / 'external' / 'monero-project' / 'contrib' / 'epee' / 'include'),
str(this_dir / 'external' / 'monero-cpp' / 'external' / 'monero-project' / 'external'),
str(this_dir / 'external' / 'monero-cpp' / 'external' / 'monero-project' / 'external' / 'easylogging++'),
str(this_dir / 'external' / 'monero-cpp' / 'external' / 'monero-project' / 'external' / 'rapidjson' / 'include'),
str(this_dir / 'src' / 'cpp'),
str(this_dir / 'src' / 'cpp' / 'common'),
str(this_dir / 'src' / 'cpp' / 'daemon'),
str(this_dir / 'src' / 'cpp' / 'wallet'),
str(this_dir / 'src' / 'cpp' / 'utils')
],
library_dirs=[
str(this_dir / 'external' / 'monero-cpp' / 'build')
],
libraries=['monero-cpp'],
language='c++',
extra_compile_args=extra_compile_args,
extra_link_args=extra_link_args
),
]
# setup.py
from skbuild import setup

setup(
name='monero',
Expand All @@ -60,12 +9,10 @@
maintainer='everoddandeven',
maintainer_email='everoddandeven@protonmail.com',
license="MIT",
packages=["monero"],
url='https://github.com/everoddandeven/monero-python',
download_url="https://github.com/everoddandeven/monero-python/releases",
description='A Python library for using Monero.',
long_description='Python bindings for monero-cpp.',
keywords=["monero", "monero-python", "python", "bindings", "pybind11"],
ext_modules=ext_modules,
install_requires=['pybind11>=2.12.0'],
cmdclass={"build_ext": build_ext}
)
2 changes: 1 addition & 1 deletion src/cpp/daemon/py_monero_daemon_rpc.h
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ class PyMoneroDaemonRpc : public PyMoneroDaemon {
std::shared_ptr<PyMoneroDaemonUpdateCheckResult> check_for_update() override;
std::shared_ptr<PyMoneroDaemonUpdateDownloadResult> download_update(const std::string& path = "") override;
void stop() override;
std::shared_ptr<monero::monero_block_header> wait_for_next_block_header();
std::shared_ptr<monero::monero_block_header> wait_for_next_block_header() override;
static void check_response_status(const std::shared_ptr<PyMoneroPathResponse>& response);
static void check_response_status(const std::shared_ptr<PyMoneroJsonResponse>& response);

Expand Down
20 changes: 10 additions & 10 deletions src/cpp/py_monero.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1575,10 +1575,10 @@ PYBIND11_MODULE(monero, m) {
MONERO_CATCH_AND_RETHROW(self.is_view_only());
})
.def("set_connection_manager", [](PyMoneroWallet& self, const std::shared_ptr<PyMoneroConnectionManager> &connection_manager) {
MONERO_CATCH_AND_RETHROW(self.set_connection_manager(connection_manager));
throw PyMoneroError("MoneroWallet.set_connection_manager(): not supported");
}, py::arg("connection_manager"))
.def("get_connection_manager", [](PyMoneroWallet& self) {
MONERO_CATCH_AND_RETHROW(self.get_connection_manager());
throw PyMoneroError("MoneroWallet.get_connection_manager(): not supported");
})
.def("set_daemon_connection", [](PyMoneroWallet& self, const boost::optional<monero::monero_rpc_connection>& connection) {
MONERO_CATCH_AND_RETHROW(self.set_daemon_connection(connection));
Expand Down Expand Up @@ -1967,17 +1967,17 @@ PYBIND11_MODULE(monero, m) {
.def("delete_address_book_entry", [](PyMoneroWallet& self, uint64_t index) {
MONERO_CATCH_AND_RETHROW(self.delete_address_book_entry(index));
}, py::arg("index"))
.def("tag_accounts", [](PyMoneroWallet& self, const std::string& tag, const std::vector<uint32_t>& account_indices) {
MONERO_CATCH_AND_RETHROW(self.tag_accounts(tag, account_indices));
.def("tag_accounts", [](monero::monero_wallet& self, const std::string& tag, const std::vector<uint32_t>& account_indices) {
throw PyMoneroError("MoneroWallet.tag_accounts(): not supported");
}, py::arg("tag"), py::arg("account_indices"))
.def("untag_accounts", [](PyMoneroWallet& self, const std::vector<uint32_t>& account_indices) {
MONERO_CATCH_AND_RETHROW(self.untag_accounts(account_indices));
.def("untag_accounts", [](monero::monero_wallet& self, const std::vector<uint32_t>& account_indices) {
throw PyMoneroError("MoneroWallet.untag_accounts(): not supported");
}, py::arg("account_indices"))
.def("get_account_tags", [](PyMoneroWallet& self) {
MONERO_CATCH_AND_RETHROW(self.get_account_tags());
.def("get_account_tags", [](monero::monero_wallet& self) {
throw PyMoneroError("MoneroWallet.get_account_tags(): not supported");
})
.def("set_account_tag_label", [](PyMoneroWallet& self, const std::string& tag, const std::string& label) {
MONERO_CATCH_AND_RETHROW(self.set_account_tag_label(tag, label));
.def("set_account_tag_label", [](monero::monero_wallet& self, const std::string& tag, const std::string& label) {
throw PyMoneroError("MoneroWallet.set_account_tag_label(): not supported");
}, py::arg("tag"), py::arg("label"))
.def("set_account_label", [](PyMoneroWallet& self, uint32_t account_idx, const std::string& label) {
MONERO_CATCH_AND_RETHROW(self.set_subaddress_label(account_idx, 0, label));
Expand Down
13 changes: 7 additions & 6 deletions src/cpp/wallet/py_monero_wallet.h
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,20 @@ class PyMoneroWallet : public monero::monero_wallet {
virtual ~PyMoneroWallet() = default;

virtual void tag_accounts(const std::string& tag, const std::vector<uint32_t>& account_indices) {
PYBIND11_OVERRIDE_PURE(void, PyMoneroWallet, tag_accounts);
throw std::runtime_error("MoneroWallet.tag_accounts(): not implemented");
}

virtual void untag_accounts(const std::vector<uint32_t>& account_indices) {
PYBIND11_OVERRIDE_PURE(void, PyMoneroWallet, untag_accounts);
throw std::runtime_error("MoneroWallet.untag_accounts(): not implemented");
}

// TODO define method in monero-cpp wallet interface
virtual std::vector<std::shared_ptr<PyMoneroAccountTag>> get_account_tags() {
PYBIND11_OVERRIDE_PURE(std::vector<std::shared_ptr<PyMoneroAccountTag>>, PyMoneroWallet, get_account_tags);
throw std::runtime_error("MoneroWallet.get_account_tags(): not implemented");
}

virtual void set_account_tag_label(const std::string& tag, const std::string& label) {
PYBIND11_OVERRIDE_PURE(void, PyMoneroWallet, set_account_tag_label);
throw std::runtime_error("MoneroWallet.set_account_tags(): not implemented");
}

bool is_view_only() const override {
Expand Down Expand Up @@ -256,7 +257,7 @@ class PyMoneroWallet : public monero::monero_wallet {
PYBIND11_OVERRIDE(monero_account, monero_wallet, get_account, account_idx);
}

monero_account get_account(const uint32_t account_idx, bool include_subaddresses) const {
monero_account get_account(const uint32_t account_idx, bool include_subaddresses) const override {
PYBIND11_OVERRIDE(monero_account, monero_wallet, get_account, account_idx, include_subaddresses);
}

Expand Down Expand Up @@ -472,7 +473,7 @@ class PyMoneroWallet : public monero::monero_wallet {
PYBIND11_OVERRIDE(void, monero_wallet, set_attribute, key, val);
}

void start_mining(boost::optional<uint64_t> num_threads, boost::optional<bool> background_mining, boost::optional<bool> ignore_battery) {
void start_mining(boost::optional<uint64_t> num_threads, boost::optional<bool> background_mining, boost::optional<bool> ignore_battery) override {
PYBIND11_OVERRIDE(void, monero_wallet, start_mining, num_threads, background_mining, ignore_battery);
}

Expand Down
10 changes: 4 additions & 6 deletions src/cpp/wallet/py_monero_wallet_rpc.h
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,7 @@ class PyMoneroWalletRpc : public PyMoneroWallet {
std::string get_tx_key(const std::string& tx_hash) const override;
std::shared_ptr<monero_check_tx> check_tx_key(const std::string& tx_hash, const std::string& tx_key, const std::string& address) const override;
std::string get_tx_proof(const std::string& tx_hash, const std::string& address, const std::string& message) const override;
// TODO why no override ?
std::shared_ptr<monero_check_tx> check_tx_proof(const std::string& tx_hash, const std::string& address, const std::string& message, const std::string& signature) const;
std::shared_ptr<monero_check_tx> check_tx_proof(const std::string& tx_hash, const std::string& address, const std::string& message, const std::string& signature) const override;
std::string get_spend_proof(const std::string& tx_hash, const std::string& message) const override;
bool check_spend_proof(const std::string& tx_hash, const std::string& message, const std::string& signature) const override;
std::string get_reserve_proof_wallet(const std::string& message) const override;
Expand All @@ -132,8 +131,7 @@ class PyMoneroWalletRpc : public PyMoneroWallet {
std::vector<std::shared_ptr<PyMoneroAccountTag>> get_account_tags() override;
void set_account_tag_label(const std::string& tag, const std::string& label) override;
std::string get_payment_uri(const monero_tx_config& config) const override;
// TODO why no override ?
std::shared_ptr<monero_tx_config> parse_payment_uri(const std::string& uri) const;
std::shared_ptr<monero_tx_config> parse_payment_uri(const std::string& uri) const override;
void set_attribute(const std::string& key, const std::string& val) override;
bool get_attribute(const std::string& key, std::string& value) const override;
void start_mining(boost::optional<uint64_t> num_threads, boost::optional<bool> background_mining, boost::optional<bool> ignore_battery) override;
Expand All @@ -142,11 +140,11 @@ class PyMoneroWalletRpc : public PyMoneroWallet {
monero_multisig_info get_multisig_info() const override;
std::string prepare_multisig() override;
std::string make_multisig(const std::vector<std::string>& multisig_hexes, int threshold, const std::string& password) override;
monero_multisig_init_result exchange_multisig_keys(const std::vector<std::string>& multisig_hexes, const std::string& password);
monero_multisig_init_result exchange_multisig_keys(const std::vector<std::string>& multisig_hexes, const std::string& password) override;
std::string export_multisig_hex() override;
int import_multisig_hex(const std::vector<std::string>& multisig_hexes) override;
monero_multisig_sign_result sign_multisig_tx_hex(const std::string& multisig_tx_hex) override;
std::vector<std::string> submit_multisig_tx_hex(const std::string& signed_multisig_tx_hex);
std::vector<std::string> submit_multisig_tx_hex(const std::string& signed_multisig_tx_hex) override;
void change_password(const std::string& old_password, const std::string& new_password) override;
void save() override;
bool is_closed() const override;
Expand Down
15 changes: 6 additions & 9 deletions tests/test_monero_wallet_interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,11 @@ def test_get_network_type(self, wallet: MoneroWallet) -> None:
wallet.get_network_type()

# TODO move definitions to monero-cpp
#@pytest.mark.not_supported
@pytest.mark.not_supported
def test_set_connection_manager(self, wallet: MoneroWallet) -> None:
wallet.set_connection_manager(MoneroConnectionManager())

@pytest.mark.skip(reason="TODO segmentation fault")
@pytest.mark.not_supported
def test_get_connection_manager(self, wallet: MoneroWallet) -> None:
wallet.get_connection_manager()

Expand Down Expand Up @@ -441,23 +441,20 @@ def test_edit_address_book_entry(self, wallet: MoneroWallet) -> None:
def test_delete_address_book_entry(self, wallet: MoneroWallet) -> None:
wallet.delete_address_book_entry(0)

#@pytest.mark.not_supported
@pytest.mark.skip(reason="TODO segmentation fault")
@pytest.mark.not_supported
def test_tag_accounts(self, wallet: MoneroWallet) -> None:
wallet.tag_accounts("", [])

#@pytest.mark.not_supported
@pytest.mark.skip(reason="TODO segmentation fault")
@pytest.mark.not_supported
def test_untag_accounts(self, wallet: MoneroWallet) -> None:
wallet.untag_accounts([])

#@pytest.mark.not_supported
@pytest.mark.skip(reason="TODO segmentation fault")
@pytest.mark.not_supported
def test_get_account_tags(self, wallet: MoneroWallet) -> None:
wallet.get_account_tags()

# TODO move definitions to monero-cpp
#@pytest.mark.not_supported
@pytest.mark.not_supported
def test_set_account_tag_label(self, wallet: MoneroWallet) -> None:
wallet.set_account_tag_label("", "")

Expand Down
Loading