Struct AnchorRetentionInterval 

pub struct AnchorRetentionInterval(/* private fields */);

The interval, in reference blocks, between the durable anchor checkpoints a wallet retains.

This is a re-export of zcash_protocol::zip318::AnchorBucketInterval, the single definition shared with zcash_pool_migration. The grid a wallet retains its checkpoints on and the grid a pool-crossing transfer anchors to must be the same, so they are one type rather than two kept aligned by a conversion.

The value recommended for use with this crate is supplied by the Default implementation, which is AnchorBucketInterval::ZIP_318. The interval, in reference blocks, between the durable anchor checkpoints a wallet retains, and equally the grid a ZIP 318 pool-crossing transfer anchors to.

The boundaries of the interval on a particular chain are given by an [AnchorGrid], which converts the interval to blocks at each height. Those are the heights whose checkpoints a wallet keeps alive past ordinary pruning, and the only tree states a pool crossing may be proved against. A crossing is proved long after its boundary has passed, so the grid a wallet retains and the grid a crossing anchors to must be the same — which is why this is one type rather than one per crate.

The interval is a modulus, so it is necessarily non-zero.

Implementations

impl AnchorBucketInterval

pub const ZIP_318: AnchorBucketInterval

The interval specified by ZIP 318: 144 reference blocks, about three hours (8 per day). That is 144 blocks before NU7 activation and 432 blocks from activation.

pub const fn custom(blocks: NonZero<u32>) -> AnchorBucketInterval

Constructs an interval other than the ZIP 318 one. Use this on a test network only.

A wallet on the production network MUST use Self::ZIP_318. The anonymity set a shared anchor provides is exactly the set of transfers that chose the same boundary, so a wallet retaining (and anchoring to) a different grid than its peers is distinguishable from every one of them — which defeats the entire purpose of anchoring to a grid. A shorter interval is useful only on test networks, where waiting out 144-block buckets makes exercising a migration impractical.

This is also the inverse of Self::block_count, for a store reading an interval back out of its own durable state. Such a store is reproducing an interval that was chosen elsewhere, so the restriction above binds whoever chose it, not the store.

pub fn block_count(&self) -> NonZero<u32>

Returns the interval as a number of reference blocks.

Trait Implementations

impl Clone for AnchorBucketInterval

fn clone(&self) -> AnchorBucketInterval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AnchorBucketInterval

impl Debug for AnchorBucketInterval

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

Formats the value using the given formatter.

impl Default for AnchorBucketInterval

fn default() -> AnchorBucketInterval

Returns the “default value” for a type.

impl Eq for AnchorBucketInterval

impl Hash for AnchorBucketInterval

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

where __H: Hasher,

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 AnchorBucketInterval

fn cmp(&self, other: &AnchorBucketInterval) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for AnchorBucketInterval

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AnchorBucketInterval

fn partial_cmp(&self, other: &AnchorBucketInterval) -> 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 StructuralPartialEq for AnchorBucketInterval