@zkproofport-app/sdk 0.2.6 → 0.2.7

package/README.md

@@ -3,7 +3,7 @@
 [![npm version](https://img.shields.io/npm/v/@zkproofport-app/sdk)](https://www.npmjs.com/package/@zkproofport-app/sdk)
 [![license](https://img.shields.io/npm/l/@zkproofport-app/sdk)](./LICENSE)
 
-TypeScript SDK for requesting zero-knowledge proofs from the [ZKProofport](https://zkproofport.com) mobile app and verifying them on-chain.
+TypeScript SDK for requesting zero-knowledge proofs from the [ZKProofport](https://zkproofport.com) mobile app and verifying them on-chain. Supports Coinbase KYC/Country attestations and OIDC domain attestations (Google, Microsoft 365).
 
 ## How It Works
 
@@ -373,9 +373,9 @@ if (result.status === 'completed') {
 const verification = await sdk.verifyResponseOnChain(response);
 ```
 
-### Step 7: Extract Scope and Nullifier
+### Step 7: Extract Scope, Nullifier, and Domain
 
-After verification, extract the scope and nullifier from the public inputs:
+After verification, extract data from the public inputs:
 
 ```typescript
 if (result.status === 'completed') {
@@ -388,6 +388,12 @@ if (result.status === 'completed') {
 
   console.log('Scope:', scope);       // '0x7a6b70726f...'
   console.log('Nullifier:', nullifier); // '0xabc123...'
+
+  // Extract domain — only for OIDC Domain Attestation
+  if (result.circuit === 'oidc_domain_attestation') {
+    const domain = sdk.extractDomain(result.publicInputs, result.circuit);
+    console.log('Domain:', domain); // 'example.com'
+  }
 }
 ```
 
@@ -398,16 +404,31 @@ The **nullifier** serves as a privacy-preserving user identifier:
 
 > **OIDC Domain:** The nullifier is a hash of the user's email and scope. The same email + scope always produces the same nullifier, enabling Sybil resistance without revealing the email address.
 
+The **domain** (OIDC Domain Attestation only) is the email domain the user proved:
+- Extracted from the circuit's public inputs
+- Matches the domain parameter provided during proof request
+- Available only for `oidc_domain_attestation` circuits
+
 **Standalone utility functions** are also available for use outside the SDK class:
 
 ```typescript
 import {
   extractScopeFromPublicInputs,
   extractNullifierFromPublicInputs,
+  extractDomainFromPublicInputs,
 } from '@zkproofport-app/sdk';
 
+// Works with all circuits: coinbase_attestation, coinbase_country_attestation, oidc_domain_attestation
 const scope = extractScopeFromPublicInputs(publicInputs, 'coinbase_attestation');
 const nullifier = extractNullifierFromPublicInputs(publicInputs, 'coinbase_attestation');
+
+// OIDC domain attestation uses a different public input layout (148 fields)
+const oidcScope = extractScopeFromPublicInputs(publicInputs, 'oidc_domain_attestation');
+const oidcNullifier = extractNullifierFromPublicInputs(publicInputs, 'oidc_domain_attestation');
+
+// Extract domain from OIDC Domain Attestation
+const domain = extractDomainFromPublicInputs(publicInputs, 'oidc_domain_attestation');
+// domain: 'example.com' or null if circuit doesn't match or inputs insufficient
 ```
 
 ## Complete Example
@@ -524,6 +545,72 @@ interface OidcDomainInputs {
 }
 ```
 
+## Public Input Layout Constants
+
+The SDK exports constants defining the field positions in each circuit's public inputs array. These are useful when working with standalone extraction functions or building custom verification logic.
+
+```typescript
+import {
+  COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT,
+  COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT,
+  OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT,
+} from '@zkproofport-app/sdk';
+```
+
+**Coinbase KYC Attestation** (128 fields total):
+```typescript
+COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT = {
+  SIGNAL_HASH_START: 0,      // RSA modulus limbs (Coinbase signer)
+  SIGNAL_HASH_END: 31,
+  MERKLE_ROOT_START: 32,     // Merkle root of signers
+  MERKLE_ROOT_END: 63,
+  SCOPE_START: 64,           // keccak256 hash of scope string
+  SCOPE_END: 95,
+  NULLIFIER_START: 96,       // Unique identifier per user+scope
+  NULLIFIER_END: 127,
+}
+```
+
+**Coinbase Country Attestation** (150 fields total):
+```typescript
+COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT = {
+  SIGNAL_HASH_START: 0,
+  SIGNAL_HASH_END: 31,
+  MERKLE_ROOT_START: 32,
+  MERKLE_ROOT_END: 63,
+  COUNTRY_LIST_START: 64,    // Packed country codes
+  COUNTRY_LIST_END: 83,
+  COUNTRY_LIST_LENGTH: 84,   // Number of countries
+  IS_INCLUDED: 85,           // Boolean: user in list or not
+  SCOPE_START: 86,
+  SCOPE_END: 117,
+  NULLIFIER_START: 118,
+  NULLIFIER_END: 149,
+}
+```
+
+**OIDC Domain Attestation** (148 fields total):
+```typescript
+OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT = {
+  PUBKEY_MODULUS_START: 0,   // RSA modulus limbs (JWT issuer key)
+  PUBKEY_MODULUS_END: 17,
+  DOMAIN_STORAGE_START: 18,  // Domain bytes (up to 64 ASCII characters)
+  DOMAIN_STORAGE_END: 81,
+  DOMAIN_LEN: 82,            // Domain string length
+  SCOPE_START: 83,           // keccak256 hash of scope string
+  SCOPE_END: 114,
+  NULLIFIER_START: 115,      // Unique identifier per user+scope
+  NULLIFIER_END: 146,
+  PROVIDER: 147,             // OIDC provider code (0=none, 1=Google, 2=Microsoft)
+
+  // Deprecated aliases (use new names above)
+  DOMAIN_START: 18,          // @deprecated Use DOMAIN_STORAGE_START
+  DOMAIN_END: 82,            // @deprecated Use DOMAIN_LEN
+}
+```
+
+> **Note on field positions:** Each position in the public inputs array corresponds to a field element in the circuit. For bytes32 values (scope, nullifier, signal hash), 32 consecutive fields are concatenated to form the final value.
+
 ## Error Handling
 
 All async SDK methods throw standard `Error` objects:

package/dist/ProofportSDK.d.ts

@@ -916,5 +916,24 @@ export declare class ProofportSDK {
      * ```
      */
     extractNullifier(publicInputs: string[], circuit: CircuitType): string | null;
+    /**
+     * Extracts the domain string from OIDC Domain Attestation proof public inputs.
+     *
+     * Only works with 'oidc_domain_attestation' circuit. Returns null for other circuits.
+     *
+     * @param publicInputs - Array of hex-encoded field elements from proof result
+     * @param circuit - Circuit type that produced the public inputs
+     * @returns Domain as ASCII string (e.g., 'example.com'), or null if not applicable
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.waitForProof(relay.requestId);
+     * if (result.status === 'completed') {
+     *   const domain = sdk.extractDomain(result.publicInputs, result.circuit);
+     *   console.log('Domain:', domain); // 'example.com'
+     * }
+     * ```
+     */
+    extractDomain(publicInputs: string[], circuit: CircuitType): string | null;
 }
 export default ProofportSDK;

package/dist/constants.d.ts

@@ -205,12 +205,16 @@ export declare const COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT: {
 export declare const OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT: {
     readonly PUBKEY_MODULUS_START: 0;
     readonly PUBKEY_MODULUS_END: 17;
-    readonly DOMAIN_LEN: 18;
-    readonly DOMAIN_START: 19;
-    readonly DOMAIN_END: 82;
+    readonly DOMAIN_STORAGE_START: 18;
+    readonly DOMAIN_STORAGE_END: 81;
+    readonly DOMAIN_LEN: 82;
     readonly SCOPE_START: 83;
     readonly SCOPE_END: 114;
     readonly NULLIFIER_START: 115;
     readonly NULLIFIER_END: 146;
     readonly PROVIDER: 147;
+    /** @deprecated Use DOMAIN_STORAGE_START */
+    readonly DOMAIN_START: 18;
+    /** @deprecated Use DOMAIN_LEN */
+    readonly DOMAIN_END: 82;
 };

package/dist/index.d.ts

@@ -26,6 +26,6 @@
  * ```
  */
 export { ProofportSDK, default } from './ProofportSDK';
-export { extractScopeFromPublicInputs, extractNullifierFromPublicInputs, } from './verifier';
+export { extractScopeFromPublicInputs, extractNullifierFromPublicInputs, extractDomainFromPublicInputs, } from './verifier';
 export { COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT, COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT, OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT, } from './constants';
 export type { CircuitType, ProofRequestStatus, CoinbaseKycInputs, CoinbaseCountryInputs, OidcDomainInputs, CircuitInputs, ProofRequest, ProofResponse, QRCodeOptions, VerifierContract, ProofportConfig, ChallengeResponse, WalletSigner, RelayProofRequest, RelayProofResult, SDKEnvironment, } from './types';

package/dist/index.esm.js

@@ -226,14 +226,18 @@ const COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT = {
 const OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT = {
     PUBKEY_MODULUS_START: 0,
     PUBKEY_MODULUS_END: 17,
-    DOMAIN_LEN: 18,
-    DOMAIN_START: 19,
-    DOMAIN_END: 82,
+    DOMAIN_STORAGE_START: 18,
+    DOMAIN_STORAGE_END: 81,
+    DOMAIN_LEN: 82,
     SCOPE_START: 83,
     SCOPE_END: 114,
     NULLIFIER_START: 115,
     NULLIFIER_END: 146,
     PROVIDER: 147,
+    /** @deprecated Use DOMAIN_STORAGE_START */
+    DOMAIN_START: 18,
+    /** @deprecated Use DOMAIN_LEN */
+    DOMAIN_END: 82,
 };
 
 /**
@@ -3880,6 +3884,38 @@ function extractNullifierFromPublicInputs(publicInputsHex, circuit) {
     const nullifierFields = publicInputsHex.slice(start, end + 1);
     return reconstructBytes32FromFields(nullifierFields);
 }
+/**
+ * Extract domain string from OIDC Domain Attestation public inputs.
+ *
+ * The domain is stored as a Noir BoundedVec<u8, 64>, which serializes as
+ * [storage[0..64], len]. Each storage element is a u8 value in a field element.
+ *
+ * @param publicInputsHex - Array of public input hex strings
+ * @param circuit - Circuit identifier (must be 'oidc_domain_attestation')
+ * @returns Domain as ASCII string, or null if circuit doesn't match or inputs are insufficient
+ *
+ * @example
+ * ```typescript
+ * const domain = extractDomainFromPublicInputs(publicInputs, 'oidc_domain_attestation');
+ * console.log(domain); // 'example.com'
+ * ```
+ */
+function extractDomainFromPublicInputs(publicInputsHex, circuit) {
+    if (circuit !== 'oidc_domain_attestation')
+        return null;
+    const layout = OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT;
+    if (publicInputsHex.length <= layout.DOMAIN_LEN)
+        return null;
+    const len = Number(BigInt(publicInputsHex[layout.DOMAIN_LEN]) & 0xffn);
+    if (len === 0 || len > 64)
+        return null;
+    const storageFields = publicInputsHex.slice(layout.DOMAIN_STORAGE_START, layout.DOMAIN_STORAGE_START + len);
+    const chars = storageFields.map(f => {
+        const byte = Number(BigInt(f) & 0xffn);
+        return String.fromCharCode(byte);
+    });
+    return chars.join('');
+}
 /** @internal Reconstruct a bytes32 value from 32 individual field elements */
 function reconstructBytes32FromFields(fields) {
     if (fields.length !== 32) {
@@ -5057,6 +5093,27 @@ class ProofportSDK {
     extractNullifier(publicInputs, circuit) {
         return extractNullifierFromPublicInputs(publicInputs, circuit);
     }
+    /**
+     * Extracts the domain string from OIDC Domain Attestation proof public inputs.
+     *
+     * Only works with 'oidc_domain_attestation' circuit. Returns null for other circuits.
+     *
+     * @param publicInputs - Array of hex-encoded field elements from proof result
+     * @param circuit - Circuit type that produced the public inputs
+     * @returns Domain as ASCII string (e.g., 'example.com'), or null if not applicable
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.waitForProof(relay.requestId);
+     * if (result.status === 'completed') {
+     *   const domain = sdk.extractDomain(result.publicInputs, result.circuit);
+     *   console.log('Domain:', domain); // 'example.com'
+     * }
+     * ```
+     */
+    extractDomain(publicInputs, circuit) {
+        return extractDomainFromPublicInputs(publicInputs, circuit);
+    }
 }
 /**
  * Creates a proof request through the relay server.
@@ -5095,5 +5152,5 @@ ProofportSDK.WALLET_SIGNATURE_CIRCUITS = [
     'coinbase_country_attestation',
 ];
 
-export { COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT, COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT, OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT, ProofportSDK, ProofportSDK as default, extractNullifierFromPublicInputs, extractScopeFromPublicInputs };
+export { COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT, COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT, OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT, ProofportSDK, ProofportSDK as default, extractDomainFromPublicInputs, extractNullifierFromPublicInputs, extractScopeFromPublicInputs };
 //# sourceMappingURL=index.esm.js.map