bee-pow 1.0.0

Provides Proof of Work utilities for the IOTA protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

// Copyright 2020-2021 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

//! Contains nonce providers for Proof of Work.

pub mod miner;
pub mod u64;

/// A trait to build nonce providers.
pub trait NonceProviderBuilder: Default + Sized {
    /// The type of the built nonce provider.
    type Provider: NonceProvider<Builder = Self>;

    /// Creates a new nonce provider builder.
    fn new() -> Self {
        Self::default()
    }

    /// Constructs the nonce provider from the builder.
    fn finish(self) -> Self::Provider;
}

/// A trait describing how a nonce is provided.
pub trait NonceProvider: Sized {
    /// The type of the nonce provider builder.
    type Builder: NonceProviderBuilder<Provider = Self>;
    /// Type of errors occurring when providing nonces.
    type Error: std::error::Error;

    /// Returns a builder for this nonce provider.
    fn builder() -> Self::Builder {
        Self::Builder::default()
    }

    /// Provides a nonce given bytes and a target score.
    fn nonce(&self, bytes: &[u8], target_score: u32) -> Result<u64, Self::Error>;
}