Documentation
    Preparing search index...

    Interface ZkLoginSignerOptions

    interface ZkLoginSignerOptions {
        address?: string;
        client?: ClientWithCoreApi;
        ephemeralSigner: Signer;
        inputs: {
            addressSeed: string;
            headerBase64: string;
            issBase64Details: { indexMod4: number; value: string };
            proofPoints: {
                a: Iterable<string, any, any> & { length: number };
                b: Iterable<Iterable<string, any, any> & { length: number }, any, any> & {
                    length: number;
                };
                c: Iterable<string, any, any> & { length: number };
            };
        };
        legacyAddress: boolean;
        maxEpoch: number;
    }
    Index

    Properties

    address? client? ephemeralSigner inputs legacyAddress maxEpoch

    Properties

    address?: string

    The expected zkLogin address. When provided, the address derived from inputs + legacyAddress is validated against it and the constructor throws on mismatch — guarding against a wrong legacyAddress flag producing a signer for the wrong address.

    client?: ClientWithCoreApi

    Optional client, threaded into the derived public key so it can verify signatures.

    ephemeralSigner: Signer

    The ephemeral signer whose signature is wrapped by the zkLogin proof.

    inputs: {
        addressSeed: string;
        headerBase64: string;
        issBase64Details: { indexMod4: number; value: string };
        proofPoints: {
            a: Iterable<string, any, any> & { length: number };
            b: Iterable<Iterable<string, any, any> & { length: number }, any, any> & {
                length: number;
            };
            c: Iterable<string, any, any> & { length: number };
        };
    }

    The zkLogin proof inputs, including the addressSeed.

    legacyAddress: boolean

    Whether this account uses the deprecated legacy address derivation. The zkLogin address is derived from the proof inputs; this flag disambiguates legacy vs. current derivation, matching the rest of the zkLogin address API (e.g. jwtToAddress, toZkLoginPublicIdentifier).

    A wrong flag silently yields a signer for the wrong address; pass address to guard against it.

    maxEpoch: number

    The maxEpoch the proof was generated for.

    Settings

    Member Visibility

    On This Page

    Properties