Add support of Auth V2 validator (#281)

* Add support of Auth V2 validator

* Fix linters

* Fix comments

* Remove process auth validator

* upd package json

* format

* remove IProver. Add method for generation Auth v2 proof

* fix

* fixes

* fix unit tests

---------

Co-authored-by: vmidyllic <[email protected]>
Co-authored-by: vbasiuk <[email protected]>

Author: 3 people

.mocharc.json

@@ -4,6 +4,6 @@
     ],
     "spec": "tests/**/*.test.ts",
     "require": "ts-node/register",
-    "timeout": "300000",
+    "timeout": "400000",
     "maxDiffSize": "10000"
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xpolygonid/js-sdk",
-  "version": "1.25.0",
+  "version": "1.25.1",
   "description": "SDK to work with Polygon ID",
   "main": "dist/node/cjs/index.js",
   "module": "dist/node/esm/index.js",

package.json

@@ -1,7 +1,13 @@
 import { Hash, Proof } from '@iden3/js-merkletree';
 import { Claim, Id } from '@iden3/js-iden3-core';
 import { CircuitError, GISTProof, TreeState } from './models';
-import { BaseConfig, getNodeAuxValue, prepareSiblingsStr } from './common';
+import {
+  BaseConfig,
+  getNodeAuxValue,
+  IStateInfoPubSignals,
+  prepareSiblingsStr,
+  StatesInfo
+} from './common';
 import { Signature } from '@iden3/js-crypto';
 import { byteDecoder, byteEncoder } from '../utils';
 
@@ -117,7 +123,7 @@ interface AuthV2CircuitInputs {
  * @public
  * @class AuthV2PubSignals
  */
-export class AuthV2PubSignals {
+export class AuthV2PubSignals implements IStateInfoPubSignals {
   userID!: Id;
   challenge!: bigint;
   GISTRoot!: Hash;
@@ -143,4 +149,11 @@ export class AuthV2PubSignals {
     this.GISTRoot = Hash.fromString(sVals[2]);
     return this;
   }
+
+  getStatesInfo(): StatesInfo {
+    return {
+      states: [],
+      gists: [{ id: this.userID, root: this.GISTRoot }]
+    };
+  }
 }

src/circuits/auth-v2.ts

@@ -12,7 +12,6 @@ import {
   BasicHandlerOptions,
   IProtocolMessageHandler
 } from './message-handler';
-
 /**
  * Interface that allows the processing of the contract request
  *
@@ -69,6 +68,7 @@ export class ContractRequestHandler
   implements IContractRequestHandler, IProtocolMessageHandler
 {
   private readonly _supportedCircuits = [
+    CircuitId.AuthV2,
     CircuitId.AtomicQueryMTPV2OnChain,
     CircuitId.AtomicQuerySigV2OnChain,
     CircuitId.AtomicQueryV3OnChain
@@ -125,12 +125,19 @@ export class ContractRequestHandler
       throw new Error(`Invalid chain id ${chain_id}`);
     }
     const verifierDid = message.from ? DID.parse(message.from) : undefined;
+
+    const { scope = [] } = message.body;
+
     const zkpResponses = await processZeroKnowledgeProofRequests(
       did,
-      message?.body?.scope,
+      scope,
       verifierDid,
       this._proofService,
-      { ethSigner, challenge, supportedCircuits: this._supportedCircuits }
+      {
+        ethSigner,
+        challenge,
+        supportedCircuits: this._supportedCircuits
+      }
     );
 
     const methodId = message.body.transaction_data.method_id.replace('0x', '');

src/iden3comm/handlers/contract-request.ts

@@ -0,0 +1,66 @@
+import { keccak256 } from 'ethers';
+import { byteEncoder, hexToBytes, isEthereumIdentity } from '../../utils';
+import { CircuitId } from '../../circuits';
+import { Hex } from '@iden3/js-crypto';
+import { DID } from '@iden3/js-iden3-core';
+import { IProofService } from '../../proof';
+import { ZeroKnowledgeProofResponse } from '../types';
+
+/**
+ * @beta
+ * Retrieves the request ID from circuit string.
+ * CircuitId.AuthV2 - 940499666
+ * @returns The request ID.
+ */
+export function calculateRequestIdForCircuit(circuitId: CircuitId): number {
+  const circuitHash = keccak256(byteEncoder.encode(circuitId));
+  const dataView = new DataView(Hex.decodeString(circuitHash.replace('0x', '')).buffer);
+  const id = dataView.getUint32(0);
+  return id;
+}
+
+/**
+ * Prepares the zero-knowledge proof response for the AuthV2 circuit.
+ * @beta
+ * @param address - The address associated with the request.
+ * @param senderDid - The sender's decentralized identifier (DID).
+ * @param proofService - The proof service used to generate the proof.
+ * @returns A promise that resolves to an array of ZeroKnowledgeProofResponse objects.
+ */
+export async function prepareAuthV2ZeroKnowledgeResponse(
+  address: string,
+  senderDid: DID,
+  proofService: IProofService
+): Promise<ZeroKnowledgeProofResponse[]> {
+  const circuitId = CircuitId.AuthV2;
+
+  //  this is now hardcoded calculated value for 'authV2' that can be changed in the future.
+  const id = 940499666;
+
+  if (isEthereumIdentity(senderDid)) {
+    return [
+      {
+        circuitId,
+        id,
+        pub_signals: [],
+        proof: {
+          pi_a: [],
+          pi_b: [],
+          pi_c: [],
+          protocol: 'groth16'
+        }
+      }
+    ];
+  }
+  const hash = Uint8Array.from([...hexToBytes(address), ...new Uint8Array(12)]).reverse();
+  const { proof, pub_signals } = await proofService.generateAuthV2Proof(hash, senderDid);
+
+  return [
+    {
+      circuitId,
+      id,
+      pub_signals,
+      proof
+    }
+  ];
+}

src/iden3comm/utils/contract-request.utils.ts

@@ -1,4 +1,5 @@
 export * from './envelope';
 export * from './message';
 export * from './did';
+export * from './contract-request.utils';
 export * from './accept-profile';

src/iden3comm/utils/index.ts

@@ -131,6 +131,15 @@ export interface IProofService {
    */
   generateAuthV2Inputs(hash: Uint8Array, did: DID, circuitId: CircuitId): Promise<Uint8Array>;
 
+  /**
+   * generates auth inputs
+   *
+   * @param {Uint8Array} hash - challenge that will be signed
+   * @param {DID} did - identity that will generate a proof
+   * @returns `Promise<ZKProof>`
+   */
+  generateAuthV2Proof(hash: Uint8Array, did: DID): Promise<ZKProof>;
+
   /**
    * state verification function
    *
@@ -488,6 +497,14 @@ export class ProofService implements IProofService {
     return authInputs.inputsMarshal();
   }
 
+  /** {@inheritdoc IProofService.generateAuthV2Proof} */
+  async generateAuthV2Proof(challenge: Uint8Array, did: DID): Promise<ZKProof> {
+    const authInputs = await this.generateAuthV2Inputs(challenge, did, CircuitId.AuthV2);
+
+    const zkProof = await this._prover.generate(authInputs, CircuitId.AuthV2);
+    return zkProof;
+  }
+
   async verifyState(
     circuitId: string,
     pubSignals: string[],