@0xpolygonid/js-sdk 1.5.0 → 1.6.0

package/dist/types/circuits/linked-multi-query.d.ts

@@ -0,0 +1,38 @@
+import { Claim } from '@iden3/js-iden3-core';
+import { BaseConfig } from './common';
+import { Query } from './models';
+/**
+ * LinkedMultiQuery circuit representation
+ * Inputs and public signals declaration, marshalling and parsing
+ *
+ * @beta
+ * @class LinkedMultiQueryInputs
+ */
+export declare class LinkedMultiQueryInputs extends BaseConfig {
+    linkNonce: bigint;
+    claim: Claim;
+    query: Query[];
+    queryLength: number;
+    inputsMarshal(): Uint8Array;
+}
+/**
+ * public signals
+ *
+ * @beta
+ * @class LinkedMultiQueryPubSignals
+ */
+export declare class LinkedMultiQueryPubSignals {
+    linkID: bigint;
+    merklized: number;
+    operatorOutput: bigint[];
+    circuitQueryHash: bigint[];
+    enabled: boolean[];
+    /**
+     * PubSignalsUnmarshal unmarshal linkedMultiQuery.circom public inputs to LinkedMultiQueryPubSignals
+     *
+     * @beta
+     * @param {Uint8Array} data
+     * @returns LinkedMultiQueryPubSignals
+     */
+    pubSignalsUnmarshal(data: Uint8Array, queryLength: number): LinkedMultiQueryPubSignals;
+}

package/dist/types/circuits/linked-nullifier.d.ts

@@ -0,0 +1,37 @@
+import { Claim, Id } from '@iden3/js-iden3-core';
+/**
+ * LinkedNullifier circuit representation
+ * Inputs and public signals declaration, marshalling and parsing
+ *
+ * @beta
+ * @class LinkedNullifierInputs
+ */
+export declare class LinkedNullifierInputs {
+    linkNonce: bigint;
+    issuerClaim: Claim;
+    id: Id;
+    claimSubjectProfileNonce: bigint;
+    verifierID?: Id;
+    nullifierSessionID: bigint;
+    inputsMarshal(): Uint8Array;
+}
+/**
+ * public signals
+ *
+ * @beta
+ * @class LinkedNullifierPubSignals
+ */
+export declare class LinkedNullifierPubSignals {
+    nullifier: bigint;
+    linkID: bigint;
+    verifierID: Id;
+    nullifierSessionID: bigint;
+    /**
+     * PubSignalsUnmarshal unmarshal nullifier.circom public inputs to LinkedNullifierPubSignals
+     *
+     * @beta
+     * @param {Uint8Array} data
+     * @returns LinkedNullifierPubSignals
+     */
+    pubSignalsUnmarshal(data: Uint8Array): LinkedNullifierPubSignals;
+}

package/dist/types/circuits/models.d.ts

