Struct MuxedAddress 

pub struct MuxedAddress { /* private fields */ }

MuxedAddress is a union type that represents either the regular Address, or a ‘multiplexed’ address that consists of a regular address and a u64 id and can be used for representing the ‘virtual’ accounts that allows for managing multiple balances off-chain with only a single on-chain balance entry. The address part can be used as a regular Address, and the id part should be used only in the events for the off-chain processing.

This type is only necessary in a few special cases, such as token transfers that support non-custodial accounts (e.g. for the exchange support). Prefer using the regular Address type unless multiplexing support is necessary.

This type is compatible with Address at the contract interface level, i.e. if a contract accepts MuxedAddress as an input, then its callers may still pass Address into the call successfully. This means that if a contract has upgraded its interface to switch from Address argument to MuxedAddress argument, it won’t break any of its existing clients.

Currently only the regular Stellar accounts can be multiplexed, i.e. multiplexed contract addresses don’t exist.

Note, that multiplexed addresses can not be used directly as a storage key. This is a precaution to prevent accidental unexpected fragmentation of the key space (like creating an arbitrary number of balances for the same actual Address).

Implementations

impl MuxedAddress

pub fn address(&self) -> Address

Returns the Address part of this multiplexed address.

The address part is necessary to perform most of the operations, such as authorization or storage.

pub fn id(&self) -> Option<u64>

Returns the multiplexing identifier part of this multiplexed address, if any.

Returns None for the regular (non-multiplexed) addresses.

This identifier should normally be used in the events in order to allow for tracking the virtual balances associated with this address off-chain.

pub fn env(&self) -> &Env

pub fn as_val(&self) -> &Val

pub fn to_val(&self) -> Val

Trait Implementations

impl Clone for MuxedAddress

fn clone(&self) -> MuxedAddress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MuxedAddress

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

Formats the value using the given formatter.

impl From<&Address> for MuxedAddress

fn from(address: &Address) -> Self

Converts to this type from the input type.

impl From<&MuxedAddress> for MuxedAddress

fn from(address: &MuxedAddress) -> Self

Converts to this type from the input type.

impl From<Address> for MuxedAddress

fn from(address: Address) -> Self

Converts to this type from the input type.

impl MuxedAddress for MuxedAddress

Available on crate feature testutils only.

fn generate(env: &Env) -> MuxedAddress

Create a new MuxedAddress with arbitrary Address and id parts.

fn new<T: Into<MuxedAddress>>(address: T, id: u64) -> MuxedAddress

Returns a new MuxedAddress that has the same Address part as the provided address and the provided multiplexing id.

impl Ord for MuxedAddress

fn cmp(&self, other: &Self) -> 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 PartialEq for MuxedAddress

fn eq(&self, other: &Self) -> 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 MuxedAddress

fn partial_cmp(&self, other: &Self) -> 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 TryFromVal<Env, &MuxedAddress> for Val

type Error = ConversionError

fn try_from_val(_env: &Env, v: &&MuxedAddress) -> Result<Self, Self::Error>

impl TryFromVal<Env, AddressObject> for MuxedAddress

type Error = Infallible

fn try_from_val(env: &Env, val: &AddressObject) -> Result<Self, Self::Error>

impl TryFromVal<Env, MuxedAddress> for Val

type Error = ConversionError

fn try_from_val(_env: &Env, v: &MuxedAddress) -> Result<Self, Self::Error>

impl TryFromVal<Env, MuxedAddressObject> for MuxedAddress

type Error = Infallible

fn try_from_val( env: &Env, val: &MuxedAddressObject, ) -> Result<Self, Self::Error>

impl TryFromVal<Env, ScAddress> for MuxedAddress

type Error = ConversionError

fn try_from_val(env: &Env, val: &ScAddress) -> Result<Self, Self::Error>

impl TryFromVal<Env, ScVal> for MuxedAddress

type Error = ConversionError

fn try_from_val(env: &Env, val: &ScVal) -> Result<Self, Self::Error>

impl TryFromVal<Env, Val> for MuxedAddress

type Error = ConversionError

fn try_from_val(env: &Env, val: &Val) -> Result<Self, Self::Error>

impl Eq for MuxedAddress