@aztec/validator-client 0.0.1-commit.29c6b1a3 → 0.0.1-commit.2b2662070

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.
Files changed (54) hide show
  1. package/README.md +60 -18
  2. package/dest/checkpoint_builder.d.ts +26 -14
  3. package/dest/checkpoint_builder.d.ts.map +1 -1
  4. package/dest/checkpoint_builder.js +137 -46
  5. package/dest/config.d.ts +1 -1
  6. package/dest/config.d.ts.map +1 -1
  7. package/dest/config.js +26 -6
  8. package/dest/duties/validation_service.d.ts +7 -9
  9. package/dest/duties/validation_service.d.ts.map +1 -1
  10. package/dest/duties/validation_service.js +15 -33
  11. package/dest/factory.d.ts +7 -4
  12. package/dest/factory.d.ts.map +1 -1
  13. package/dest/factory.js +6 -5
  14. package/dest/index.d.ts +2 -3
  15. package/dest/index.d.ts.map +1 -1
  16. package/dest/index.js +1 -2
  17. package/dest/key_store/ha_key_store.d.ts +1 -1
  18. package/dest/key_store/ha_key_store.d.ts.map +1 -1
  19. package/dest/key_store/ha_key_store.js +3 -3
  20. package/dest/metrics.d.ts +16 -3
  21. package/dest/metrics.d.ts.map +1 -1
  22. package/dest/metrics.js +58 -5
  23. package/dest/proposal_handler.d.ts +108 -0
  24. package/dest/proposal_handler.d.ts.map +1 -0
  25. package/dest/proposal_handler.js +974 -0
  26. package/dest/validator.d.ts +45 -23
  27. package/dest/validator.d.ts.map +1 -1
  28. package/dest/validator.js +193 -199
  29. package/package.json +19 -19
  30. package/src/checkpoint_builder.ts +183 -50
  31. package/src/config.ts +26 -6
  32. package/src/duties/validation_service.ts +25 -37
  33. package/src/factory.ts +10 -3
  34. package/src/index.ts +1 -2
  35. package/src/key_store/ha_key_store.ts +3 -3
  36. package/src/metrics.ts +81 -6
  37. package/src/proposal_handler.ts +1042 -0
  38. package/src/validator.ts +269 -226
  39. package/dest/block_proposal_handler.d.ts +0 -63
  40. package/dest/block_proposal_handler.d.ts.map +0 -1
  41. package/dest/block_proposal_handler.js +0 -546
  42. package/dest/tx_validator/index.d.ts +0 -3
  43. package/dest/tx_validator/index.d.ts.map +0 -1
  44. package/dest/tx_validator/index.js +0 -2
  45. package/dest/tx_validator/nullifier_cache.d.ts +0 -14
  46. package/dest/tx_validator/nullifier_cache.d.ts.map +0 -1
  47. package/dest/tx_validator/nullifier_cache.js +0 -24
  48. package/dest/tx_validator/tx_validator_factory.d.ts +0 -18
  49. package/dest/tx_validator/tx_validator_factory.d.ts.map +0 -1
  50. package/dest/tx_validator/tx_validator_factory.js +0 -54
  51. package/src/block_proposal_handler.ts +0 -554
  52. package/src/tx_validator/index.ts +0 -2
  53. package/src/tx_validator/nullifier_cache.ts +0 -30
  54. package/src/tx_validator/tx_validator_factory.ts +0 -135
package/src/factory.ts CHANGED
@@ -7,13 +7,14 @@ import type { L2BlockSink, L2BlockSource } from '@aztec/stdlib/block';
7
7
  import type { ValidatorClientFullConfig, WorldStateSynchronizer } from '@aztec/stdlib/interfaces/server';
8
8
  import type { L1ToL2MessageSource } from '@aztec/stdlib/messaging';
9
9
  import type { TelemetryClient } from '@aztec/telemetry-client';
10
+ import type { SlashingProtectionDatabase } from '@aztec/validator-ha-signer/types';
10
11
 
