Struct DecompressedPruningSeed

pub struct DecompressedPruningSeed { /* private fields */ }

This represents a valid Monero pruning seed.

It does allow representations of pruning seeds that Monero’s P2P network would not allow, i.e. it does not restrict the seed to only have a log_stripes of 8.

Implementations

impl DecompressedPruningSeed

pub const fn new(stripe: u32, log_stripes: u32) -> Result<Self, PruningError>

Creates a new pruning seed from a stripe and log_stripes

What is a stripe

A stripe is the part of the blockchain this peer will keep.

Monero, when pruning, will split the blockchain into multiple “stripes”, that amount is currently 8 and each pruned peer will keep one of those 8 stripes.

What is log_stripes

log_stripes is log2 of the amount of stripes used.

For Monero, currently, that amount is 8 so log_stripes will be 3.

---

note this function allows you to make invalid seeds, this is done to allow the specifics of pruning to change in the future. To make a valid seed you currently MUST pass in a number 1 to 8 for stripe and 3 for log_stripes.

pub const fn decompress(seed: u32) -> Result<Option<Self>, PruningError>

Attempts to decompress a raw pruning seed.

Will return Ok(None) if the pruning seed means no pruning.

An error means the pruning seed was invalid.

pub const fn compress(&self) -> u32

Compresses the pruning seed into a u32.

pub const fn has_full_block( &self, height: usize, blockchain_height: usize, ) -> bool

Returns true if a peer with this pruning seed should have a non-pruned version of a block.

pub fn get_next_unpruned_block( &self, block_height: usize, blockchain_height: usize, ) -> Result<usize, PruningError>

Gets the next unpruned block for a given block_height and blockchain_height

Each seed will store, in a cyclic manner, a portion of blocks while discarding the ones that are out of your stripe. This function is finding the next height for which a specific seed will start storing blocks.

Errors

This function will return an Error if the inputted block_height or blockchain_height is greater than MAX_BLOCK_HEIGHT_USIZE.

This function will also error if block_height > blockchain_height

pub fn get_next_pruned_block( &self, block_height: usize, blockchain_height: usize, ) -> Result<Option<usize>, PruningError>

Gets the next pruned block for a given block_height and blockchain_height

Each seed will store, in a cyclic manner, a portion of blocks while discarding the ones that are out of your stripe. This function is finding the next height for which a specific seed will start pruning blocks.

Errors

This function will return an Error if the inputted block_height or blockchain_height is greater than MAX_BLOCK_HEIGHT_USIZE.

This function will also error if block_height > blockchain_height

Trait Implementations

impl BorshDeserialize for DecompressedPruningSeed

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for DecompressedPruningSeed

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for DecompressedPruningSeed

fn clone(&self) -> DecompressedPruningSeed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DecompressedPruningSeed

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

Formats the value using the given formatter.

impl Hash for DecompressedPruningSeed

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DecompressedPruningSeed

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DecompressedPruningSeed

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for DecompressedPruningSeed

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for DecompressedPruningSeed

impl Eq for DecompressedPruningSeed

impl StructuralPartialEq for DecompressedPruningSeed

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes