Struct TransferPolicy 

pub struct TransferPolicy { /* private fields */ }

Descriptor for the transfer policy registered with a super::TokenPolicyManager for either the send or the receive kind.

A transfer policy binds together the procedure root that the manager’s invoke_send_policy / invoke_receive_policy wrapper dispatches to (via dyncall, after the account-wide pause check) with any companion AccountComponents that must be installed on the account for that procedure root to work.

The same descriptor applies to both send (on_before_asset_added_to_note) and receive (on_before_asset_added_to_account) callbacks — the policy procedure receives no direction parameter and reads the relevant account context via native_account::get_id.

Note that minting crosses the send callback: mint_and_send ends in output_note::add_asset, which the kernel routes through on_before_asset_added_to_note with the issuing faucet itself as the native account, indistinguishable at that point from an ordinary send. The bundled blocklist and allowlist policies therefore exempt the issuer by comparing the asset’s faucet ID against the native account ID.

The companion components carried by the descriptor are inlined into the account by the super::TokenPolicyManager when it is converted into account components.

Implementations

impl TransferPolicy

pub fn allow_all() -> TransferPolicy

Returns a transfer policy that accepts every transfer unconditionally.

Resolves to TransferAllowAll::root and ships the companion TransferAllowAll component.

pub fn empty_basic_blocklist() -> TransferPolicy

Returns a transfer policy that rejects transfers whose native account is in the blocked_accounts map, starting with an empty blocklist. To seed initial entries use Self::with_basic_blocklist.

pub fn with_basic_blocklist<I>(blocked_accounts: I) -> TransferPolicy

where I: IntoIterator<Item = AccountId>,

Returns a basic-blocklist transfer policy seeded with the given initial blocked accounts.

pub fn empty_basic_allowlist() -> TransferPolicy

Returns a transfer policy that rejects transfers whose native account is not in the allowed_accounts map, starting with an empty allowlist (every transfer rejected). To seed initial entries use Self::with_basic_allowlist.

pub fn with_basic_allowlist(allow_list: AllowlistStorage) -> TransferPolicy

Returns a transfer policy that rejects transfers whose native account is not in the allowed_accounts map. The provided AllowlistStorage seeds the initial allowlist entries at component-construction time.

pub fn custom<I>( root: AccountProcedureRoot, components: I, ) -> Result<TransferPolicy, TransferPolicyError>

where I: IntoIterator, <I as IntoIterator>::Item: Into<AccountComponent>,

Returns a transfer policy resolving to root and shipping the provided companion components (anything that can be converted into an AccountComponent).

Errors

Returns TransferPolicyError::RootNotInComponents if root is not the procedure root of any procedure exported by the provided components.

pub fn root(&self) -> AccountProcedureRoot

Returns the procedure root of the policy this descriptor resolves to.

Trait Implementations

impl Clone for TransferPolicy

fn clone(&self) -> TransferPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransferPolicy

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

Formats the value using the given formatter.

impl Default for TransferPolicy

fn default() -> TransferPolicy

Returns the “default value” for a type.

impl IntoIterator for TransferPolicy

fn into_iter(self) -> <TransferPolicy as IntoIterator>::IntoIter

Yields the AccountComponents carried by this transfer policy descriptor in installation order.

type Item = AccountComponent

The type of the elements being iterated over.

type IntoIter = IntoIter<AccountComponent>

Which kind of iterator are we turning this into?