@0xpolygonid/js-sdk 1.9.0 → 1.9.1

package/dist/node/esm/iden3comm/handlers/revocation-status.js

@@ -0,0 +1,92 @@
+import { PROTOCOL_MESSAGE_TYPE } from '../constants';
+import { MediaType } from '../constants';
+import { DID } from '@iden3/js-iden3-core';
+import * as uuid from 'uuid';
+import { byteEncoder } from '../../utils';
+import { proving } from '@iden3/js-jwz';
+/**
+ *
+ * Allows to process RevocationStatusRequest protocol message
+ *
+
+ * @class RevocationStatusHandler
+ * @implements implements IRevocationStatusHandler interface
+ */
+export class RevocationStatusHandler {
+    /**
+     * Creates an instance of RevocationStatusHandler.
+     * @param {IPackageManager} _packerMgr - package manager to unpack message envelope
+     * @param {IIdentityWallet} _identityWallet - identity wallet
+     *
+     */
+    constructor(_packerMgr, _identityWallet) {
+        this._packerMgr = _packerMgr;
+        this._identityWallet = _identityWallet;
+    }
+    /**
+     * @inheritdoc IRevocationStatusHandler#parseRevocationStatusRequest
+     */
+    async parseRevocationStatusRequest(request) {
+        const { unpackedMessage: message } = await this._packerMgr.unpack(request);
+        const ciRequest = message;
+        if (message.type !== PROTOCOL_MESSAGE_TYPE.REVOCATION_STATUS_REQUEST_MESSAGE_TYPE) {
+            throw new Error('Invalid media type');
+        }
+        return ciRequest;
+    }
+    /**
+     * @inheritdoc IRevocationStatusHandler#handleRevocationStatusRequest
+     */
+    async handleRevocationStatusRequest(did, request, opts) {
+        if (!opts) {
+            opts = {
+                mediaType: MediaType.PlainMessage
+            };
+        }
+        if (opts.mediaType === MediaType.SignedMessage && !opts.packerOptions) {
+            throw new Error(`jws packer options are required for ${MediaType.SignedMessage}`);
+        }
+        const rsRequest = await this.parseRevocationStatusRequest(request);
+        if (!rsRequest.to) {
+            throw new Error(`failed request. empty 'to' field`);
+        }
+        if (!rsRequest.from) {
+            throw new Error(`failed request. empty 'from' field`);
+        }
+        if (!rsRequest.body?.revocation_nonce) {
+            throw new Error(`failed request. empty 'revocation_nonce' field`);
+        }
+        const issuerDID = DID.parse(rsRequest.to);
+        const mtpWithTreeState = await this._identityWallet.generateNonRevocationMtpWithNonce(issuerDID, BigInt(rsRequest.body.revocation_nonce), opts?.treeState);
+        const treeState = mtpWithTreeState.treeState;
+        const revStatus = {
+            issuer: {
+                state: treeState?.state.string(),
+                claimsTreeRoot: treeState.claimsRoot.string(),
+                revocationTreeRoot: treeState.revocationRoot.string(),
+                rootOfRoots: treeState.rootOfRoots.string()
+            },
+            mtp: mtpWithTreeState.proof
+        };
+        const packerOpts = opts.mediaType === MediaType.SignedMessage
+            ? opts.packerOptions
+            : {
+                provingMethodAlg: proving.provingMethodGroth16AuthV2Instance.methodAlg
+            };
+        const senderDID = DID.parse(rsRequest.to);
+        const guid = uuid.v4();
+        const response = {
+            id: guid,
+            typ: MediaType.PlainMessage,
+            type: PROTOCOL_MESSAGE_TYPE.REVOCATION_STATUS_RESPONSE_MESSAGE_TYPE,
+            thid: rsRequest.thid ?? guid,
+            body: revStatus,
+            from: did.string(),
+            to: rsRequest.from
+        };
+        return this._packerMgr.pack(opts.mediaType, byteEncoder.encode(JSON.stringify(response)), {
+            senderDID,
+            ...packerOpts
+        });
+    }
+}

package/dist/node/esm/identity/identity-wallet.js

