feat: multi curve support by ieow · Pull Request #216 · Web3Auth/mpc-core-kit

ieow · 2025-02-10T07:55:26Z

integrate multicurve tkey
tests passed

Motivation and Context

Jira Link:

Description

How has this been tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My code follows the code style of this project. (run lint)
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.
My code requires a db migration.

integrate multicurve tkey tests passed

fix tests add multicurve tests

matthiasgeihs · 2025-02-25T17:46:08Z

package.json

+    "@tkey/common-types": "file:../tkey/packages/common-types",
+    "@tkey/core": "file:../tkey/packages/core/tkey-core-15.2.1-alpha.0.tgz",
    "@tkey/share-serialization": "^15.1.0",
-    "@tkey/storage-layer-torus": "^15.1.0",
-    "@tkey/tss": "^15.1.0",
+    "@tkey/storage-layer-torus": "file:../tkey/packages/storage-layer-torus/tkey-storage-layer-torus-15.2.1-alpha.0.tgz",
+    "@tkey/tss": "file:../tkey/packages/tss/tkey-tss-15.2.1-alpha.0.tgz",


matthiasgeihs · 2025-02-25T17:46:14Z

package.json

    "@toruslabs/openlogin-utils": "^8.2.1",
-    "@toruslabs/torus.js": "15.2.0-alpha.0",
    "@toruslabs/session-manager": "^3.1.0",
+    "@toruslabs/torus.js": "file:../torus.js/toruslabs-torus.js-15.1.1.tgz",


matthiasgeihs · 2025-02-25T17:46:32Z

tests/backwardCompatible.spec.ts

+      // console.log(coreKitInstance.tKey.metadata)
+      // console.log(coreKitInstance.state);


matthiasgeihs

as mentioned in the other PR, I think it would be better to merge the refactors into this one here, before we do further reviews.

also, i think it would be great to have an intro session with @ieow and the reviewers to get an overview of the changes, since all changes together make for a relatively large PR.

matthiasgeihs · 2025-02-25T20:43:55Z

src/interfaces.ts

+  /**
+   * @defaultValue `false`
+   * Set this flag to true to use the legacy flag for signing
+   * legacy flag do not support multicurve mode
+   * legacy ed25519 customAuth is only supported in legacy mode
+   * Note: This option is set to false by default.
+   */


Suggested change

/**

* @defaultValue `false`

* Set this flag to true to use the legacy flag for signing

* legacy flag do not support multicurve mode

* legacy ed25519 customAuth is only supported in legacy mode

* Note: This option is set to false by default.

*/

/**

* @defaultValue `false`

* Set this flag to true to use the legacy mode.

* Legacy mode does not support multi-curve.

* CustomAuth with key type ed25519 is only supported in legacy mode.

* Note: This option is set to false by default.

*/

I like that this has a comment, but it's a bit raw. could add some punctuation and revise language.

matthiasgeihs · 2025-02-25T20:50:50Z

src/mpcCoreKit.ts

+  public setTkeyType(tkeyType: KeyType) {
+    // check tkeyType is supported by tssLib
+    if (!this.supportedCurveKeyTypes.has(tkeyType)) throw CoreError.default("KeyType not supported, please provide valid tssLib");
+    this._keyType = tkeyType;
+  }


You don't need this. Key type can be derived from sig type.

matthiasgeihs · 2025-02-25T20:52:11Z

src/mpcCoreKit.ts

    }
  ): Promise<Buffer> {
-    this.wasmLib = await this.loadTssWasm();
+    // this.wasmLib = await this.loadTssWasm();


matthiasgeihs · 2025-02-25T20:52:23Z

src/mpcCoreKit.ts

    const tkeyDetails = this.tKey.getKeyDetails();
-    const tssPubKey = this.state.tssPubKey ? Point.fromSEC1(this.tkey.tssCurve, this.state.tssPubKey.toString("hex")) : undefined;
+    const tssCurve = getKeyCurve(this.keyType);
+    // TODO: fix me, should remove tssPubKey from state


address and remove

matthiasgeihs · 2025-02-25T20:53:21Z

src/mpcCoreKit.ts

+  // private async importTssKey(tssKey: string, factorPub: Point, newTSSIndex: TssShareType = TssShareType.DEVICE): Promise<void> {
+  //   if (!this.state.signatures) {
+  //     throw CoreKitError.signaturesNotPresent("Signatures not present in state when importing tss key.");
+  //   }

-    await this.tKey.importTssKey(
-      { tag: this.tKey.tssTag, importKey: Buffer.from(tssKey, "hex"), factorPub, newTSSIndex },
-      { authSignatures: this.state.signatures }
-    );
-  }
+  //   const keyType = this._keyType
+  //   await this.tKey.importTssKey(
+  //     { tssTag: this.tKey.tssTag, importKey: Buffer.from(tssKey, "hex"), factorPubs: [factorPub], newTSSIndexes: [newTSSIndex], tssKeyType: keyType },
+  //     { authSignatures: this.state.signatures }
+  //   );
+  // }


huggingbot · 2025-02-26T07:06:53Z

tests/ed25519.spec.ts

-  await coreKitInstance.tKey.getTSSShare(new BN(factorkey.factorKey, "hex"), {
-    accountIndex,
-  });
+  await coreKitInstance.getTssShare(new BN(factorkey.factorKey, "hex") ,accountIndex);


