Struct andromeda_std::amp::addresses::AndrAddr

pub struct AndrAddr(/* private fields */);

An address that can be used within the Andromeda ecosystem. Inspired by the cosmwasm-std Addr type. https://github.com/CosmWasm/cosmwasm/blob/2a1c698520a1aacedfe3f4803b0d7d653892217a/packages/std/src/addresses.rs#L33

This address can be one of two things:

1. A valid human readable address e.g. cosmos1...
2. A valid Andromeda VFS path e.g. /home/user/app/component

VFS paths can be local in the case of an app and can be done by referencing ./component they can also contain protocols for cross chain communication. A VFS path is usually structured as so:

<protocol>://<chain (required if ibc used)>/<path> or ibc://cosmoshub-4/user/app/component

Implementations

impl AndrAddr

pub fn as_str(&self) -> &str

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

pub fn into_string(self) -> String

pub fn from_string(addr: impl Into<String>) -> AndrAddr

pub fn validate(&self, api: &dyn Api) -> Result<(), ContractError>

Validates an AndrAddr, to be valid the given address must either be a human readable address or a valid VFS path.

The existence of the provided path is not validated.

If you wish to validate the existence of the path you must use get_raw_address.

pub fn get_raw_address(&self, deps: &Deps<'_>) -> Result<Addr, ContractError>

Retrieves the raw address represented by the AndrAddr.

If the address is a valid human readable address then that is returned, otherwise it is assumed to be a Andromeda VFS path and is resolved accordingly.

If the address is assumed to be a VFS path and no VFS contract address is provided then an appropriate error is returned.

pub fn get_raw_address_from_vfs( &self, deps: &Deps<'_>, vfs_contract: impl Into<String> ) -> Result<Addr, ContractError>

Retrieves the raw address represented by the AndrAddr from the given VFS contract.

If the address is a valid human readable address then that is returned, otherwise it is assumed to be a Andromeda VFS path and is resolved accordingly.

If the address is assumed to be a VFS path and no VFS contract address is provided then an appropriate error is returned.

pub fn is_local_path(&self) -> bool

Whether the provided address is local to the app

pub fn is_vfs_path(&self) -> bool

Whether the provided address is a VFS path

pub fn is_addr(&self, api: &dyn Api) -> bool

Whether the provided address is a valid human readable address

pub fn get_chain(&self) -> Option<&str>

Gets the chain for a given AndrAddr if it exists

E.g. ibc://cosmoshub-4/user/app/component would return cosmoshub-4

A human readable address will always return None

pub fn get_protocol(&self) -> Option<&str>

Gets the protocol for a given AndrAddr if it exists

E.g. ibc://cosmoshub-4/user/app/component would return ibc

A human readable address will always return None

pub fn get_raw_path(&self) -> &str

Gets the raw path for a given AndrAddr by stripping away any protocols or chain declarations.

E.g. ibc://cosmoshub-4/user/app/component would return /user/app/component

Returns the human readable address if the address is not a VFS path.

pub fn get_root_dir(&self) -> &str

Gets the root directory for a given AndrAddr

E.g. /home/user/app/component would return home

Returns the human readable address if the address is not a VFS path or the local path if the address is a local reference

Trait Implementations

impl AsRef<str> for AndrAddr

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for AndrAddr

fn clone(&self) -> AndrAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AndrAddr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AndrAddr

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AndrAddr

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

Formats the value using the given formatter.

impl From<&AndrAddr> for String

fn from(addr: &AndrAddr) -> Self

Converts to this type from the input type.

impl From<AndrAddr> for String

fn from(addr: AndrAddr) -> Self

Converts to this type from the input type.

impl Hash for AndrAddr

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 JsonSchema for AndrAddr

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for AndrAddr

fn cmp(&self, other: &AndrAddr) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<&str> for AndrAddr

fn eq(&self, rhs: &&str) -> 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 PartialEq<AndrAddr> for &str

fn eq(&self, rhs: &AndrAddr) -> 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 PartialEq<AndrAddr> for String

fn eq(&self, rhs: &AndrAddr) -> 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 PartialEq<String> for AndrAddr

fn eq(&self, rhs: &String) -> 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 PartialEq for AndrAddr

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AndrAddr

impl StructuralPartialEq for AndrAddr