fix: update interface and comment

rename function name

Author: ieow

src/interfaces.ts

@@ -478,21 +478,44 @@ export interface ICoreKit {
   commitChanges(): Promise<void>;
 
   /**
-   * Create a signature for the given data.
+   * Create a SECP256K1 ECDSA signature for the given data.
+   * will throw if secp256k1 is not configured as supported keyType
+   * will thrwo if dkls lib is not added prior signing
    *
    * Options:
    * - hashed: The data is already hashed. Do not hash again. Only works for ecdsa-secp256k1.
    * - secp256k1Precompute: Provide a precomputed client for faster signing. Only works for ecdsa-secp256k1.
+   */
+  signECDSA(
+    data: Buffer,
+    opts?: {
+      hashed?: boolean;
+      secp256k1Precompute?: Secp256k1PrecomputedClient;
+    }
+  ): Promise<Buffer>;
+
+  /**
+   * Create a BIP340 signature for the given data.
+   * will throw if secp256k1 is not configured as supported keyType
+   * will thrwo if bip340 frost lib is not added prior signing
+   *
+   * Options:
    * - keyTweak: Provide a bip340 key tweak. Only works for bip340.
    */
-  // sign(
-  //   data: Buffer,
-  //   opts?: {
-  //     hashed?: boolean;
-  //     secp256k1Precompute?: Secp256k1PrecomputedClient;
-  //     keyTweak?: BN;
-  //   }
-  // ): Promise<Buffer>;
+  signBIP340(
+    data: Buffer,
+    opts?: {
+      keyTweak?: BN;
+    }
+  ): Promise<Buffer>;
+
+  /**
+   * Create a ED25519 signature for the given data.
+   * will throw if ed25519 is not configured as supported keyType
+   * will thrwo if ed25519 frost lib is not added prior signing
+   *
+   */
+  signED25519(data: Buffer): Promise<Buffer>;
 
   /**
    * WARNING: Use with caution. This will export the private signing key.

src/mpcCoreKit.ts

@@ -900,7 +900,7 @@ export class Web3AuthMPCCoreKit implements ICoreKit, IMPCContext {
     return Buffer.concat([sig.r, sig.s, Buffer.from([sig.v])]);
   }
 
-  public async signBip340(data: Uint8Array, opts?: { hashed?: boolean; keyTweak?: BN }) {
+  public async signBIP340(data: Uint8Array, opts?: { hashed?: boolean; keyTweak?: BN }) {
     if (!this.supportedCurveKeyTypes.has(KeyType.secp256k1)) {
       throw CoreKitError.default(`secp256k1 KeyTYpe is not supported, please configure secp256k1 curve key type `);
     }
@@ -922,7 +922,7 @@ export class Web3AuthMPCCoreKit implements ICoreKit, IMPCContext {
     return this.sign_frost({ data: Buffer.from(data), frostlib, keyTweak: opts?.keyTweak });
   }
 
-  public async signEd25519(data: Uint8Array) {
+  public async signED25519(data: Uint8Array) {
     if (!this.supportedCurveKeyTypes.has(KeyType.ed25519)) {
       throw CoreKitError.default(`ed25519 KeyTYpe is not supported, please configure ed25519 curve key type `);
     }

src/utils.ts

@@ -219,7 +219,7 @@ export function makeBip340Signer(kit: Web3AuthMPCCoreKit): Bip340Signer {
 
   return {
     sign: async (msgHash: Buffer) => {
-      return kit.signBip340(msgHash, { hashed: false });
+      return kit.signBIP340(msgHash, { hashed: false });
     },
     getPublic: async () => {
       const pk = Point.fromSEC1(secp256k1, kit.getPubKey(KeyType.secp256k1).toString("hex"));
@@ -234,7 +234,7 @@ export function makeEd25519Signer(kit: Web3AuthMPCCoreKit): Ed25519Signer {
   }
   return {
     sign: async (msgHash: Buffer) => {
-      return kit.signEd25519(msgHash);
+      return kit.signED25519(msgHash);
     },
     getPublic: async () => {
       return kit.getPubKeyEd25519();

tests/bip340.spec.ts

@@ -151,7 +151,7 @@ variable.forEach((testVariable) => {
       const msg = "hello world";
       const msgBuffer = Buffer.from(msg);
 
-      const signature = await coreKitInstance.signBip340(msgBuffer);
+      const signature = await coreKitInstance.signBIP340(msgBuffer);
       const pk = coreKitInstance.getPubKeyBip340();
       const valid = bip340.verify(signature, msgBuffer, pk);
       assert(valid);

tests/ed25519.spec.ts

@@ -148,7 +148,7 @@ variable.forEach((testVariable) => {
       const msg = "hello world";
       const msgBuffer = Buffer.from(msg);
 
-      const signature = ed25519().makeSignature((await coreKitInstance.signEd25519(msgBuffer)).toString("hex"));
+      const signature = ed25519().makeSignature((await coreKitInstance.signED25519(msgBuffer)).toString("hex"));
       const valid = ed25519().verify(msgBuffer, signature, coreKitInstance.getPubKeyEd25519());
       assert(valid);
     });

tests/multiCurveTest.spec.ts

@@ -56,14 +56,14 @@ describe("multiCurveTest", () => {
         expect(validsecp256k1).eq(true);
 
         instance.addTssLibs([frostBip340lib]);
-        const result2 = await instance.signBip340( Buffer.from(utf8ToBytes(message)), {hashed: false})
+        const result2 = await instance.signBIP340( Buffer.from(utf8ToBytes(message)), {hashed: false})
 
         const validb340 = bip340.verify(bytesToHex(result2), bytesToHex(utf8ToBytes(message)), bytesToHex(instance.getPubKeyBip340()));
         expect(validb340).eq(true);
 
 
         instance.addTssLibs([frostLib]);
-        const result3 = await instance.signEd25519(Buffer.from(message))
+        const result3 = await instance.signED25519(Buffer.from(message))
         const valided25519 = ed25519.verify(bytesToHex(result3), bytesToHex(Buffer.from(message)), bytesToHex( new Uint8Array(instance.getPubKeyEd25519()) ) )
         expect(valided25519).eq(true);