Struct PoolMigrationParams 

pub struct PoolMigrationParams { /* private fields */ }

The ZIP 318 pool-migration parameters in force for a particular wallet: the specified values, with the anchor bucket grid taken from the grid that wallet actually retains, on the block spacing of the wallet’s network.

The wallet is the authority on the grid, because it is the side that keeps the checkpoints alive. A crossing anchored to a boundary the wallet did not retain cannot be proved, so every decision that depends on the grid — whether to bucket an anchor, and whether the resulting transaction is a canonical crossing — must consult the same source. Reading the grid from the network defaults instead would agree with the wallet only by coincidence, and silently disagree for any wallet configured with a different interval.

Obtained from WalletRead::pool_migration_params.

Implementations

impl PoolMigrationParams

pub fn new(spacing: BlockSpacing, interval: AnchorRetentionInterval) -> Self

Constructs the parameters for a wallet on a chain with the given spacing that retains anchors on interval. Every other ZIP 318 value takes its specified default.

Trait Implementations

impl Clone for PoolMigrationParams

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PoolMigrationParams

impl Debug for PoolMigrationParams

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

Formats the value using the given formatter.

impl Eq for PoolMigrationParams

impl PartialEq for PoolMigrationParams

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

Equality operator ==.

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

Inequality operator !=.

impl PoolMigrationConstants for PoolMigrationParams

fn anchor_bucket_interval(&self) -> AnchorRetentionInterval

The interval of the grid that durable anchor checkpoints are retained on, and that pool-crossing transfers are proved against.

fn block_spacing(&self) -> BlockSpacing

The block spacing of the chain these parameters apply to, which converts their durations from reference blocks into blocks.

fn anchor_grid(&self) -> AnchorGrid

The boundaries of anchor_bucket_interval on the chain these parameters apply to.

fn denomination_cap(&self) -> Zatoshis

The largest denomination a single pool crossing may carry.

fn max_residual_value(&self) -> Zatoshis

The smallest denomination a pool crossing may carry; a residual below this is left in the source pool rather than crossed.

fn preparation_tx_actions(&self) -> usize

The exact Orchard action count that every note-preparation transaction is padded to.

fn transfer_delay(&self) -> (NonZero<u32>, NonZero<u32>)

The mean and inclusive cap, in reference blocks, of the transfer inter-arrival delay distribution.

fn preparation_delay(&self) -> (NonZero<u32>, NonZero<u32>)

The mean and inclusive cap, in reference blocks, of the preparation inter-arrival delay distribution.

fn anchor_age_cap(&self) -> u32

The maximum anchor age, in boundaries, that a recency-weighted anchor draw will accept.

fn expiry_window(&self) -> (u32, u32)

The modulus and window, in reference blocks, of the canonical rolling expiry window.

fn is_canonical_denomination(&self, value: Zatoshis) -> bool

Returns whether value is a canonical crossing denomination under these parameters: a {1, 2, 5} * 10^k amount within [max_residual_value, denomination_cap].

fn canonical_expiry(&self, reference: BlockHeight) -> BlockHeight

The canonical rolling expiry height for a transaction targeting reference, under these parameters. See the free [expiry_height], which this generalizes to an overridden expiry_window.

fn is_canonical_expiry( &self, expiry: BlockHeight, reference: BlockHeight, ) -> bool

Returns whether expiry is the canonical rolling expiry for a transaction targeting reference.

fn is_canonical_expiry_value(&self, expiry: BlockHeight) -> bool

Returns whether expiry could be a canonical rolling expiry for SOME height: whether it is a multiple of the expiry modulus and at least one whole window above zero.

impl StructuralPartialEq for PoolMigrationParams