@zkproofport-app/sdk 0.2.1 → 0.2.2

package/dist/index.js

@@ -140,6 +140,69 @@ const DEFAULT_REQUEST_EXPIRY_MS = 10 * 60 * 1000;
  * ```
  */
 const MAX_QR_DATA_SIZE = 2953; // Version 40 with L error correction
+/**
+ * Coinbase Attestation circuit public input layout (byte offsets).
+ * Defines the byte positions of each field in the flattened public inputs array.
+ *
+ * Public inputs are packed as bytes32 values:
+ * - signal_hash: bytes 0-31
+ * - merkle_root: bytes 32-63
+ * - scope: bytes 64-95
+ *
+ * @example
+ * ```typescript
+ * const publicInputs = response.publicInputs;
+ * const signalHash = publicInputs.slice(
+ *   COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT.SIGNAL_HASH_START,
+ *   COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT.SIGNAL_HASH_END + 1
+ * );
+ * ```
+ */
+const COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT = {
+    SIGNAL_HASH_START: 0,
+    SIGNAL_HASH_END: 31,
+    MERKLE_ROOT_START: 32,
+    MERKLE_ROOT_END: 63,
+    SCOPE_START: 64,
+    SCOPE_END: 95,
+    NULLIFIER_START: 96,
+    NULLIFIER_END: 127,
+};
+/**
+ * Coinbase Country Attestation circuit public input layout (byte offsets).
+ * Defines the byte positions of each field in the flattened public inputs array.
+ *
+ * Public inputs are packed as bytes32 values:
+ * - signal_hash: bytes 0-31
+ * - merkle_root: bytes 32-63
+ * - country_list: bytes 64-83 (20 bytes for 10 countries)
+ * - country_list_length: byte 84
+ * - is_included: byte 85
+ * - scope: bytes 86-117
+ *
+ * @example
+ * ```typescript
+ * const publicInputs = response.publicInputs;
+ * const countryList = publicInputs.slice(
+ *   COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT.COUNTRY_LIST_START,
+ *   COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT.COUNTRY_LIST_END + 1
+ * );
+ * ```
+ */
+const 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,
+    COUNTRY_LIST_END: 83,
+    COUNTRY_LIST_LENGTH: 84,
+    IS_INCLUDED: 85,
+    SCOPE_START: 86,
+    SCOPE_END: 117,
+    NULLIFIER_START: 118,
+    NULLIFIER_END: 149,
+};
 
 /**
  * Deep Link utilities for ZKProofport SDK
@@ -865,6 +928,39 @@ function extractScopeFromPublicInputs(publicInputsHex, circuit) {
     const scopeFields = publicInputsHex.slice(start, end + 1);
     return reconstructBytes32FromFields(scopeFields);
 }
+/**
+ * Extracts the nullifier (bytes32) from public inputs based on circuit type.
+ *
+ * The nullifier is a unique, deterministic hash derived from the user's attestation
+ * and scope. It serves as a privacy-preserving user identifier — the same user
+ * with the same scope always produces the same nullifier, enabling duplicate
+ * detection without revealing the wallet address.
+ *
+ * @param publicInputsHex - Array of hex-encoded field elements
+ * @param circuit - Circuit type (defaults to coinbase_attestation)
+ * @returns Nullifier as hex string (bytes32), or null if publicInputs too short
+ *
+ * @example
+ * ```typescript
+ * const nullifier = extractNullifierFromPublicInputs(publicInputs, 'coinbase_attestation');
+ * console.log(nullifier); // '0xabc123...'
+ * ```
+ */
+function extractNullifierFromPublicInputs(publicInputsHex, circuit) {
+    let start, end;
+    if (circuit === 'coinbase_country_attestation') {
+        start = 118;
+        end = 149;
+    }
+    else {
+        start = 96;
+        end = 127;
+    }
+    if (publicInputsHex.length <= end)
+        return null;
+    const nullifierFields = publicInputsHex.slice(start, end + 1);
+    return reconstructBytes32FromFields(nullifierFields);
+}
 /** @internal Reconstruct a bytes32 value from 32 individual field elements */
 function reconstructBytes32FromFields(fields) {
     if (fields.length !== 32) {
@@ -2045,8 +2141,36 @@ class ProofportSDK {
     extractScope(publicInputs, circuit) {
         return extractScopeFromPublicInputs(publicInputs, circuit);
     }
+    /**
+     * Extracts the nullifier (bytes32) from proof public inputs.
+     *
+     * The nullifier is a unique, deterministic hash derived from the user's attestation
+     * and scope. It serves as a privacy-preserving user identifier — the same user
+     * with the same scope always produces the same nullifier, enabling duplicate
+     * detection without revealing the wallet address.
+     *
+     * @param publicInputs - Array of hex-encoded field elements from proof result
+     * @param circuit - Circuit type that produced the public inputs
+     * @returns Nullifier as hex string (bytes32), or null if publicInputs too short
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.waitForProof(relay.requestId);
+     * if (result.status === 'completed') {
+     *   const nullifier = sdk.extractNullifier(result.publicInputs, result.circuit);
+     *   console.log('Nullifier:', nullifier); // '0xabc123...'
+     * }
+     * ```
+     */
+    extractNullifier(publicInputs, circuit) {
+        return extractNullifierFromPublicInputs(publicInputs, circuit);
+    }
 }
 
+exports.COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT = COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT;
+exports.COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT = COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT;
 exports.ProofportSDK = ProofportSDK;
 exports.default = ProofportSDK;
+exports.extractNullifierFromPublicInputs = extractNullifierFromPublicInputs;
+exports.extractScopeFromPublicInputs = extractScopeFromPublicInputs;
 //# sourceMappingURL=index.js.map