Feat/refactor module utils

packages/common-types/src/baseTypes/aggregateTypes.ts

@@ -47,7 +47,8 @@ export type RefreshMiddlewareMap = {
 };
 
 export type ReconstructKeyMiddlewareMap = {
-  [moduleName: string]: () => Promise<BN[]>;
+  // eslint-disable-next-line no-use-before-define
+  [moduleName: string]: (tkey: ITKeyApi) => Promise<BN[]>;
 };
 
 export type ShareSerializationMiddleware = {
@@ -267,7 +268,7 @@ export interface ITKeyApi {
     moduleName: string,
     middleware: (generalStore: unknown, oldShareStores: ShareStoreMap, newShareStores: ShareStoreMap) => unknown
   ): void;
-  _addReconstructKeyMiddleware(moduleName: string, middleware: () => Promise<Array<BN>>): void;
+  _addReconstructKeyMiddleware(moduleName: string, middleware: (tkey: ITKeyApi) => Promise<Array<BN>>): void;
   _addShareSerializationMiddleware(
     serialize: (share: BN, type: string) => Promise<unknown>,
     deserialize: (serializedShare: unknown, type: string) => Promise<BN>

packages/common-types/src/baseTypes/commonTypes.ts

@@ -45,6 +45,14 @@ export interface TorusServiceProviderArgs extends ServiceProviderArgs {
   nodePubKeys?: PointHex[];
 }
 
+export enum TkeyStatus {
+  NOT_INITIALIZED = "NOT_INITIALIZED",
+  // READ MODE
+  INITIALIZED = "INITIALIZED",
+  // WRITE MODE
+  RECONSTRUCTED = "RECONSTRUCTED",
+}
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type StringifiedType = Record<string, any>;
 

packages/core/src/core.ts

@@ -48,6 +48,7 @@ import {
   ShareStorePolyIDShareIndexMap,
   StringifiedType,
   TKeyArgs,
+  TkeyStatus,
   TkeyStoreItemType,
   toPrivKeyECC,
 } from "@tkey/common-types";
@@ -220,6 +221,20 @@ class ThresholdKey implements ITKey {
     throw CoreError.metadataUndefined();
   }
 
+  getTkeyStatus(): TkeyStatus {
+    try {
+      const keyDetails = this.getKeyDetails();
+      if (keyDetails.totalShares < keyDetails.threshold) {
+        // READ MODE
+        return TkeyStatus.INITIALIZED;
+      }
+      // WRITE MODE
+      return TkeyStatus.RECONSTRUCTED;
+    } catch {
+      return TkeyStatus.NOT_INITIALIZED;
+    }
+  }
+
   async initialize(params?: {
     withShare?: ShareStore;
     importKey?: BN;
@@ -232,7 +247,7 @@ class ThresholdKey implements ITKey {
     deviceTSSShare?: BN;
     deviceTSSIndex?: number;
     factorPub?: Point;
-  }): Promise<KeyDetails> {
+  }): Promise<KeyDetails & { deviceShare?: ShareStore; userShare?: ShareStore }> {
     // setup initial params/states
     const p = params || {};
 
@@ -287,7 +302,7 @@ class ThresholdKey implements ITKey {
           throw CoreError.default("key has not been generated yet");
         }
         // no metadata set, assumes new user
-        await this._initializeNewKey({
+        const result = await this._initializeNewKey({
           initializeModules: true,
           importedKey: importKey,
           delete1OutOf1: p.delete1OutOf1,
@@ -296,14 +311,44 @@ class ThresholdKey implements ITKey {
           const { factorEncs, factorPubs, tssPolyCommits } = await this._initializeNewTSSKey(this.tssTag, deviceTSSShare, factorPub, deviceTSSIndex);
           this.metadata.addTSSData({ tssTag: this.tssTag, tssNonce: 0, tssPolyCommits, factorPubs, factorEncs });
         }
-        return this.getKeyDetails();
+        const keyDetails = this.getKeyDetails();
+        return { ...keyDetails, deviceShare: result.deviceShare, userShare: result.userShare };
       }
       // else we continue with catching up share and metadata
       shareStore = ShareStore.fromJSON(rawServiceProviderShare);
     } else {
       throw CoreError.default("Input is not supported");
     }
 
+    return this.initializeWithShareStore({
+      shareStore,
+      transitionMetadata,
+      previouslyFetchedCloudMetadata,
+      previousLocalMetadataTransitions,
+      useTSS,
+      deviceTSSShare,
+      factorPub,
+    });
+  }
+
+  async initializeWithShareStore(params: {
+    shareStore: ShareStore;
+    transitionMetadata?: Metadata;
+    previouslyFetchedCloudMetadata?: Metadata;
+    previousLocalMetadataTransitions?: LocalMetadataTransitions;
+    useTSS?: boolean;
+    deviceTSSShare?: BN;
+    factorPub?: Point;
+  }) {
+    const { shareStore, transitionMetadata, previouslyFetchedCloudMetadata, previousLocalMetadataTransitions, useTSS, deviceTSSShare, factorPub } =
+      params;
+
+    const previousLocalMetadataTransitionsExists =
+      previousLocalMetadataTransitions && previousLocalMetadataTransitions[0].length > 0 && previousLocalMetadataTransitions[1].length > 0;
+    const reinitializing = transitionMetadata && previousLocalMetadataTransitionsExists; // are we reinitializing the SDK?
+    // in the case we're reinitializing whilst newKeyAssign has not been synced
+    const reinitializingWithNewKeyAssign = reinitializing && previouslyFetchedCloudMetadata === undefined;
+
     // We determine the latest metadata on the SDK and if there has been
     // needed transitions to include
     let currentMetadata: Metadata;
@@ -578,7 +623,7 @@ class ThresholdKey implements ITKey {
       await Promise.all(
         Object.keys(this._reconstructKeyMiddleware).map(async (x) => {
           if (Object.prototype.hasOwnProperty.call(this._reconstructKeyMiddleware, x)) {
-            const extraKeys = await this._reconstructKeyMiddleware[x]();
+            const extraKeys = await this._reconstructKeyMiddleware[x](this);
             returnObject[x] = extraKeys;
             returnObject.allKeys.push(...extraKeys);
           }
@@ -1471,7 +1516,7 @@ class ThresholdKey implements ITKey {
     this._refreshMiddleware[moduleName] = middleware;
   }
 
-  _addReconstructKeyMiddleware(moduleName: string, middleware: () => Promise<BN[]>): void {
+  _addReconstructKeyMiddleware(moduleName: string, middleware: (tkey: ITKeyApi) => Promise<BN[]>): void {
     this._reconstructKeyMiddleware[moduleName] = middleware;
   }