@0xpolygonid/js-sdk 1.17.8 → 1.18.0

package/dist/types/storage/blockchain/onchain-zkp-verifier.d.ts

@@ -1,7 +1,25 @@
 import { Signer } from 'ethers';
 import { EthConnectionConfig } from './state';
 import { IOnChainZKPVerifier } from '../interfaces/onchain-zkp-verifier';
-import { ContractInvokeTransactionData, ZeroKnowledgeProofResponse } from '../../iden3comm';
+import { ContractInvokeTransactionData, JsonDocumentObjectValue, ZeroKnowledgeProofResponse } from '../../iden3comm';
+/**
+ * Supported function signature for SubmitZKPResponse
+ */
+export declare enum FunctionSignatures {
+    /**
+     * solidity identifier for function signature:
+     * function submitZKPResponse(uint64 requestId, uint256[] calldata inputs,
+     * uint256[2] calldata a, uint256[2][2] calldata b, uint256[2] calldata c) public
+     */
+    SumbitZKPResponseV1 = "b68967e2",
+    SumbitZKPResponseV2 = "ade09fcd"
+}
+/**
+ * OnChainZKPVerifierOptions represents OnChainZKPVerifier options
+ */
+export type OnChainZKPVerifierOptions = {
+    didResolverUrl?: string;
+};
 /**
  * OnChainZKPVerifier is a class that allows to interact with the OnChainZKPVerifier contract
  * and submitZKPResponse.
@@ -11,26 +29,40 @@ import { ContractInvokeTransactionData, ZeroKnowledgeProofResponse } from '../..
  */
 export declare class OnChainZKPVerifier implements IOnChainZKPVerifier {
     private readonly _configs;
+    private readonly _opts?;
     /**
-     * solidity identifier for function signature:
-     * function submitZKPResponse(uint64 requestId, uint256[] calldata inputs,
-     * uint256[2] calldata a, uint256[2][2] calldata b, uint256[2] calldata c) public
+     * supported circuits
+     */
+    private readonly _supportedCircuits;
+    /**
+     * abi coder to encode/decode structures to solidity bytes
      */
-    private readonly _supportedMethodId;
+    private readonly _abiCoder;
     /**
      *
      * Creates an instance of OnChainZKPVerifier.
      * @beta
      * @param {EthConnectionConfig[]} - array of ETH configs
      */
-    constructor(_configs: EthConnectionConfig[]);
+    constructor(_configs: EthConnectionConfig[], _opts?: OnChainZKPVerifierOptions | undefined);
     /**
-     * Submit ZKP Responses to OnChainZKPVerifier contract.
-     * @beta
-     * @param {Signer} ethSigner - tx signer
-     * @param {txData} ContractInvokeTransactionData - transaction data
-     * @param {ZeroKnowledgeProofResponse[]} zkProofResponses - zkProofResponses
-     * @returns {Promise<Map<string, ZeroKnowledgeProofResponse>>} - map of transaction hash - ZeroKnowledgeProofResponse
+     * {@inheritDoc IOnChainZKPVerifier.prepareTxArgsSubmitV1}
+     */
+    prepareTxArgsSubmitV1(txData: ContractInvokeTransactionData, zkProofResponse: ZeroKnowledgeProofResponse): Promise<JsonDocumentObjectValue[]>;
+    /**
+     * {@inheritDoc IOnChainZKPVerifier.submitZKPResponse}
      */
     submitZKPResponse(ethSigner: Signer, txData: ContractInvokeTransactionData, zkProofResponses: ZeroKnowledgeProofResponse[]): Promise<Map<string, ZeroKnowledgeProofResponse>>;
+    /**
+     * {@inheritDoc IOnChainZKPVerifier.submitZKPResponseV2}
+     */
+    submitZKPResponseV2(ethSigner: Signer, txData: ContractInvokeTransactionData, zkProofResponses: ZeroKnowledgeProofResponse[]): Promise<Map<string, ZeroKnowledgeProofResponse[]>>;
+    prepareTxArgsSubmitV2(txData: ContractInvokeTransactionData, zkProofResponses: ZeroKnowledgeProofResponse[]): Promise<JsonDocumentObjectValue[]>;
+    private packZkpProof;
+    private packCrossChainProofs;
+    private packGlobalStateMsg;
+    private packIdentityStateMsg;
+    private packMetadatas;
+    private getOnChainGistRootStatePubSignals;
+    private resolveDidDocumentEip712MessageAndSignature;
 }

package/dist/types/storage/entities/state.d.ts

@@ -43,3 +43,47 @@ export interface RootInfo {
     createdAtBlock: bigint;
     replacedAtBlock: bigint;
 }
