Feat: data bus

README.md

@@ -5,7 +5,7 @@ The Lido Council Daemon monitors deposit contract keys and compares them to Lido
 ## Table of Contents
 
 - [Environment Variables](#environment-variables)
-  - [RabbitMQ](#rabbitmq)
+  - [Data Bus Transports](#data-bus-transports)
   - [Wallet Private Key](#wallet-private-key)
   - [Keys-API Configuration](#keys-api-configuration)
 - [Example ENV Config File](#example-env-config-file)
@@ -19,10 +19,12 @@ The Lido Council Daemon monitors deposit contract keys and compares them to Lido
 
 ## Environment Variables
 
-Several environment variables must be set for the daemon to function properly. These variables include RabbitMQ settings, wallet private key, and Keys-API configuration.
+Several environment variables must be set for the daemon to function properly. These variables include Data Bus Transports settings, wallet private key, and Keys-API configuration.
 
-### RabbitMQ
+### Data Bus Transports
+You need to install one of the transports
 
+#### RabbitMQ
 ```env
 ...
 PUBSUB_SERVICE=rabbitmq
@@ -33,6 +35,16 @@ RABBITMQ_PASSCODE=<rabbitmq password>
 ...
 ```
 
+#### EVM Chain transport
+```env
+...
+PUBSUB_SERVICE=evm-chain
+
+EVM_CHAIN_DATA_BUS_ADDRESS=<evm transport contract address>
+EVM_CHAIN_DATA_BUS_PROVIDER_URL=<evm chain node url>
+...
+```
+
 ### Wallet Private Key
 
 ```env

develop.env

@@ -9,13 +9,10 @@ LOG_LEVEL=info
 LOG_FORMAT=simple
 
 # Pubsub (default: rabbitmq)
-PUBSUB_SERVICE=rabbitmq
-
-# RabbitMQ
-
-RABBITMQ_URL=ws://127.0.0.1:15674/ws
-RABBITMQ_LOGIN=guest
-RABBITMQ_PASSCODE=guest
+PUBSUB_SERVICE=evm-chain
+# This is a sample configuration, be sure to replace it with an up-to-date one
+EVM_CHAIN_DATA_BUS_ADDRESS="0xD02E999e4F0d464a322d9969d0EdF32ec93257ac"
+EVM_CHAIN_DATA_BUS_PROVIDER_URL="https://gnosis-chiado-rpc.publicnode.com"
 
 
 # Private key

package.json

@@ -60,7 +60,8 @@
     "rimraf": "^3.0.2",
     "rxjs": "^7.2.0",
     "winston": "^3.3.3",
-    "ws": "^8.10.0"
+    "ws": "^8.10.0",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@nestjs/cli": "^8.2.5",

src/abi/data-bus.abi.json

@@ -0,0 +1,7 @@
+[
+  "event MessageDepositV1(address indexed guardianAddress, (uint256 blockNumber, bytes32 blockHash, bytes32 depositRoot, uint256 stakingModuleId, uint256 nonce, (bytes32 r, bytes32 vs) signature, (bytes32 version) app) data)",
+  "event MessagePauseV2(address indexed guardianAddress, (uint256 blockNumber, bytes32 blockHash, (bytes32 r, bytes32 vs) signature, uint256 stakingModuleId, (bytes32 version) app) data)",
+  "event MessagePauseV3(address indexed guardianAddress, (uint256 blockNumber, bytes32 blockHash, (bytes32 r, bytes32 vs) signature, (bytes32 version) app) data)",
+  "event MessagePingV1(address indexed guardianAddress, (uint256 blockNumber, (bytes32 version) app) data)",
+  "event MessageUnvetV1(address indexed guardianAddress, (uint256 blockNumber, bytes32 blockHash, uint256 stakingModuleId, uint256 nonce, bytes operatorIds, bytes vettedKeysByOperator, (bytes32 r, bytes32 vs) signature, (bytes32 version) app) data)"
+]

src/common/config/config-loader.service.spec.ts

@@ -15,6 +15,8 @@ const DEFAULTS = {
   RABBITMQ_URL: 'some-rabbit-url',
   RABBITMQ_LOGIN: 'some-rabbit-login',
   KEYS_API_URL: 'keys-api',
+  EVM_CHAIN_DATA_BUS_ADDRESS: 'DATA_BUS_ADDRESS',
+  EVM_CHAIN_DATA_BUS_PROVIDER_URL: 'DATA_BUS_PROVIDER_URL',
 };
 
 const extractError = async <T>(

src/common/config/configuration.ts

@@ -4,7 +4,7 @@ import { ethers } from 'ethers';
 
 export const Configuration = createInterface<Configuration>('Configuration');
 
-export type PubsubService = 'rabbitmq' | 'kafka';
+export type PubsubService = 'rabbitmq' | 'kafka' | 'evm-chain';
 
 export interface Configuration {
   NODE_ENV: string;
@@ -35,4 +35,7 @@ export interface Configuration {
   LOCATOR_DEVNET_ADDRESS: string;
   WALLET_MIN_BALANCE: ethers.BigNumber;
   WALLET_CRITICAL_BALANCE: ethers.BigNumber;
+  EVM_CHAIN_DATA_BUS_ADDRESS: string;
+  EVM_CHAIN_DATA_BUS_PROVIDER_URL: string;
+  EVM_CHAIN_DATA_BUS_WALLET_MIN_BALANCE: ethers.BigNumber;
 }

src/common/config/in-memory-configuration.ts

@@ -18,6 +18,7 @@ import { TransformToWei } from 'common/decorators/transform-to-wei';
 
 const RABBITMQ = 'rabbitmq';
 const KAFKA = 'kafka';
+const EVM_CHAIN = 'evm-chain';
 
 @Injectable()
 @implementationOf(Configuration)
@@ -57,7 +58,7 @@ export class InMemoryConfiguration implements Configuration {
   BROKER_TOPIC = 'defender';
 
   @IsString()
-  @IsIn([KAFKA, RABBITMQ])
+  @IsIn([KAFKA, RABBITMQ, EVM_CHAIN])
   PUBSUB_SERVICE: PubsubService = RABBITMQ;
 
   @ValidateIf((conf) => conf.PUBSUB_SERVICE === KAFKA)
@@ -160,4 +161,21 @@ export class InMemoryConfiguration implements Configuration {
   @TransformToWei()
   @IsInstance(BigNumber)
   WALLET_CRITICAL_BALANCE: BigNumber = ethers.utils.parseEther('0.2');
+
+  @ValidateIf((conf) => conf.PUBSUB_SERVICE === EVM_CHAIN)
+  @IsNotEmpty()
+  @IsString()
+  EVM_CHAIN_DATA_BUS_ADDRESS = '';
+
+  @ValidateIf((conf) => conf.PUBSUB_SERVICE === EVM_CHAIN)
+  @IsNotEmpty()
+  @IsString()
+  EVM_CHAIN_DATA_BUS_PROVIDER_URL = '';
+
+  @ValidateIf((conf) => conf.PUBSUB_SERVICE === EVM_CHAIN)
+  @IsOptional()
+  @TransformToWei()
+  @IsInstance(BigNumber)
+  EVM_CHAIN_DATA_BUS_WALLET_MIN_BALANCE: BigNumber =
+    ethers.utils.parseEther('1');
 }

src/common/prometheus/prometheus.constants.ts

@@ -10,6 +10,11 @@ export const METRIC_RPC_REQUEST_ERRORS = `${METRICS_PREFIX}rpc_requests_errors`;
 
 export const METRIC_ACCOUNT_BALANCE = `${METRICS_PREFIX}account_balance`;
 
+export const METRIC_DATA_BUS_RPC_REQUEST_DURATION = `${METRICS_PREFIX}_data_bus_rpc_requests_duration_seconds`;
+export const METRIC_DATA_BUS_RPC_REQUEST_ERRORS = `${METRICS_PREFIX}_data_bus_rpc_requests_errors`;
+
+export const METRIC_DATA_BUS_ACCOUNT_BALANCE = `${METRICS_PREFIX}_data_bus_account_balance`;
+
 export const METRIC_BLOCK_DATA_REQUEST_DURATION = `${METRICS_PREFIX}block_data_requests_duration_seconds`;
 export const METRIC_BLOCK_DATA_REQUEST_ERRORS = `${METRICS_PREFIX}block_data_requests_errors`;
 

src/common/prometheus/prometheus.module.ts

@@ -16,6 +16,9 @@ import {
   PrometheusDuplicatedKeysProvider,
   PrometheusInvalidKeysProvider,
   PrometheusUnvetKeysCounterProvider,
+  PrometheusDataBusRPCErrorsCounterProvider,
+  PrometheusDataBusAccountBalanceProvider,
+  PrometheusDataBusRPCRequestsHistogramProvider,
 } from './prometheus.provider';
 import { METRICS_PREFIX, METRICS_URL } from './prometheus.constants';
 
@@ -33,6 +36,9 @@ const providers = [
   PrometheusRPCRequestsHistogramProvider,
   PrometheusRPCErrorsCounterProvider,
   PrometheusAccountBalanceProvider,
+  PrometheusDataBusRPCRequestsHistogramProvider,
+  PrometheusDataBusRPCErrorsCounterProvider,
+  PrometheusDataBusAccountBalanceProvider,
   PrometheusBlockDataRequestsProvider,
   PrometheusBlockDataErrorsCounterProvider,
   PrometheusBuildInfoGaugeProvider,

src/common/prometheus/prometheus.provider.ts

@@ -20,6 +20,9 @@ import {
   METRIC_DUPLICATED_KEYS_TOTAL,
   METRIC_INVALID_KEYS_TOTAL,
   METRIC_UNVET_ATTEMPTS,
+  METRIC_DATA_BUS_ACCOUNT_BALANCE,
+  METRIC_DATA_BUS_RPC_REQUEST_DURATION,
+  METRIC_DATA_BUS_RPC_REQUEST_ERRORS,
 } from './prometheus.constants';
 
 export const PrometheusTransportMessageCounterProvider = makeCounterProvider({
@@ -49,6 +52,24 @@ export const PrometheusRPCErrorsCounterProvider = makeCounterProvider({
   help: 'Number of RPC requests errors',
 });
 
+export const PrometheusDataBusAccountBalanceProvider = makeGaugeProvider({
+  name: METRIC_DATA_BUS_ACCOUNT_BALANCE,
+  help: 'DataBus guardian account balance',
+  labelNames: ['chainId'] as const,
+});
+
+export const PrometheusDataBusRPCRequestsHistogramProvider =
+  makeHistogramProvider({
+    name: METRIC_DATA_BUS_RPC_REQUEST_DURATION,
+    help: 'DataBus RPC request duration',
+    buckets: [0.1, 0.2, 0.3, 0.6, 1, 1.5, 2, 5],
+  });
+
+export const PrometheusDataBusRPCErrorsCounterProvider = makeCounterProvider({
+  name: METRIC_DATA_BUS_RPC_REQUEST_ERRORS,
+  help: 'Number of DataBus RPC requests errors',
+});
+
 export const PrometheusAccountBalanceProvider = makeGaugeProvider({
   name: METRIC_ACCOUNT_BALANCE,
   help: 'Guardian account balance',