refactor: add types for extra params

.gitignore

@@ -104,3 +104,4 @@ dist
 .tern-port
 
 .env.test
+**/*.DS_Store

src/TorusUtilsExtraParams.ts

@@ -0,0 +1,23 @@
+export interface TorusUtilsExtraParams {
+  nonce?: string; // farcaster
+
+  message?: string; // farcaster
+
+  signature?: string; // farcaster, passkey, webauthn
+
+  clientDataJson?: string; // passkey, webauthn
+
+  authenticatorData?: string; // passkey, webauhn
+
+  publicKey?: string; // passkey, webauthn
+
+  challenge?: string; // passkey, webauthn
+
+  rpOrigin?: string; // passkey, webauthn
+
+  rpId?: string; // passkey, webauthn
+
+  session_token_exp_second?: number;
+
+  timestamp?: number; // Signature
+}

src/helpers/nodeUtils.ts

@@ -26,6 +26,7 @@ import {
 } from "../interfaces";
 import log from "../loglevel";
 import { Some } from "../some";
+import { TorusUtilsExtraParams } from "../TorusUtilsExtraParams";
 import { calculateMedian, getProxyCoordinatorEndpointIndex, kCombinations, normalizeKeysResult, retryCommitment, thresholdSame } from "./common";
 import {
   derivePubKey,
@@ -174,7 +175,7 @@ export async function retrieveOrImportShare(params: {
   overrideExistingKey: boolean;
   nodePubkeys: INodePub[];
   newImportedShares?: ImportedShare[];
-  extraParams: Record<string, unknown>;
+  extraParams: TorusUtilsExtraParams;
 }): Promise<TorusKey> {
   const {
     legacyMetadataHost,

src/torus.ts

@@ -34,6 +34,7 @@ import {
   VerifierParams,
 } from "./interfaces";
 import log from "./loglevel";
+import { TorusUtilsExtraParams } from "./TorusUtilsExtraParams";
 
 // Implement threshold logic wrappers around public APIs
 // of Torus nodes to handle malicious node responses
@@ -117,7 +118,7 @@ class Torus {
     verifierParams: VerifierParams,
     idToken: string,
     nodePubkeys: INodePub[],
-    extraParams: Record<string, unknown> = {},
+    extraParams: TorusUtilsExtraParams = {},
     useDkg?: boolean
   ): Promise<TorusKey> {
     if (nodePubkeys.length === 0) {
@@ -144,6 +145,11 @@ class Torus {
     if (!shouldUseDkg && nodePubkeys.length === 0) {
       throw new Error("nodePubkeys param is required");
     }
+
+    if (!extraParams.session_token_exp_second) {
+      extraParams.session_token_exp_second = Torus.sessionTime;
+    }
+
     return retrieveOrImportShare({
       legacyMetadataHost: this.legacyMetadataHost,
       serverTimeOffset: this.serverTimeOffset,
@@ -162,10 +168,7 @@ class Torus {
       newImportedShares: [],
       overrideExistingKey: false,
       nodePubkeys,
-      extraParams: {
-        ...extraParams,
-        session_token_exp_second: Torus.sessionTime,
-      },
+      extraParams,
     });
   }
 
@@ -186,12 +189,16 @@ class Torus {
     verifierParams: VerifierParams,
     idToken: string,
     newPrivateKey: string,
-    extraParams: Record<string, unknown> = {}
+    extraParams: TorusUtilsExtraParams = {}
   ): Promise<TorusKey> {
     if (endpoints.length !== nodeIndexes.length) {
       throw new Error(`length of endpoints array must be same as length of nodeIndexes array`);
     }
 
+    if (!extraParams.session_token_exp_second) {
+      extraParams.session_token_exp_second = Torus.sessionTime;
+    }
+
     let privKeyBuffer;
 
     if (this.keyType === KEY_TYPE.SECP256K1) {
@@ -218,6 +225,7 @@ class Torus {
         throw new Error("invalid shares data for ed25519 key, public key is not matching after generating shares");
       }
     }
+
     return retrieveOrImportShare({
       legacyMetadataHost: this.legacyMetadataHost,
       serverTimeOffset: this.serverTimeOffset,
@@ -236,10 +244,7 @@ class Torus {
       overrideExistingKey: true,
       newImportedShares: sharesData,
       nodePubkeys,
-      extraParams: {
-        ...extraParams,
-        session_token_exp_second: Torus.sessionTime,
-      },
+      extraParams,
     });
   }