Struct SuiAddress

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

Implementations

impl SuiAddress

pub const ZERO: Self

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

Convert the address to a byte buffer.

pub fn random_for_testing_only() -> Self

Return a random SuiAddress.

pub fn generate<R: RngCore + CryptoRng>(rng: R) -> Self

pub fn optional_address_as_hex<S>( key: &Option<SuiAddress>, serializer: S, ) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize an Option<SuiAddress> in Hex.

pub fn optional_address_from_hex<'de, D>( deserializer: D, ) -> Result<Option<SuiAddress>, D::Error>

where D: Deserializer<'de>,

Deserialize into an Option<SuiAddress>.

pub fn to_inner(self) -> [u8; 32]

Return the underlying byte array of a SuiAddress.

pub fn from_bytes<T: AsRef<[u8]>>(bytes: T) -> Result<Self, SuiError>

Parse a SuiAddress from a byte array or buffer.

pub fn try_from_padded(inputs: &ZkLoginInputs) -> SuiResult<Self>

This derives a zkLogin address by parsing the iss and address_seed from [struct ZkLoginAuthenticator]. Define as iss_bytes_len || iss_bytes || padded_32_byte_address_seed. This is to be differentiated with try_from_unpadded defined below.

pub fn try_from_unpadded(inputs: &ZkLoginInputs) -> SuiResult<Self>

Define as iss_bytes_len || iss_bytes || unpadded_32_byte_address_seed.

Trait Implementations

impl Arbitrary for SuiAddress

type Parameters = <[u8; 32] as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<<[u8; 32] as Arbitrary>::Strategy, fn(_: [u8; 32]) -> SuiAddress>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl AsRef<[u8]> for SuiAddress

fn as_ref(&self) -> &[u8]

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

impl Clone for SuiAddress

fn clone(&self) -> SuiAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SuiAddress

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

Formats the value using the given formatter.

impl Default for SuiAddress

fn default() -> SuiAddress

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SuiAddress

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SuiAddress

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

Formats the value using the given formatter.

impl From<&MultiSigPublicKey> for SuiAddress

fn from(multisig_pk: &MultiSigPublicKey) -> Self

Derive a SuiAddress from [struct MultiSigPublicKey]. A MultiSig address is defined as the 32-byte Blake2b hash of serializing the flag, the threshold, concatenation of all n flag, public keys and its weight. flag_MultiSig || threshold || flag_1 || pk_1 || weight_1 || ... || flag_n || pk_n || weight_n.

When flag_i is ZkLogin, pk_i refers to [struct ZkLoginPublicIdentifier] derived from padded address seed in bytes and iss.

impl From<&PublicKey> for SuiAddress

fn from(pk: &PublicKey) -> Self

Converts to this type from the input type.

impl<T: SuiPublicKey> From<&T> for SuiAddress

fn from(pk: &T) -> Self

Converts to this type from the input type.

impl From<AccountAddress> for SuiAddress

fn from(address: AccountAddress) -> SuiAddress

Converts to this type from the input type.

impl From<Address> for SuiAddress

fn from(value: Address) -> Self

Converts to this type from the input type.

impl From<ObjectID> for SuiAddress

fn from(object_id: ObjectID) -> SuiAddress

Converts to this type from the input type.

impl From<ObjectId> for SuiAddress

fn from(value: ObjectId) -> Self

Converts to this type from the input type.

impl From<SuiAddress> for AccountAddress

fn from(address: SuiAddress) -> Self

Converts to this type from the input type.

impl From<SuiAddress> for Address

fn from(value: SuiAddress) -> Self

Converts to this type from the input type.

impl From<SuiAddress> for ObjectID

fn from(address: SuiAddress) -> ObjectID

Converts to this type from the input type.

impl From<SuiAddress> for ObjectId

fn from(value: SuiAddress) -> Self

Converts to this type from the input type.

impl FromStr for SuiAddress

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for SuiAddress

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 SuiAddress

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 MoveTypeTagTrait for SuiAddress

fn get_type_tag() -> TypeTag

impl Ord for SuiAddress

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for SuiAddress

fn try_from(bytes: &[u8]) -> Result<Self, SuiError>

Tries to convert the provided byte array into a SuiAddress.

type Error = SuiError

The type returned in the event of a conversion error.

impl TryFrom<&GenericSignature> for SuiAddress

fn try_from(sig: &GenericSignature) -> SuiResult<Self>

Derive a SuiAddress from a serialized signature in Sui GenericSignature.

type Error = SuiError

The type returned in the event of a conversion error.

impl TryFrom<&ZkLoginAuthenticator> for SuiAddress

Sui address for [struct ZkLoginAuthenticator] is defined as the black2b hash of [zklogin_flag || iss_bytes_length || iss_bytes || unpadded_address_seed_in_bytes].

type Error = SuiError

The type returned in the event of a conversion error.

fn try_from(authenticator: &ZkLoginAuthenticator) -> SuiResult<Self>

Performs the conversion.

impl TryFrom<Vec<u8>> for SuiAddress

fn try_from(bytes: Vec<u8>) -> Result<Self, SuiError>

Tries to convert the provided byte buffer into a SuiAddress.

type Error = SuiError

The type returned in the event of a conversion error.

impl Copy for SuiAddress

impl Eq for SuiAddress

impl StructuralPartialEq for SuiAddress