Struct BasicOutput

pub struct BasicOutput {
    pub id: UID,
    pub balance: Balance,
    pub native_tokens: Bag,
    pub storage_deposit_return: Option<StorageDepositReturnUnlockCondition>,
    pub timelock: Option<TimelockUnlockCondition>,
    pub expiration: Option<ExpirationUnlockCondition>,
    pub metadata: Option<Vec<u8>>,
    pub tag: Option<Vec<u8>>,
    pub sender: Option<IotaAddress>,
}

Rust version of the stardust basic output.

Fields

id: UID

Hash of the OutputId that was migrated.

balance: Balance

The amount of coins held by the output.

native_tokens: Bag

The Bag holds native tokens, key-ed by the stringified type of the asset. Example: key: “0xabcded::soon::SOON”, value: Balance<0xabcded::soon::SOON>.

storage_deposit_return: Option<StorageDepositReturnUnlockCondition>

The storage deposit return unlock condition.

timelock: Option<TimelockUnlockCondition>

The timelock unlock condition.

expiration: Option<ExpirationUnlockCondition>

The expiration unlock condition.

metadata: Option<Vec<u8>>

The metadata feature.

tag: Option<Vec<u8>>

The tag feature.

sender: Option<IotaAddress>

The sender feature.

Implementations

impl BasicOutput

pub fn new(header_object_id: ObjectID, output: &BasicOutput) -> Result<Self>

Construct the basic output with an empty Bag using the Output Header ID and Stardust [BasicOutput][iota_stardust_sdk::types::block::output::BasicOutput].

pub fn tag(type_param: TypeTag) -> StructTag

Returns the struct tag of the BasicOutput struct

pub fn is_simple_coin(&self, target_milestone_timestamp_sec: u32) -> bool

Infer whether this object can resolve into a simple coin.

Returns true in particular when the given milestone timestamp is equal or past the unix timestamp in a present timelock and no other unlock condition or metadata, tag, sender feature is present.

pub fn to_genesis_object( &self, owner: IotaAddress, protocol_config: &ProtocolConfig, tx_context: &TxContext, version: SequenceNumber, coin_type: &CoinType, ) -> Result<Object>

pub fn into_genesis_coin_object( self, owner: IotaAddress, protocol_config: &ProtocolConfig, tx_context: &TxContext, version: SequenceNumber, coin_type: &CoinType, ) -> Result<Object>

pub fn from_bcs_bytes(content: &[u8]) -> Result<Self, IotaError>

Create a BasicOutput from BCS bytes.

pub fn is_basic_output(s: &StructTag) -> bool

Whether the given StructTag represents a BasicOutput.

Trait Implementations

impl Clone for BasicOutput

fn clone(&self) -> BasicOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BasicOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BasicOutput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BasicOutput

fn eq(&self, other: &BasicOutput) -> 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 Serialize for BasicOutput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Object> for BasicOutput

type Error = IotaError

The type returned in the event of a conversion error.

fn try_from(object: &Object) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for BasicOutput

impl StructuralPartialEq for BasicOutput