Enum SponsorshipPolicy 

#[non_exhaustive]
#[repr(u8)]
pub enum SponsorshipPolicy {
    AtMostCollectedFees = 1,
    Unlimited = 0,
}

How much of its own funds a network account is willing to spend sponsoring the network notes it creates.

Paying the transaction fee also creates a FEE_SPONSORSHIP note for every network output note of the transaction, funded from the account’s vault, so that the target account is prepaid for consuming it. Independently, the account collects the fees prepaid by the FEE_SPONSORSHIP notes among its own input notes. This policy decides whether the former is bounded by the latter.

It is fixed at deployment: the auth procedure reads it from the transaction’s initial storage state and there is no account procedure to change it.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AtMostCollectedFees = 1

Sponsorships must not exceed the fees collected in the same transaction, so the account never subsidises a downstream consumer out of its own funds.

A transaction that sponsors anything additionally requires the account’s configured fee asset to be the chain’s native fee asset, since collected fees are denominated in the former while sponsorship notes are funded in the latter and the two amounts would otherwise not be comparable. An account that never creates network notes is unaffected by that requirement.

Unlimited = 0

Sponsorships are funded from the account’s vault without bound, so the account pays for outgoing notes that the fees it collected do not cover.

Implementations

impl SponsorshipPolicy

pub fn slot_name() -> &'static StorageSlotName

Returns the StorageSlotName of the standardized sponsorship policy slot.

pub fn slot_schema() -> (StorageSlotName, StorageSlotSchema)

Returns the schema entry for the sponsorship policy slot.

pub fn into_storage_slot(self) -> StorageSlot

Returns the StorageSlot encoding this policy, suitable for inclusion in an AccountComponent’s storage layout.

pub fn to_word(self) -> Word

Returns the storage encoding of this policy.

The policy is encoded as [discriminant, 0, 0, 0].

Trait Implementations

impl Clone for SponsorshipPolicy

fn clone(&self) -> SponsorshipPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SponsorshipPolicy

impl Debug for SponsorshipPolicy

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

Formats the value using the given formatter.

impl Default for SponsorshipPolicy

fn default() -> SponsorshipPolicy

Returns the “default value” for a type.

impl Eq for SponsorshipPolicy

impl PartialEq for SponsorshipPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SponsorshipPolicy

impl TryFrom<&AccountStorage> for SponsorshipPolicy

fn try_from( storage: &AccountStorage, ) -> Result<SponsorshipPolicy, <SponsorshipPolicy as TryFrom<&AccountStorage>>::Error>

Reads the sponsorship policy from account storage.

Errors

Returns an error if:

• The standardized policy slot is not present in storage.
• The slot is present but is not a StorageSlotContent::Value.
• The slot’s value is not a valid policy encoding.

type Error = SponsorshipPolicyError

The type returned in the event of a conversion error.

impl TryFrom<Word> for SponsorshipPolicy

fn try_from( word: Word, ) -> Result<SponsorshipPolicy, <SponsorshipPolicy as TryFrom<Word>>::Error>

Decodes a policy from its storage encoding, see SponsorshipPolicy::to_word.

Errors

Returns an error if the word’s first element is not a known discriminant or any of its reserved elements is non-zero.

type Error = SponsorshipPolicyError

The type returned in the event of a conversion error.