Module stardust::alias

use iota::address;
use iota::hex;
use iota::object;
use iota::tx_context;
use std::ascii;
use std::bcs;
use std::option;
use std::string;
use std::vector;

Structs

struct Alias

The persisted Alias object from Stardust, without tokens and assets. Outputs owned the AliasID/Address in Stardust will be sent to this object and have to be received via this object once extracted from AliasOutput.

public struct Alias has key, store

Fields

id: iota::object::UID

The ID of the Alias = hash of the Output ID that created the Alias Output in Stardust. This is the AliasID from Stardust.

legacy_state_controller: address

The last State Controller address assigned before the migration.

state_index: u32

A counter increased by 1 every time the alias was state transitioned.

state_metadata: std::option::Option<vector<u8>>

State metadata that can be used to store additional information.

sender: std::option::Option<address>

The sender feature.

metadata: std::option::Option<vector<u8>>

The metadata feature.

immutable_issuer: std::option::Option<address>

The immutable issuer feature.

immutable_metadata: std::option::Option<vector<u8>>

The immutable metadata feature.

pub destroy

Destroy the Alias object, equivalent to burning an Alias Output in Stardust.

public fun destroy(self: stardust::alias::Alias)

Implementation

public fun destroy(self: Alias) {
    let Alias {
        id,
        legacy_state_controller: _,
        state_index: _,
        state_metadata: _,
        sender: _,
        metadata: _,
        immutable_issuer: _,
        immutable_metadata: _,
    } = self;
    object::delete(id);
}

pub immutable_issuer

Get the Alias's immutable_sender.

public fun immutable_issuer(self: &stardust::alias::Alias): &std::option::Option<address>

Implementation

public fun immutable_issuer(self: &Alias): &Option<address> {
    &self.immutable_issuer
}

pub immutable_metadata

Get the Alias's immutable_metadata.

public fun immutable_metadata(self: &stardust::alias::Alias): &std::option::Option<vector<u8>>

Implementation

public fun immutable_metadata(self: &Alias): &Option> {
    &self.immutable_metadata
}

pub legacy_state_controller

Get the Alias's legacy_state_controller.

public fun legacy_state_controller(self: &stardust::alias::Alias): &address

Implementation

public fun legacy_state_controller(self: &Alias): &address {
    &self.legacy_state_controller
}

pub metadata

Get the Alias's metadata.

public fun metadata(self: &stardust::alias::Alias): &std::option::Option<vector<u8>>

Implementation

public fun metadata(self: &Alias): &Option> {
    &self.metadata
}

pub sender

Get the Alias's sender.

public fun sender(self: &stardust::alias::Alias): &std::option::Option<address>

Implementation

public fun sender(self: &Alias): &Option<address> {
    &self.sender
}

pub state_index

Get the Alias's state_index.

public fun state_index(self: &stardust::alias::Alias): u32

Implementation

public fun state_index(self: &Alias): u32 {
    self.state_index
}

pub state_metadata

Get the Alias's state_metadata.

public fun state_metadata(self: &stardust::alias::Alias): &std::option::Option<vector<u8>>

Implementation

public fun state_metadata(self: &Alias): &Option> {
    &self.state_metadata
}

pub(pkg) id

Get the Alias's id.

public(package) fun id(self: &mut stardust::alias::Alias): &mut iota::object::UID

Implementation

public(package) fun id(self: &mut Alias): &mut UID {
    &mut self.id
}