@aztec/validator-ha-signer 0.0.1-commit.3469e52 → 0.0.1-commit.3895657bc

package/src/validator_ha_signer.ts

@@ -6,18 +6,26 @@
  * node will sign for a given duty (slot + duty type).
  */
 import type { Buffer32 } from '@aztec/foundation/buffer';
-import type { EthAddress } from '@aztec/foundation/eth-address';
+import { EthAddress } from '@aztec/foundation/eth-address';
 import type { Signature } from '@aztec/foundation/eth-signature';
 import { type Logger, createLogger } from '@aztec/foundation/log';
-
-import type { ValidatorHASignerConfig } from './config.js';
-import { type DutyIdentifier, DutyType } from './db/types.js';
-import { SlashingProtectionService } from './slashing_protection_service.js';
+import type { DateProvider } from '@aztec/foundation/timer';
 import {
+  type BaseSignerConfig,
+  DutyType,
   type HAProtectedSigningContext,
-  type SlashingProtectionDatabase,
   getBlockNumberFromSigningContext,
-} from './types.js';
+} from '@aztec/stdlib/ha-signing';
+
+import type { DutyIdentifier } from './db/types.js';
+import type { HASignerMetrics } from './metrics.js';
+import { SlashingProtectionService } from './slashing_protection_service.js';
+import type { SlashingProtectionDatabase } from './types.js';
+
+export interface ValidatorHASignerDeps {
+  metrics: HASignerMetrics;
+  dateProvider: DateProvider;
+}
 
 /**
  * Validator High Availability Signer
@@ -41,24 +49,32 @@ import {
 export class ValidatorHASigner {
   private readonly log: Logger;
   private readonly slashingProtection: SlashingProtectionService;
+  private readonly rollupAddress: EthAddress;
+
+  private readonly dateProvider: DateProvider;
+  private readonly metrics: HASignerMetrics;
 
   constructor(
     db: SlashingProtectionDatabase,
-    private readonly config: ValidatorHASignerConfig,
+    private readonly config: BaseSignerConfig,
+    deps: ValidatorHASignerDeps,
   ) {
     this.log = createLogger('validator-ha-signer');
 
-    if (!config.haSigningEnabled) {
-      // this shouldn't happen, the validator should use different signer for non-HA setups
-      throw new Error('Validator HA Signer is not enabled in config');
-    }
+    this.metrics = deps.metrics;
+    this.dateProvider = deps.dateProvider;
 
     if (!config.nodeId || config.nodeId === '') {
       throw new Error('NODE_ID is required for high-availability setups');
     }
-    this.slashingProtection = new SlashingProtectionService(db, config);
+    this.rollupAddress = config.l1Contracts.rollupAddress;
+    this.slashingProtection = new SlashingProtectionService(db, config, {
+      metrics: deps.metrics,
+      dateProvider: deps.dateProvider,
+    });
     this.log.info('Validator HA Signer initialized with slashing protection', {
       nodeId: config.nodeId,
+      rollupAddress: this.rollupAddress.toString(),
     });
   }
 
@@ -85,9 +101,13 @@ export class ValidatorHASigner {
     context: HAProtectedSigningContext,
     signFn: (messageHash: Buffer32) => Promise<Signature>,
   ): Promise<Signature> {
+    const startTime = this.dateProvider.now();
+    const dutyType = context.dutyType;
+
     let dutyIdentifier: DutyIdentifier;
     if (context.dutyType === DutyType.BLOCK_PROPOSAL) {
       dutyIdentifier = {
+        rollupAddress: this.rollupAddress,
         validatorAddress,
         slot: context.slot,
         blockIndexWithinCheckpoint: context.blockIndexWithinCheckpoint,
@@ -95,6 +115,7 @@ export class ValidatorHASigner {
       };
     } else {
       dutyIdentifier = {
+        rollupAddress: this.rollupAddress,
         validatorAddress,
         slot: context.slot,
         dutyType: context.dutyType,
@@ -102,6 +123,7 @@ export class ValidatorHASigner {
     }
 
     // Acquire lock and get the token for ownership verification
+    // DutyAlreadySignedError and SlashingProtectionError may be thrown here and are recorded in the service
     const blockNumber = getBlockNumberFromSigningContext(context);
     const lockToken = await this.slashingProtection.checkAndRecord({
       ...dutyIdentifier,
@@ -117,6 +139,7 @@ export class ValidatorHASigner {
     } catch (error: any) {
       // Delete duty to allow retry (only succeeds if we own the lock)
       await this.slashingProtection.deleteDuty({ ...dutyIdentifier, lockToken });
+      this.metrics.recordSigningError(dutyType);
       throw error;
     }
 
@@ -128,6 +151,9 @@ export class ValidatorHASigner {
       lockToken,
     });
 
+    const duration = this.dateProvider.now() - startTime;
+    this.metrics.recordSigningSuccess(dutyType, duration);
+
     return signature;
   }
 
@@ -142,8 +168,8 @@ export class ValidatorHASigner {
    * Start the HA signer background tasks (cleanup of stuck duties).
    * Should be called after construction and before signing operations.
    */
