Struct AliasOutput 

pub struct AliasOutput { /* private fields */ }

Available on crate feature block only.

Describes an alias account in the ledger that can be controlled by the state and governance controllers.

Implementations

impl AliasOutput

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

Available on crate feature dto only.

pub fn try_from_dto_unverified(value: &AliasOutputDto) -> Result<Self, DtoError>

Available on crate feature dto only.

pub fn try_from_dtos( amount: OutputBuilderAmountDto, native_tokens: Option<Vec<NativeTokenDto>>, alias_id: &AliasIdDto, state_index: Option<u32>, state_metadata: Option<Vec<u8>>, foundry_counter: Option<u32>, unlock_conditions: Vec<UnlockConditionDto>, features: Option<Vec<FeatureDto>>, immutable_features: Option<Vec<FeatureDto>>, token_supply: u64, ) -> Result<Self, DtoError>

Available on crate feature dto only.

impl AliasOutput

pub const KIND: u8 = 4

The Output kind of an AliasOutput.

pub const STATE_METADATA_LENGTH_MAX: u16 = 8192

Maximum possible length in bytes of the state metadata.

pub const ALLOWED_UNLOCK_CONDITIONS: UnlockConditionFlags

The set of allowed UnlockConditions for an AliasOutput.

pub const ALLOWED_FEATURES: FeatureFlags

The set of allowed Features for an AliasOutput.

pub const ALLOWED_IMMUTABLE_FEATURES: FeatureFlags

The set of allowed immutable Features for an AliasOutput.

pub fn new_with_amount( amount: u64, alias_id: AliasId, token_supply: u64, ) -> Result<Self, Error>

Creates a new AliasOutput with a provided amount.

pub fn new_with_minimum_storage_deposit( alias_id: AliasId, rent_structure: RentStructure, token_supply: u64, ) -> Result<Self, Error>

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

pub fn build_with_amount( amount: u64, alias_id: AliasId, ) -> Result<AliasOutputBuilder, Error>

Creates a new AliasOutputBuilder with a provided amount.

pub fn build_with_minimum_storage_deposit( rent_structure: RentStructure, alias_id: AliasId, ) -> Result<AliasOutputBuilder, Error>

Creates a new AliasOutputBuilder 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 alias_id(&self) -> &AliasId

pub fn alias_id_non_null(&self, output_id: &OutputId) -> AliasId

Returns the alias ID if not null, or creates it from the output ID.

pub fn state_index(&self) -> u32

pub fn state_metadata(&self) -> &[u8]

pub fn foundry_counter(&self) -> u32

pub fn unlock_conditions(&self) -> &UnlockConditions

pub fn features(&self) -> &Features

pub fn immutable_features(&self) -> &Features

pub fn state_controller_address(&self) -> &Address

pub fn governor_address(&self) -> &Address

pub fn chain_id(&self) -> ChainId

pub fn alias_address(&self, output_id: &OutputId) -> AliasAddress

Returns the alias address for this output.

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

Trait Implementations

impl Clone for AliasOutput

fn clone(&self) -> AliasOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AliasOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AliasOutput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&AliasOutput> for AliasOutputBuilder

fn from(output: &AliasOutput) -> Self

Converts to this type from the input type.

impl From<&AliasOutput> for AliasOutputDto

Available on crate feature dto only.

fn from(value: &AliasOutput) -> Self

Converts to this type from the input type.

impl From<AliasOutput> for Output

fn from(original: AliasOutput) -> Output

Converts to this type from the input type.

impl Hash for AliasOutput

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AliasOutput

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl Packable for AliasOutput

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 for AliasOutput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for AliasOutput

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for AliasOutput

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 AliasOutput

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 AliasOutput

impl StructuralPartialEq for AliasOutput