Crate randomx_bindings

Rust bindings to librandomx, a library for computing RandomX hashes.

Examples

Light mode hash

Requires 256M of shared memory.

use randomx_bindings::{RandomxCache, RandomxError, RandomxFlags, RandomxVm};

// Get flags supported by this system.
let flags = RandomxFlags::default();
let cache = RandomxCache::new(flags, b"key")?;
let vm = RandomxVm::new(flags, &cache)?;
let hash = vm.hash(b"input"); // is a [u8; 32]

Fast mode hash

Requires 2080M of shared memory.

use randomx_bindings::{RandomxDataset, RandomxError, RandomxFlags, RandomxVm};

// OR the default flags with FULLMEM (aka. fast mode)
let flags = RandomxFlags::default() | RandomxFlags::FULLMEM;
// Speed up dataset initialisation
const THREADS: u8 = 4;
let dataset = RandomxDataset::new(flags, b"key", THREADS)?;
let vm = RandomxVm::new_fast(flags, &dataset)?;
let hash = vm.hash(b"input");

Errors

Some operations (e.g. allocating a VM or dataset) can fail if the system doesn’t have enough free memory, or if you tried to force a feature like large pages or AVX2 on a system that does not support it.

Re-exports

pub use crate::cache::*;
pub use crate::dataset::*;
pub use crate::error::*;
pub use crate::flags::*;
pub use crate::vm::*;

Modules

cache
dataset
error
flags
vm