nit: formatting ,accountIndex

huggingbot · 2025-02-26T07:13:37Z

tests/sessionTime.spec.ts

        }
      });

+      console.log(coreKitInstance.keyType)


console log to be removed

huggingbot · 2025-02-26T07:16:05Z

tests/multiCurveTest.ts

+
+
+        const recoverFactor = await instance.enableMFA({})
+        console.log(recoverFactor);


console log to be removed

huggingbot · 2025-02-26T09:47:28Z

tests/factors.spec.ts

+import { AsyncMemoryStorage, criticalResetAccount, mockLogin } from "./setup";
+import { getKeyCurve } from "@toruslabs/torus.js";
+import { randomId } from "@toruslabs/customauth";
+import log  from "loglevel";


nit: formatting

huggingbot · 2025-02-26T09:47:36Z

tests/factors.spec.ts

  storage?: IAsyncStorage | IStorage;
  email: string;
  tssLib?: TssLibType;
+  resetAccount? : false


nit: formatting

huggingbot · 2025-02-26T09:48:12Z

tests/factors.spec.ts

  async function beforeTest() {
+    if (testVariable.resetAccount === false) {
+      log.debug("skipping reset account");
+      return ;


nit: formatting

huggingbot · 2025-02-26T09:48:26Z

tests/factors.spec.ts

  if (!kit.supportsAccountIndex) {
    indices = indices.filter((i) => i === 0);
  }
+  const tssCurve = getKeyCurve(kit.keyType)


nit: formatting ;

huggingbot · 2025-02-26T09:49:28Z

tests/multiCurveTest.ts

+        instance.setSigType("ed25519")
+        instance.setTkeyType(KeyType.ed25519)
+        const result3 = await instance.sign(Buffer.from(message), { hashed: false })
+        const valided25519 = ed25519.verify(bytesToHex(result3), bytesToHex(Buffer.from(message)), bytesToHex( new Uint8Array(instance.getPubKeyEd25519()) ) )


nit: formatting

huggingbot · 2025-02-26T09:55:32Z

adding this comment to highlight the formatting issues as there are too many of them to be mentioned individually

huggingbot · 2025-02-26T10:09:56Z

src/mpcCoreKit.ts

+    // check tkeyType is supported by tssLib
+    if (!this.supportedSigTypes.has(sigType)) throw CoreError.default("SigType not supported, please provide valid tssLib");
+    this._sigType = sigType;
+  }


keyType should be updated with sigType for consistency

huggingbot · 2025-02-26T10:38:42Z

src/mpcCoreKit.ts

+    if (this.options.legacyFlag) {
+      // Check for existing curve in tssData for legacy mode
+      const tssData = this.getTssData({ skipThrow: true });
+      if (!tssData) throw CoreKitError.default("Legacy mode only support single curve, please congfiure with correct keyType");


shouldn't we also check for tssData's existence in non-legacy mode?

huggingbot · 2025-02-26T10:46:54Z

src/mpcCoreKit.ts

+    if (this.options.legacyFlag) {
+      // Check for existing curve in tssData for legacy mode
+      const tssData = this.getTssData({ skipThrow: true });
+      if (!tssData) throw CoreKitError.default("Legacy mode only support single curve, please congfiure with correct keyType");


shouldn't we check for tssData's existence in non-legacy mode?

huggingbot · 2025-02-26T11:29:02Z

src/mpcCoreKit.ts

+      this.supportedSigTypes.add(tssLibItem.sigType as SigType);
+    });
+    this._keyType = options.tssLibs[0].keyType as KeyType;
+    this._sigType = options.tssLibs[0].sigType as SigType;


why are these only storing a single key type and sig type?

ieow · 2025-02-26T17:14:19Z

Sorry for the confusion.
It was previous decided to go with the direction of pr #217
need to close this pr

ieow added 2 commits February 7, 2025 19:51

feat: initial commit

e61342e

integrate multicurve tkey tests passed

fix: add randomId verifier testcases

9a25f60

ieow changed the title ~~feat: initial commit~~ feat: multi curve support Feb 10, 2025

fix: enable multicurve

b80ad8a

fix tests add multicurve tests

ieow marked this pull request as ready for review February 12, 2025 02:45

matthiasgeihs self-requested a review February 25, 2025 17:45

matthiasgeihs requested changes Feb 25, 2025

View reviewed changes

matthiasgeihs self-requested a review February 25, 2025 17:48

matthiasgeihs requested changes Feb 25, 2025

View reviewed changes

huggingbot reviewed Feb 26, 2025

View reviewed changes

tests/sessionTime.spec.ts

}

});

console.log(coreKitInstance.keyType)

Copy link

Contributor

huggingbot Feb 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

console log to be removed

huggingbot reviewed Feb 26, 2025

View reviewed changes

ieow closed this Feb 26, 2025

		// console.log(coreKitInstance.tKey.metadata)
		// console.log(coreKitInstance.state);



		const recoverFactor = await instance.enableMFA({})
		console.log(recoverFactor);

Conversation

ieow commented Feb 10, 2025

Motivation and Context

Description

How has this been tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matthiasgeihs left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

huggingbot commented Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

huggingbot Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ieow commented Feb 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

huggingbot commented Feb 26, 2025 •

edited

Loading

huggingbot Feb 26, 2025 •

edited

Loading