Struct bee_block::output::foundry::FoundryOutput

pub struct FoundryOutput { /* private fields */ }

Describes a foundry output that is controlled by an alias.

Implementations

impl FoundryOutput

pub fn try_from_dto(
    value: &FoundryOutputDto,
    token_supply: u64
) -> Result<FoundryOutput, DtoError>

pub fn try_from_dtos(
    amount: OutputBuilderAmountDto,
    native_tokens: Option<Vec<NativeTokenDto>>,
    serial_number: u32,
    token_scheme: &TokenSchemeDto,
    unlock_conditions: Vec<UnlockConditionDto>,
    features: Option<Vec<FeatureDto>>,
    immutable_features: Option<Vec<FeatureDto>>,
    token_supply: u64
) -> Result<FoundryOutput, DtoError>

impl FoundryOutput

pub const KIND: u8 = 5u8

The Output kind of a FoundryOutput.

pub const ALLOWED_UNLOCK_CONDITIONS: UnlockConditionFlags = UnlockConditionFlags::IMMUTABLE_ALIAS_ADDRESS

The set of allowed UnlockConditions for a FoundryOutput.

pub const ALLOWED_FEATURES: FeatureFlags = FeatureFlags::METADATA

The set of allowed Features for a FoundryOutput.

pub const ALLOWED_IMMUTABLE_FEATURES: FeatureFlags = FeatureFlags::METADATA

The set of allowed immutable Features for a FoundryOutput.

pub fn new_with_amount(
    amount: u64,
    serial_number: u32,
    token_scheme: TokenScheme,
    token_supply: u64
) -> Result<Self, Error>

Creates a new FoundryOutput with a provided amount.

pub fn new_with_minimum_storage_deposit(
    serial_number: u32,
    token_scheme: TokenScheme,
    rent_structure: RentStructure,
    token_supply: u64
) -> Result<Self, Error>

Creates a new FoundryOutput with a provided rent structure. The amount will be set to the minimum storage deposit.

pub fn build_with_amount(
    amount: u64,
    serial_number: u32,
    token_scheme: TokenScheme
) -> Result<FoundryOutputBuilder, Error>

Creates a new FoundryOutputBuilder with a provided amount.

pub fn build_with_minimum_storage_deposit(
    rent_structure: RentStructure,
    serial_number: u32,
    token_scheme: TokenScheme
) -> Result<FoundryOutputBuilder, Error>

Creates a new FoundryOutputBuilder with a provided rent structure. The amount will be set to the minimum storage deposit.

pub fn amount(&self) -> u64

pub fn native_tokens(&self) -> &NativeTokens

pub fn serial_number(&self) -> u32

pub fn token_scheme(&self) -> &TokenScheme

pub fn unlock_conditions(&self) -> &UnlockConditions

pub fn features(&self) -> &Features

pub fn immutable_features(&self) -> &Features

pub fn alias_address(&self) -> &AliasAddress

pub fn id(&self) -> FoundryId

Returns the FoundryId of the FoundryOutput.

pub fn token_id(&self) -> TokenId

Returns the TokenId of the FoundryOutput.

pub fn chain_id(&self) -> ChainId

pub fn unlock(
    &self,
    _output_id: &OutputId,
    unlock: &Unlock,
    inputs: &[(OutputId, &Output)],
    context: &mut ValidationContext<'_>
) -> Result<(), ConflictReason>

Trait Implementations

impl Clone for FoundryOutput

fn clone(&self) -> FoundryOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FoundryOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FoundryOutput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&FoundryOutput> for FoundryOutputBuilder

fn from(output: &FoundryOutput) -> Self

Converts to this type from the input type.

impl From<&FoundryOutput> for FoundryOutputDto

fn from(value: &FoundryOutput) -> Self

Converts to this type from the input type.

impl From<FoundryOutput> for Output

fn from(original: FoundryOutput) -> Output

Converts to this type from the input type.

impl Ord for FoundryOutput

fn cmp(&self, other: &FoundryOutput) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl Packable for FoundryOutput

type UnpackError = Error

The error type that can be returned if some semantic error occurs while unpacking.

type UnpackVisitor = ProtocolParameters

FIXME: docs

fn pack<P: Packer>(&self, packer: &mut P) -> Result<(), P::Error>

Packs this value into the given Packer.

fn unpack<U: Unpacker, const VERIFY: bool>(
    unpacker: &mut U,
    visitor: &Self::UnpackVisitor
) -> Result<Self, UnpackError<Self::UnpackError, U::Error>>

Unpacks this value from the given Unpacker. The VERIFY generic parameter can be used to skip additional syntactic checks.

impl PartialEq<FoundryOutput> for FoundryOutput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<FoundryOutput> for FoundryOutput

fn partial_cmp(&self, other: &FoundryOutput) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for FoundryOutput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl StateTransitionVerifier for FoundryOutput

fn creation(
    next_state: &Self,
    context: &ValidationContext<'_>
) -> Result<(), StateTransitionError>

fn transition(
    current_state: &Self,
    next_state: &Self,
    context: &ValidationContext<'_>
) -> Result<(), StateTransitionError>

fn destruction(
    current_state: &Self,
    context: &ValidationContext<'_>
) -> Result<(), StateTransitionError>

impl Eq for FoundryOutput

impl StructuralEq for FoundryOutput

impl StructuralPartialEq for FoundryOutput