@@ -52,7 +52,23 @@ export declare enum CircuitId {
     AtomicQueryMTPV2 = "credentialAtomicQueryMTPV2",
     AtomicQueryMTPV2OnChain = "credentialAtomicQueryMTPV2OnChain",
     AtomicQuerySigV2 = "credentialAtomicQuerySigV2",
-    AtomicQuerySigV2OnChain = "credentialAtomicQuerySigV2OnChain"
+    AtomicQuerySigV2OnChain = "credentialAtomicQuerySigV2OnChain",
+    /**
+     * @beta
+     */
+    AtomicQueryV3 = "credentialAtomicQueryV3-beta.0",
+    /**
+     * @beta
+     */
+    AtomicQueryV3OnChain = "credentialAtomicQueryV3OnChain-beta.0",
+    /**
+     * @beta
+     */
+    LinkedNullifier = "linkedNullifier-beta.0",
+    /**
+     * @beta
+     */
+    LinkedMultiQuery10 = "linkedMultiQuery10-beta.0"
 }
 /**
  * Claim structure for circuit inputs
@@ -147,7 +163,9 @@ export declare enum CircuitError {
     EmptyId = "empty Id",
     EmptyChallenge = "empty challenge",
     EmptyGISTProof = "empty GIST merkle tree proof",
-    EmptyRequestID = "empty request ID"
+    EmptyTreeState = "empty tree state",
+    EmptyRequestID = "empty request ID",
+    InvalidProofType = "invalid proof type"
 }
 /**
  * ValueProof represents a Merkle Proof for a value stored as MT

package/dist/types/credentials/index.d.ts

@@ -6,3 +6,4 @@ export * from './status/agent-revocation';
 export * from './status/utils';
 export * from './credential-wallet';
 export * from './rhs';
+export * from './utils';

package/dist/types/credentials/utils.d.ts

@@ -0,0 +1,12 @@
+import { DID } from '@iden3/js-iden3-core';
+import { W3CCredential } from '../verifiable';
+/**
+ * Retrieves the user DID from a given credential.
+ * If the credential does not have a credentialSubject.id property, the issuer DID is returned.
+ * If the credentialSubject.id is not a string, an error is thrown.
+ * @param issuerDID The DID of the issuer.
+ * @param credential The credential object.
+ * @returns The user DID parsed from the credential.
+ * @throws Error if the credentialSubject.id is not a string.
+ */
+export declare const getUserDIDFromCredential: (issuerDID: DID, credential: W3CCredential) => DID;

package/dist/types/iden3comm/types/packer.d.ts

@@ -12,7 +12,7 @@ export type ProtocolMessage = string;
 /**
  * JSONValue
  */
-type JSONValue = string | number | boolean | object | Array<object>;
+export type JSONValue = string | number | boolean | object | Array<object>;
 /**
  * JSON object
  */
@@ -93,4 +93,3 @@ export type ProvingParams = {
     provingKey: Uint8Array;
     wasm: Uint8Array;
 };
-export {};

package/dist/types/iden3comm/types/protocol/auth.d.ts

