Struct ProofOutput

pub struct ProofOutput {
    pub merkle_root: U256Wrapper,
    pub nullifier_hash: U256Wrapper,
    pub raw_proof: Proof,
    pub proof: PackedProof,
    pub credential_type: CredentialType,
}

Represents the complete output of a World ID Proof (i.e. a credential persentation). This output can be serialized to JSON and can be verified easily with the Developer Portal or Sign up Sequencer.

For on-chain verification, the proof (which is packed) should generally be deserialized into uint256[8].

More information on: On-Chain Verification

Fields

merkle_root: U256Wrapper

The root hash of the Merkle tree used to prove membership. This root hash should match published hashes in the World ID protocol contract in Ethereum mainnet. See address book.

nullifier_hash: U256Wrapper

Represents the unique identifier for a specific context (app & action) and World ID. A World ID holder will always generate the same nullifier_hash for the same context.

raw_proof: Proof

The raw zero-knowledge proof.

proof: PackedProof

The ABI-encoded zero-knowledge proof represented as a string. This is the format generally used with other libraries and can be directly used with the Developer Portal for verification.

credential_type: CredentialType

The credential type used to generate the proof.

Implementations

impl ProofOutput

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

Converts the entire proof output to a JSON string with standard attribute names.

Errors

Will error if serialization fails.

pub const fn get_nullifier_hash(&self) -> U256Wrapper

Exposes the nullifier hash to foreign code. Struct fields are not directly exposed to foreign code.

pub const fn get_merkle_root(&self) -> U256Wrapper

Exposes the merkle root to foreign code. Struct fields are not directly exposed to foreign code.

pub fn get_proof_as_string(&self) -> String

Exposes the proof as a string to foreign code. Struct fields are not directly exposed to foreign code.

pub const fn get_credential_type(&self) -> CredentialType

Exposes the credential type to foreign code. Struct fields are not directly exposed to foreign code.

Trait Implementations

impl Clone for ProofOutput

fn clone(&self) -> ProofOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProofOutput

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

Formats the value using the given formatter.

impl PartialEq for ProofOutput

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProofOutput

impl StructuralPartialEq for ProofOutput