Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Chia-Network/chiapos
Chia Proof of Space library
https://github.com/Chia-Network/chiapos
blockchain blockchain-network chia chia-blockchain farmer hellman-attacks proof-of-space
Last synced: 3 months ago
JSON representation
Chia Proof of Space library
- Host: GitHub
- URL: https://github.com/Chia-Network/chiapos
- Owner: Chia-Network
- License: apache-2.0
- Created: 2020-03-10T19:25:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-15T21:34:20.000Z (4 months ago)
- Last Synced: 2024-07-16T02:00:46.596Z (4 months ago)
- Topics: blockchain, blockchain-network, chia, chia-blockchain, farmer, hellman-attacks, proof-of-space
- Language: HTML
- Size: 4.32 MB
- Stars: 268
- Watchers: 50
- Forks: 279
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- best-of-crypto - GitHub - 22% open · ⏱️ 30.05.2024): (Smart Contract Platforms)
README
# Chia Proof of Space
[](https://coveralls.io/github/Chia-Network/chiapos?branch=main)
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](https://www.chia.net/wp-content/uploads/2022/09/Chia_Proof_of_Space_Construction_v1.1.pdf) to
learn about what proof of space is and how it works.
## C++ Usage Instructions
### Compile
```bash
# Requires cmake 3.14+
mkdir -p build && cd build
cmake ../
cmake --build . -- -j 6
```
## Static Compilation With glibc
### Statically compile ProofOfSpace
```bash
mkdir -p build && cd build
cmake -DBUILD_PROOF_OF_SPACE_STATICALLY=ON ../
cmake --build . -- -j 6
```
### Run tests
```bash
./RunTests
```
### CLI usage
```bash
./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 <32 byte hex challenge>
./ProofOfSpace -f "plot.dat" check
```
### Benchmark
```bash
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.
```bash
./HellmanAttacks -k 18 -f "plot.dat" -m "0x1234" create
./HellmanAttacks -f "plot.dat" check
```
## Python
Finally, python bindings are provided in the python-bindings directory.
### Install
```bash
python3 -m venv .venv
. .venv/bin/activate
pip3 install .
```
### Run python tests
Testings uses pytest. Linting uses flake8 and mypy.
```bash
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](https://cmake.org/cmake/help/latest/module/FetchContent.html)
to download [pybind11](https://github.com/pybind/pybind11). Building is then
managed by [cibuildwheel](https://github.com/joerick/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](https://github.com/Chia-Network/chia-blockchain/blob/main/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](https://lgtm.com/projects/g/Chia-Network/chiapos/?mode=list). Please
make sure your build is passing and that it does not increase alerts at lgtm.