Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Chia proof of space plotting, proving, and verifying (wraps C++)

Project description

Chia Proof of Space

Build PyPI PyPI - Format GitHub

Total alerts Language grade: Python Language grade: C/C++

Chia's proof of space is written in C++. Includes a plotter, prover, and verifier. It exclusively runs on 64 bit architectures. Read the Proof of Space document to learn about what proof of space is and how it works.

C++ Usage Instructions

Compile

# Requires cmake 3.14+

mkdir -p build && cd build
cmake ../
cmake --build . -- -j 6

Run tests

./RunTests

CLI usage

./ProofOfSpace -k 25 -f "plot.dat" -m "0x1234" create
./ProofOfSpace -k 25 -f "final-plot.dat" -m "0x4567" -t TMPDIR -2 SECOND_TMPDIR create
./ProofOfSpace -f "plot.dat" prove <32 byte hex challenge>
./ProofOfSpace -k 25 verify <hex proof> <32 byte hex challenge>
./ProofOfSpace -f "plot.dat" check <iterations>

Benchmark

time ./ProofOfSpace -k 25 create

Hellman Attacks usage

There is an experimental implementation which implements some of the Hellman Attacks that can provide significant space savings for the final file.

./HellmanAttacks -k 18 -f "plot.dat" -m "0x1234" create
./HellmanAttacks -f "plot.dat" check <iterations>

Python

Finally, python bindings are provided in the python-bindings directory.

Install

python3 -m venv .venv
. .venv/bin/activate
pip3 install .

Run python tests

Testings uses pytest. Linting uses flake8 and mypy.

py.test ./tests -s -v

ci Building

The primary build process for this repository is to use GitHub Actions to build binary wheels for MacOS, Linux (x64 and aarch64), and Windows and publish them with a source wheel on PyPi. See .github/workflows/build.yml. CMake uses FetchContent to download pybind11. Building is then managed by cibuildwheel. Further installation is then available via pip install chiapos e.g.

Contributing and workflow

Contributions are welcome and more details are available in chia-blockchain's CONTRIBUTING.md.

The main branch is usually the currently released latest version on PyPI. Note that at times chiapos will be ahead of the release version that chia-blockchain requires in it's main/release version in preparation for a new chia-blockchain release. Please branch or fork main and then create a pull request to the main branch. Linear merging is enforced on main and merging requires a completed review. PRs will kick off a GitHub actions ci build and analysis of chiapos at lgtm.com. Please make sure your build is passing and that it does not increase alerts at lgtm.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for chiapos, version 1.0.2
Filename, size File type Python version Upload date Hashes
Filename, size chiapos-1.0.2-cp37-cp37m-macosx_10_14_x86_64.whl (210.0 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size chiapos-1.0.2-cp37-cp37m-manylinux2010_x86_64.whl (339.4 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size chiapos-1.0.2-cp37-cp37m-manylinux2014_aarch64.whl (336.2 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size chiapos-1.0.2-cp37-cp37m-win_amd64.whl (232.3 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size chiapos-1.0.2-cp38-cp38-macosx_10_14_x86_64.whl (210.5 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size chiapos-1.0.2-cp38-cp38-manylinux2010_x86_64.whl (337.9 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size chiapos-1.0.2-cp38-cp38-manylinux2014_aarch64.whl (331.8 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size chiapos-1.0.2-cp38-cp38-win_amd64.whl (232.3 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size chiapos-1.0.2-cp39-cp39-macosx_10_14_x86_64.whl (210.5 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size chiapos-1.0.2-cp39-cp39-manylinux2010_x86_64.whl (338.0 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size chiapos-1.0.2-cp39-cp39-manylinux2014_aarch64.whl (331.9 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size chiapos-1.0.2-cp39-cp39-win_amd64.whl (231.3 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size chiapos-1.0.2.tar.gz (1.3 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page