Skip to content
A python toolbox for Monero.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
moneropy
tests
.gitignore
LICENSE Copyright The MoneroPy Developers Nov 4, 2016
README.md Add more info to README on current and future work Nov 14, 2016
requirements.txt Initial msg signing, pysha3 Keccak, and clean up build Apr 7, 2017
setup.py

README.md

MoneroPy - A python toolbox for Monero.

Copyright (c) 2016 The MoneroPy Developers.
All rights reserved.

Released under the BSD 3-Clause License. See LICENSE.

About

This Python 2/3 package aims to be a resource for Monero actions. The package implements basic Monero cryptography, mnemonic key derivation, and key and address creation.

Future additions and improvements include developing routines for checking if transaction outputs belong to a Monero address, if outputs have been spent, and creating and signing outputs. As this is a being developed under a best-effort model, there is not a set timeline for the completion of these or other tasks. If you would like to see progress made in a certain area, feel free to contribute.

Currently, this package is a pure Python implementation of Monero tools and protocol. Future improvements may include using the Monero reference C and C++ libraries for some or all cryptography and other functions.

Installation

MoneroPy will be added to Python's pip once development has somewhat stabilized.

In the meantime, MoneroPy can be installed by downloading this package and then running setup.py as follows:

python setup.py install

Example

Each module in MoneroPy can be imported and used separately. For example, to create spend and view keys and derive a wallet address from a mnemonic seed,

import moneropy.account

seed = ["vixen", "eavesdrop", "fuming", "aching", "react", "waffle",
    "nowhere", "water", "upon", "scoop", "aztec", "sunken", "diplomat",
    "salads", "rift", "inkling", "null", "testing", "sixteen", "return",
    "kitchens", "narrate", "moisture", "nucleus", "testing"]

spendkey, viewkey, address = moneropy.account.account_from_seed(seed)

Full documentation is under development and will be available soon.

Unit Testing

Unit tests are available under tests using data from Monero software. To run tests, navigate to the tests directory and execute. For example,

python test_mnemonic.py

Tests should pass on both Python 2.x and Python 3.x. Please run tests (and write new tests where appropriate) when submitting pull requests.

Data for testing is stored in tests/testdata.py.

Disclaimer

This package uses Daniel J. Bernstein's reference ed25519 Python implementation, adapted for Python 3 compatibility. In addition, it uses Renaud Bauvin's reference Keccak sponge function implementation (v3.2). Both are available in the public domain, and both are written in pure Python. Therefore, key and address derivation using MoneroPy should be considered vulnerable to side-channel attacks, and should not be used on shared hardware to prevent, for example, potential timing attacks.

MoneroPy uses os.urandom to generate a secure mnemonic seed for new wallet creation. Do not use on systems with poor os.urandom entropy sources.

You can’t perform that action at this time.