https://github.com/matoking/nanolib

Python library for working with the NANO cryptocurrency protocol
https://github.com/matoking/nanolib

nanocurrency python python3 unmaintained

Last synced: 4 months ago
JSON representation

Python library for working with the NANO cryptocurrency protocol

• Host: GitHub
• URL: https://github.com/matoking/nanolib
• Owner: Matoking
• License: cc0-1.0
• Created: 2019-02-28T19:03:01.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-08-11T15:36:01.000Z (over 3 years ago)
• Last Synced: 2024-10-08T19:25:14.364Z (4 months ago)
• Topics: nanocurrency, python, python3, unmaintained
• Language: C
• Homepage:
• Size: 997 KB
• Stars: 65
• Watchers: 5
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
nanolib

=======

[![image](https://img.shields.io/pypi/v/nanolib.svg)](https://pypi.org/project/nanolib/)

[![codecov](https://codecov.io/gh/Matoking/nanolib/branch/master/graph/badge.svg)](https://codecov.io/gh/Matoking/nanolib)

[![Build Status](https://travis-ci.com/Matoking/nanolib.png?branch=master)](https://travis-ci.com/Matoking/nanolib)

[![image](https://readthedocs.org/projects/nanolib/badge/?version=latest)](https://nanolib.readthedocs.io/en/latest/?badge=latest)

A set of tools for handling functions related to the NANO cryptocurrency protocol.

Features

========

* Solve and verify proof-of-work

* Create and deserialize legacy and universal blocks

* Account generation from seed using the same algorithm as the original NANO wallet and NanoVault

* Functions for converting between different NANO denominations

* High performance cryptographic operations using C extensions (signing and verifying blocks, and generating block proof-of-work)

  * Proof-of-work generation supports SSE2, SSSE3, SSE4.1, AVX and NEON instruction sets for improved performance. The best supported implementation is selected at runtime with a fallback implementation with universal compatibility.

* Backed by automated tests

* Compatible with Python 3.6 and up

* Licensed under the very permissive *Creative Commons Zero* license

Installation

============

You can install the library using pip:

```

pip install nanolib

```

nanolib requires a working build environment for the C extensions. For example, on Debian-based distros you can install the required Python header files and a C compiler using the following command:

```

apt install build-essential python3-dev

```

Documentation

=============

An online copy of the documentation can be found at [Read the Docs](https://nanolib.readthedocs.io/en/latest/).

You can also build the documentation yourself by running `python setup.py build_sphinx`.

Commands

========

The `setup.py` script comes with a few additional commands besides installation:

* `build_sphinx`

  * Build the documentation in `build/sphinx/html`.

* `test`

  * Run tests using pytest

* `speed`

  * Run a benchmark testing the performance of various cryptographic operations used in the library.

Donations

=========

**xrb_33psgb1exxuftgjthbz4tsgzm5qmyzawrfzptpmp3nwzousbypqf6bcmrk69**