@@ -41,6 +41,7 @@ export type ZeroKnowledgeProofRequest = {
     circuitId: string;
     optional?: boolean;
     query: JSONObject;
+    params?: JSONObject;
 };
 /** ZeroKnowledgeProofResponse represents structure of zkp response */
 export type ZeroKnowledgeProofResponse = {

package/dist/types/proof/common.d.ts

@@ -1,13 +1,27 @@
-import { ClaimNonRevStatus, GISTProof } from '../circuits';
+import { ClaimNonRevStatus, GISTProof, Operators } from '../circuits';
 import { StateProof } from '../storage/entities/state';
-import { RevocationStatus } from '../verifiable';
+import { MerkleTreeProofWithTreeState, RevocationStatus, W3CCredential } from '../verifiable';
+import { Options, Path } from '@iden3/js-jsonld-merklization';
+import { JSONObject } from '../iden3comm';
+import { Claim } from '@iden3/js-iden3-core';
+export type PreparedCredential = {
+    credential: W3CCredential;
+    credentialCoreClaim: Claim;
+    revStatus?: RevocationStatus;
+};
+export type PreparedAuthBJJCredential = {
+    credential: W3CCredential;
+    incProof: MerkleTreeProofWithTreeState;
+    nonRevProof: MerkleTreeProofWithTreeState;
+    coreClaim: Claim;
+};
 /**
  * converts verifiable RevocationStatus model to circuits structure
  *
  * @param {RevocationStatus} - credential.status of the verifiable credential
  * @returns {ClaimNonRevStatus}
  */
-export declare const toClaimNonRevStatus: (s: RevocationStatus) => ClaimNonRevStatus;
+export declare const toClaimNonRevStatus: (s?: RevocationStatus) => ClaimNonRevStatus;
 /**
  * converts state info from smart contract to gist proof
  *
@@ -15,3 +29,20 @@ export declare const toClaimNonRevStatus: (s: RevocationStatus) => ClaimNonRevSt
  * @returns {GISTProof}
  */
 export declare const toGISTProof: (smtProof: StateProof) => GISTProof;
+export type PropertyQuery = {
+    fieldName: string;
+    operator: Operators;
+    operatorValue?: unknown;
+};
+export type QueryMetadata = PropertyQuery & {
+    slotIndex: number;
+    values: bigint[];
+    path: Path;
+    claimPathKey: bigint;
+    datatype: string;
+    merklizedSchema: boolean;
+};
+export declare const parseCredentialSubject: (credentialSubject?: JSONObject) => PropertyQuery[];
+export declare const parseQueryMetadata: (propertyQuery: PropertyQuery, ldContextJSON: string, credentialType: string, options: Options) => Promise<QueryMetadata>;
+export declare const parseQueriesMetadata: (credentialType: string, ldContextJSON: string, credentialSubject: JSONObject, options: Options) => Promise<QueryMetadata[]>;
+export declare const transformQueryValueToBigInts: (value: unknown, ldType: string) => Promise<bigint[]>;

package/dist/types/proof/inputs-generator.d.ts

@@ -0,0 +1,46 @@
+import { DID } from '@iden3/js-iden3-core';
+import { RevocationStatus, W3CCredential } from '../verifiable';
+import { ZeroKnowledgeProofRequest } from '../iden3comm';
+import { CircuitClaim, Query, TreeState } from '../circuits';
+import { PreparedAuthBJJCredential, PreparedCredential } from './common';
+import { IIdentityWallet } from '../identity';
+import { IStateStorage } from '../storage';
+import { ICredentialWallet } from '../credentials';
+export type DIDProfileMetadata = {
+    authProfileNonce: number;
+    credentialSubjectProfileNonce: number;
+};
+export type ProofGenerationOptions = {
+    skipRevocation: boolean;
+    challenge?: bigint;
+    credential?: W3CCredential;
+    credentialRevocationStatus?: RevocationStatus;
+    verifierDid?: DID;
+    linkNonce?: bigint;
+};
+export type ProofInputsParams = ProofGenerationOptions & DIDProfileMetadata;
+type InputContext = {
+    preparedCredential: PreparedCredential;
+    identifier: DID;
+    proofReq: ZeroKnowledgeProofRequest;
+    params: ProofInputsParams;
+    circuitQueries: Query[];
+};
+export declare class InputGenerator {
+    private readonly _identityWallet;
+    private readonly _credentialWallet;
+    private readonly _stateStorage;
+    constructor(_identityWallet: IIdentityWallet, _credentialWallet: ICredentialWallet, _stateStorage: IStateStorage);
+    generateInputs(ctx: InputContext): Promise<Uint8Array>;
+    newCircuitClaimData(preparedCredential: PreparedCredential): Promise<CircuitClaim>;
+    prepareAuthBJJCredential(did: DID, treeStateInfo?: TreeState): Promise<PreparedAuthBJJCredential>;
+    private credentialAtomicQueryMTPV2PrepareInputs;
+    private credentialAtomicQueryMTPV2OnChainPrepareInputs;
+    private credentialAtomicQuerySigV2PrepareInputs;
+    private credentialAtomicQuerySigV2OnChainPrepareInputs;
+    private credentialAtomicQueryV3PrepareInputs;
+    private credentialAtomicQueryV3OnChainPrepareInputs;
+    private linkedNullifierPrepareInputs;
+    linkedMultiQuery10PrepareInputs: ({ preparedCredential, proofReq, params, circuitQueries }: InputContext) => Promise<Uint8Array>;
+}
+export {};

package/dist/types/proof/proof-service.d.ts

@@ -1,30 +1,21 @@
-import { Signature } from '@iden3/js-crypto';
 import { DID } from '@iden3/js-iden3-core';
 import { CircuitId, Query, TreeState } from '../circuits';
 import { ICredentialWallet } from '../credentials';
 import { IIdentityWallet } from '../identity';
-import { W3CCredential } from '../verifiable';
+import { ProofQuery, RevocationStatus, W3CCredential } from '../verifiable';
 import { IZKProver } from './prover';
 import { Options } from '@iden3/js-jsonld-merklization';
 import { ZKProof } from '@iden3/js-jwz';
 import { Signer } from 'ethers';
 import { ZeroKnowledgeProofRequest, ZeroKnowledgeProofResponse } from '../iden3comm';
 import { ICircuitStorage, IStateStorage } from '../storage';
+import { ProofGenerationOptions } from './inputs-generator';
 export interface QueryWithFieldName {
     query: Query;
     fieldName: string;
     rawValue?: unknown;
     isSelectiveDisclosure?: boolean;
 }
-export interface ProofGenerationOptions {
-    skipRevocation: boolean;
-    challenge?: bigint;
-    credential?: W3CCredential;
-}
-export interface DIDProfileMetadata {
-    authProfileNonce: number;
-    credentialSubjectProfileNonce: number;
-}
 /**
  *  List of options to customize ProofService
  */
@@ -82,6 +73,12 @@ export interface IProofService {
      * @returns `{Promise<string>}` - transaction hash is returned
      */
     transitState(did: DID, oldTreeState: TreeState, isOldStateGenesis: boolean, stateStorage: IStateStorage, ethSigner: Signer): Promise<string>;
+    findCredentialByProofQuery(did: DID, query: ProofQuery, opts?: {
+        skipClaimRevocationCheck: boolean;
+    }): Promise<{
+        cred: W3CCredential;
+        revStatus: RevocationStatus | undefined;
+    }>;
 }
 /**
  * Proof service is an implementation of IProofService
@@ -97,6 +94,7 @@ export declare class ProofService implements IProofService {
     private readonly _stateStorage;
     private readonly _prover;
     private readonly _ldOptions;
+    private readonly _inputsGenerator;
     /**
      * Creates an instance of ProofService.
      * @param {IIdentityWallet} _identityWallet - identity wallet
@@ -111,23 +109,14 @@ export declare class ProofService implements IProofService {
     generateProof(proofReq: ZeroKnowledgeProofRequest, identifier: DID, opts?: ProofGenerationOptions): Promise<ZeroKnowledgeProofResponse>;
     /** {@inheritdoc IProofService.transitState} */
     transitState(did: DID, oldTreeState: TreeState, isOldStateGenesis: boolean, stateStorage: IStateStorage, ethSigner: Signer): Promise<string>;
-    private getPreparedCredential;
-    private prepareAuthBJJCredential;
     private generateInputs;
-    private generateMTPV2Inputs;
-    private generateMTPV2OnChainInputs;
-    private generateQuerySigV2Inputs;
-    private generateQuerySigV2OnChainInputs;
-    private newCircuitClaimData;
     private toCircuitsQuery;
-    private prepareMerklizedQuery;
-    private prepareNonMerklizedQuery;
-    private loadLdContextFromJSONSchema;
-    private parseRequest;
-    transformQueryValueToBigInts(value: unknown, ldType: string): Promise<bigint[]>;
+    private loadLdContext;
     /** {@inheritdoc IProofService.generateAuthV2Inputs} */
     generateAuthV2Inputs(hash: Uint8Array, did: DID, circuitId: CircuitId): Promise<Uint8Array>;
     verifyState(circuitId: string, pubSignals: Array<string>): Promise<boolean>;
-    private findCredential;
+    findCredentialByProofQuery(did: DID, query: ProofQuery): Promise<{
+        cred: W3CCredential;
+        revStatus: RevocationStatus | undefined;
+    }>;
 }
