feat: add Firo chain support to rosen-service

- Add `@rosen-bridge/firo-scanner` and
  `@rosen-bridge/firo-observation-extractor` as dependencies.
- Wire up a new `FiroRpcScanner` in `scanner-service`, reading from the
  configured Firo RPC node using a failover connector manager.
- Register `FiroRpcObservationExtractor` for the lock address.
- Register the `firo-extractor` event-trigger extractor on the Ergo
  scanner.
- Register a Firo scanner-sync health check
  (`firoScannerWarnDiff` / `firoScannerCriticalDiff`).
- Pass the Firo calculator config (addresses + `explorerUrl`) to
  `AssetCalculator`.
- Add `firo` network section plus health-check thresholds and
  `calculator.addresses.firo` defaults to `config/default.yaml`.
- Add `FIRO_SCANNER_INTERVAL`, `FIRO_SCANNER_LOGGER_NAME`, and
  `FIRO_BLOCK_TIME` constants.

Part of the RCS-003 Bridge Expansion Kit for Firo. Builds on the Firo
asset-calculator integration.

Author: reubenyap

.changeset/firo-rosen-service.md

@@ -0,0 +1,17 @@
+---
+'@rosen-bridge/rosen-service': minor
+---
+
+Add Firo chain support to rosen-service
+
+- Add `@rosen-bridge/firo-scanner` and `@rosen-bridge/firo-observation-extractor`
+  as dependencies.
+- Wire up a new `FiroRpcScanner` in `scanner-service`, reading from the
+  configured Firo RPC node.
+- Register `FiroRpcObservationExtractor` for the lock address.
+- Register the `firo-extractor` event-trigger extractor on the Ergo scanner.
+- Register a Firo scanner-sync health check.
+- Pass the Firo calculator config (addresses + `explorerUrl`) to
+  `AssetCalculator`.
+- Add `firo` network section plus health-check thresholds and
+  `calculator.addresses.firo` defaults to `config/default.yaml`.

apps/rosen-service/config/default.yaml

@@ -70,6 +70,21 @@ doge:
     # - url:
     #   username:
     #   password:
+firo:
+  addresses:
+    lock:
+    eventTrigger:
+    permit:
+    fraud:
+    commitment:
+  tokens:
+    rwt:
+  initialHeight:
+  explorerUrl: https://explorer.firo.org
+  rpc:
+    url:
+    username:
+    password:
 ethereum:
   addresses:
     lock:
@@ -107,6 +122,7 @@ calculator:
     doge: []
     ethereum: []
     binance: []
+    firo: []
 healthCheck:
   ergoScannerWarnDiff: 3
   ergoScannerCriticalDiff: 5
@@ -120,6 +136,8 @@ healthCheck:
   ethereumScannerCriticalDiff: 5
   binanceScannerWarnDiff: 3
   binanceScannerCriticalDiff: 5
+  firoScannerWarnDiff: 3
+  firoScannerCriticalDiff: 5
   interval: 60 # health check update interval (in seconds)
   duration: 600 # log duration time check (in seconds)
   maxAllowedErrorCount: 1 # maximum allowed error log lines

apps/rosen-service/package.json

@@ -38,6 +38,8 @@
     "@rosen-bridge/ergo-scanner": "^1.0.2",
     "@rosen-bridge/evm-observation-extractor": "^6.0.3",
     "@rosen-bridge/evm-scanner": "^1.0.2",
+    "@rosen-bridge/firo-observation-extractor": "^0.1.2",
+    "@rosen-bridge/firo-scanner": "^0.1.1",
     "@rosen-bridge/health-check": "^8.0.0",
     "@rosen-bridge/log-level-check": "^4.0.0",
     "@rosen-bridge/scanner-interfaces": "^0.2.2",

apps/rosen-service/src/calculator/calculator-service.ts

@@ -78,6 +78,10 @@ const start = async () => {
       addresses: config.calculator.addresses.doge,
       blockcypherUrl: config.doge.blockcypherUrl,
     },
+    {
+      addresses: config.calculator.addresses.firo,
+      explorerUrl: config.firo.explorerUrl,
+    },
     dataSource,
     logger,
   );

apps/rosen-service/src/configs.ts

@@ -144,6 +144,23 @@ const getConfig = () => {
           }>
         >('doge.rpcConnections'),
       },
