Struct cardano_multiplatform_lib::address::Address

pub struct Address { /* private fields */ }

Implementations

impl Address

pub fn from_bytes(data: Vec<u8>) -> Result<Address, DeserializeError>

impl Address

pub fn to_json(&self) -> Result<String, JsError>

pub fn from_json(json: &str) -> Result<Address, JsError>

impl Address

pub fn header(&self) -> u8

header has 4 bits addr type discrim then 4 bits network discrim. Copied from shelley.cddl:

base address bits 7-6: 00 bit 5: stake cred is keyhash/scripthash bit 4: payment cred is keyhash/scripthash bits 3-0: network id

pointer address bits 7-5: 010 bit 4: payment cred is keyhash/scripthash bits 3-0: network id

enterprise address bits 7-5: 010 bit 4: payment cred is keyhash/scripthash bits 3-0: network id

reward addresses: bits 7-5: 111 bit 4: credential is keyhash/scripthash bits 3-0: network id

byron addresses: bits 7-4: 1000 bits 3-0: unrelated data (recall: no network ID in Byron addresses)

pub fn header_matches_kind(header: u8, kind: AddressHeaderKind) -> bool

pub fn to_bytes(&self) -> Vec<u8>

pub fn to_bech32(&self, prefix: Option<String>) -> Result<String, JsError>

pub fn from_bech32(bech_str: &str) -> Result<Address, JsError>

pub fn is_valid_bech32(bech_str: &str) -> bool

Note: bech32-encoded Byron addresses will also pass validation here

pub fn is_valid_byron(base58: &str) -> bool

pub fn is_valid(bech_str: &str) -> bool

pub fn network_id(&self) -> Result<u8, JsError>

pub fn as_byron(&self) -> Option<ByronAddress>

pub fn as_reward(&self) -> Option<RewardAddress>

pub fn as_pointer(&self) -> Option<PointerAddress>

pub fn as_enterprise(&self) -> Option<EnterpriseAddress>

pub fn as_base(&self) -> Option<BaseAddress>

pub fn payment_cred(&self) -> Option<StakeCredential>

Note: by convention, the key inside reward addresses are considered payment credentials

pub fn staking_cred(&self) -> Option<StakeCredential>

Note: by convention, the key inside reward addresses are NOT considered staking credentials Note: None is returned pointer addresses as the chain history is required to resolve its associated cred

Trait Implementations

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<'de> Deserialize<'de> for Address

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Deserialize for Address

fn deserialize<R: BufRead>(
    raw: &mut Deserializer<R>
) -> Result<Self, DeserializeError>

impl JsonSchema for Address

fn schema_name() -> String

The name of the generated JSON Schema.

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 Address

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Address> for Address

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl Serialize for Address

fn serialize<'se, W: Write>(
    &self,
    serializer: &'se mut Serializer<W>
) -> Result<&'se mut Serializer<W>>

impl Eq for Address

impl StructuralEq for Address

impl StructuralPartialEq for Address