Struct PoWModule

pub struct PoWModule {
    pub genesis: Timestamp,
    pub target: u32,
    pub fixed_difficulty: Option<BigUint>,
    pub timestamps: RingBuffer<Timestamp, BUF_SIZE>,
    pub difficulties: RingBuffer<BigUint, BUF_SIZE>,
    pub cummulative_difficulty: BigUint,
}

This struct represents the information required by the PoW algorithm

Fields

genesis: Timestamp

Genesis block timestamp

target: u32

Target block time, in seconds

fixed_difficulty: Option<BigUint>

Optional fixed difficulty

timestamps: RingBuffer<Timestamp, BUF_SIZE>

Latest block timestamps ringbuffer

difficulties: RingBuffer<BigUint, BUF_SIZE>

Latest block cummulative difficulties ringbuffer

cummulative_difficulty: BigUint

Total blocks cummulative difficulty Note: we keep this as a struct field for faster access(optimization), since its always same as difficulties buffer last.

Implementations

impl PoWModule

pub fn new( blockchain: Blockchain, target: u32, fixed_difficulty: Option<BigUint>, height: Option<u32>, ) -> Result<Self>

pub fn next_difficulty(&self) -> Result<BigUint>

Compute the next mining difficulty, based on current ring buffers. If ring buffers contain 2 or less items, difficulty 1 is returned. If a fixed difficulty has been set, this function will always return that after first 2 difficulties.

fn cutoff(&self, length: usize) -> Result<(usize, usize)>

Calculate cutoff indexes. If buffers have been filled, we return the already known indexes, for performance.

pub fn next_mine_target(&self) -> Result<BigUint>

Compute the next mine target.

pub fn next_mine_target_and_difficulty(&self) -> Result<(BigUint, BigUint)>

Compute the next mine target and difficulty.

pub fn verify_difficulty(&self, difficulty: &BigUint) -> Result<bool>

Verify provided difficulty corresponds to the next one.

pub fn verify_current_timestamp(&self, timestamp: Timestamp) -> Result<bool>

Verify provided block timestamp is not far in the future and check its valid acorrding to current timestamps median.

pub fn verify_timestamp_by_median(&self, timestamp: Timestamp) -> bool

Verify provided block timestamp is valid and matches certain criteria.

pub fn verify_current_block(&self, block: &BlockInfo) -> Result<()>

Verify provided block timestamp and hash.

pub fn verify_block_hash(&self, block: &BlockInfo) -> Result<()>

Verify provided block corresponds to next mine target.

pub fn append(&mut self, timestamp: Timestamp, difficulty: &BigUint)

Append provided timestamp and difficulty to the ring buffers.

pub fn append_difficulty( &mut self, overlay: &BlockchainOverlayPtr, difficulty: BlockDifficulty, ) -> Result<()>

Append provided block difficulty to the ring buffers and insert it to provided overlay.

pub fn mine_block( &self, miner_block: &mut BlockInfo, threads: usize, stop_signal: &Receiver<()>, ) -> Result<()>

Mine provided block, based on next mine target.

Trait Implementations

impl Clone for PoWModule

fn clone(&self) -> PoWModule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for PoWModule

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

Formats the value using the given formatter.