@@ -227,6 +227,10 @@ export class IdentityWallet {
     async generateNonRevocationMtp(did, credential, treeState) {
         const coreClaim = await this.getCoreClaimFromCredential(credential);
         const revNonce = coreClaim.getRevocationNonce();
+        return this.generateNonRevocationMtpWithNonce(did, revNonce, treeState);
+    }
+    /** {@inheritDoc IIdentityWallet.generateNonRevocationMtpWithNonce} */
+    async generateNonRevocationMtpWithNonce(did, revNonce, treeState) {
         const treesModel = await this.getDIDTreeModel(did);
         const revocationTree = await this._storage.mt.getMerkleTreeByIdentifierAndType(did.string(), MerkleTreeType.Revocations);
         const claimsRoot = await treesModel.claimsTree.root();

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

@@ -99,6 +99,7 @@ export interface AuthHandlerOptions {
 export declare class AuthHandler implements IAuthHandler {
     private readonly _packerMgr;
     private readonly _proofService;
+    private readonly _supportedCircuits;
     /**
      * Creates an instance of AuthHandler.
      * @param {IPackageManager} _packerMgr - package manager to unpack message envelope

package/dist/types/iden3comm/handlers/common.d.ts

@@ -0,0 +1,23 @@
+import { JWSPackerParams, ZeroKnowledgeProofRequest, ZeroKnowledgeProofResponse } from '../types';
+import { DID } from '@iden3/js-iden3-core';
+import { IProofService } from '../../proof';
+import { CircuitId } from '../../circuits';
+import { MediaType } from '../constants';
+import { Signer } from 'ethers';
+/**
+ * Processes zero knowledge proof requests.
+ *
+ * @param senderIdentifier - The identifier of the sender.
+ * @param requests - An array of zero knowledge proof requests.
+ * @param from - The identifier of the sender.
+ * @param proofService - The proof service.
+ * @param opts - Additional options for processing the requests.
+ * @returns A promise that resolves to an array of zero knowledge proof responses.
+ */
+export declare const processZeroKnowledgeProofRequests: (senderIdentifier: DID, requests: ZeroKnowledgeProofRequest[] | undefined, from: DID | undefined, proofService: IProofService, opts: {
+    mediaType?: MediaType;
+    packerOptions?: JWSPackerParams;
+    supportedCircuits: CircuitId[];
+    ethSigner?: Signer;
+    challenge?: bigint;
+}) => Promise<ZeroKnowledgeProofResponse[]>;

package/dist/types/iden3comm/handlers/contract-request.d.ts

@@ -46,7 +46,7 @@ export declare class ContractRequestHandler implements IContractRequestHandler {
     private readonly _packerMgr;
     private readonly _proofService;
     private readonly _zkpVerifier;
-    private readonly _allowedCircuits;
+    private readonly _supportedCircuits;
     /**
      * Creates an instance of ContractRequestHandler.
      * @param {IPackageManager} _packerMgr - package manager to unpack message envelope

package/dist/types/iden3comm/handlers/index.d.ts

@@ -2,3 +2,5 @@ export * from './auth';
 export * from './fetch';
 export * from './contract-request';
 export * from './refresh';
+export * from './revocation-status';
+export * from './common';

package/dist/types/iden3comm/handlers/revocation-status.d.ts

@@ -0,0 +1,59 @@
+import { MediaType } from '../constants';
+import { IPackageManager, JWSPackerParams, RevocationStatusRequestMessage } from '../types';
+import { DID } from '@iden3/js-iden3-core';
+import { TreeState } from '../../circuits';
+import { IIdentityWallet } from '../../identity';
+/**
+ * Interface that allows the processing of the revocation status
+ *
+ * @interface IRevocationStatusHandler
+ */
+export interface IRevocationStatusHandler {
+    /**
+     * unpacks revocation status request
+     * @param {Uint8Array} request - raw byte message
+     * @returns `Promise<RevocationStatusRequestMessage>`
+     */
+    parseRevocationStatusRequest(request: Uint8Array): Promise<RevocationStatusRequestMessage>;
+    /**
+     * handle revocation status request
+     * @param {did} did  - sender DID
+     * @param {Uint8Array} request - raw byte message
+     * @param {RevocationStatusHandlerOptions} opts - handler options
+     * @returns {Promise<Uint8Array>}` - revocation status response message
+     */
+    handleRevocationStatusRequest(did: DID, request: Uint8Array, opts?: RevocationStatusHandlerOptions): Promise<Uint8Array>;
+}
+/** RevocationStatusHandlerOptions represents revocation status handler options */
+export type RevocationStatusHandlerOptions = {
+    mediaType: MediaType;
+    packerOptions?: JWSPackerParams;
+    treeState?: TreeState;
+};
+/**
+ *
+ * Allows to process RevocationStatusRequest protocol message
+ *
+
+ * @class RevocationStatusHandler
+ * @implements implements IRevocationStatusHandler interface
+ */
+export declare class RevocationStatusHandler implements IRevocationStatusHandler {
+    private readonly _packerMgr;
+    private readonly _identityWallet;
+    /**
+     * Creates an instance of RevocationStatusHandler.
+     * @param {IPackageManager} _packerMgr - package manager to unpack message envelope
+     * @param {IIdentityWallet} _identityWallet - identity wallet
+     *
+     */
+    constructor(_packerMgr: IPackageManager, _identityWallet: IIdentityWallet);
+    /**
+     * @inheritdoc IRevocationStatusHandler#parseRevocationStatusRequest
+     */
+    parseRevocationStatusRequest(request: Uint8Array): Promise<RevocationStatusRequestMessage>;
+    /**
+     * @inheritdoc IRevocationStatusHandler#handleRevocationStatusRequest
+     */
+    handleRevocationStatusRequest(did: DID, request: Uint8Array, opts?: RevocationStatusHandlerOptions): Promise<Uint8Array>;
+}

package/dist/types/identity/identity-wallet.d.ts

@@ -114,7 +114,7 @@ export interface IIdentityWallet {
      */
     generateCredentialMtp(did: DID, credential: W3CCredential, treeState?: TreeState): Promise<MerkleTreeProofWithTreeState>;
     /**
-     * Generates proof of credential revocation nonce inclusion / non-inclusion to the given revocation tree
+     * Generates proof of credential revocation nonce (with credential as a param) inclusion / non-inclusion to the given revocation tree
      * and its root or to the current root of the Revocation tree in the given Merkle tree storage.
      *
      * @param {DID} did
@@ -123,6 +123,16 @@ export interface IIdentityWallet {
      * @returns `Promise<MerkleTreeProofWithTreeState>` -  MerkleTreeProof and TreeState on which proof has been generated
      */
     generateNonRevocationMtp(did: DID, credential: W3CCredential, treeState?: TreeState): Promise<MerkleTreeProofWithTreeState>;
+    /**
+     * Generates proof of credential revocation nonce (with revNonce as a param) inclusion / non-inclusion to the given revocation tree
+     * and its root or to the current root of the Revocation tree in the given Merkle tree storage.
+     *
+     * @param {DID} did
+     * @param {bigint} revNonce
+     * @param {TreeState} [treeState]
+     * @returns `Promise<MerkleTreeProofWithTreeState>` -  MerkleTreeProof and TreeState on which proof has been generated
+     */
+    generateNonRevocationMtpWithNonce(did: DID, revNonce: bigint, treeState?: TreeState): Promise<MerkleTreeProofWithTreeState>;
     /**
      * Signs a payload of arbitrary size with an Auth BJJ Credential that identifies a key for signing.
      *
@@ -325,6 +335,8 @@ export declare class IdentityWallet implements IIdentityWallet {
     generateCredentialMtp(did: DID, credential: W3CCredential, treeState?: TreeState): Promise<MerkleTreeProofWithTreeState>;
     /** {@inheritDoc IIdentityWallet.generateNonRevocationMtp} */
     generateNonRevocationMtp(did: DID, credential: W3CCredential, treeState?: TreeState): Promise<MerkleTreeProofWithTreeState>;
+    /** {@inheritDoc IIdentityWallet.generateNonRevocationMtpWithNonce} */
+    generateNonRevocationMtpWithNonce(did: DID, revNonce: bigint, treeState?: TreeState): Promise<MerkleTreeProofWithTreeState>;
     /** {@inheritDoc IIdentityWallet.sign} */
     sign(message: Uint8Array, credential: W3CCredential): Promise<Signature>;
     /** {@inheritDoc IIdentityWallet.signChallenge} */

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

@@ -31,7 +31,7 @@ export declare class W3CCredential {
     };
     private proofToJSON;
     private static proofFromJSON;
-    static fromJSON(obj: W3CCredential): W3CCredential;
+    static fromJSON(obj: any): W3CCredential;
     /**
      * merklization of the verifiable credential
      *

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

@@ -186,7 +186,11 @@ export interface CredentialStatus {
     id: string;
     type: CredentialStatusType;
     revocationNonce?: number;
-    statusIssuer?: CredentialStatus;
+    statusIssuer?: {
+        id: string;
+        type: CredentialStatusType;
+        revocationNonce?: number;
+    };
 }
 /**
  * RefreshService contains type and id

package/package.json

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