Struct soroban_sdk::Address

pub struct Address { /* private fields */ }

Address is a universal opaque identifier to use in contracts.

Address can be used as an input argument (for example, to identify the payment recipient), as a data key (for example, to store the balance), as the authentication & authorization source (for example, to authorize the token transfer) etc.

See require_auth documentation for more details on using Address for authorization.

Internally, Address may represent a Stellar account or a contract. Contract address may be used to identify the account contracts - special contracts that allow customizing authentication logic and adding custom authorization rules.

In tests Addresses should be generated via Address::random().

Implementations

impl Address

pub fn require_auth_for_args(&self, args: Vec<RawVal>)

Ensures that this Address has authorized invocation of the current contract with the provided arguments.

During the on-chain execution the Soroban host will perform the needed authentication (verify the signatures) and ensure the replay prevention. The contracts don’t need to perform this tasks.

The arguments don’t have to match the arguments of the contract invocation. However, it’s considered the best practice to have a well-defined, deterministic and ledger-state-independent mapping between the contract invocation arguments and require_auth arguments. This will allow the contract callers to easily build the required signature payloads and prevent potential authorization failures.

When called in the tests, the require_auth calls are just recorded and no signatures are required. In order to make sure that the contract has indeed called require_auth for this Address with expected arguments use env.verify_top_authorization.

Panics

If the invocation is not authorized.

pub fn require_auth(&self)

Ensures that this Address has authorized invocation of the current contract with all the invocation arguments

This works exactly in the same fashion as require_auth_for_args, but arguments are automatically inferred from the current contract invocation.

This is useful when there is only a single Address that needs to authorize the contract invocation and there are no dynamic arguments that don’t need authorization.

Panics

If the invocation is not authorized.

pub fn from_contract_id(env: &Env, contract_id: &BytesN<32>) -> Self

Creates an Address corresponding to the provided contract identifier.

Prefer using the Address directly as input or output argument. Only use this in special cases, for example to get an Address of a freshly deployed contract.

pub fn from_account_id(env: &Env, account_pk: &BytesN<32>) -> Self

Creates an Address corresponding to the provided Stellar account 32-byte identifier (public key).

Prefer using the Address directly as input or output argument. Only use this in special cases, like for cross-chain interoperability.

pub fn contract_id(&self) -> Option<BytesN<32>>

Returns 32-byte contract identifier corresponding to this Address.

Returns None when this Address does not belong to a contract.

Avoid using the returned contract identifier for authorization purposes and prefer using Address directly whenever possible. This is only useful in special cases, for example, to be able to invoke a contract given its Address.

pub fn account_id(&self) -> Option<BytesN<32>>

Returns 32-byte Stellar account identifier (public key) corresponding to this Address.

Returns None when this Address does not belong to an account.

Avoid using the returned account identifier for authorization purposes and prefer using Address directly whenever possible. This is only useful in special cases, like for cross-chain interoperability.

pub fn env(&self) -> &Env

pub fn as_raw(&self) -> &RawVal

pub fn to_raw(&self) -> RawVal

pub fn as_object(&self) -> &AddressObject

pub fn to_object(&self) -> AddressObject

Trait Implementations

impl Address for Address

Available on crate feature testutils only.

fn random(env: &Env) -> Self

Create a random Address.

impl Clone for Address

fn clone(&self) -> Address

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl Ord for Address

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Address> for Address

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

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

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 TryFrom<&Address> for ScVal

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: &Address) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Address> for ScVal

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: Address) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFromVal<Env, &Address> for RawVal

type Error = ConversionError

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

impl TryFromVal<Env, Address> for RawVal

type Error = ConversionError

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

impl TryFromVal<Env, AddressObject> for Address

type Error = Infallible

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

impl TryFromVal<Env, RawVal> for Address

type Error = ConversionError

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

impl TryFromVal<Env, ScVal> for Address

type Error = ConversionError

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

impl Eq for Address