@0xpolygonid/js-sdk 1.18.3 → 1.19.0

package/dist/node/cjs/identity/common.js

@@ -41,12 +41,24 @@ exports.defineMerklizedRootPosition = defineMerklizedRootPosition;
  * Returns profile DID based on did and profile nonce
  *
  * @param {DID} [did] - did from which profile will be derived
- * @param {number} [profileNonce] - profile nonce
+ * @param {number | string} [profileNonce] - profile nonce
  * @returns {DID}
  */
 const generateProfileDID = (did, profileNonce) => {
     const id = js_iden3_core_1.DID.idFromDID(did);
-    const profile = js_iden3_core_1.Id.profileId(id, BigInt(profileNonce ?? 0));
+    profileNonce = profileNonce ?? 0;
+    if (!isBigInt(profileNonce)) {
+        throw new Error('profile must be number or decimal string');
+    }
+    const profile = js_iden3_core_1.Id.profileId(id, BigInt(profileNonce));
     return js_iden3_core_1.DID.parseFromId(profile);
 };
 exports.generateProfileDID = generateProfileDID;
+const isBigInt = (x) => {
+    try {
+        return BigInt(x).toString() === x.toString();
+    }
+    catch {
+        return false; // conversion to BigInt failed, surely it is not a BigInt
+    }
+};

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

@@ -176,12 +176,20 @@ class IdentityWallet {
             },
             allowedIssuers: [did.string()]
         });
-        if (credentials.length) {
+        // if credential exists with the same credential status type we return this credential
+        if (credentials.length === 1 &&
+            credentials[0].credentialStatus.type === opts.revocationOpts.type) {
             return {
                 did,
                 credential: credentials[0]
             };
         }
+        // otherwise something is already wrong with storage as it has more than 1 credential in it or credential status type of existing credential is different from what user provides - We should remove everything and create new credential.
+        // in this way credential status of auth credential can be upgraded
+        for (let i = 0; i < credentials.length; i++) {
+            await this._credentialWallet.remove(credentials[i].id);
+        }
+        // otherwise  we create a new credential
         const credential = await this.createAuthBJJCredential(did, pubKey, authClaim, currentState, opts.revocationOpts);
         const index = authClaim.hIndex();
         const { proof } = await claimsTree.generateProof(index, ctr);
@@ -199,10 +207,13 @@ class IdentityWallet {
             coreClaim: authClaim
         });
         credential.proof = [mtpProof];
-        await this.publishRevocationInfoByCredentialStatusType(did, opts.revocationOpts.type, {
-            rhsUrl: opts.revocationOpts.id,
-            onChain: opts.revocationOpts.onChain
-        });
+        // only if user specified that genesis state publishing is not needed we won't do this.
+        if (!opts.revocationOpts.genesisPublishingDisabled) {
+            await this.publishRevocationInfoByCredentialStatusType(did, opts.revocationOpts.type, {
+                rhsUrl: opts.revocationOpts.id,
+                onChain: opts.revocationOpts.onChain
+            });
+        }
         await this._credentialWallet.save(credential);
         return {
             did,
@@ -565,23 +576,13 @@ class IdentityWallet {
             throw new Error(`there is no registered publisher to save  hash is not registered for ${credentialStatusType} is not registered`);
         }
         let nodes = [];
-        if (opts?.treeModel) {
-            nodes = await (0, credentials_1.getNodesRepresentation)(opts.revokedNonces, {
-                revocationTree: opts.treeModel.revocationTree,
-                claimsTree: opts.treeModel.claimsTree,
-                state: opts.treeModel.state,
-                rootsTree: opts.treeModel.rootsTree
-            }, opts.treeModel.state);
-        }
-        else {
-            const treeState = await this.getDIDTreeModel(issuerDID);
-            nodes = await (0, credentials_1.getNodesRepresentation)(opts?.revokedNonces, {
-                revocationTree: treeState.revocationTree,
-                claimsTree: treeState.claimsTree,
-                state: treeState.state,
-                rootsTree: treeState.rootsTree
-            }, treeState.state);
-        }
+        const tree = opts?.treeModel ?? (await this.getDIDTreeModel(issuerDID));
+        nodes = await (0, credentials_1.getNodesRepresentation)(opts?.revokedNonces ?? [], {
+            revocationTree: tree.revocationTree,
+            claimsTree: tree.claimsTree,
+            state: tree.state,
+            rootsTree: tree.rootsTree
+        }, tree.state);
         if (!nodes.length) {
             return;
         }

package/dist/node/esm/identity/common.js

@@ -36,11 +36,23 @@ export const defineMerklizedRootPosition = (metadata, position) => {
  * Returns profile DID based on did and profile nonce
  *
  * @param {DID} [did] - did from which profile will be derived
- * @param {number} [profileNonce] - profile nonce
+ * @param {number | string} [profileNonce] - profile nonce
  * @returns {DID}
  */
 export const generateProfileDID = (did, profileNonce) => {
     const id = DID.idFromDID(did);
-    const profile = Id.profileId(id, BigInt(profileNonce ?? 0));
+    profileNonce = profileNonce ?? 0;
+    if (!isBigInt(profileNonce)) {
+        throw new Error('profile must be number or decimal string');
+    }
+    const profile = Id.profileId(id, BigInt(profileNonce));
     return DID.parseFromId(profile);
 };
+const isBigInt = (x) => {
+    try {
+        return BigInt(x).toString() === x.toString();
+    }
+    catch {
+        return false; // conversion to BigInt failed, surely it is not a BigInt
+    }
+};

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

@@ -150,12 +150,20 @@ export class IdentityWallet {
             },
             allowedIssuers: [did.string()]
         });