11
- import { BlockProposalHandler } from './block_proposal_handler.js';
12
12
  import type { FullNodeCheckpointsBuilder } from './checkpoint_builder.js';
13
13
  import { ValidatorMetrics } from './metrics.js';
14
+ import { ProposalHandler } from './proposal_handler.js';
14
15
  import { ValidatorClient } from './validator.js';
15
16
 
16
- export function createBlockProposalHandler(
17
+ export function createProposalHandler(
17
18
  config: ValidatorClientFullConfig,
18
19
  deps: {
19
20
  checkpointsBuilder: FullNodeCheckpointsBuilder;
@@ -22,6 +23,7 @@ export function createBlockProposalHandler(
22
23
  l1ToL2MessageSource: L1ToL2MessageSource;
23
24
  p2pClient: P2PClient;
24
25
  epochCache: EpochCache;
26
+ blobClient: BlobClientInterface;
25
27
  dateProvider: DateProvider;
26
28
  telemetry: TelemetryClient;
27
29
  },
@@ -29,8 +31,9 @@ export function createBlockProposalHandler(
29
31
  const metrics = new ValidatorMetrics(deps.telemetry);
30
32
  const blockProposalValidator = new BlockProposalValidator(deps.epochCache, {
31
33
  txsPermitted: !config.disableTransactions,
34
+ maxTxsPerBlock: config.validateMaxTxsPerBlock ?? config.validateMaxTxsPerCheckpoint,
32
35
  });
33
- return new BlockProposalHandler(
36
+ return new ProposalHandler(
34
37
  deps.checkpointsBuilder,
35
38
  deps.worldState,
36
39
  deps.blockSource,
@@ -39,9 +42,11 @@ export function createBlockProposalHandler(
39
42
  blockProposalValidator,
40
43
  deps.epochCache,
41
44
  config,
45
+ deps.blobClient,
42
46
  metrics,
43
47
  deps.dateProvider,
44
48
  deps.telemetry,
49
+ undefined,
45
50
  );
46
51
  }
47
52
 
@@ -58,6 +63,7 @@ export function createValidatorClient(
58
63
  epochCache: EpochCache;
59
64
  keyStoreManager: KeystoreManager | undefined;
60
65
  blobClient: BlobClientInterface;
66
+ slashingProtectionDb?: SlashingProtectionDatabase;
61
67
  },
62
68
  ) {
63
69
  if (config.disableValidator || !deps.keyStoreManager) {
@@ -78,5 +84,6 @@ export function createValidatorClient(
78
84
  deps.blobClient,
79
85
  deps.dateProvider,
80
86
  deps.telemetry,
87
+ deps.slashingProtectionDb,
81
88
  );
82
89
  }
package/src/index.ts CHANGED
@@ -1,7 +1,6 @@
1
- export * from './block_proposal_handler.js';
1
+ export * from './proposal_handler.js';
2
2
  export * from './checkpoint_builder.js';
3
3
  export * from './config.js';
4
4
  export * from './factory.js';
5
5
  export * from './validator.js';
6
6
  export * from './key_store/index.js';
7
- export * from './tx_validator/index.js';
@@ -240,7 +240,7 @@ export class HAKeyStore implements ExtendedValidatorKeyStore {
240
240
  }
241
241
 
242
242
  if (error instanceof SlashingProtectionError) {
243
- this.log.warn(`Duty already signed by another node with different payload`, {
243
+ this.log.info(`Duty already signed by another node with different payload`, {
244
244
  dutyType: context.dutyType,
245
245
  slot: context.slot,
246
246
  existingMessageHash: error.existingMessageHash,
@@ -256,8 +256,8 @@ export class HAKeyStore implements ExtendedValidatorKeyStore {
256
256
  /**
257
257
  * Start the high-availability key store
258
258
  */
259
- public start(): Promise<void> {
260
- return Promise.resolve(this.haSigner.start());
259
+ public async start() {
260
+ await this.haSigner.start();
261
261
  }
262
262
 
263
263
  /**
package/src/metrics.ts CHANGED
@@ -1,3 +1,5 @@
1
+ import type { EpochNumber } from '@aztec/foundation/branded-types';
2
+ import type { EthAddress } from '@aztec/foundation/eth-address';
1
3
  import type { BlockProposal } from '@aztec/stdlib/p2p';
2
4
  import {
3
5
  Attributes,
@@ -6,38 +8,83 @@ import {
6
8
  Metrics,
7
9
  type TelemetryClient,
8
10
  type UpDownCounter,
11
+ createUpDownCounterWithDefault,
9
12
  } from '@aztec/telemetry-client';
10
13
 
14
+ import type { BlockProposalValidationFailureReason } from './proposal_handler.js';
15
+
11
16
  export class ValidatorMetrics {
12
17
  private failedReexecutionCounter: UpDownCounter;
13
18
  private successfulAttestationsCount: UpDownCounter;
14
19
  private failedAttestationsBadProposalCount: UpDownCounter;
15
20
  private failedAttestationsNodeIssueCount: UpDownCounter;
21
+ private currentEpoch: Gauge;
22
+ private attestedEpochCount: UpDownCounter;
16
23
 
17
24
  private reexMana: Histogram;
18
25
  private reexTx: Histogram;
19
26
  private reexDuration: Gauge;
27
+ private checkpointProposalToPipelinedStateDuration: Histogram;
28
+ private checkpointProposalReceiveOffsetFromNextSlotBoundary: Histogram;
20
29
 
21
30
  constructor(telemetryClient: TelemetryClient) {
22
31
  const meter = telemetryClient.getMeter('Validator');
23
32
 
24
- this.failedReexecutionCounter = meter.createUpDownCounter(Metrics.VALIDATOR_FAILED_REEXECUTION_COUNT);
33
+ this.failedReexecutionCounter = createUpDownCounterWithDefault(meter, Metrics.VALIDATOR_FAILED_REEXECUTION_COUNT, {
34
+ [Attributes.STATUS]: ['failed'],
35
+ });
25
36
 
26
- this.successfulAttestationsCount = meter.createUpDownCounter(Metrics.VALIDATOR_ATTESTATION_SUCCESS_COUNT);
37
+ this.successfulAttestationsCount = createUpDownCounterWithDefault(
38
+ meter,
39
+ Metrics.VALIDATOR_ATTESTATION_SUCCESS_COUNT,
40
+ );
27
41
 
28
- this.failedAttestationsBadProposalCount = meter.createUpDownCounter(
42
+ this.failedAttestationsBadProposalCount = createUpDownCounterWithDefault(
43
+ meter,
29
44
  Metrics.VALIDATOR_ATTESTATION_FAILED_BAD_PROPOSAL_COUNT,
45
+ {
46
+ [Attributes.ERROR_TYPE]: [
47
+ 'invalid_proposal',
48
+ 'state_mismatch',
49
+ 'failed_txs',
50
+ 'in_hash_mismatch',
51
+ 'parent_block_wrong_slot',
52
+ ],
53
+ [Attributes.IS_COMMITTEE_MEMBER]: [true, false],
54
+ },
30
55
  );
31
56
 
32
- this.failedAttestationsNodeIssueCount = meter.createUpDownCounter(
57
+ this.failedAttestationsNodeIssueCount = createUpDownCounterWithDefault(
58
+ meter,
33
59
  Metrics.VALIDATOR_ATTESTATION_FAILED_NODE_ISSUE_COUNT,
60
+ {
61
+ [Attributes.ERROR_TYPE]: [
62
+ 'parent_block_not_found',
63
+ 'global_variables_mismatch',
64
+ 'block_number_already_exists',
65
+ 'txs_not_available',
66
+ 'timeout',
67
+ 'unknown_error',
68
+ ],
69
+ [Attributes.IS_COMMITTEE_MEMBER]: [true, false],
70
+ },
34
71
  );
35
72
 
73
+ this.currentEpoch = meter.createGauge(Metrics.VALIDATOR_CURRENT_EPOCH);
74
+
75
+ this.attestedEpochCount = createUpDownCounterWithDefault(meter, Metrics.VALIDATOR_ATTESTED_EPOCH_COUNT);
76
+
36
77
  this.reexMana = meter.createHistogram(Metrics.VALIDATOR_RE_EXECUTION_MANA);
37
78
 
38
79
  this.reexTx = meter.createHistogram(Metrics.VALIDATOR_RE_EXECUTION_TX_COUNT);
39
80
 
40
81
  this.reexDuration = meter.createGauge(Metrics.VALIDATOR_RE_EXECUTION_TIME);
82
+ this.checkpointProposalToPipelinedStateDuration = meter.createHistogram(
83
+ Metrics.VALIDATOR_CHECKPOINT_PROPOSAL_TO_PIPELINED_STATE_DURATION,
84
+ );
85
+ this.checkpointProposalReceiveOffsetFromNextSlotBoundary = meter.createHistogram(
86
+ Metrics.VALIDATOR_CHECKPOINT_PROPOSAL_RECEIVE_OFFSET_FROM_NEXT_SLOT_BOUNDARY,
87
+ );
41
88
  }
42
89
 
43
90
  public recordReex(time: number, txs: number, mManaTotal: number) {
@@ -46,6 +93,16 @@ export class ValidatorMetrics {
46
93
  this.reexMana.record(mManaTotal);
47
94
  }
48
95
 
96
+ public recordCheckpointProposalToPipelinedStateDuration(durationMs: number) {
97
+ this.checkpointProposalToPipelinedStateDuration.record(Math.ceil(durationMs));
98
+ }
99
+
100
+ public recordCheckpointProposalReceiveOffsetFromNextSlotBoundary(offsetMs: number) {
101
+ this.checkpointProposalReceiveOffsetFromNextSlotBoundary.record(Math.ceil(Math.abs(offsetMs)), {
102
+ [Attributes.SLOT_BOUNDARY_SIDE]: offsetMs < 0 ? 'before' : 'after',
103
+ });
104
+ }
105
+
49
106
  public recordFailedReexecution(proposal: BlockProposal) {
50
107
  const proposer = proposal.getSender();
51
108
  this.failedReexecutionCounter.add(1, {
@@ -58,17 +115,35 @@ export class ValidatorMetrics {
58
115
  this.successfulAttestationsCount.add(num);
59
116
  }
60
117
 
61
- public incFailedAttestationsBadProposal(num: number, reason: string, inCommittee: boolean) {
118
+ public incFailedAttestationsBadProposal(
119
+ num: number,
120
+ reason: BlockProposalValidationFailureReason,
121
+ inCommittee: boolean,
122
+ ) {
62
123
  this.failedAttestationsBadProposalCount.add(num, {
63
124
  [Attributes.ERROR_TYPE]: reason,
64
125
  [Attributes.IS_COMMITTEE_MEMBER]: inCommittee,
65
126
  });
66
127
  }
67
128
 
68
- public incFailedAttestationsNodeIssue(num: number, reason: string, inCommittee: boolean) {
129
+ public incFailedAttestationsNodeIssue(
130
+ num: number,
131
+ reason: BlockProposalValidationFailureReason,
132
+ inCommittee: boolean,
133
+ ) {
69
134
  this.failedAttestationsNodeIssueCount.add(num, {
70
135
  [Attributes.ERROR_TYPE]: reason,
71
136
  [Attributes.IS_COMMITTEE_MEMBER]: inCommittee,
72
137
  });
73
138
  }
139
+
140
+ /** Update the gauge tracking the current epoch number (proxy for total epochs elapsed). */
141
+ public setCurrentEpoch(epoch: EpochNumber) {
142
+ this.currentEpoch.record(Number(epoch));
143
+ }
144
+
145
+ /** Increment the count of epochs in which the given attester submitted at least one attestation. */
146
+ public incAttestedEpochCount(attester: EthAddress) {
147
+ this.attestedEpochCount.add(1, { [Attributes.ATTESTER_ADDRESS]: attester.toString() });
148
+ }
74
149
  }