# README
Proof of Work Algorithms
Overview
Note: This library is still in active development and is subject to breaking changes
Even though there are a wide variety of Proof of Work algorithms, finding the technical details for the implementations is quite a task. For example, both Kawpow and Firopow are variations off of ProgPow but finding the exact differences is painful. This is meant to be a unified library to make the specification of existing Proof of Work algorithms more standardized.
All DAG-based algorithms only implement a light DAG, which is sufficient for validation
but not full nodes or miners. For the DAG-based algorithms and verthash, data is cached in ~/.powcache.
Ethash will generally be between 40-80Mb per epoch (and generally 3 caches are stored), but verthash
requires a strict 1.2Gb, so be careful if you're using verthash in memory. At the time of writing, running
make test will throw about 3.3Gb of data into ~/.powcache due to the variety and breadth of tests.
Algorithms
| Algorithm | DAG | Supported |
|---|---|---|
| Ethash | yes | yes |
| Etchash | yes | yes |
| Kawpow | yes | yes |
| Firopow | yes | yes |
| Octopus | yes | yes |
| Verthash | yes | yes |
| Equihash | no | yes |
| HeavyHash | no | yes |
| Autolykos2 | no | yes |
| Cuckoo Cycle | no | yes |
| Eaglesong | no | yes |
| BeamHashIII | no | yes |
| ZelHash | no | yes |
| Cortex | no | yes |
Things to Note
- Most of these algorithms are partially optimized but I'm sure they could be improved. That being said, that will probably never happen since these have never been intended to be used for miner clients. All of these algorithms far surpass a reasonable threshold for performance and I have no intention of hypertuning them.
- The base ProgPow implementation ("ProgPow094") exists in the
internal/progpowpackage. - Since ZelHash is such a minor Equihash variant, it is treated as just "twisted Equihash" (in
equihash/). - All testing is done on linux, windows support is hazy at best.
- The library assumes the host architecture is little-endian, I'm fairly confident big-endian architectures will not function properly.
- As of now, the only other algorithms that are on the list of "maybes" are: cryptonight, randomx, X25X, and cuckatoo.
Roadmap
Currently, though powkit is used in production internally, it probably isn't a good idea to use yourself. The API is still in flux and each minor version will probably be breaking. Once we do a v1.0.0 release, the structure will probably be pretty set in stone.