-        if (credentials.length) {
+        // if credential exists with the same credential status type we return this credential
+        if (credentials.length === 1 &&
+            credentials[0].credentialStatus.type === opts.revocationOpts.type) {
             return {
                 did,
                 credential: credentials[0]
             };
         }
+        // otherwise something is already wrong with storage as it has more than 1 credential in it or credential status type of existing credential is different from what user provides - We should remove everything and create new credential.
+        // in this way credential status of auth credential can be upgraded
+        for (let i = 0; i < credentials.length; i++) {
+            await this._credentialWallet.remove(credentials[i].id);
+        }
+        // otherwise  we create a new credential
         const credential = await this.createAuthBJJCredential(did, pubKey, authClaim, currentState, opts.revocationOpts);
         const index = authClaim.hIndex();
         const { proof } = await claimsTree.generateProof(index, ctr);
@@ -173,10 +181,13 @@ export class IdentityWallet {
             coreClaim: authClaim
         });
         credential.proof = [mtpProof];
-        await this.publishRevocationInfoByCredentialStatusType(did, opts.revocationOpts.type, {
-            rhsUrl: opts.revocationOpts.id,
-            onChain: opts.revocationOpts.onChain
-        });
+        // only if user specified that genesis state publishing is not needed we won't do this.
+        if (!opts.revocationOpts.genesisPublishingDisabled) {
+            await this.publishRevocationInfoByCredentialStatusType(did, opts.revocationOpts.type, {
+                rhsUrl: opts.revocationOpts.id,
+                onChain: opts.revocationOpts.onChain
+            });
+        }
         await this._credentialWallet.save(credential);
         return {
             did,
@@ -539,23 +550,13 @@ export class IdentityWallet {
             throw new Error(`there is no registered publisher to save  hash is not registered for ${credentialStatusType} is not registered`);
         }
         let nodes = [];
-        if (opts?.treeModel) {
-            nodes = await getNodesRepresentation(opts.revokedNonces, {
-                revocationTree: opts.treeModel.revocationTree,
-                claimsTree: opts.treeModel.claimsTree,
-                state: opts.treeModel.state,
-                rootsTree: opts.treeModel.rootsTree
-            }, opts.treeModel.state);
-        }
-        else {
-            const treeState = await this.getDIDTreeModel(issuerDID);
-            nodes = await getNodesRepresentation(opts?.revokedNonces, {
-                revocationTree: treeState.revocationTree,
-                claimsTree: treeState.claimsTree,
-                state: treeState.state,
-                rootsTree: treeState.rootsTree
-            }, treeState.state);
-        }
+        const tree = opts?.treeModel ?? (await this.getDIDTreeModel(issuerDID));
+        nodes = await getNodesRepresentation(opts?.revokedNonces ?? [], {
+            revocationTree: tree.revocationTree,
+            claimsTree: tree.claimsTree,
+            state: tree.state,
+            rootsTree: tree.rootsTree
+        }, tree.state);
         if (!nodes.length) {
             return;
         }

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

@@ -50,7 +50,7 @@ export type PackerParams = {
 export type ZKPPackerParams = PackerParams & {
     senderDID: DID;
     /** @deprecated */
-    profileNonce?: number;
+    profileNonce?: number | string;
     provingMethodAlg: ProvingMethodAlg;
 };
 /**

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

@@ -20,7 +20,7 @@ export declare const defineMerklizedRootPosition: (metadata?: SchemaMetadata, po
  * Returns profile DID based on did and profile nonce
  *
  * @param {DID} [did] - did from which profile will be derived
- * @param {number} [profileNonce] - profile nonce
+ * @param {number | string} [profileNonce] - profile nonce
  * @returns {DID}
  */
-export declare const generateProfileDID: (did: DID, profileNonce?: number) => DID;
+export declare const generateProfileDID: (did: DID, profileNonce?: number | string) => DID;

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

@@ -24,13 +24,19 @@ export type IdentityCreationOptions = {
 /**
  * Options for creating Auth BJJ credential
  * seed - seed to generate BJJ key pair
- * revocationOpts -
+ * revocationOpts
+ *  nonce - explicit revocation nonce to use
+ *  onChain - onchain status related option
+ *      txCallback - defines how the TransactionReceipt is handled
+ *      publishMode  - specifies the work of transaction polling type: sync / async / callback
+ *  genesisPublishingDisabled - genesis is publishing by default. Set `true` to prevent genesis publishing
  */
 export type AuthBJJCredentialCreationOptions = {
     revocationOpts: {
         id: string;
         type: CredentialStatusType;
         nonce?: number;
+        genesisPublishingDisabled?: boolean;
         onChain?: {
             txCallback?: (tx: TransactionReceipt) => Promise<void>;
             publishMode?: PublishMode;
@@ -109,11 +115,11 @@ export interface IIdentityWallet {
      * Creates profile based on genesis identifier
      *
      * @param {DID} did - identity to derive profile from
-     * @param {number} nonce - unique integer number to generate a profile
+     * @param {number |string} nonce - unique integer number to generate a profile
      * @param {string} verifier - verifier identity/alias in a string from
      * @returns `Promise<DID>` - profile did
      */
-    createProfile(did: DID, nonce: number, verifier: string): Promise<DID>;
+    createProfile(did: DID, nonce: number | string, verifier: string): Promise<DID>;
     /**
      * Generates a new key
      *
@@ -271,7 +277,7 @@ export interface IIdentityWallet {
      * @returns `{Promise<{nonce:number, genesisIdentifier: DID}>}`
      */
     getGenesisDIDMetadata(did: DID): Promise<{
-        nonce: number;
+        nonce: number | string;
         genesisDID: DID;
     }>;
     /**
@@ -388,11 +394,11 @@ export declare class IdentityWallet implements IIdentityWallet {
     }>;
     /** {@inheritDoc IIdentityWallet.getGenesisDIDMetadata} */
     getGenesisDIDMetadata(did: DID): Promise<{
-        nonce: number;
+        nonce: number | string;
         genesisDID: DID;
     }>;
     /** {@inheritDoc IIdentityWallet.createProfile} */
-    createProfile(did: DID, nonce: number, verifier: string): Promise<DID>;
+    createProfile(did: DID, nonce: number | string, verifier: string): Promise<DID>;
     /**
      *
      * gets profile identity by genesis identifiers

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

@@ -69,7 +69,6 @@ export interface IProofService {
      *
      * @param {Uint8Array} hash - challenge that will be signed
      * @param {DID} did - identity that will generate a proof
-     * @param {Number} profileNonce - identity that will generate a proof
      * @param {CircuitId} circuitId - circuit id for authentication
      * @returns `Promise<Uint8Array>`
      */

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

@@ -7,8 +7,8 @@ import { IIdentityWallet } from '../../identity';
 import { IStateStorage } from '../../storage';
 import { ICredentialWallet } from '../../credentials';
 export type DIDProfileMetadata = {
-    authProfileNonce: number;
-    credentialSubjectProfileNonce: number;
+    authProfileNonce: number | string;
+    credentialSubjectProfileNonce: number | string;
 };
 export type ProofGenerationOptions = {
     skipRevocation: boolean;

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

@@ -9,7 +9,7 @@ export type Identity = {
 /** Profile structure that can be used for profiles  storage */
 export type Profile = {
     id: string;
-    nonce: number;
+    nonce: number | string;
     genesisIdentifier: string;
     verifier: string;
 };

package/package.json

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