Struct AccountIdAnchor

pub struct AccountIdAnchor { /* private fields */ }

The anchor of an AccountId. See the type’s documentation for details on anchors.

This type is recommended to be created from a reference to a BlockHeader via the TryFrom impl.

Constraints

This type enforces the following constraints.

• The anchor_block_number % 2^BlockNumber::EPOCH_LENGTH_EXPONENT must be zero. In other words, the block number must a multiple of 2^BlockNumber::EPOCH_LENGTH_EXPONENT.
• The epoch derived from the anchor_block_number must be strictly less than u16::MAX.

Implementations

impl AccountIdAnchor

pub const PRE_GENESIS: Self

A “pre-genesis” AccountIdAnchor which can be used to anchor accounts created in the genesis block.

This anchor should only be used for accounts included in the genesis state, but should not be used as actual anchors in a running network. The reason is that this anchor has the same epoch as the genesis block will have (epoch 0). However, the genesis block will have a different block_commitment than this anchor (EMPTY_WORD) and so any account ID that would use this anchor would be rejected as invalid by the transaction kernel.

pub fn new( anchor_block_number: BlockNumber, anchor_block_commitment: Digest, ) -> Result<Self, AccountIdError>

Creates a new AccountIdAnchor from the provided anchor_block_number and anchor_block_commitment.

Errors

Returns an error if any of the anchor constraints are not met. See the type documentation for details.

pub fn new_unchecked(anchor_epoch: u16, anchor_block_commitment: Digest) -> Self

Creates a new AccountIdAnchor from the provided anchor_epoch and anchor_block_commitment without validation.

Warning

The caller must ensure validity of the anchor_epoch, in particular the correctness of the relationship between the anchor_epoch and the provided anchor_block_commitment.

Panics

If debug_assertions are enabled (e.g. in debug mode), this function panics if the anchor_epoch is u16::MAX.

pub fn epoch(self) -> u16

Returns the epoch of this anchor.

pub fn block_commitment(self) -> Digest

Returns the block commitment of this anchor.

Trait Implementations

impl Clone for AccountIdAnchor

fn clone(&self) -> AccountIdAnchor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccountIdAnchor

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

Formats the value using the given formatter.

impl TryFrom<&BlockHeader> for AccountIdAnchor

fn try_from(block_header: &BlockHeader) -> Result<Self, Self::Error>

Extracts the BlockHeader::block_num and BlockHeader::commitment from the provided block_header and tries to convert it to an AccountIdAnchor.

Errors

Returns an error if any of the anchor constraints are not met. See the type documentation for details.

type Error = AccountIdError

The type returned in the event of a conversion error.

impl Copy for AccountIdAnchor