Merge branch '27-refator-encryptor' into 'dev'

Resolve "Refactor the packages to retrieve the message encryptor from external sources" Closes #27 See merge request ergo/rosen-bridge/sign-protocols!37
rosen-bridge · Nov 8, 2024 · aeec351 · aeec351
2 parents 790bba0 + 96ea1c3
commit aeec351
Show file tree

Hide file tree

Showing 19 changed files with 124 additions and 108 deletions.
diff --git a/.changeset/nine-colts-kneel.md b/.changeset/nine-colts-kneel.md
@@ -0,0 +1,8 @@
+---
+'@rosen-bridge/ergo-multi-sig': major
+'@rosen-bridge/communication': major
+'@rosen-bridge/detection': major
+'@rosen-bridge/tss': major
+---
+
+Refactor constructor interfaces, add messageEnc and remove unnecessary secrets
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# Rosen Bridge Sign Protocols
+
+A monorepo containing all the packages related to Rosen Bridge Signing process. It contains the following packages:
+
+1. [keygen-service](./services/keygen-service/README.md): Keygen service is a tool top of [tss-api](./services/tss-api/README.md) for setup keygen ceremony for new guards.
+2. [tss-api](./services/tss-api/README.md): A service for keygen, sign and regroup operations on eddsa and ecdsa protocols in threshold signature.
+3. [communication](./packages/communication/README.md): A package that abstractly manages communication between endpoints.
+4. [encryption](./packages/encryption/README.md): unify encryption interface.
+5. [detection](./packages/detection/README.md): A package that finds available endpoints in private network.
+6. [tss](./packages/tss/README.md): A package for building and validating TSS signatures.
+7. [ergo-multi-sig](./packages/ergo-multi-sig/README.md): A package that manage multi signature protocol for ergo network.
+
+For more info on how each of the packages works, refer to their specific page.
diff --git a/packages/communication/lib/Communicator.ts b/packages/communication/lib/Communicator.ts
@@ -5,7 +5,7 @@ import { guardMessageValidTimeoutDefault } from './const/const';
 
 export abstract class Communicator {
   protected logger: AbstractLogger;
-  protected signer: EncryptionHandler;
+  protected messageEnc: EncryptionHandler;
   private readonly submitMessage: (
     msg: string,
     peers: Array<string>,
@@ -21,13 +21,13 @@ export abstract class Communicator {
 
   protected constructor(
     logger: AbstractLogger,
-    signer: EncryptionHandler,
+    messageEnc: EncryptionHandler,
     submitMessage: (msg: string, peers: Array<string>) => unknown,
     guardPks: Array<string>,
     messageValidDurationSeconds?: number,
   ) {
     this.logger = logger;
-    this.signer = signer;
+    this.messageEnc = messageEnc;
     this.guardPks = guardPks;
     this.submitMessage = submitMessage;
     this.messageValidDuration = messageValidDurationSeconds
@@ -40,7 +40,7 @@ export abstract class Communicator {
    */
   protected getIndex = async () => {
     if (this.index === -1) {
-      const pk = await this.signer.getPk();
+      const pk = await this.messageEnc.getPk();
       this.index = this.guardPks.indexOf(pk);
     }
     return this.index;
@@ -66,8 +66,8 @@ export abstract class Communicator {
    * @param timestamp
    */
   signPayload = async (payload: any, timestamp: number) => {
-    const publicKey = await this.signer.getPk();
-    return await this.signer.sign(
+    const publicKey = await this.messageEnc.getPk();
+    return await this.messageEnc.sign(
       Communicator.generatePayloadToSign(payload, timestamp, publicKey),
     );
   };
@@ -92,7 +92,7 @@ export abstract class Communicator {
       )} to ${JSON.stringify(peers)}`,
     );
     timestamp = timestamp ? timestamp : this.getDate();
-    const publicKey = await this.signer.getPk();
+    const publicKey = await this.messageEnc.getPk();
     const payloadSign = await this.signPayload(payload, timestamp);
     const message: CommunicationMessage = {
       type: messageType,
@@ -142,7 +142,7 @@ export abstract class Communicator {
       return;
     }
     if (
-      !(await this.signer.verify(
+      !(await this.messageEnc.verify(
         Communicator.generatePayloadToSign(
           msg.payload,
           msg.timestamp,

diff --git a/packages/communication/tests/Comunicator.spec.ts b/packages/communication/tests/Comunicator.spec.ts
@@ -5,19 +5,23 @@ import { describe, expect, it, vi, beforeEach } from 'vitest';
 describe('Communicator', () => {
   let communicator: TestCommunicator;
   let mockSubmit = vi.fn();
-  let guardSigners: Array<EdDSA>;
+  let guardMessageEncs: Array<EdDSA>;
   const payload = { foo: 'bar' };
 
   beforeEach(async () => {
-    guardSigners = [];
+    guardMessageEncs = [];
     const guardPks: Array<string> = [];
     for (let index = 0; index < 10; index++) {
       const sk = new EdDSA(await EdDSA.randomKey());
-      guardSigners.push(sk);
+      guardMessageEncs.push(sk);
       guardPks.push(await sk.getPk());
     }
     mockSubmit = vi.fn();
-    communicator = new TestCommunicator(guardSigners[1], mockSubmit, guardPks);
+    communicator = new TestCommunicator(
+      guardMessageEncs[1],
+      mockSubmit,
+      guardPks,
+    );
   });
 
   describe('getDate', () => {
@@ -51,8 +55,8 @@ describe('Communicator', () => {
      */
     it('should call submit message', async () => {
       const currentTime = 1685683141;
-      const publicKey = await guardSigners[1].getPk();
-      const sign = await guardSigners[1].sign(
+      const publicKey = await guardMessageEncs[1].getPk();
+      const sign = await guardMessageEncs[1].sign(
         `${JSON.stringify(payload)}${currentTime}${publicKey}`,
       );
       vi.spyOn(Date, 'now').mockReturnValue(currentTime * 1000);
@@ -84,8 +88,8 @@ describe('Communicator', () => {
      */
     it('should pass arguments to process message function when sign is valid', async () => {
       const currentTime = 1685683142;
-      const publicKey = await guardSigners[2].getPk();
-      const sign = await guardSigners[2].sign(
+      const publicKey = await guardMessageEncs[2].getPk();
+      const sign = await guardMessageEncs[2].sign(
         `${JSON.stringify(payload)}${currentTime}${publicKey}`,
       );
       vi.spyOn(Date, 'now').mockReturnValue(currentTime * 1000);
@@ -120,15 +124,15 @@ describe('Communicator', () => {
      */
     it('should not call processMessage when signature is not valid', async () => {
       const currentTime = 1685683143;
-      const publicKey = await guardSigners[2].getPk();
-      const sign = await guardSigners[2].sign(
+      const publicKey = await guardMessageEncs[2].getPk();
+      const sign = await guardMessageEncs[2].sign(
         `${JSON.stringify(payload)}${currentTime}${publicKey}`,
       );
       vi.spyOn(Date, 'now').mockReturnValue(currentTime * 1000);
       const message = {
         type: 'message',
         payload: payload,
-        publicKey: await guardSigners[3].getPk(),
+        publicKey: await guardMessageEncs[3].getPk(),
         timestamp: currentTime,
         sign: sign,
         index: 3,
@@ -148,8 +152,8 @@ describe('Communicator', () => {
      */
     it('should not call processMessage when signer public key differ from index', async () => {
       const currentTime = 1685683144;
-      const publicKey = await guardSigners[2].getPk();
-      const sign = await guardSigners[2].sign(
+      const publicKey = await guardMessageEncs[2].getPk();
+      const sign = await guardMessageEncs[2].sign(
         `${JSON.stringify(payload)}${currentTime}${publicKey}`,
       );
       vi.spyOn(Date, 'now').mockReturnValue(currentTime * 1000);
@@ -177,8 +181,8 @@ describe('Communicator', () => {
      */
     it('should not call processMessage when message timed out', async () => {
       const currentTime = 1685683145;
-      const publicKey = await guardSigners[2].getPk();
-      const sign = await guardSigners[2].sign(
+      const publicKey = await guardMessageEncs[2].getPk();
+      const sign = await guardMessageEncs[2].sign(
         `${JSON.stringify(payload)}${currentTime - 60001}${publicKey}`,
       );
       vi.spyOn(Date, 'now').mockReturnValue(currentTime * 1000);

diff --git a/packages/detection/lib/GuardDetection.ts b/packages/detection/lib/GuardDetection.ts
@@ -39,7 +39,7 @@ export class GuardDetection extends Communicator {
   constructor(config: GuardDetectionConfig) {
     super(
       config.logger ? config.logger : new DummyLogger(),
-      config.signer,
+      config.messageEnc,
       config.submit,
       config.guardsPublicKey,
       config.messageValidDurationSeconds,
@@ -322,7 +322,7 @@ export class GuardDetection extends Communicator {
    */
   activeGuards = async (): Promise<Array<ActiveGuard>> => {
     const myActiveGuard: ActiveGuard = {
-      publicKey: await this.signer.getPk(),
+      publicKey: await this.messageEnc.getPk(),
       peerId: await this.getPeerId(),
     };
     return [

diff --git a/packages/detection/lib/interfaces/types.ts b/packages/detection/lib/interfaces/types.ts
@@ -10,7 +10,7 @@ export interface ActiveGuard {
 export interface GuardDetectionConfig {
   logger?: AbstractLogger;
   guardsPublicKey: string[];
-  signer: EncryptionHandler;
+  messageEnc: EncryptionHandler;
   submit: (msg: string, peers: Array<string>) => unknown;
   activeTimeoutSeconds?: number;
   heartbeatTimeoutSeconds?: number;

diff --git a/packages/detection/tests/GuardDetection.spec.ts b/packages/detection/tests/GuardDetection.spec.ts
@@ -12,16 +12,16 @@ import { describe, expect, it, vi, beforeEach } from 'vitest';
 describe('GuardDetection', () => {
   let detection: TestGuardDetection;
   let mockSubmit = vi.fn();
-  let guardSigners: Array<EdDSA>;
+  let guardMessageEncs: Array<EdDSA>;
 
   beforeEach(async () => {
     const signers = await generateSigners();
-    guardSigners = signers.guardSigners;
+    guardMessageEncs = signers.guardSigners;
     vi.resetAllMocks();
     mockSubmit = vi.fn();
     detection = new TestGuardDetection({
       submit: mockSubmit,
-      signer: guardSigners[0],
+      messageEnc: guardMessageEncs[0],
       guardsPublicKey: signers.guardPks,
       getPeerId: () => Promise.resolve('myPeerId'),
     });
@@ -241,7 +241,7 @@ describe('GuardDetection', () => {
       const info = detection.getInfo();
       const currentTime = 1685683141;
       vi.setSystemTime(new Date(currentTime * 1000));
-      const myPk = await guardSigners[0].getPk();
+      const myPk = await guardMessageEncs[0].getPk();
       info.forEach((item, index) => {
         if (item.publicKey !== myPk) {
           item.lastUpdate = currentTime;
@@ -294,7 +294,7 @@ describe('GuardDetection', () => {
       const callback = vi.fn();
       await detection.register(
         'peerId-1',
-        await guardSigners[1].getPk(),
+        await guardMessageEncs[1].getPk(),
         callback,
       );
       await expect(callback).toHaveBeenCalledTimes(1);
@@ -320,7 +320,7 @@ describe('GuardDetection', () => {
       const callback = vi.fn();
       await detection.register(
         'peerId-1',
-        await guardSigners[1].getPk(),
+        await guardMessageEncs[1].getPk(),
         callback,
       );
       await expect(callback).toHaveBeenCalledTimes(1);
@@ -340,7 +340,7 @@ describe('GuardDetection', () => {
     it('should call send message if guard is not in active state', async () => {
       await detection.register(
         'peerId-1',
-        await guardSigners[1].getPk(),
+        await guardMessageEncs[1].getPk(),
         vi.fn(),
       );
       expect(mockSubmit).toHaveBeenCalledTimes(1);
@@ -368,12 +368,12 @@ describe('GuardDetection', () => {
       vi.spyOn(detection as any, 'addNonce').mockReturnValue('new nonce');
       await detection.mockedHandleRegister(
         { nonce: 'random nonce' },
-        await guardSigners[1].getPk(),
+        await guardMessageEncs[1].getPk(),
         1,
       );
       expect(mockSubmit).toHaveBeenCalledTimes(1);
       expect(mockSubmit).toHaveBeenCalledWith(expect.any(String), [
-        await guardSigners[1].getPk(),
+        await guardMessageEncs[1].getPk(),
       ]);
       const msg = JSON.parse(mockSubmit.mock.calls[0][0]);
       expect(msg.type).toEqual(approveMessage);

diff --git a/packages/ergo-multi-sig/lib/MultiSigHandler.ts b/packages/ergo-multi-sig/lib/MultiSigHandler.ts
@@ -12,7 +12,6 @@ import {
 } from './types';
 import { turnTime } from './const';
 import { Semaphore } from 'await-semaphore';
-import { ECDSA } from '@rosen-bridge/encryption';
 import { MultiSigUtils } from './MultiSigUtils';
 import { AbstractLogger, DummyLogger } from '@rosen-bridge/abstract-logger';
 import { ActiveGuard, GuardDetection } from '@rosen-bridge/detection';
@@ -33,7 +32,7 @@ export class MultiSigHandler extends Communicator {
   constructor(config: ErgoMultiSigConfig) {
     super(
       config.logger ? config.logger : new DummyLogger(),
-      new ECDSA(config.secretHex),
+      config.messageEnc,
       config.submit,
       config.guardsPk,
     );

diff --git a/packages/ergo-multi-sig/lib/types.ts b/packages/ergo-multi-sig/lib/types.ts
@@ -2,6 +2,7 @@ import * as wasm from 'ergo-lib-wasm-nodejs';
 import { AbstractLogger } from '@rosen-bridge/abstract-logger';
 import { MultiSigUtils } from './MultiSigUtils';
 import { GuardDetection } from '@rosen-bridge/detection';
+import { EncryptionHandler } from '@rosen-bridge/encryption';
 
 interface Signer {
   id?: string;
@@ -107,6 +108,7 @@ export enum MessageType {
 interface ErgoMultiSigConfig {
   logger?: AbstractLogger;
   multiSigUtilsInstance: MultiSigUtils;
+  messageEnc: EncryptionHandler;
   secretHex: string;
   txSignTimeout: number;
   multiSigFirstSignDelay?: number;

diff --git a/packages/ergo-multi-sig/tests/MultiSigUtils.spec.ts b/packages/ergo-multi-sig/tests/MultiSigUtils.spec.ts
@@ -1,13 +1,6 @@
 import { MultiSigUtils } from '../lib';
 import { describe, expect, it } from 'vitest';
-import { boxJs } from './testData';
-import {
-  getChangeBoxJs,
-  getOutBoxJs,
-  jsToReducedTx,
-} from './testUtils/txUtils';
 import * as wasm from 'ergo-lib-wasm-nodejs';
-import { ErgoBox } from 'ergo-lib-wasm-nodejs';
 import fs from 'fs';
 import path from 'path';
 import { mockedErgoStateContext } from '@rosen-bridge/ergo-multi-sig/tests/testData';

diff --git a/packages/ergo-multi-sig/tests/testUtils/TestUtils.ts b/packages/ergo-multi-sig/tests/testUtils/TestUtils.ts
@@ -28,10 +28,10 @@ class TestUtils {
     });
     const pubKeys = pks ? pks : testPubs;
     const secretInd = testSecrets.indexOf(secret);
-    const ecdsaSigner = new ECDSA(testSecrets[secretInd]);
+    const ecdsaMessageEnc = new ECDSA(testSecrets[secretInd]);
     const guardDetection = new GuardDetection({
       guardsPublicKey: pubKeys,
-      signer: ecdsaSigner,
+      messageEnc: ecdsaMessageEnc,
       submit: submit,
       getPeerId: () => Promise.resolve(testPubs[secretInd]),
     });
@@ -43,6 +43,7 @@ class TestUtils {
 
     return new MultiSigHandler({
       multiSigUtilsInstance: multiSigUtilsInstance,
+      messageEnc: ecdsaMessageEnc,
       secretHex: secret,
       txSignTimeout: TestConfigs.txSignTimeout,
       multiSigFirstSignDelay: TestConfigs.multiSigFirstSignDelay,

diff --git a/packages/tss/lib/tss/EcdsaSigner.ts b/packages/tss/lib/tss/EcdsaSigner.ts
@@ -1,12 +1,13 @@
-import { ECDSA } from '@rosen-bridge/encryption';
-import { EcdsaConfig, Sign, SignResult } from '../types/signer';
+import { Sign, SignerConfig, SignResult } from '../types/signer';
 import { TssSigner } from './TssSigner';
 
 export class EcdsaSigner extends TssSigner {
-  constructor(config: EcdsaConfig) {
+  constructor(config: SignerConfig) {
     super({
       logger: config.logger,
       guardsPk: config.guardsPk,
+      signingCrypto: 'ecdsa',
+      messageEnc: config.messageEnc,
       submitMsg: config.submitMsg,
       messageValidDuration: config.messageValidDuration,
       timeoutSeconds: config.timeoutSeconds,
@@ -20,7 +21,6 @@ export class EcdsaSigner extends TssSigner {
       thresholdTTL: config.thresholdTTL,
       responseDelay: config.responseDelay,
       signPerRoundLimit: config.signPerRoundLimit,
-      signer: new ECDSA(config.secret),
     });
   }
 

diff --git a/packages/tss/lib/tss/EddsaSigner.ts b/packages/tss/lib/tss/EddsaSigner.ts
@@ -1,12 +1,13 @@
-import { EdDSA } from '@rosen-bridge/encryption';
-import { EddsaConfig, Sign, SignResult } from '../types/signer';
+import { Sign, SignerConfig, SignResult } from '../types/signer';
 import { TssSigner } from './TssSigner';
 
 export class EddsaSigner extends TssSigner {
-  constructor(config: EddsaConfig) {
+  constructor(config: SignerConfig) {
     super({
       logger: config.logger,
       guardsPk: config.guardsPk,
+      signingCrypto: 'eddsa',
+      messageEnc: config.messageEnc,
       submitMsg: config.submitMsg,
       messageValidDuration: config.messageValidDuration,
       timeoutSeconds: config.timeoutSeconds,
@@ -20,7 +21,6 @@ export class EddsaSigner extends TssSigner {
       thresholdTTL: config.thresholdTTL,
       responseDelay: config.responseDelay,
       signPerRoundLimit: config.signPerRoundLimit,
-      signer: new EdDSA(config.secret),
     });
   }