Struct ZkLoginPublicIdentifier 

pub struct ZkLoginPublicIdentifier { /* private fields */ }

Public Key equivalent for Zklogin authenticators

A ZkLoginPublicIdentifier is the equivalent of a public key for other account authenticators, and contains the information required to derive the onchain account Address for a Zklogin authenticator.

Note

Due to a historical bug that was introduced in the Sui Typescript SDK when the zklogin authenticator was first introduced, there are now possibly two “valid” addresses for each zklogin authenticator depending on the bit-pattern of the address_seed value.

The original bug incorrectly derived a zklogin’s address by stripping any leading zero-bytes that could have been present in the 32-byte length address_seed value prior to hashing, leading to a different derived address. This incorrectly derived address was presented to users of various wallets, leading them to sending funds to these addresses that they couldn’t access. Instead of letting these users lose any assets that were sent to these addresses, the Sui network decided to change the protocol to allow for a zklogin authenticator who’s address_seed value had leading zero-bytes be authorized to sign for both the addresses derived from both the unpadded and padded address_seed value.

BCS

The BCS serialized form for this type is defined by the following ABNF:

zklogin-public-identifier-bcs = bytes ; where the contents are defined by
                                      ; <zklogin-public-identifier>

zklogin-public-identifier = zklogin-public-identifier-iss
                            address-seed

zklogin-public-identifier-unpadded = zklogin-public-identifier-iss
                                     address-seed-unpadded

; The iss, or issuer, is a utf8 string that is less than 255 bytes long
; and is serialized with the iss's length in bytes as a u8 followed by
; the bytes of the iss
zklogin-public-identifier-iss = u8 *255(OCTET)

; A Bn254FieldElement serialized as a 32-byte big-endian value
address-seed = 32(OCTET)

; A Bn254FieldElement serialized as a 32-byte big-endian value
; with any leading zero bytes stripped
address-seed-unpadded = %x00 / %x01-ff *31(OCTET)

Implementations

impl ZkLoginPublicIdentifier

pub fn scheme(&self) -> SignatureScheme

Return the flag for this signature scheme

impl ZkLoginPublicIdentifier

pub fn new(iss: String, address_seed: Bn254FieldElement) -> Option<Self>

pub fn iss(&self) -> &str

pub fn address_seed(&self) -> &Bn254FieldElement

impl ZkLoginPublicIdentifier

pub fn derive_address_padded(&self) -> Address

Available on crate feature hash only.

Derive an Address from this ZkLoginPublicIdentifier by hashing the byte length of the iss followed by the iss bytes themselves and the full 32 byte address_seed value, all prefixed with the zklogin SignatureScheme flag (0x05).

hash( 0x05 || iss_bytes_len || iss_bytes || 32_byte_address_seed )

pub fn derive_address_unpadded(&self) -> Address

Available on crate feature hash only.

Derive an Address from this ZkLoginPublicIdentifier by hashing the byte length of the iss followed by the iss bytes themselves and the address_seed bytes with any leading zero-bytes stripped, all prefixed with the zklogin SignatureScheme flag (0x05).

hash( 0x05 || iss_bytes_len || iss_bytes || unpadded_32_byte_address_seed )

pub fn derive_address(&self) -> impl ExactSizeIterator<Item = Address>

Available on crate feature hash only.

Provides an iterator over the addresses that correspond to this zklogin authenticator.

In the majority of instances this will only yield a single address, except for the instances where the address_seed value has a leading zero-byte, in such cases the returned iterator will yield two addresses.

Trait Implementations

impl Arbitrary for ZkLoginPublicIdentifier

type Parameters = ()

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

type Strategy = BoxedStrategy<ZkLoginPublicIdentifier>

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

fn arbitrary_with(args: <Self as Arbitrary>::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 Clone for ZkLoginPublicIdentifier

fn clone(&self) -> ZkLoginPublicIdentifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZkLoginPublicIdentifier

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ZkLoginPublicIdentifier

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ZkLoginPublicIdentifier

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

Available on crate feature serde only.

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 ZkLoginPublicIdentifier

impl StructuralPartialEq for ZkLoginPublicIdentifier