update profile nonce, so it can be number or string (#268)

* update profile nonce, so it can be number or string

* 1.19.0

* add validation check

package.json

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

src/iden3comm/types/packer.ts

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

src/identity/common.ts

@@ -45,11 +45,25 @@ export const 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}
  */
-export const generateProfileDID = (did: DID, profileNonce?: number): DID => {
+export const generateProfileDID = (did: DID, profileNonce?: number | string): DID => {
   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: number | string): boolean => {
+  try {
+    return BigInt(x).toString() === x.toString();
+  } catch {
+    return false; // conversion to BigInt failed, surely it is not a BigInt
+  }
+};

src/identity/identity-wallet.ts

@@ -169,11 +169,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
@@ -387,7 +387,7 @@ export interface IIdentityWallet {
    * @param {DID} did -  profile that has been derived or genesis identity
    * @returns `{Promise<{nonce:number, genesisIdentifier: DID}>}`
    */
-  getGenesisDIDMetadata(did: DID): Promise<{ nonce: number; genesisDID: DID }>;
+  getGenesisDIDMetadata(did: DID): Promise<{ nonce: number | string; genesisDID: DID }>;
 
   /**
    *
@@ -786,7 +786,7 @@ export class IdentityWallet implements IIdentityWallet {
   }
 
   /** {@inheritDoc IIdentityWallet.getGenesisDIDMetadata} */
-  async getGenesisDIDMetadata(did: DID): Promise<{ nonce: number; genesisDID: DID }> {
+  async getGenesisDIDMetadata(did: DID): Promise<{ nonce: number | string; genesisDID: DID }> {
     // check if it is a genesis identity
     const identity = await this._storage.identity.getIdentity(did.string());
 
@@ -802,7 +802,7 @@ export class IdentityWallet implements IIdentityWallet {
   }
 
   /** {@inheritDoc IIdentityWallet.createProfile} */
-  async createProfile(did: DID, nonce: number, verifier: string): Promise<DID> {
+  async createProfile(did: DID, nonce: number | string, verifier: string): Promise<DID> {
     const profileDID = generateProfileDID(did, nonce);
 
     const identityProfiles = await this._storage.identity.getProfilesByGenesisIdentifier(

src/proof/proof-service.ts

@@ -126,7 +126,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>`
    */

src/proof/provers/inputs-generator.ts

@@ -40,8 +40,8 @@ import {
 import { isEthereumIdentity } from '../../utils';
 
 export type DIDProfileMetadata = {
-  authProfileNonce: number;
-  credentialSubjectProfileNonce: number;
+  authProfileNonce: number | string;
+  credentialSubjectProfileNonce: number | string;
 };
 
 export type ProofGenerationOptions = {

src/storage/entities/identity.ts

@@ -11,7 +11,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;
 };