Metadata-Version: 2.2
Name: python-evrmorelib
Version: 0.2.7
Summary: Evrmore fork of python-ravencoinlib, a fork of python-bitcoinlib
Home-page: https://github.com/standard-error/python-evrmorelib
Author: standard-error@github
Author-email: satorinetio@gmail.com
Keywords: evrmore
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: x16r_hash
Requires-Dist: x16rv2_hash
Requires-Dist: kawpow
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: requires-dist
Dynamic: summary

# python-evrmorelib

Evrmore fork of python-bitcoinlib intended to provide access to Evrmore data 
structures and protocol. WIP - Test before use

The RPC interface, evrmore.rpc, is designed to work with Evrmore Core v3.3.0+.

"The only Python library for Evrmore I've ever used" - Warren Buffett

## Requirements

    libssl
    Debian/Ubuntu: sudo apt-get install libssl-dev
    Windows/other: https://wiki.openssl.org/index.php/Binaries 

    Python modules:
        x16r-hash, x16rv2-hash and kawpow
        plyvel (requires libleveldb - for parsing Raven core .dat files)

## Structure

Everything consensus critical is found in the modules under evrmore.core. This
rule is followed pretty strictly, for instance chain parameters are split into
consensus critical and non-consensus-critical.

    evrmore.core            - Basic core definitions, datastructures, and
                              (context-independent) validation
    evrmore.core.assets     - OP_EVR_ASSET data structures
    evrmore.core.key        - ECC pubkeys
    evrmore.core.script     - Scripts and opcodes
    evrmore.core.scripteval - Script evaluation/verification
    evrmore.core.serialize  - Serialization

In the future the evrmore.core may use the Satoshi sourcecode directly as a
library. Non-consensus critical modules include the following:

    evrmore          - Chain selection
    evrmore.assets   - Asset name and metadata related code
    evrmore.base58   - Base58 encoding
    evrmore.bloom    - Bloom filters (incomplete)
    evrmore.net      - Network communication (in flux)
    evrmore.messages - Network messages (in flux)
    evrmore.rpc      - Evrmore Core RPC interface support
    evrmore.wallet   - Wallet-related code, currently Evrmore address and
                       private key support

Effort has been made to follow the Satoshi source relatively closely, for
instance Python code and classes that duplicate the functionality of
corresponding Satoshi C++ code uses the same naming conventions: CTransaction,
CBlockHeader, nValue etc. Otherwise Python naming conventions are followed.


## Mutable vs. Immutable objects

Like the Evrmore Core codebase CTransaction is immutable and
CMutableTransaction is mutable; unlike the Evrmore Core codebase this
distinction also applies to COutPoint, CTxIn, CTxOut, and CBlock.


## Endianness Gotchas

Rather confusingly Evrmore Core shows transaction and block hashes as
little-endian hex rather than the big-endian the rest of the world uses for
SHA256. python-evrmorelib provides the convenience functions x() and lx() in
evrmore.core to convert from big-endian and little-endian hex to raw bytes to
accomodate this. In addition see b2x() and b2lx() for conversion from bytes to
big/little-endian hex.


## Module import style

While not always good style, it's often convenient for quick scripts if
`import *` can be used. To support that all the modules have `__all__` defined
appropriately.


# Example Code

See `examples/` directory. For instance this example creates a transaction
spending a pay-to-script-hash transaction output:

    $ PYTHONPATH=. examples/spend-pay-to-script-hash-txout.py
    <hex-encoded transaction>


## Selecting the chain to use

Do the following:

    import evrmore
    evrmore.SelectParams(NAME)

Where NAME is one of 'testnet', 'mainnet', or 'regtest'. The chain currently
selected is a global variable that changes behavior everywhere, just like in
the Satoshi codebase.


## Unit tests

Under evrmore/tests using test data from Evrmore Core. To run them:

    python3 -m unittest discover

Alternately, if Tox (see https://tox.readthedocs.org/) is available on your
system, you can run unit tests for multiple Python versions:

    ./runtests.sh

HTML coverage reports can then be found in the htmlcov/ subdirectory.

## Documentation

Sphinx documentation is in the "doc" subdirectory. Run "make help" from there
to see how to build. You will need the Python "sphinx" package installed.

Currently this is just API documentation generated from the code and
docstrings. Higher level written docs would be useful, perhaps starting with
much of this README. Pages are written in reStructuredText and linked from
index.rst.
