Skip to main content

Module sui::zklogin_verified_id

use std::ascii;
use std::bcs;
use std::option;
use std::string;
use std::vector;
use sui::address;
use sui::hex;
use sui::object;
use sui::tx_context;

Struct VerifiedID​

Possession of a VerifiedID proves that the user's address was created using zklogin and the given parameters.

public struct VerifiedID has key
Click to open
Fields
id: sui::object::UID
The ID of this VerifiedID
owner: address
The address this VerifiedID is associated with
key_claim_name: std::string::String
The name of the key claim
key_claim_value: std::string::String
The value of the key claim
issuer: std::string::String
The issuer
audience: std::string::String
The audience (wallet)

Constants​

const EFunctionDisabled: u64 = 0;

Function owner​

Returns the address associated with the given VerifiedID

public fun owner(verified_id: &sui::zklogin_verified_id::VerifiedID): address

Function key_claim_name​

Returns the name of the key claim associated with the given VerifiedID

public fun key_claim_name(verified_id: &sui::zklogin_verified_id::VerifiedID): &std::string::String

Function key_claim_value​

Returns the value of the key claim associated with the given VerifiedID

public fun key_claim_value(verified_id: &sui::zklogin_verified_id::VerifiedID): &std::string::String

Function issuer​

Returns the issuer associated with the given VerifiedID

public fun issuer(verified_id: &sui::zklogin_verified_id::VerifiedID): &std::string::String

Function audience​

Returns the audience (wallet) associated with the given VerifiedID

public fun audience(verified_id: &sui::zklogin_verified_id::VerifiedID): &std::string::String

Function delete​

Delete a VerifiedID

public fun delete(verified_id: sui::zklogin_verified_id::VerifiedID)

Function verify_zklogin_id​

This function has been disabled.

public fun verify_zklogin_id(_key_claim_name: std::string::String, _key_claim_value: std::string::String, _issuer: std::string::String, _audience: std::string::String, _pin_hash: u256, _ctx: &mut sui::tx_context::TxContext)

Function check_zklogin_id​

This function has been disabled.

public fun check_zklogin_id(_address: address, _key_claim_name: &std::string::String, _key_claim_value: &std::string::String, _issuer: &std::string::String, _audience: &std::string::String, _pin_hash: u256): bool

Function check_zklogin_id_internal​

Returns true if address was created using zklogin and the given parameters.

Aborts with EInvalidInput if any of kc_name, kc_value, iss and aud is not a properly encoded UTF-8 string or if the inputs are longer than the allowed upper bounds: kc_name must be at most 32 characters, kc_value must be at most 115 characters and aud must be at most 145 characters.

fun check_zklogin_id_internal(address: address, key_claim_name: &vector<u8>, key_claim_value: &vector<u8>, issuer: &vector<u8>, audience: &vector<u8>, pin_hash: u256): bool