+      firo: {
+        addresses: {
+          lock: nodeConfig.get<string>('firo.addresses.lock'),
+          eventTrigger: nodeConfig.get<string>('firo.addresses.eventTrigger'),
+          permit: nodeConfig.get<string>('firo.addresses.permit'),
+          fraud: nodeConfig.get<string>('firo.addresses.fraud'),
+          commitment: nodeConfig.get<string>('firo.addresses.commitment'),
+        },
+        initialHeight: nodeConfig.get<number>('firo.initialHeight'),
+        tokens: {
+          rwt: nodeConfig.get<string>('firo.tokens.rwt'),
+        },
+        explorerUrl: nodeConfig.get<string>('firo.explorerUrl'),
+        rpcUrl: nodeConfig.get<string>('firo.rpc.url'),
+        rpcUsername: getOptionalString('firo.rpc.username'),
+        rpcPassword: getOptionalString('firo.rpc.password'),
+      },
       postgres: {
         url: nodeConfig.get<string>('postgres.url'),
         logging: nodeConfig.get<boolean>('postgres.logging'),
@@ -160,6 +177,7 @@ const getConfig = () => {
           ethereum: nodeConfig.get<string[]>('calculator.addresses.ethereum'),
           binance: nodeConfig.get<string[]>('calculator.addresses.binance'),
           doge: nodeConfig.get<string[]>('calculator.addresses.doge'),
+          firo: nodeConfig.get<string[]>('calculator.addresses.firo'),
         },
         interval: nodeConfig.get<number>('calculator.interval'),
       },
