Skip to main content

Crate equix

Crate equix 

Source
Expand description

§equix

equix: Rust reimplementation of tevador’s Equi-X, a client puzzle for Tor based on the Equihash and HashX algorithms

Check out tevador’s dev log for more information. The Equihash layer is based on Equihash60,3 and the underlying hash function HashX is another new project built as a lightweight ASIC-resistant hash function in the spirit of RandomX.

This crate implements a compact Equihash solver with the same memory footprint as the original Equi-X implementation. HashX is delegated to the hashx crate.

This is for Tor client puzzle support in Arti. (#889)

Re-exports§

pub use bucket_array::mem::BucketArray;
pub use bucket_array::mem::BucketArrayMemory;
pub use bucket_array::mem::BucketArrayPair;
pub use bucket_array::mem::Count;
pub use bucket_array::mem::Uninit;
pub use err::Error;
pub use solution::Solution;
pub use solution::SolutionArray;
pub use solution::SolutionByteArray;
pub use solution::SolutionItem;
pub use solution::SolutionItemArray;
pub use solver::SolverMemory;
pub(crate) use HashX; 🔒
pub(crate) use HashXBuilder; 🔒

Modules§

bucket_array 🔒
A data structure for the solver’s bucket sort layers
collision 🔒
Utilities for representing and finding partial sum collisions in the solver
err 🔒
Error types for the equix crate
solution 🔒
Representation and validation of Equi-X puzzle solutions
solver 🔒
Find Equi-X solutions.

Structs§

EquiX
One Equi-X instance, customized for a challenge string
EquiXBuilder
Builder for creating EquiX instances with custom settings

Enums§

HashError
Errors that could occur while building a hash function
Runtime
Effective HashX runtime for a constructed program
RuntimeOption
Option for selecting a HashX runtime

Functions§

solve
Search for solutions, using default EquiXBuilder options.
verify
Check a Solution against a particular challenge.
verify_array
Check a SolutionItemArray.
verify_bytes
Check a SolutionByteArray.