Skip to content
Merged
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ test_wallets
.github/instructions/codacy.instructions.md
.idea
.codacy
coverage*
coverage/
.coverage
.cache
monero.log
Expand Down
4 changes: 4 additions & 0 deletions src/cpp/daemon/py_monero_daemon.h
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,10 @@ class PyMoneroDaemon : public monero_daemon {
PYBIND11_OVERRIDE(std::shared_ptr<monero_mining_status>, monero_daemon, get_mining_status);
}

std::shared_ptr<monero_generate_blocks_result> generate_blocks(const std::string& wallet_address, uint64_t num_blocks, const boost::optional<std::string>& prev_block_hash = boost::none, const boost::optional<uint32_t>& starting_nonce = boost::none) {
PYBIND11_OVERRIDE(std::shared_ptr<monero_generate_blocks_result>, monero_daemon, generate_blocks, wallet_address, num_blocks, prev_block_hash, starting_nonce);
}

void submit_block(const std::string& block_blob) override {
PYBIND11_OVERRIDE(void, monero_daemon, submit_block, block_blob);
}
Expand Down
20 changes: 18 additions & 2 deletions src/cpp/py_monero.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ PYBIND11_MODULE(monero, m) {
auto py_monero_integrated_address = py::class_<monero_integrated_address, serializable_struct, std::shared_ptr<monero_integrated_address>>(m, "MoneroIntegratedAddress");
auto py_monero_decoded_address = py::class_<monero_decoded_address, serializable_struct, std::shared_ptr<monero_decoded_address>>(m, "MoneroDecodedAddress");
auto py_monero_tx_config = py::class_<monero_tx_config, serializable_struct, std::shared_ptr<monero_tx_config>>(m, "MoneroTxConfig");
auto py_monero_key_image_export_result = py::class_<monero_key_image_export_result, serializable_struct, std::shared_ptr<monero_key_image_export_result>>(m, "MoneroKeyImageExportResult");
auto py_monero_key_image_import_result = py::class_<monero_key_image_import_result, serializable_struct, std::shared_ptr<monero_key_image_import_result>>(m, "MoneroKeyImageImportResult");
auto py_monero_message_signature_result = py::class_<monero_message_signature_result, serializable_struct, std::shared_ptr<monero_message_signature_result>>(m, "MoneroMessageSignatureResult");
auto py_monero_check = py::class_<monero_check, serializable_struct, std::shared_ptr<monero_check>>(m, "MoneroCheck");
Expand Down Expand Up @@ -678,6 +679,12 @@ PYBIND11_MODULE(monero, m) {
.def_readwrite("is_tx_extra_too_big", &monero_submit_tx_result::m_is_tx_extra_too_big)
.def_readwrite("is_nonzero_unlock_time", &monero_submit_tx_result::m_is_nonzero_unlock_time);

// monero_generate_blocks_result
py::class_<monero_generate_blocks_result, serializable_struct, std::shared_ptr<monero_generate_blocks_result>>(m, "MoneroGenerateBlocksResult")
.def(py::init<>())
.def_readwrite("block_hashes", &monero_generate_blocks_result::m_block_hashes)
.def_readwrite("height", &monero_generate_blocks_result::m_height);

// monero_tx_pool_stats
py::class_<monero_tx_pool_stats, serializable_struct, std::shared_ptr<monero_tx_pool_stats>>(m, "MoneroTxPoolStats")
.def(py::init<>())
Expand Down Expand Up @@ -1193,6 +1200,12 @@ PYBIND11_MODULE(monero, m) {
MONERO_CATCH_AND_RETHROW(self.get_normalized_destinations());
});

// monero_key_image_export_result
py_monero_key_image_export_result
.def(py::init<>())
.def_readwrite("offset", &monero_key_image_export_result::m_offset)
.def_readwrite("key_images", &monero_key_image_export_result::m_key_images);

// monero_key_image_import_result
py_monero_key_image_import_result
.def(py::init<>())
Expand Down Expand Up @@ -1469,6 +1482,9 @@ PYBIND11_MODULE(monero, m) {
.def("get_mining_status", [](monero_daemon& self) {
MONERO_CATCH_AND_RETHROW(self.get_mining_status());
}, py::call_guard<py::gil_scoped_release>())
.def("generate_blocks", [](monero_daemon& self,const std::string& wallet_address, uint64_t num_blocks, const boost::optional<std::string>& prev_block_hash, const boost::optional<uint32_t>& starting_nonce) {
MONERO_CATCH_AND_RETHROW(self.generate_blocks(wallet_address, num_blocks, prev_block_hash, starting_nonce));
}, py::arg("wallet_address"), py::arg("num_blocks"), py::arg("prev_block_hash") = py::none(), py::arg("starting_nonce") = py::none(), py::call_guard<py::gil_scoped_release>())
.def("submit_block", [](monero_daemon& self, const std::string& block_blob) {
MONERO_CATCH_AND_RETHROW(self.submit_block(block_blob));
}, py::arg("block_blob"), py::call_guard<py::gil_scoped_release>())
Expand Down Expand Up @@ -1742,9 +1758,9 @@ PYBIND11_MODULE(monero, m) {
.def("export_key_images", [](PyMoneroWallet& self, bool all) {
MONERO_CATCH_AND_RETHROW(self.export_key_images(all));
}, py::arg("all") = false, py::call_guard<py::gil_scoped_release>())
.def("import_key_images", [](PyMoneroWallet& self, const std::vector<std::shared_ptr<monero_key_image>>& key_images) {
.def("import_key_images", [](PyMoneroWallet& self, const std::vector<std::shared_ptr<monero_key_image>>& key_images, uint64_t offset) {
MONERO_CATCH_AND_RETHROW(self.import_key_images(key_images));
}, py::arg("key_images"), py::call_guard<py::gil_scoped_release>())
}, py::arg("key_images"), py::arg("offset") = 0, py::call_guard<py::gil_scoped_release>())
.def("get_new_key_images_from_last_import", [](PyMoneroWallet& self) {
MONERO_CATCH_AND_RETHROW(self.export_key_images(false));
}, py::call_guard<py::gil_scoped_release>())
Expand Down
8 changes: 4 additions & 4 deletions src/cpp/wallet/py_monero_wallet.h
Original file line number Diff line number Diff line change
Expand Up @@ -354,12 +354,12 @@ class PyMoneroWallet : public monero_wallet {
PYBIND11_OVERRIDE(int, monero_wallet, import_outputs, outputs_hex);
}

std::vector<std::shared_ptr<monero_key_image>> export_key_images(bool all = false) const override {
PYBIND11_OVERRIDE(std::vector<std::shared_ptr<monero_key_image>>, monero_wallet, export_key_images, all);
std::shared_ptr<monero_key_image_export_result> export_key_images(bool all = false) const override {
PYBIND11_OVERRIDE(std::shared_ptr<monero_key_image_export_result>, monero_wallet, export_key_images, all);
}

std::shared_ptr<monero_key_image_import_result> import_key_images(const std::vector<std::shared_ptr<monero_key_image>>& key_images) override {
PYBIND11_OVERRIDE(std::shared_ptr<monero_key_image_import_result>, monero_wallet, import_key_images, key_images);
std::shared_ptr<monero_key_image_import_result> import_key_images(const std::vector<std::shared_ptr<monero_key_image>>& key_images, uint64_t offset = 0) override {
PYBIND11_OVERRIDE(std::shared_ptr<monero_key_image_import_result>, monero_wallet, import_key_images, key_images, offset);
}

void freeze_output(const std::string& key_image) override {
Expand Down
4 changes: 4 additions & 0 deletions src/python/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,12 @@ from .monero_decoded_address import MoneroDecodedAddress
from .monero_destination import MoneroDestination
from .monero_error import MoneroError
from .monero_fee_estimate import MoneroFeeEstimate
from .monero_generate_blocks_result import MoneroGenerateBlocksResult
from .monero_hard_fork_info import MoneroHardForkInfo
from .monero_incoming_transfer import MoneroIncomingTransfer
from .monero_integrated_address import MoneroIntegratedAddress
from .monero_key_image import MoneroKeyImage
from .monero_key_image_export_result import MoneroKeyImageExportResult
from .monero_key_image_import_result import MoneroKeyImageImportResult
from .monero_key_image_spent_status import MoneroKeyImageSpentStatus
from .monero_message_signature_result import MoneroMessageSignatureResult
Expand Down Expand Up @@ -157,10 +159,12 @@ __all__ = [
'MoneroDestination',
'MoneroError',
'MoneroFeeEstimate',
'MoneroGenerateBlocksResult',
'MoneroHardForkInfo',
'MoneroIncomingTransfer',
'MoneroIntegratedAddress',
'MoneroKeyImage',
'MoneroKeyImageExportResult',
'MoneroKeyImageImportResult',
'MoneroKeyImageSpentStatus',
'MoneroMessageSignatureResult',
Expand Down
12 changes: 12 additions & 0 deletions src/python/monero_daemon.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import typing
from .monero_daemon_listener import MoneroDaemonListener
from .monero_daemon_update_check_result import MoneroDaemonUpdateCheckResult
from .monero_daemon_update_download_result import MoneroDaemonUpdateDownloadResult
from .monero_generate_blocks_result import MoneroGenerateBlocksResult
from .monero_alt_chain import MoneroAltChain
from .monero_block import MoneroBlock
from .monero_block_header import MoneroBlockHeader
Expand Down Expand Up @@ -318,6 +319,17 @@ class MoneroDaemon:
"""
...

def generate_blocks(self, wallet_address: str, num_blocks: int, prev_block_hash: str | None = None, starting_nonce: int | None = None) -> MoneroGenerateBlocksResult:
"""
Generate blocks to a wallet address (regtest only).

:param str wallet_address: is the address of the wallet to receive miner transactions if block is successfully mined.
:param int num_blocks: is the number of blocks to generate.
:param str | None prev_block_hash: is the hash of the previous block to build on top of (optional, builds on the current tip if not given).
:param int | None starting_nonce: is the starting nonce to use (optional).
:returns MoneroGenerateBlockResult: the result of generating blocks; height is the height of the last block generated.
"""

def get_output_distribution(self, amounts: list[int], is_cumulative: bool | None = None, start_height: int | None = None, end_height: int | None = None) -> list[MoneroOutputDistributionEntry]:
"""
Creates an output distribution.
Expand Down
10 changes: 10 additions & 0 deletions src/python/monero_generate_blocks_result.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
from .serializable_struct import SerializableStruct


class MoneroGenerateBlocksResult(SerializableStruct):
"""Models the result of generating blocks."""

block_hashes: list[str]
"""Generated block hashes."""
height: int | None
"""New chain height."""
15 changes: 15 additions & 0 deletions src/python/monero_key_image_export_result.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
from .serializable_struct import SerializableStruct
from .monero_key_image import MoneroKeyImage


class MoneroKeyImageExportResult(SerializableStruct):
"""Models results from exporting key images."""

offset: int | None
"""Offset height."""
key_images: list[MoneroKeyImage]
"""Exported key images."""

def __init__(self) -> None:
"""Initialize a Monero key image export result."""
...
8 changes: 5 additions & 3 deletions src/python/monero_wallet.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ from .monero_tx_wallet import MoneroTxWallet
from .monero_tx_query import MoneroTxQuery
from .monero_version import MoneroVersion
from .monero_integrated_address import MoneroIntegratedAddress
from .monero_key_image_export_result import MoneroKeyImageExportResult
from .monero_key_image_import_result import MoneroKeyImageImportResult
from .monero_tx_set import MoneroTxSet
from .monero_multisig_init_result import MoneroMultisigInitResult
Expand Down Expand Up @@ -211,12 +212,12 @@ class MoneroWallet:
"""

...
def export_key_images(self, all: bool = False) -> list[MoneroKeyImage]:
def export_key_images(self, all: bool = False) -> MoneroKeyImageExportResult:
"""
Export signed key images.

:param bool all: export all key images if `True`, else export key images since the last export.
:returns list[MoneroKeyImage]: the wallet's signed key images.
:returns MoneroKeyImageResult: the wallet's signed key images.
"""
...
def export_multisig_hex(self) -> str:
Expand Down Expand Up @@ -795,11 +796,12 @@ class MoneroWallet:
:returns MoneroVersion: the wallet's version.
"""
...
def import_key_images(self, key_images: list[MoneroKeyImage]) -> MoneroKeyImageImportResult:
def import_key_images(self, key_images: list[MoneroKeyImage], offset: int = 0) -> MoneroKeyImageImportResult:
"""
Import signed key images and verify their spent status.

:param list[MoneroKeyImage] key_images: are key images to import and verify (requires hex and signature).
:param int offset: offset of the first key image among the wallet's outputs.
:returns MoneroKeyImageImportResult: results of the import.
"""
...
Expand Down
21 changes: 11 additions & 10 deletions tests/test_monero_wallet_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
MoneroTxWallet, MoneroOutputWallet, MoneroTx, MoneroAccount, MoneroSubaddress,
MoneroMessageSignatureType, MoneroTxPriority, MoneroFeeEstimate,
MoneroIntegratedAddress, MoneroCheckTx, MoneroCheckReserve,
MoneroAddressBookEntry, MoneroSubmitTxResult, MoneroAccountTag
MoneroAddressBookEntry, MoneroSubmitTxResult, MoneroAccountTag,
MoneroKeyImageExportResult
)
from utils import (
MultisigSampleCodeTester,
Expand Down Expand Up @@ -2986,18 +2987,18 @@ def test_set_tx_notes(self, wallet: MoneroWallet) -> None:
# Can export signed key images
@pytest.mark.skipif(TestUtils.TEST_NON_RELAYS is False, reason="TEST_NON_RELAYS disabled")
def test_export_key_images(self, wallet: MoneroWallet) -> None:
images = wallet.export_key_images(True)
assert len(images) > 0, "No signed key images in wallet"
result: MoneroKeyImageExportResult = wallet.export_key_images(True)
assert len(result.key_images) > 0, "No signed key images in wallet"

for image in images:
for image in result.key_images:
assert isinstance(image, MoneroKeyImage)
assert image.hex is not None and len(image.hex) > 0
assert image.signature is not None and len(image.signature) > 0

# wallet exports key images since last export by default
images = wallet.export_key_images()
images_all: list[MoneroKeyImage] = wallet.export_key_images(True)
assert len(images_all) > len(images)
images: MoneroKeyImageExportResult = wallet.export_key_images()
images_all: MoneroKeyImageExportResult = wallet.export_key_images(True)
assert len(images_all.key_images) > len(images.key_images)

# Can get new key images from the last import
@pytest.mark.skipif(TestUtils.TEST_NON_RELAYS is False, reason="TEST_NON_RELAYS disabled")
Expand All @@ -3024,9 +3025,9 @@ def test_get_new_key_images_from_last_import(self, wallet: MoneroWallet) -> None
# TODO monero-project: importing key images can cause erasure of incoming transfers per wallet2.cpp:11957
@pytest.mark.skipif(TestUtils.TEST_NON_RELAYS is False, reason="TEST_NON_RELAYS disabled")
def test_import_key_images(self, wallet: MoneroWallet) -> None:
images = wallet.export_key_images()
assert len(images) > 0, "Wallet does not have any key images run send tests"
result = wallet.import_key_images(images)
export_result: MoneroKeyImageExportResult = wallet.export_key_images()
assert len(export_result.key_images) > 0, "Wallet does not have any key images run send tests"
result = wallet.import_key_images(export_result.key_images)
assert result.height is not None and result.height > 0

# determine if non-zero spent and unspent amounts are expected
Expand Down
6 changes: 3 additions & 3 deletions tests/utils/view_only_and_offline_wallet_tester.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from monero import (
MoneroWallet, MoneroTxWallet, MoneroTransfer,
MoneroOutputWallet, MoneroWalletRpc, MoneroTxQuery,
MoneroKeyImage, MoneroTxConfig, MoneroTxSet
MoneroKeyImageExportResult, MoneroTxConfig, MoneroTxSet
)
from .test_utils import TestUtils
from .tx_wallet_utils import TxWalletUtils
Expand Down Expand Up @@ -121,11 +121,11 @@ def test(self) -> None:
assert num_outputs_imported > 0, "No outputs imported"

# export key images from offline wallet
key_images: list[MoneroKeyImage] = self._offline_wallet.export_key_images()
result: MoneroKeyImageExportResult = self._offline_wallet.export_key_images()

# import key images to view-only wallet
assert self._view_only_wallet.is_connected_to_daemon()
self._view_only_wallet.import_key_images(key_images)
self._view_only_wallet.import_key_images(result.key_images)
assert self._wallet.get_balance() == self._view_only_wallet.get_balance()

# create unsigned tx using view-only wallet
Expand Down
Loading