-export declare const bJJSignatureFromHexString: (sigHex: string) => Promise<Signature>;

package/dist/types/schema-processor/json/parser.d.ts

@@ -85,6 +85,7 @@ export declare class Parser {
     static parseClaim(credential: W3CCredential, opts?: CoreClaimOptions): Promise<CoreClaim>;
     static findCredentialType(mz: Merklizer): string;
     static getSerializationAttr(credential: W3CCredential, opts: Options, tp: string): Promise<string>;
+    static getSerializationAttrFromContext(context: object, opts: Options, tp: string): Promise<string>;
     static getSerializationAttrFromParsedContext(ldCtx: {
         mappings: Map<string, Record<string, unknown>>;
     }, tp: string): Promise<string>;

package/dist/types/storage/filters/jsonQuery.d.ts

@@ -9,7 +9,7 @@ export declare enum SearchError {
     NotDefinedComparator = "not defined comparator"
 }
 /** allowed operators to search */
-export type FilterOperatorMethod = '$noop' | '$eq' | '$in' | '$nin' | '$gt' | '$lt' | '$ne';
+export type FilterOperatorMethod = '$noop' | '$eq' | '$in' | '$nin' | '$gt' | '$lt' | '$ne' | '$gte' | '$lte' | '$sd';
 /** filter function type */
 export type FilterOperatorFunction = (a: any, b: any) => boolean;
 /**

package/dist/types/utils/did-helper.d.ts

@@ -0,0 +1,6 @@
+import { Id } from '@iden3/js-iden3-core';
+export declare const buildVerifierId: (address: string, info: {
+    method: string;
+    blockchain: string;
+    networkId: string;
+}) => Id;

package/dist/types/utils/index.d.ts

@@ -1 +1,3 @@
 export * from './encoding';
+export * from './object';
+export * from './did-helper';

package/dist/types/utils/object.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Merges two objects together, prioritizing the properties of the second object.
+ * If a property exists in both objects, the value from the second object will be used.
+ * @param credSubject - The first object to merge.
+ * @param otherCredSubject - The second object to merge.
+ * @returns A new object with the merged properties.
+ */
+type obj = {
+    [k: string]: unknown;
+};
+export declare function mergeObjects(credSubject: obj, otherCredSubject: obj): obj;
+export {};

package/dist/types/verifiable/presentation.d.ts

@@ -1,14 +1,10 @@
-import { Hasher, MtValue, Options, Path } from '@iden3/js-jsonld-merklization';
+import { Options, Path } from '@iden3/js-jsonld-merklization';
 import { W3CCredential } from './credential';
-import { ProofQuery } from './proof';
+import { QueryMetadata } from '../proof';
+import { JSONObject } from '../iden3comm';
 export declare const stringByPath: (obj: {
     [key: string]: unknown;
 }, path: string) => string;
-export declare const buildQueryPath: (contextURL: string, contextType: string, field: string, opts?: Options) => Promise<Path>;
-export declare const createVerifiablePresentation: (context: string, tp: string, path: string, value: unknown) => object;
-export declare const verifiablePresentationFromCred: (w3cCred: W3CCredential, requestObj: ProofQuery, field: string, opts?: Options) => Promise<{
-    vp: object;
-    mzValue: MtValue;
-    dataType: string;
-    hasher: Hasher;
-}>;
+export declare const buildFieldPath: (ldSchema: string, contextType: string, field: string, opts?: Options) => Promise<Path>;
+export declare const findValue: (fieldName: string, credential: W3CCredential) => JSONObject;
+export declare const createVerifiablePresentation: (context: string, tp: string, credential: W3CCredential, queries: QueryMetadata[]) => object;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xpolygonid/js-sdk",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "SDK to work with Polygon ID",
   "main": "dist/node/cjs/index.js",
   "module": "dist/node/esm/index.js",
@@ -86,9 +86,9 @@
   },
   "peerDependencies": {
     "@iden3/js-crypto": "1.0.3",
-    "@iden3/js-iden3-core": "1.2.0",
+    "@iden3/js-iden3-core": "1.2.1",
     "@iden3/js-jsonld-merklization": "1.1.2",
-    "@iden3/js-jwz": "1.2.0",
+    "@iden3/js-jwz": "1.2.1",
     "@iden3/js-merkletree": "1.1.2",
     "ffjavascript": "0.2.62",
     "snarkjs": "0.7.2",