-  start() {
-    this.slashingProtection.start();
+  async start() {
+    await this.slashingProtection.start();
   }
 
   /**

package/dest/config.d.ts

@@ -1,79 +0,0 @@
-import { type ConfigMappingsType } from '@aztec/foundation/config';
-import { z } from 'zod';
-/**
- * Configuration for the Validator HA Signer
- *
- * This config is used for distributed locking and slashing protection
- * when running multiple validator nodes in a high-availability setup.
- */
-export interface ValidatorHASignerConfig {
-    /** Whether HA signing / slashing protection is enabled */
-    haSigningEnabled: boolean;
-    /** Unique identifier for this node */
-    nodeId: string;
-    /** How long to wait between polls when a duty is being signed (ms) */
-    pollingIntervalMs: number;
-    /** Maximum time to wait for a duty being signed to complete (ms) */
-    signingTimeoutMs: number;
-    /** Maximum age of a stuck duty in ms (defaults to 2x hardcoded Aztec slot duration if not set) */
-    maxStuckDutiesAgeMs?: number;
-    /**
-     * PostgreSQL connection string
-     * Format: postgresql://user:password@host:port/database
-     */
-    databaseUrl?: string;
-    /**
-     * PostgreSQL connection pool configuration
-     */
-    /** Maximum number of clients in the pool (default: 10) */
-    poolMaxCount?: number;
-    /** Minimum number of clients in the pool (default: 0) */
-    poolMinCount?: number;
-    /** Idle timeout in milliseconds (default: 10000) */
-    poolIdleTimeoutMs?: number;
-    /** Connection timeout in milliseconds (default: 0, no timeout) */
-    poolConnectionTimeoutMs?: number;
-}
-export declare const validatorHASignerConfigMappings: ConfigMappingsType<ValidatorHASignerConfig>;
-export declare const defaultValidatorHASignerConfig: ValidatorHASignerConfig;
-/**
- * Returns the validator HA signer configuration from environment variables.
- * Note: If an environment variable is not set, the default value is used.
- * @returns The validator HA signer configuration.
- */
-export declare function getConfigEnvVars(): ValidatorHASignerConfig;
-export declare const ValidatorHASignerConfigSchema: z.ZodObject<{
-    haSigningEnabled: z.ZodBoolean;
-    nodeId: z.ZodString;
-    pollingIntervalMs: z.ZodNumber;
-    signingTimeoutMs: z.ZodNumber;
-    maxStuckDutiesAgeMs: z.ZodOptional<z.ZodNumber>;
-    databaseUrl: z.ZodOptional<z.ZodString>;
-    poolMaxCount: z.ZodOptional<z.ZodNumber>;
-    poolMinCount: z.ZodOptional<z.ZodNumber>;
-    poolIdleTimeoutMs: z.ZodOptional<z.ZodNumber>;
-    poolConnectionTimeoutMs: z.ZodOptional<z.ZodNumber>;
-}, "strip", z.ZodTypeAny, {
-    haSigningEnabled: boolean;
-    nodeId: string;
-    pollingIntervalMs: number;
-    signingTimeoutMs: number;
-    maxStuckDutiesAgeMs?: number | undefined;
-    databaseUrl?: string | undefined;
-    poolMaxCount?: number | undefined;
-    poolMinCount?: number | undefined;
-    poolIdleTimeoutMs?: number | undefined;
-    poolConnectionTimeoutMs?: number | undefined;
-}, {
-    haSigningEnabled: boolean;
-    nodeId: string;
-    pollingIntervalMs: number;
-    signingTimeoutMs: number;
-    maxStuckDutiesAgeMs?: number | undefined;
-    databaseUrl?: string | undefined;
-    poolMaxCount?: number | undefined;
-    poolMinCount?: number | undefined;
-    poolIdleTimeoutMs?: number | undefined;
-    poolConnectionTimeoutMs?: number | undefined;
-}>;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvY29uZmlnLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFDTCxLQUFLLGtCQUFrQixFQU14QixNQUFNLDBCQUEwQixDQUFDO0FBR2xDLE9BQU8sRUFBRSxDQUFDLEVBQUUsTUFBTSxLQUFLLENBQUM7QUFFeEI7Ozs7O0dBS0c7QUFDSCxNQUFNLFdBQVcsdUJBQXVCO0lBQ3RDLDBEQUEwRDtJQUMxRCxnQkFBZ0IsRUFBRSxPQUFPLENBQUM7SUFDMUIsc0NBQXNDO0lBQ3RDLE1BQU0sRUFBRSxNQUFNLENBQUM7SUFDZixzRUFBc0U7SUFDdEUsaUJBQWlCLEVBQUUsTUFBTSxDQUFDO0lBQzFCLG9FQUFvRTtJQUNwRSxnQkFBZ0IsRUFBRSxNQUFNLENBQUM7SUFDekIsa0dBQWtHO0lBQ2xHLG1CQUFtQixDQUFDLEVBQUUsTUFBTSxDQUFDO0lBQzdCOzs7T0FHRztJQUNILFdBQVcsQ0FBQyxFQUFFLE1BQU0sQ0FBQztJQUNyQjs7T0FFRztJQUNILDBEQUEwRDtJQUMxRCxZQUFZLENBQUMsRUFBRSxNQUFNLENBQUM7SUFDdEIseURBQXlEO0lBQ3pELFlBQVksQ0FBQyxFQUFFLE1BQU0sQ0FBQztJQUN0QixvREFBb0Q7SUFDcEQsaUJBQWlCLENBQUMsRUFBRSxNQUFNLENBQUM7SUFDM0Isa0VBQWtFO0lBQ2xFLHVCQUF1QixDQUFDLEVBQUUsTUFBTSxDQUFDO0NBQ2xDO0FBRUQsZUFBTyxNQUFNLCtCQUErQixFQUFFLGtCQUFrQixDQUFDLHVCQUF1QixDQW1EdkYsQ0FBQztBQUVGLGVBQU8sTUFBTSw4QkFBOEIsRUFBRSx1QkFFNUMsQ0FBQztBQUVGOzs7O0dBSUc7QUFDSCx3QkFBZ0IsZ0JBQWdCLElBQUksdUJBQXVCLENBRTFEO0FBRUQsZUFBTyxNQUFNLDZCQUE2Qjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0VBV0UsQ0FBQyJ9

package/dest/config.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,kBAAkB,EAMxB,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,0DAA0D;IAC1D,gBAAgB,EAAE,OAAO,CAAC;IAC1B,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,sEAAsE;IACtE,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oEAAoE;IACpE,gBAAgB,EAAE,MAAM,CAAC;IACzB,kGAAkG;IAClG,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,0DAA0D;IAC1D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yDAAyD;IACzD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kEAAkE;IAClE,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,eAAO,MAAM,+BAA+B,EAAE,kBAAkB,CAAC,uBAAuB,CAmDvF,CAAC;AAEF,eAAO,MAAM,8BAA8B,EAAE,uBAE5C,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,uBAAuB,CAE1D;AAED,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWE,CAAC"}

package/dest/config.js

@@ -1,73 +0,0 @@
-import { booleanConfigHelper, getConfigFromMappings, getDefaultConfig, numberConfigHelper, optionalNumberConfigHelper } from '@aztec/foundation/config';
-import { z } from 'zod';
-export const validatorHASignerConfigMappings = {
-    haSigningEnabled: {
-        env: 'VALIDATOR_HA_SIGNING_ENABLED',
-        description: 'Whether HA signing / slashing protection is enabled',
-        ...booleanConfigHelper(false)
-    },
-    nodeId: {
-        env: 'VALIDATOR_HA_NODE_ID',
-        description: 'The unique identifier for this node',
-        defaultValue: ''
-    },
-    pollingIntervalMs: {
-        env: 'VALIDATOR_HA_POLLING_INTERVAL_MS',
-        description: 'The number of ms to wait between polls when a duty is being signed',
-        ...numberConfigHelper(100)
-    },
-    signingTimeoutMs: {
-        env: 'VALIDATOR_HA_SIGNING_TIMEOUT_MS',
-        description: 'The maximum time to wait for a duty being signed to complete',
-        ...numberConfigHelper(3_000)
-    },
-    maxStuckDutiesAgeMs: {
-        env: 'VALIDATOR_HA_MAX_STUCK_DUTIES_AGE_MS',
-        description: 'The maximum age of a stuck duty in ms (defaults to 2x Aztec slot duration)',
-        ...optionalNumberConfigHelper()
-    },
-    databaseUrl: {
-        env: 'VALIDATOR_HA_DATABASE_URL',
-        description: 'PostgreSQL connection string for validator HA signer (format: postgresql://user:password@host:port/database)'
-    },
-    poolMaxCount: {
-        env: 'VALIDATOR_HA_POOL_MAX',
-        description: 'Maximum number of clients in the pool',
-        ...numberConfigHelper(10)
-    },
-    poolMinCount: {
-        env: 'VALIDATOR_HA_POOL_MIN',
-        description: 'Minimum number of clients in the pool',
-        ...numberConfigHelper(0)
-    },
-    poolIdleTimeoutMs: {
-        env: 'VALIDATOR_HA_POOL_IDLE_TIMEOUT_MS',
-        description: 'Idle timeout in milliseconds',
-        ...numberConfigHelper(10_000)
-    },
-    poolConnectionTimeoutMs: {
-        env: 'VALIDATOR_HA_POOL_CONNECTION_TIMEOUT_MS',
-        description: 'Connection timeout in milliseconds (0 means no timeout)',
-        ...numberConfigHelper(0)
-    }
-};
-export const defaultValidatorHASignerConfig = getDefaultConfig(validatorHASignerConfigMappings);
-/**
- * Returns the validator HA signer configuration from environment variables.
- * Note: If an environment variable is not set, the default value is used.
- * @returns The validator HA signer configuration.
- */ export function getConfigEnvVars() {
-    return getConfigFromMappings(validatorHASignerConfigMappings);
-}
-export const ValidatorHASignerConfigSchema = z.object({
-    haSigningEnabled: z.boolean(),
-    nodeId: z.string(),
-    pollingIntervalMs: z.number().min(0),
-    signingTimeoutMs: z.number().min(0),
-    maxStuckDutiesAgeMs: z.number().min(0).optional(),
-    databaseUrl: z.string().optional(),
-    poolMaxCount: z.number().min(0).optional(),
-    poolMinCount: z.number().min(0).optional(),
-    poolIdleTimeoutMs: z.number().min(0).optional(),
-    poolConnectionTimeoutMs: z.number().min(0).optional()
-});

package/src/config.ts

@@ -1,125 +0,0 @@
-import {
-  type ConfigMappingsType,
-  booleanConfigHelper,
-  getConfigFromMappings,
-  getDefaultConfig,
-  numberConfigHelper,
-  optionalNumberConfigHelper,
-} from '@aztec/foundation/config';
-import type { ZodFor } from '@aztec/foundation/schemas';
-
-import { z } from 'zod';
-
-/**
- * Configuration for the Validator HA Signer
- *
- * This config is used for distributed locking and slashing protection
- * when running multiple validator nodes in a high-availability setup.
- */
-export interface ValidatorHASignerConfig {
-  /** Whether HA signing / slashing protection is enabled */
-  haSigningEnabled: boolean;
-  /** Unique identifier for this node */
-  nodeId: string;
-  /** How long to wait between polls when a duty is being signed (ms) */
-  pollingIntervalMs: number;
-  /** Maximum time to wait for a duty being signed to complete (ms) */
-  signingTimeoutMs: number;
-  /** Maximum age of a stuck duty in ms (defaults to 2x hardcoded Aztec slot duration if not set) */
-  maxStuckDutiesAgeMs?: number;
-  /**
-   * PostgreSQL connection string
-   * Format: postgresql://user:password@host:port/database
-   */
-  databaseUrl?: string;
-  /**
-   * PostgreSQL connection pool configuration
-   */
-  /** Maximum number of clients in the pool (default: 10) */
-  poolMaxCount?: number;
-  /** Minimum number of clients in the pool (default: 0) */
-  poolMinCount?: number;
-  /** Idle timeout in milliseconds (default: 10000) */
-  poolIdleTimeoutMs?: number;
-  /** Connection timeout in milliseconds (default: 0, no timeout) */
-  poolConnectionTimeoutMs?: number;
-}
-
-export const validatorHASignerConfigMappings: ConfigMappingsType<ValidatorHASignerConfig> = {
-  haSigningEnabled: {
-    env: 'VALIDATOR_HA_SIGNING_ENABLED',
-    description: 'Whether HA signing / slashing protection is enabled',
-    ...booleanConfigHelper(false),
-  },
-  nodeId: {
-    env: 'VALIDATOR_HA_NODE_ID',
-    description: 'The unique identifier for this node',
-    defaultValue: '',
-  },
-  pollingIntervalMs: {
-    env: 'VALIDATOR_HA_POLLING_INTERVAL_MS',
-    description: 'The number of ms to wait between polls when a duty is being signed',
-    ...numberConfigHelper(100),
-  },
-  signingTimeoutMs: {
-    env: 'VALIDATOR_HA_SIGNING_TIMEOUT_MS',
-    description: 'The maximum time to wait for a duty being signed to complete',
-    ...numberConfigHelper(3_000),
-  },
-  maxStuckDutiesAgeMs: {
-    env: 'VALIDATOR_HA_MAX_STUCK_DUTIES_AGE_MS',
-    description: 'The maximum age of a stuck duty in ms (defaults to 2x Aztec slot duration)',
-    ...optionalNumberConfigHelper(),
-  },
-  databaseUrl: {
-    env: 'VALIDATOR_HA_DATABASE_URL',
-    description:
-      'PostgreSQL connection string for validator HA signer (format: postgresql://user:password@host:port/database)',
-  },
-  poolMaxCount: {
-    env: 'VALIDATOR_HA_POOL_MAX',
-    description: 'Maximum number of clients in the pool',
-    ...numberConfigHelper(10),
-  },
-  poolMinCount: {
-    env: 'VALIDATOR_HA_POOL_MIN',
-    description: 'Minimum number of clients in the pool',
-    ...numberConfigHelper(0),
-  },
-  poolIdleTimeoutMs: {
-    env: 'VALIDATOR_HA_POOL_IDLE_TIMEOUT_MS',
-    description: 'Idle timeout in milliseconds',
-    ...numberConfigHelper(10_000),
-  },
-  poolConnectionTimeoutMs: {
-    env: 'VALIDATOR_HA_POOL_CONNECTION_TIMEOUT_MS',
-    description: 'Connection timeout in milliseconds (0 means no timeout)',
-    ...numberConfigHelper(0),
-  },
-};
-
-export const defaultValidatorHASignerConfig: ValidatorHASignerConfig = getDefaultConfig(
-  validatorHASignerConfigMappings,
-);
-
-/**
- * Returns the validator HA signer configuration from environment variables.
- * Note: If an environment variable is not set, the default value is used.
- * @returns The validator HA signer configuration.
- */
-export function getConfigEnvVars(): ValidatorHASignerConfig {
-  return getConfigFromMappings<ValidatorHASignerConfig>(validatorHASignerConfigMappings);
-}
-
-export const ValidatorHASignerConfigSchema = z.object({
-  haSigningEnabled: z.boolean(),
-  nodeId: z.string(),
-  pollingIntervalMs: z.number().min(0),
-  signingTimeoutMs: z.number().min(0),
-  maxStuckDutiesAgeMs: z.number().min(0).optional(),
-  databaseUrl: z.string().optional(),
-  poolMaxCount: z.number().min(0).optional(),
-  poolMinCount: z.number().min(0).optional(),
-  poolIdleTimeoutMs: z.number().min(0).optional(),
-  poolConnectionTimeoutMs: z.number().min(0).optional(),
-}) satisfies ZodFor<ValidatorHASignerConfig>;