Config

Struct Config 

Source
pub struct Config {
    pub salt: String,
}
Expand description

Configuration for generting proof of work Please choose a long, unique value for salt Resistance to dictionary/rainbow attacks depend on uniqueness of the salt

Fields§

§salt: String

Implementations§

Source§

impl Config

Source

pub fn prove_work<T>(&self, t: &T, difficulty: u32) -> Result<PoW<T>>
where T: Serialize,

Create Proof of Work over item of type T.

Make sure difficulty is not too high. A 64 bit difficulty, for example, takes a long time on a general purpose processor. Returns bincode::Error if serialization fails.

Examples found in repository?
examples/simple.rs (line 22)
12fn main() {
13    let config = ConfigBuilder::default()
14        .salt("myrandomsaltisnotlongenoug".into())
15        .build()
16        .unwrap();
17
18    let phrase = "ironmansucks";
19
20    const DIFFICULTY: u32 = 1000;
21
22    let work = config.prove_work(&phrase, DIFFICULTY).unwrap();
23    assert!(config.is_valid_proof(&work, &phrase));
24    assert!(config.is_sufficient_difficulty(&work, DIFFICULTY));
25}
Source

pub fn prove_work_serialized<T>(&self, prefix: &[u8], difficulty: u32) -> PoW<T>
where T: Serialize,

Create Proof of Work on an already serialized item of type T. The input is assumed to be serialized using network byte order.

Make sure difficulty is not too high. A 64 bit difficulty, for example, takes a long time on a general purpose processor.

Source

pub fn calculate<T>(&self, pow: &PoW<T>, t: &T) -> Result<u128>
where T: Serialize,

Calculate the PoW score with the provided input T.

Source

pub fn calculate_serialized<T>(&self, pow: &PoW<T>, target: &[u8]) -> u128
where T: Serialize,

Calculate the PoW score of an already serialized T and self. The input is assumed to be serialized using network byte order.

Source

pub fn is_valid_proof<T>(&self, pow: &PoW<T>, t: &T) -> bool
where T: Serialize,

Verifies that the PoW is indeed generated out of the phrase provided.

Examples found in repository?
examples/simple.rs (line 23)
12fn main() {
13    let config = ConfigBuilder::default()
14        .salt("myrandomsaltisnotlongenoug".into())
15        .build()
16        .unwrap();
17
18    let phrase = "ironmansucks";
19
20    const DIFFICULTY: u32 = 1000;
21
22    let work = config.prove_work(&phrase, DIFFICULTY).unwrap();
23    assert!(config.is_valid_proof(&work, &phrase));
24    assert!(config.is_sufficient_difficulty(&work, DIFFICULTY));
25}
Source

pub fn is_sufficient_difficulty<T>( &self, pow: &PoW<T>, target_diff: u32, ) -> bool
where T: Serialize,

Checks if the PoW result is of sufficient difficulty

Examples found in repository?
examples/simple.rs (line 24)
12fn main() {
13    let config = ConfigBuilder::default()
14        .salt("myrandomsaltisnotlongenoug".into())
15        .build()
16        .unwrap();
17
18    let phrase = "ironmansucks";
19
20    const DIFFICULTY: u32 = 1000;
21
22    let work = config.prove_work(&phrase, DIFFICULTY).unwrap();
23    assert!(config.is_valid_proof(&work, &phrase));
24    assert!(config.is_sufficient_difficulty(&work, DIFFICULTY));
25}

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Config

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Config

Source§

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Config

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Config

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,