+/**
+ * identity state message
+ *
+ * @public
+ * @interface IdentityStateMsg
+ */
+export interface IdentityStateMsg {
+    timestamp: number;
+    id: bigint;
+    state: bigint;
+    replacedAtTimestamp: number;
+}
+/**
+ * global state message
+ *
+ * @public
+ * @interface GlobalStateMsg
+ */
+export interface GlobalStateMsg {
+    timestamp: number;
+    idType: string;
+    root: bigint;
+    replacedAtTimestamp: number;
+}
+/**
+ * identity state update
+ *
+ * @public
+ * @interface IdentityStateUpdate
+ */
+export interface IdentityStateUpdate {
+    idStateMsg: IdentityStateMsg;
+    signature: string;
+}
+/**
+ * global state update
+ *
+ * @public
+ * @interface GlobalStateUpdate
+ */
+export interface GlobalStateUpdate {
+    globalStateMsg: GlobalStateMsg;
+    signature: string;
+}

package/dist/types/storage/interfaces/onchain-zkp-verifier.d.ts

@@ -1,5 +1,5 @@
 import { Signer } from 'ethers';
-import { ContractInvokeTransactionData, ZeroKnowledgeProofResponse } from '../../iden3comm';
+import { ContractInvokeTransactionData, JsonDocumentObjectValue, ZeroKnowledgeProofResponse } from '../../iden3comm';
 /**
  * Interface that defines methods for ZKP verifier
  *
@@ -16,4 +16,25 @@ export interface IOnChainZKPVerifier {
      * @returns {Promise<Map<string, ZeroKnowledgeProofResponse>>} - map of transaction hash - ZeroKnowledgeProofResponse
      */
     submitZKPResponse(ethSigner: Signer, txData: ContractInvokeTransactionData, zkProofResponses: ZeroKnowledgeProofResponse[]): Promise<Map<string, ZeroKnowledgeProofResponse>>;
+    /**
+     * Submit ZKP Response V2 to OnChainZKPVerifier contract.
+     * @beta
+     * @param {Signer} ethSigner - tx signer
+     * @param {txData} ContractInvokeTransactionData - transaction data
+     * @param {ZeroKnowledgeProofResponse[]} zkProofResponses - zkProofResponses
+     * @returns {Promise<Map<string, ZeroKnowledgeProofResponse[]>>} - map of transaction hash - ZeroKnowledgeProofResponse[]
+     */
+    submitZKPResponseV2(ethSigner: Signer, txData: ContractInvokeTransactionData, zkProofResponses: ZeroKnowledgeProofResponse[]): Promise<Map<string, ZeroKnowledgeProofResponse[]>>;
+    /**
+     * Returns tx args for the ZKP verifier contract submission (singe tx args for each response).
+     * @param txData
+     * @param zkProofResponse
+     */
+    prepareTxArgsSubmitV1(txData: ContractInvokeTransactionData, zkProofResponse: ZeroKnowledgeProofResponse): Promise<JsonDocumentObjectValue[]>;
+    /**
+     * Returns args for the ZKP verifier contract submission V2 (single tx args for an array of responses).
+     * @param txData
+     * @param zkProofResponses
+     */
+    prepareTxArgsSubmitV2(txData: ContractInvokeTransactionData, zkProofResponses: ZeroKnowledgeProofResponse[]): Promise<JsonDocumentObjectValue[]>;
 }

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

@@ -1,6 +1,12 @@
 import { Id, DID } from '@iden3/js-iden3-core';
 import { Hash } from '@iden3/js-merkletree';
-import { VerificationMethod } from 'did-resolver';
+import { VerificationMethod, DIDResolutionMetadata } from 'did-resolver';
+/**
+ * Supported DID Document Signatures
+ */
+export declare enum DIDDocumentSignature {
+    EthereumEip712Signature2021 = "EthereumEip712Signature2021"
+}
 /**
  * Checks if state is genesis state
  *
@@ -23,4 +29,9 @@ export declare const buildVerifierId: (address: string, info: {
 }) => Id;
 export declare const validateDIDDocumentAuth: (did: DID, resolverURL: string, state: Hash) => Promise<void>;
 export declare const resolveDIDDocumentAuth: (did: DID, resolveURL: string, state?: Hash) => Promise<VerificationMethod | undefined>;
+export declare const resolveDidDocument: (did: DID, resolverUrl: string, opts?: {
+    state?: Hash;
+    gist?: Hash;
+    signature?: DIDDocumentSignature;
+}) => Promise<DIDResolutionMetadata>;
 export declare const buildDIDFromEthPubKey: (didType: Uint8Array, pubKeyEth: string) => DID;

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

@@ -1,10 +1,10 @@
 import { Options, Path } from '@iden3/js-jsonld-merklization';
 import { W3CCredential } from './credential';
 import { QueryMetadata } from '../proof';
-import { JsonDocumentObject } from '../iden3comm';
+import { VerifiablePresentation, JsonDocumentObject } from '../iden3comm';
 export declare const stringByPath: (obj: {
     [key: string]: unknown;
 }, path: string) => string;
 export declare const buildFieldPath: (ldSchema: string, contextType: string, field: string, opts?: Options) => Promise<Path>;
 export declare const findValue: (fieldName: string, credential: W3CCredential) => JsonDocumentObject;
-export declare const createVerifiablePresentation: (context: string, tp: string, credential: W3CCredential, queries: QueryMetadata[]) => object;
+export declare const createVerifiablePresentation: (context: string, tp: string, credential: W3CCredential, queries: QueryMetadata[]) => VerifiablePresentation;

package/package.json

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