@@ -200,6 +218,12 @@ const getConfig = () => {
         binanceScannerCriticalDiff: nodeConfig.get<number>(
           'healthCheck.binanceScannerCriticalDiff',
         ),
+        firoScannerWarnDiff: nodeConfig.get<number>(
+          'healthCheck.firoScannerWarnDiff',
+        ),
+        firoScannerCriticalDiff: nodeConfig.get<number>(
+          'healthCheck.firoScannerCriticalDiff',
+        ),
         updateInterval: nodeConfig.get<number>('healthCheck.interval'),
         logDuration: nodeConfig.get<number>('healthCheck.duration'),
         errorLogAllowedCount: nodeConfig.get<number>(

apps/rosen-service/src/constants.ts

@@ -6,18 +6,21 @@ export const BITCOIN_SCANNER_INTERVAL = 10 * 60 * 1000;
 export const DOGE_SCANNER_INTERVAL = 60 * 1000;
 export const ETHEREUM_SCANNER_INTERVAL = 60 * 1000;
 export const BINANCE_SCANNER_INTERVAL = 10 * 1000;
+export const FIRO_SCANNER_INTERVAL = 2 * 60 * 1000;
 
 export const ERGO_SCANNER_LOGGER_NAME = 'ergoScanner';
 export const CARDANO_SCANNER_LOGGER_NAME = 'cardanoScanner';
 export const BITCOIN_SCANNER_LOGGER_NAME = 'bitcoinScanner';
 export const DOGE_SCANNER_LOGGER_NAME = 'dogeScanner';
 export const ETHEREUM_SCANNER_LOGGER_NAME = 'ethereumScanner';
 export const BINANCE_SCANNER_LOGGER_NAME = 'binanceScanner';
+export const FIRO_SCANNER_LOGGER_NAME = 'firoScanner';
 export const ERGO_BLOCK_TIME = 120;
 export const CARDANO_BLOCK_TIME = 20;
 export const BITCOIN_BLOCK_TIME = 600;
 export const ETHEREUM_BLOCK_TIME = 12;
 export const BINANCE_BLOCK_TIME = 3;
 export const DOGE_BLOCK_TIME = 60;
+export const FIRO_BLOCK_TIME = 150;
 
 export const BITCOIN_RUNES_CONFIG_KEY = 'bitcoinRunes';

apps/rosen-service/src/event-trigger/event-trigger-service.ts

@@ -29,6 +29,9 @@ const binanceEventTriggerExtractorLogger = logger.child(
 const dogeEventTriggerExtractorLogger = logger.child(
   'dogeEventTriggerExtractor',
 );
+const firoEventTriggerExtractorLogger = logger.child(
+  'firoEventTriggerExtractor',
+);
 
 /**
  * register event trigger extractors for all chains
@@ -113,13 +116,25 @@ export const registerExtractors = async (scanner: ErgoScanner) => {
       configs.binance.addresses.fraud,
       binanceEventTriggerExtractorLogger,
     );
+    const firoEventTriggerExtractor = new EventTriggerExtractor(
+      'firo-extractor',
+      dataSource,
+      ErgoNetworkType.Explorer,
+      configs.ergo.explorerUrl,
+      configs.firo.addresses.eventTrigger,
+      configs.firo.tokens.rwt,
+      configs.firo.addresses.permit,
+      configs.firo.addresses.fraud,
+      firoEventTriggerExtractorLogger,
+    );
     await scanner.registerExtractor(ergoEventTriggerExtractor);
     await scanner.registerExtractor(cardanoEventTriggerExtractor);
     await scanner.registerExtractor(bitcoinEventTriggerExtractor);
     await scanner.registerExtractor(bitcoinRunesEventTriggerExtractor);
     await scanner.registerExtractor(dogeEventTriggerExtractor);
     await scanner.registerExtractor(ethereumEventTriggerExtractor);
     await scanner.registerExtractor(binanceEventTriggerExtractor);
+    await scanner.registerExtractor(firoEventTriggerExtractor);
 
     logger.debug('event trigger extractors registered', {
       scannerName: scanner.name(),
@@ -131,6 +146,7 @@ export const registerExtractors = async (scanner: ErgoScanner) => {
         dogeEventTriggerExtractor.getId(),
         ethereumEventTriggerExtractor.getId(),
         binanceEventTriggerExtractor.getId(),
+        firoEventTriggerExtractor.getId(),
       ],
     });
   } catch (error) {

apps/rosen-service/src/health-check/health-check-service.ts

@@ -21,6 +21,8 @@ import {
   ERGO_SCANNER_INTERVAL,
   ETHEREUM_BLOCK_TIME,
   ETHEREUM_SCANNER_INTERVAL,
+  FIRO_BLOCK_TIME,
+  FIRO_SCANNER_INTERVAL,
 } from '../constants';
 import scannerService from '../scanner/scanner-service';
 import { getLastSavedBlock } from './health-check-utils';
@@ -131,6 +133,17 @@ const registerAllHealthChecks = (healthCheck: HealthCheck) => {
       ),
       label: 'binance',
     },
+    {
+      instance: new ScannerSyncHealthCheckParam(
+        scannerService.getFiroScanner().name(),
+        async () => getLastSavedBlock(scannerService.getFiroScanner().name()),
+        config.healthCheck.firoScannerWarnDiff,
+        config.healthCheck.firoScannerCriticalDiff,
+        FIRO_BLOCK_TIME,
+        FIRO_SCANNER_INTERVAL,
+      ),
+      label: 'firo',
+    },
   ];
 
   for (const { instance, label } of checks) {

apps/rosen-service/src/observation/chains/firo.ts

@@ -0,0 +1,41 @@
+import { DefaultLogger } from '@rosen-bridge/abstract-logger';
+import { FiroRpcObservationExtractor } from '@rosen-bridge/firo-observation-extractor';
+import { FiroRpcScanner } from '@rosen-bridge/firo-scanner';
+
+import config from '../../configs';
+import dataSource from '../../data-source';
+import AppError from '../../errors/AppError';
+import { getTokenMap } from '../../utils';
+
+const logger = DefaultLogger.getInstance().child(import.meta.url);
+
+/**
+ * register an observation extractor for the provided scanner
+ * @param scanner
+ */
+export const registerFiroExtractor = async (scanner: FiroRpcScanner) => {
+  try {
+    const observationExtractor = new FiroRpcObservationExtractor(
+      config.firo.addresses.lock,
+      dataSource,
+      await getTokenMap(),
+      logger.child('firoRpcObservationExtractor'),
+    );
+
+    await scanner.registerExtractor(observationExtractor);
+
+    logger.debug('firo observation extractor registered', {
+      scannerName: scanner.name(),
+    });
+  } catch (error) {
+    throw new AppError(
+      `cannot create or register firo observation extractor due to error: ${error}`,
+      false,
+      'error',
+      error instanceof Error ? error.stack : undefined,
+      {
+        scannerName: scanner.name(),
+      },
+    );
+  }
+};

apps/rosen-service/src/observation/observation-service.ts

@@ -5,6 +5,7 @@ import { registerCardanoExtractor } from './chains/cardano';
 import { registerDogeExtractor } from './chains/doge';
 import { registerErgoExtractor } from './chains/ergo';
 import { registerEthereumExtractor } from './chains/ethereum';
+import { registerFiroExtractor } from './chains/firo';
 
 const observationService = {
   registerBitcoinExtractor,
@@ -14,6 +15,7 @@ const observationService = {
   registerErgoExtractor,
   registerEthereumExtractor,
   registerBinanceExtractor,
+  registerFiroExtractor,
 };
 
 export default observationService;