@aztec/validator-ha-signer 0.0.1-commit.cd76b27 → 0.0.1-commit.d1cd2107c
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -2
- package/dest/db/index.d.ts +2 -1
- package/dest/db/index.d.ts.map +1 -1
- package/dest/db/index.js +1 -0
- package/dest/db/lmdb.d.ts +66 -0
- package/dest/db/lmdb.d.ts.map +1 -0
- package/dest/db/lmdb.js +188 -0
- package/dest/db/postgres.d.ts +4 -2
- package/dest/db/postgres.d.ts.map +1 -1
- package/dest/db/postgres.js +13 -13
- package/dest/db/types.d.ts +37 -18
- package/dest/db/types.d.ts.map +1 -1
- package/dest/db/types.js +30 -15
- package/dest/factory.d.ts +22 -4
- package/dest/factory.d.ts.map +1 -1
- package/dest/factory.js +50 -5
- package/dest/metrics.d.ts +51 -0
- package/dest/metrics.d.ts.map +1 -0
- package/dest/metrics.js +103 -0
- package/dest/slashing_protection_service.d.ts +12 -3
- package/dest/slashing_protection_service.d.ts.map +1 -1
- package/dest/slashing_protection_service.js +15 -4
- package/dest/types.d.ts +17 -70
- package/dest/types.d.ts.map +1 -1
- package/dest/types.js +3 -20
- package/dest/validator_ha_signer.d.ts +12 -4
- package/dest/validator_ha_signer.d.ts.map +1 -1
- package/dest/validator_ha_signer.js +16 -8
- package/package.json +10 -6
- package/src/db/index.ts +1 -0
- package/src/db/lmdb.ts +264 -0
- package/src/db/postgres.ts +13 -11
- package/src/db/types.ts +61 -16
- package/src/factory.ts +61 -4
- package/src/metrics.ts +138 -0
- package/src/slashing_protection_service.ts +26 -5
- package/src/types.ts +32 -104
- package/src/validator_ha_signer.ts +33 -12
- package/dest/config.d.ts +0 -101
- package/dest/config.d.ts.map +0 -1
- package/dest/config.js +0 -92
- package/src/config.ts +0 -149
|
@@ -5,9 +5,8 @@
|
|
|
5
5
|
* This ensures that even with multiple validator nodes running, only one
|
|
6
6
|
* node will sign for a given duty (slot + duty type).
|
|
7
7
|
*/ import { createLogger } from '@aztec/foundation/log';
|
|
8
|
-
import { DutyType } from '
|
|
8
|
+
import { DutyType, getBlockNumberFromSigningContext } from '@aztec/stdlib/ha-signing';
|
|
9
9
|
import { SlashingProtectionService } from './slashing_protection_service.js';
|
|
10
|
-
import { getBlockNumberFromSigningContext } from './types.js';
|
|
11
10
|
/**
|
|
12
11
|
* Validator High Availability Signer
|
|
13
12
|
*
|
|
@@ -31,18 +30,21 @@ import { getBlockNumberFromSigningContext } from './types.js';
|
|
|
31
30
|
log;
|
|
32
31
|
slashingProtection;
|
|
33
32
|
rollupAddress;
|
|
34
|
-
|
|
33
|
+
dateProvider;
|
|
34
|
+
metrics;
|
|
35
|
+
constructor(db, config, deps){
|
|
35
36
|
this.config = config;
|
|
36
37
|
this.log = createLogger('validator-ha-signer');
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
throw new Error('Validator HA Signer is not enabled in config');
|
|
40
|
-
}
|
|
38
|
+
this.metrics = deps.metrics;
|
|
39
|
+
this.dateProvider = deps.dateProvider;
|
|
41
40
|
if (!config.nodeId || config.nodeId === '') {
|
|
42
41
|
throw new Error('NODE_ID is required for high-availability setups');
|
|
43
42
|
}
|
|
44
43
|
this.rollupAddress = config.l1Contracts.rollupAddress;
|
|
45
|
-
this.slashingProtection = new SlashingProtectionService(db, config
|
|
44
|
+
this.slashingProtection = new SlashingProtectionService(db, config, {
|
|
45
|
+
metrics: deps.metrics,
|
|
46
|
+
dateProvider: deps.dateProvider
|
|
47
|
+
});
|
|
46
48
|
this.log.info('Validator HA Signer initialized with slashing protection', {
|
|
47
49
|
nodeId: config.nodeId,
|
|
48
50
|
rollupAddress: this.rollupAddress.toString()
|
|
@@ -65,6 +67,8 @@ import { getBlockNumberFromSigningContext } from './types.js';
|
|
|
65
67
|
* @throws DutyAlreadySignedError if the duty was already signed (expected in HA)
|
|
66
68
|
* @throws SlashingProtectionError if attempting to sign different data for same slot (expected in HA)
|
|
67
69
|
*/ async signWithProtection(validatorAddress, messageHash, context, signFn) {
|
|
70
|
+
const startTime = this.dateProvider.now();
|
|
71
|
+
const dutyType = context.dutyType;
|
|
68
72
|
let dutyIdentifier;
|
|
69
73
|
if (context.dutyType === DutyType.BLOCK_PROPOSAL) {
|
|
70
74
|
dutyIdentifier = {
|
|
@@ -83,6 +87,7 @@ import { getBlockNumberFromSigningContext } from './types.js';
|
|
|
83
87
|
};
|
|
84
88
|
}
|
|
85
89
|
// Acquire lock and get the token for ownership verification
|
|
90
|
+
// DutyAlreadySignedError and SlashingProtectionError may be thrown here and are recorded in the service
|
|
86
91
|
const blockNumber = getBlockNumberFromSigningContext(context);
|
|
87
92
|
const lockToken = await this.slashingProtection.checkAndRecord({
|
|
88
93
|
...dutyIdentifier,
|
|
@@ -100,6 +105,7 @@ import { getBlockNumberFromSigningContext } from './types.js';
|
|
|
100
105
|
...dutyIdentifier,
|
|
101
106
|
lockToken
|
|
102
107
|
});
|
|
108
|
+
this.metrics.recordSigningError(dutyType);
|
|
103
109
|
throw error;
|
|
104
110
|
}
|
|
105
111
|
// Record success (only succeeds if we own the lock)
|
|
@@ -109,6 +115,8 @@ import { getBlockNumberFromSigningContext } from './types.js';
|
|
|
109
115
|
nodeId: this.config.nodeId,
|
|
110
116
|
lockToken
|
|
111
117
|
});
|
|
118
|
+
const duration = this.dateProvider.now() - startTime;
|
|
119
|
+
this.metrics.recordSigningSuccess(dutyType, duration);
|
|
112
120
|
return signature;
|
|
113
121
|
}
|
|
114
122
|
/**
|
package/package.json
CHANGED
|
@@ -1,24 +1,25 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aztec/validator-ha-signer",
|
|
3
|
-
"version": "0.0.1-commit.
|
|
3
|
+
"version": "0.0.1-commit.d1cd2107c",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"exports": {
|
|
6
|
-
"./config": "./dest/config.js",
|
|
7
6
|
"./db": "./dest/db/index.js",
|
|
8
7
|
"./errors": "./dest/errors.js",
|
|
9
8
|
"./factory": "./dest/factory.js",
|
|
9
|
+
"./metrics": "./dest/metrics.js",
|
|
10
10
|
"./migrations": "./dest/migrations.js",
|
|
11
11
|
"./slashing-protection-service": "./dest/slashing_protection_service.js",
|
|
12
12
|
"./types": "./dest/types.js",
|
|
13
13
|
"./validator-ha-signer": "./dest/validator_ha_signer.js",
|
|
14
|
-
"./test": "./dest/test/pglite_pool.js"
|
|
14
|
+
"./test": "./dest/test/pglite_pool.js",
|
|
15
|
+
"./db/lmdb": "./dest/db/lmdb.js"
|
|
15
16
|
},
|
|
16
17
|
"typedocOptions": {
|
|
17
18
|
"entryPoints": [
|
|
18
|
-
"./src/config.ts",
|
|
19
19
|
"./src/db/index.ts",
|
|
20
20
|
"./src/errors.ts",
|
|
21
21
|
"./src/factory.ts",
|
|
22
|
+
"./src/metrics.ts",
|
|
22
23
|
"./src/migrations.ts",
|
|
23
24
|
"./src/slashing_protection_service.ts",
|
|
24
25
|
"./src/types.ts",
|
|
@@ -74,8 +75,11 @@
|
|
|
74
75
|
]
|
|
75
76
|
},
|
|
76
77
|
"dependencies": {
|
|
77
|
-
"@aztec/ethereum": "0.0.1-commit.
|
|
78
|
-
"@aztec/foundation": "0.0.1-commit.
|
|
78
|
+
"@aztec/ethereum": "0.0.1-commit.d1cd2107c",
|
|
79
|
+
"@aztec/foundation": "0.0.1-commit.d1cd2107c",
|
|
80
|
+
"@aztec/kv-store": "0.0.1-commit.d1cd2107c",
|
|
81
|
+
"@aztec/stdlib": "0.0.1-commit.d1cd2107c",
|
|
82
|
+
"@aztec/telemetry-client": "0.0.1-commit.d1cd2107c",
|
|
79
83
|
"node-pg-migrate": "^8.0.4",
|
|
80
84
|
"pg": "^8.11.3",
|
|
81
85
|
"tslib": "^2.4.0",
|
package/src/db/index.ts
CHANGED
package/src/db/lmdb.ts
ADDED
|
@@ -0,0 +1,264 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LMDB implementation of SlashingProtectionDatabase
|
|
3
|
+
*
|
|
4
|
+
* Provides local (single-node) double-signing protection using LMDB as the backend.
|
|
5
|
+
* Suitable for nodes that do NOT run in a high-availability multi-node setup.
|
|
6
|
+
*
|
|
7
|
+
* The LMDB store is single-writer, making setIfNotExists inherently atomic.
|
|
8
|
+
* This means we get crash-restart protection without needing an external database.
|
|
9
|
+
*/
|
|
10
|
+
import { SlotNumber } from '@aztec/foundation/branded-types';
|
|
11
|
+
import { randomBytes } from '@aztec/foundation/crypto/random';
|
|
12
|
+
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
13
|
+
import { type Logger, createLogger } from '@aztec/foundation/log';
|
|
14
|
+
import type { DateProvider } from '@aztec/foundation/timer';
|
|
15
|
+
import type { AztecAsyncKVStore, AztecAsyncMap } from '@aztec/kv-store';
|
|
16
|
+
|
|
17
|
+
import type { SlashingProtectionDatabase, TryInsertOrGetResult } from '../types.js';
|
|
18
|
+
import {
|
|
19
|
+
type CheckAndRecordParams,
|
|
20
|
+
DutyStatus,
|
|
21
|
+
DutyType,
|
|
22
|
+
type StoredDutyRecord,
|
|
23
|
+
getBlockIndexFromDutyIdentifier,
|
|
24
|
+
recordFromFields,
|
|
25
|
+
} from './types.js';
|
|
26
|
+
|
|
27
|
+
function dutyKey(
|
|
28
|
+
rollupAddress: string,
|
|
29
|
+
validatorAddress: string,
|
|
30
|
+
slot: string,
|
|
31
|
+
dutyType: string,
|
|
32
|
+
blockIndexWithinCheckpoint: number,
|
|
33
|
+
): string {
|
|
34
|
+
return `${rollupAddress}:${validatorAddress}:${slot}:${dutyType}:${blockIndexWithinCheckpoint}`;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* LMDB-backed implementation of SlashingProtectionDatabase.
|
|
39
|
+
*
|
|
40
|
+
* Provides single-node double-signing protection that survives crashes and restarts.
|
|
41
|
+
* Does not provide cross-node coordination (that requires the PostgreSQL implementation).
|
|
42
|
+
*/
|
|
43
|
+
export class LmdbSlashingProtectionDatabase implements SlashingProtectionDatabase {
|
|
44
|
+
public static readonly SCHEMA_VERSION = 1;
|
|
45
|
+
|
|
46
|
+
private readonly duties: AztecAsyncMap<string, StoredDutyRecord>;
|
|
47
|
+
private readonly log: Logger;
|
|
48
|
+
|
|
49
|
+
constructor(
|
|
50
|
+
private readonly store: AztecAsyncKVStore,
|
|
51
|
+
private readonly dateProvider: DateProvider,
|
|
52
|
+
) {
|
|
53
|
+
this.log = createLogger('slashing-protection:lmdb');
|
|
54
|
+
this.duties = store.openMap<string, StoredDutyRecord>('signing-protection-duties');
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Atomically try to insert a new duty record, or get the existing one if present.
|
|
59
|
+
*
|
|
60
|
+
* LMDB is single-writer so the read-then-write inside transactionAsync is naturally atomic.
|
|
61
|
+
*/
|
|
62
|
+
public async tryInsertOrGetExisting(params: CheckAndRecordParams): Promise<TryInsertOrGetResult> {
|
|
63
|
+
const blockIndexWithinCheckpoint = getBlockIndexFromDutyIdentifier(params);
|
|
64
|
+
const key = dutyKey(
|
|
65
|
+
params.rollupAddress.toString(),
|
|
66
|
+
params.validatorAddress.toString(),
|
|
67
|
+
params.slot.toString(),
|
|
68
|
+
params.dutyType,
|
|
69
|
+
blockIndexWithinCheckpoint,
|
|
70
|
+
);
|
|
71
|
+
|
|
72
|
+
const lockToken = randomBytes(16).toString('hex');
|
|
73
|
+
const now = this.dateProvider.now();
|
|
74
|
+
|
|
75
|
+
const result = await this.store.transactionAsync(async () => {
|
|
76
|
+
const existing = await this.duties.getAsync(key);
|
|
77
|
+
if (existing) {
|
|
78
|
+
return { isNew: false as const, record: { ...existing, lockToken: '' } };
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
const newRecord: StoredDutyRecord = {
|
|
82
|
+
rollupAddress: params.rollupAddress.toString(),
|
|
83
|
+
validatorAddress: params.validatorAddress.toString(),
|
|
84
|
+
slot: params.slot.toString(),
|
|
85
|
+
blockNumber: params.blockNumber.toString(),
|
|
86
|
+
blockIndexWithinCheckpoint,
|
|
87
|
+
dutyType: params.dutyType,
|
|
88
|
+
status: DutyStatus.SIGNING,
|
|
89
|
+
messageHash: params.messageHash,
|
|
90
|
+
nodeId: params.nodeId,
|
|
91
|
+
lockToken,
|
|
92
|
+
startedAtMs: now,
|
|
93
|
+
};
|
|
94
|
+
await this.duties.set(key, newRecord);
|
|
95
|
+
return { isNew: true as const, record: newRecord };
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
if (result.isNew) {
|
|
99
|
+
this.log.debug(`Acquired lock for duty ${params.dutyType} at slot ${params.slot}`, {
|
|
100
|
+
validatorAddress: params.validatorAddress.toString(),
|
|
101
|
+
nodeId: params.nodeId,
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
return { isNew: result.isNew, record: recordFromFields(result.record) };
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Update a duty to 'signed' status with the signature.
|
|
110
|
+
* Only succeeds if the lockToken matches.
|
|
111
|
+
*/
|
|
112
|
+
public updateDutySigned(
|
|
113
|
+
rollupAddress: EthAddress,
|
|
114
|
+
validatorAddress: EthAddress,
|
|
115
|
+
slot: SlotNumber,
|
|
116
|
+
dutyType: DutyType,
|
|
117
|
+
signature: string,
|
|
118
|
+
lockToken: string,
|
|
119
|
+
blockIndexWithinCheckpoint: number,
|
|
120
|
+
): Promise<boolean> {
|
|
121
|
+
const key = dutyKey(
|
|
122
|
+
rollupAddress.toString(),
|
|
123
|
+
validatorAddress.toString(),
|
|
124
|
+
slot.toString(),
|
|
125
|
+
dutyType,
|
|
126
|
+
blockIndexWithinCheckpoint,
|
|
127
|
+
);
|
|
128
|
+
|
|
129
|
+
return this.store.transactionAsync(async () => {
|
|
130
|
+
const existing = await this.duties.getAsync(key);
|
|
131
|
+
if (!existing) {
|
|
132
|
+
this.log.warn('Failed to update duty to signed: duty not found', {
|
|
133
|
+
rollupAddress: rollupAddress.toString(),
|
|
134
|
+
validatorAddress: validatorAddress.toString(),
|
|
135
|
+
slot: slot.toString(),
|
|
136
|
+
dutyType,
|
|
137
|
+
blockIndexWithinCheckpoint,
|
|
138
|
+
});
|
|
139
|
+
return false;
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
if (existing.lockToken !== lockToken) {
|
|
143
|
+
this.log.warn('Failed to update duty to signed: invalid token', {
|
|
144
|
+
rollupAddress: rollupAddress.toString(),
|
|
145
|
+
validatorAddress: validatorAddress.toString(),
|
|
146
|
+
slot: slot.toString(),
|
|
147
|
+
dutyType,
|
|
148
|
+
blockIndexWithinCheckpoint,
|
|
149
|
+
});
|
|
150
|
+
return false;
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
await this.duties.set(key, {
|
|
154
|
+
...existing,
|
|
155
|
+
status: DutyStatus.SIGNED,
|
|
156
|
+
signature,
|
|
157
|
+
completedAtMs: this.dateProvider.now(),
|
|
158
|
+
});
|
|
159
|
+
|
|
160
|
+
return true;
|
|
161
|
+
});
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* Delete a duty record.
|
|
166
|
+
* Only succeeds if the lockToken matches.
|
|
167
|
+
*/
|
|
168
|
+
public deleteDuty(
|
|
169
|
+
rollupAddress: EthAddress,
|
|
170
|
+
validatorAddress: EthAddress,
|
|
171
|
+
slot: SlotNumber,
|
|
172
|
+
dutyType: DutyType,
|
|
173
|
+
lockToken: string,
|
|
174
|
+
blockIndexWithinCheckpoint: number,
|
|
175
|
+
): Promise<boolean> {
|
|
176
|
+
const key = dutyKey(
|
|
177
|
+
rollupAddress.toString(),
|
|
178
|
+
validatorAddress.toString(),
|
|
179
|
+
slot.toString(),
|
|
180
|
+
dutyType,
|
|
181
|
+
blockIndexWithinCheckpoint,
|
|
182
|
+
);
|
|
183
|
+
|
|
184
|
+
return this.store.transactionAsync(async () => {
|
|
185
|
+
const existing = await this.duties.getAsync(key);
|
|
186
|
+
if (!existing || existing.lockToken !== lockToken) {
|
|
187
|
+
this.log.warn('Failed to delete duty: invalid token or duty not found', {
|
|
188
|
+
rollupAddress: rollupAddress.toString(),
|
|
189
|
+
validatorAddress: validatorAddress.toString(),
|
|
190
|
+
slot: slot.toString(),
|
|
191
|
+
dutyType,
|
|
192
|
+
blockIndexWithinCheckpoint,
|
|
193
|
+
});
|
|
194
|
+
return false;
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
await this.duties.delete(key);
|
|
198
|
+
return true;
|
|
199
|
+
});
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* Cleanup own stuck duties (SIGNING status older than maxAgeMs).
|
|
204
|
+
*/
|
|
205
|
+
public cleanupOwnStuckDuties(nodeId: string, maxAgeMs: number): Promise<number> {
|
|
206
|
+
const cutoffMs = this.dateProvider.now() - maxAgeMs;
|
|
207
|
+
|
|
208
|
+
return this.store.transactionAsync(async () => {
|
|
209
|
+
const keysToDelete: string[] = [];
|
|
210
|
+
for await (const [key, record] of this.duties.entriesAsync()) {
|
|
211
|
+
if (record.nodeId === nodeId && record.status === DutyStatus.SIGNING && record.startedAtMs < cutoffMs) {
|
|
212
|
+
keysToDelete.push(key);
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
for (const key of keysToDelete) {
|
|
216
|
+
await this.duties.delete(key);
|
|
217
|
+
}
|
|
218
|
+
return keysToDelete.length;
|
|
219
|
+
});
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* Cleanup duties with outdated rollup address.
|
|
224
|
+
*
|
|
225
|
+
* This is always a no-op for the LMDB implementation: the underlying store is created via
|
|
226
|
+
* DatabaseVersionManager (in factory.ts), which already resets the entire data directory at
|
|
227
|
+
* startup whenever the rollup address changes.
|
|
228
|
+
*/
|
|
229
|
+
public cleanupOutdatedRollupDuties(_currentRollupAddress: EthAddress): Promise<number> {
|
|
230
|
+
return Promise.resolve(0);
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* Cleanup old signed duties older than maxAgeMs.
|
|
235
|
+
*/
|
|
236
|
+
public cleanupOldDuties(maxAgeMs: number): Promise<number> {
|
|
237
|
+
const cutoffMs = this.dateProvider.now() - maxAgeMs;
|
|
238
|
+
|
|
239
|
+
return this.store.transactionAsync(async () => {
|
|
240
|
+
const keysToDelete: string[] = [];
|
|
241
|
+
for await (const [key, record] of this.duties.entriesAsync()) {
|
|
242
|
+
if (
|
|
243
|
+
record.status === DutyStatus.SIGNED &&
|
|
244
|
+
record.completedAtMs !== undefined &&
|
|
245
|
+
record.completedAtMs < cutoffMs
|
|
246
|
+
) {
|
|
247
|
+
keysToDelete.push(key);
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
for (const key of keysToDelete) {
|
|
251
|
+
await this.duties.delete(key);
|
|
252
|
+
}
|
|
253
|
+
return keysToDelete.length;
|
|
254
|
+
});
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
/**
|
|
258
|
+
* Close the underlying LMDB store.
|
|
259
|
+
*/
|
|
260
|
+
public async close(): Promise<void> {
|
|
261
|
+
await this.store.close();
|
|
262
|
+
this.log.debug('LMDB slashing protection database closed');
|
|
263
|
+
}
|
|
264
|
+
}
|
package/src/db/postgres.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* PostgreSQL implementation of SlashingProtectionDatabase
|
|
3
3
|
*/
|
|
4
|
-
import {
|
|
4
|
+
import { SlotNumber } from '@aztec/foundation/branded-types';
|
|
5
5
|
import { randomBytes } from '@aztec/foundation/crypto/random';
|
|
6
6
|
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
7
7
|
import { type Logger, createLogger } from '@aztec/foundation/log';
|
|
@@ -20,7 +20,7 @@ import {
|
|
|
20
20
|
UPDATE_DUTY_SIGNED,
|
|
21
21
|
} from './schema.js';
|
|
22
22
|
import type { CheckAndRecordParams, DutyRow, DutyType, InsertOrGetRow, ValidatorDutyRecord } from './types.js';
|
|
23
|
-
import { getBlockIndexFromDutyIdentifier } from './types.js';
|
|
23
|
+
import { getBlockIndexFromDutyIdentifier, recordFromFields } from './types.js';
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
26
|
* Minimal pool interface for database operations.
|
|
@@ -220,14 +220,16 @@ export class PostgresSlashingProtectionDatabase implements SlashingProtectionDat
|
|
|
220
220
|
}
|
|
221
221
|
|
|
222
222
|
/**
|
|
223
|
-
* Convert a database row to a ValidatorDutyRecord
|
|
223
|
+
* Convert a database row to a ValidatorDutyRecord.
|
|
224
|
+
* Maps snake_case column names to StoredDutyRecord (camelCase, ms timestamps),
|
|
225
|
+
* then delegates to the shared recordFromFields() converter.
|
|
224
226
|
*/
|
|
225
227
|
private rowToRecord(row: DutyRow): ValidatorDutyRecord {
|
|
226
|
-
return {
|
|
227
|
-
rollupAddress:
|
|
228
|
-
validatorAddress:
|
|
229
|
-
slot:
|
|
230
|
-
blockNumber:
|
|
228
|
+
return recordFromFields({
|
|
229
|
+
rollupAddress: row.rollup_address,
|
|
230
|
+
validatorAddress: row.validator_address,
|
|
231
|
+
slot: row.slot,
|
|
232
|
+
blockNumber: row.block_number,
|
|
231
233
|
blockIndexWithinCheckpoint: row.block_index_within_checkpoint,
|
|
232
234
|
dutyType: row.duty_type,
|
|
233
235
|
status: row.status,
|
|
@@ -235,10 +237,10 @@ export class PostgresSlashingProtectionDatabase implements SlashingProtectionDat
|
|
|
235
237
|
signature: row.signature ?? undefined,
|
|
236
238
|
nodeId: row.node_id,
|
|
237
239
|
lockToken: row.lock_token,
|
|
238
|
-
|
|
239
|
-
|
|
240
|
+
startedAtMs: row.started_at.getTime(),
|
|
241
|
+
completedAtMs: row.completed_at?.getTime(),
|
|
240
242
|
errorMessage: row.error_message ?? undefined,
|
|
241
|
-
};
|
|
243
|
+
});
|
|
242
244
|
}
|
|
243
245
|
|
|
244
246
|
/**
|
package/src/db/types.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
1
|
+
import {
|
|
2
|
+
BlockNumber,
|
|
3
|
+
type CheckpointNumber,
|
|
4
|
+
type IndexWithinCheckpoint,
|
|
5
|
+
SlotNumber,
|
|
6
|
+
} from '@aztec/foundation/branded-types';
|
|
7
|
+
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
3
8
|
import type { Signature } from '@aztec/foundation/eth-signature';
|
|
9
|
+
import { DutyType } from '@aztec/stdlib/ha-signing';
|
|
4
10
|
|
|
5
11
|
/**
|
|
6
12
|
* Row type from PostgreSQL query
|
|
@@ -23,24 +29,34 @@ export interface DutyRow {
|
|
|
23
29
|
}
|
|
24
30
|
|
|
25
31
|
/**
|
|
26
|
-
*
|
|
32
|
+
* Plain-primitive representation of a duty record suitable for serialization
|
|
33
|
+
* (e.g. msgpackr for LMDB). All domain types are stored as their string/number
|
|
34
|
+
* equivalents. Timestamps are Unix milliseconds.
|
|
27
35
|
*/
|
|
28
|
-
export interface
|
|
29
|
-
|
|
36
|
+
export interface StoredDutyRecord {
|
|
37
|
+
rollupAddress: string;
|
|
38
|
+
validatorAddress: string;
|
|
39
|
+
slot: string;
|
|
40
|
+
blockNumber: string;
|
|
41
|
+
blockIndexWithinCheckpoint: number;
|
|
42
|
+
dutyType: DutyType;
|
|
43
|
+
status: DutyStatus;
|
|
44
|
+
messageHash: string;
|
|
45
|
+
signature?: string;
|
|
46
|
+
nodeId: string;
|
|
47
|
+
lockToken: string;
|
|
48
|
+
/** Unix timestamp in milliseconds when signing started */
|
|
49
|
+
startedAtMs: number;
|
|
50
|
+
/** Unix timestamp in milliseconds when signing completed */
|
|
51
|
+
completedAtMs?: number;
|
|
52
|
+
errorMessage?: string;
|
|
30
53
|
}
|
|
31
54
|
|
|
32
55
|
/**
|
|
33
|
-
*
|
|
56
|
+
* Row type from INSERT_OR_GET_DUTY query (includes is_new flag)
|
|
34
57
|
*/
|
|
35
|
-
export
|
|
36
|
-
|
|
37
|
-
CHECKPOINT_PROPOSAL = 'CHECKPOINT_PROPOSAL',
|
|
38
|
-
ATTESTATION = 'ATTESTATION',
|
|
39
|
-
ATTESTATIONS_AND_SIGNERS = 'ATTESTATIONS_AND_SIGNERS',
|
|
40
|
-
GOVERNANCE_VOTE = 'GOVERNANCE_VOTE',
|
|
41
|
-
SLASHING_VOTE = 'SLASHING_VOTE',
|
|
42
|
-
AUTH_REQUEST = 'AUTH_REQUEST',
|
|
43
|
-
TXS = 'TXS',
|
|
58
|
+
export interface InsertOrGetRow extends DutyRow {
|
|
59
|
+
is_new: boolean;
|
|
44
60
|
}
|
|
45
61
|
|
|
46
62
|
/**
|
|
@@ -51,8 +67,12 @@ export enum DutyStatus {
|
|
|
51
67
|
SIGNED = 'signed',
|
|
52
68
|
}
|
|
53
69
|
|
|
70
|
+
// Re-export DutyType from stdlib
|
|
71
|
+
export { DutyType };
|
|
72
|
+
|
|
54
73
|
/**
|
|
55
|
-
*
|
|
74
|
+
* Rich representation of a validator duty, with branded types and Date objects.
|
|
75
|
+
* This is the common output type returned by all SlashingProtectionDatabase implementations.
|
|
56
76
|
*/
|
|
57
77
|
export interface ValidatorDutyRecord {
|
|
58
78
|
/** Ethereum address of the rollup contract */
|
|
@@ -85,6 +105,31 @@ export interface ValidatorDutyRecord {
|
|
|
85
105
|
errorMessage?: string;
|
|
86
106
|
}
|
|
87
107
|
|
|
108
|
+
/**
|
|
109
|
+
* Convert a {@link StoredDutyRecord} (plain-primitive wire format) to a
|
|
110
|
+
* {@link ValidatorDutyRecord} (rich domain type).
|
|
111
|
+
*
|
|
112
|
+
* Shared by LMDB and any future non-Postgres backend implementations.
|
|
113
|
+
*/
|
|
114
|
+
export function recordFromFields(stored: StoredDutyRecord): ValidatorDutyRecord {
|
|
115
|
+
return {
|
|
116
|
+
rollupAddress: EthAddress.fromString(stored.rollupAddress),
|
|
117
|
+
validatorAddress: EthAddress.fromString(stored.validatorAddress),
|
|
118
|
+
slot: SlotNumber.fromString(stored.slot),
|
|
119
|
+
blockNumber: BlockNumber.fromString(stored.blockNumber),
|
|
120
|
+
blockIndexWithinCheckpoint: stored.blockIndexWithinCheckpoint,
|
|
121
|
+
dutyType: stored.dutyType,
|
|
122
|
+
status: stored.status,
|
|
123
|
+
messageHash: stored.messageHash,
|
|
124
|
+
signature: stored.signature,
|
|
125
|
+
nodeId: stored.nodeId,
|
|
126
|
+
lockToken: stored.lockToken,
|
|
127
|
+
startedAt: new Date(stored.startedAtMs),
|
|
128
|
+
completedAt: stored.completedAtMs !== undefined ? new Date(stored.completedAtMs) : undefined,
|
|
129
|
+
errorMessage: stored.errorMessage,
|
|
130
|
+
};
|
|
131
|
+
}
|
|
132
|
+
|
|
88
133
|
/**
|
|
89
134
|
* Duty identifier for block proposals.
|
|
90
135
|
* blockIndexWithinCheckpoint is REQUIRED and must be >= 0.
|
package/src/factory.ts
CHANGED
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Factory functions for creating validator HA signers
|
|
3
3
|
*/
|
|
4
|
+
import { DateProvider } from '@aztec/foundation/timer';
|
|
5
|
+
import { createStore } from '@aztec/kv-store/lmdb-v2';
|
|
6
|
+
import type { LocalSignerConfig, ValidatorHASignerConfig } from '@aztec/stdlib/ha-signing';
|
|
7
|
+
import { getTelemetryClient } from '@aztec/telemetry-client';
|
|
8
|
+
|
|
4
9
|
import { Pool } from 'pg';
|
|
5
10
|
|
|
6
|
-
import
|
|
11
|
+
import { LmdbSlashingProtectionDatabase } from './db/lmdb.js';
|
|
7
12
|
import { PostgresSlashingProtectionDatabase } from './db/postgres.js';
|
|
8
|
-
import
|
|
13
|
+
import { HASignerMetrics } from './metrics.js';
|
|
14
|
+
import type { CreateHASignerDeps, CreateLocalSignerWithProtectionDeps, SlashingProtectionDatabase } from './types.js';
|
|
9
15
|
import { ValidatorHASigner } from './validator_ha_signer.js';
|
|
10
16
|
|
|
11
17
|
/**
|
|
@@ -23,7 +29,6 @@ import { ValidatorHASigner } from './validator_ha_signer.js';
|
|
|
23
29
|
* ```typescript
|
|
24
30
|
* const { signer, db } = await createHASigner({
|
|
25
31
|
* databaseUrl: process.env.DATABASE_URL,
|
|
26
|
-
* haSigningEnabled: true,
|
|
27
32
|
* nodeId: 'validator-node-1',
|
|
28
33
|
* pollingIntervalMs: 100,
|
|
29
34
|
* signingTimeoutMs: 3000,
|
|
@@ -55,6 +60,10 @@ export async function createHASigner(
|
|
|
55
60
|
if (!databaseUrl) {
|
|
56
61
|
throw new Error('databaseUrl is required for createHASigner');
|
|
57
62
|
}
|
|
63
|
+
|
|
64
|
+
const telemetryClient = deps?.telemetryClient ?? getTelemetryClient();
|
|
65
|
+
const dateProvider = deps?.dateProvider ?? new DateProvider();
|
|
66
|
+
|
|
58
67
|
// Create connection pool (or use provided pool)
|
|
59
68
|
let pool: Pool;
|
|
60
69
|
if (!deps?.pool) {
|
|
@@ -75,8 +84,56 @@ export async function createHASigner(
|
|
|
75
84
|
// Verify database schema is initialized and version matches
|
|
76
85
|
await db.initialize();
|
|
77
86
|
|
|
87
|
+
// Create metrics
|
|
88
|
+
const metrics = new HASignerMetrics(telemetryClient, signerConfig.nodeId);
|
|
89
|
+
|
|
78
90
|
// Create signer
|
|
79
|
-
const signer = new ValidatorHASigner(db, {
|
|
91
|
+
const signer = new ValidatorHASigner(db, signerConfig, { metrics, dateProvider });
|
|
92
|
+
|
|
93
|
+
return { signer, db };
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Create a local (single-node) signing protection signer backed by LMDB.
|
|
98
|
+
*
|
|
99
|
+
* This provides double-signing protection for nodes that are NOT running in a
|
|
100
|
+
* high-availability (multi-node) setup. It prevents a proposer from sending two
|
|
101
|
+
* proposals for the same slot if the node crashes and restarts mid-proposal.
|
|
102
|
+
*
|
|
103
|
+
* When `config.dataDirectory` is set, the protection database is persisted to disk
|
|
104
|
+
* and survives crashes/restarts. When unset, an ephemeral in-memory store is
|
|
105
|
+
* used which protects within a single run but not across restarts.
|
|
106
|
+
*
|
|
107
|
+
* @param config - Local signer config
|
|
108
|
+
* @param deps - Optional dependencies (telemetry, date provider).
|
|
109
|
+
* @returns An object containing the signer and database instances.
|
|
110
|
+
*/
|
|
111
|
+
export async function createLocalSignerWithProtection(
|
|
112
|
+
config: LocalSignerConfig,
|
|
113
|
+
deps?: CreateLocalSignerWithProtectionDeps,
|
|
114
|
+
): Promise<{
|
|
115
|
+
signer: ValidatorHASigner;
|
|
116
|
+
db: SlashingProtectionDatabase;
|
|
117
|
+
}> {
|
|
118
|
+
const telemetryClient = deps?.telemetryClient ?? getTelemetryClient();
|
|
119
|
+
const dateProvider = deps?.dateProvider ?? new DateProvider();
|
|
120
|
+
|
|
121
|
+
const kvStore = await createStore('signing-protection', LmdbSlashingProtectionDatabase.SCHEMA_VERSION, {
|
|
122
|
+
dataDirectory: config.dataDirectory,
|
|
123
|
+
dataStoreMapSizeKb: config.signingProtectionMapSizeKb ?? config.dataStoreMapSizeKb,
|
|
124
|
+
l1Contracts: config.l1Contracts,
|
|
125
|
+
});
|
|
126
|
+
|
|
127
|
+
const db = new LmdbSlashingProtectionDatabase(kvStore, dateProvider);
|
|
128
|
+
|
|
129
|
+
const signerConfig = {
|
|
130
|
+
...config,
|
|
131
|
+
nodeId: config.nodeId || 'local',
|
|
132
|
+
};
|
|
133
|
+
|
|
134
|
+
const metrics = new HASignerMetrics(telemetryClient, signerConfig.nodeId, 'LocalSigningProtectionMetrics');
|
|
135
|
+
|
|
136
|
+
const signer = new ValidatorHASigner(db, signerConfig, { metrics, dateProvider });
|
|
80
137
|
|
|
81
138
|
return { signer, db };
|
|
82
139
|
}
|