@aztec/p2p 4.0.4 → 4.1.0-rc.2

package/src/msg_validators/proposal_validator/proposal_validator_test_suite.ts

@@ -1,373 +0,0 @@
-import type { EpochCacheInterface } from '@aztec/epoch-cache';
-import { NoCommitteeError } from '@aztec/ethereum/contracts';
-import type { Secp256k1Signer } from '@aztec/foundation/crypto/secp256k1-signer';
-import type { EthAddress } from '@aztec/foundation/eth-address';
-import {
-  type BlockProposal,
-  type CheckpointProposal,
-  PeerErrorSeverity,
-  type ValidationResult,
-} from '@aztec/stdlib/p2p';
-import type { TxHash } from '@aztec/stdlib/tx';
-
-import { jest } from '@jest/globals';
-import type { MockProxy } from 'jest-mock-extended';
-
-export interface ProposalValidatorTestParams<TProposal extends BlockProposal | CheckpointProposal> {
-  validatorFactory: (
-    epochCache: EpochCacheInterface,
-    opts: { txsPermitted: boolean; maxTxsPerBlock?: number },
-  ) => { validate: (proposal: TProposal) => Promise<ValidationResult> };
-  makeProposal: (options?: any) => Promise<TProposal>;
-  makeHeader: (epochNumber: number | bigint, slotNumber: number | bigint, blockNumber: number | bigint) => any;
-  getSigner: () => Secp256k1Signer;
-  getAddress: (signer?: Secp256k1Signer) => EthAddress;
-  getSlot: (slot: number | bigint) => any;
-  getTxHashes: (n: number) => TxHash[];
-  getTxs: () => any[];
-  epochCacheMock: () => MockProxy<EpochCacheInterface>;
-}
-
-export function sharedProposalValidatorTests<TProposal extends BlockProposal | CheckpointProposal>(
-  params: ProposalValidatorTestParams<TProposal>,
-) {
-  const { validatorFactory, makeProposal, makeHeader, getSigner, getAddress, getSlot, getTxHashes, epochCacheMock } =
-    params;
-
-  describe('shared proposal validation logic', () => {
-    let epochCache: MockProxy<EpochCacheInterface>;
-    let validator: { validate: (proposal: TProposal) => Promise<ValidationResult> };
-    const previousSlot = getSlot(99);
-    const currentSlot = getSlot(100);
-    const nextSlot = getSlot(101);
-
-    function mockGetProposer(currentProposer: EthAddress, nextProposer: EthAddress, previousProposer?: EthAddress) {
-      epochCache.getProposerAttesterAddressInSlot.mockImplementation(slot => {
-        if (slot === currentSlot) {
-          return Promise.resolve(currentProposer);
-        }
-        if (slot === nextSlot) {
-          return Promise.resolve(nextProposer);
-        }
-        if (slot === previousSlot && previousProposer) {
-          return Promise.resolve(previousProposer);
-        }
-        throw new Error('Unexpected argument');
-      });
-    }
-
-    beforeEach(() => {
-      epochCache = epochCacheMock();
-      validator = validatorFactory(epochCache, { txsPermitted: true });
-      epochCache.getCurrentAndNextSlot.mockReturnValue({
-        currentSlot: currentSlot,
-        nextSlot: nextSlot,
-      });
-    });
-
-    it('returns high tolerance error if slot number is not current or next slot (outside clock tolerance)', async () => {
-      const header = makeHeader(1, 99, 99);
-      const mockProposal = await makeProposal({ blockHeader: header, lastBlockHeader: header });
-
-      // Mock getEpochAndSlotNow to return time OUTSIDE clock tolerance (1000ms elapsed)
-      epochCache.getEpochAndSlotNow.mockReturnValue({
-        epoch: 1 as any,
-        slot: currentSlot,
-        ts: 1000n, // slot started at 1000 seconds
-        nowMs: 1001000n, // 1000ms elapsed, outside 500ms tolerance
-      });
-
-      epochCache.getProposerAttesterAddressInSlot.mockResolvedValue(getAddress());
-      const result = await validator.validate(mockProposal);
-      expect(result).toEqual({ result: 'reject', severity: PeerErrorSeverity.HighToleranceError });
-
-      // Should not try to resolve proposers if base validation fails
-      expect(epochCache.getProposerAttesterAddressInSlot).not.toHaveBeenCalled();
-    });
-
-    it('returns ignore if previous slot proposal is within clock tolerance', async () => {
-      const previousProposer = getSigner();
-      const header = makeHeader(1, 99, 99);
-      const mockProposal = await makeProposal({
-        blockHeader: header,
-        lastBlockHeader: header,
-        signer: previousProposer,
-      });
-
-      // Mock getEpochAndSlotNow to return time WITHIN clock tolerance (100ms elapsed)
-      epochCache.getEpochAndSlotNow.mockReturnValue({
-        epoch: 1 as any,
-        slot: currentSlot,
-        ts: 1000n, // slot started at 1000 seconds
-        nowMs: 1000100n, // 100ms elapsed, within 500ms tolerance
-      });
-
-      mockGetProposer(getAddress(), getAddress(), getAddress(previousProposer));
-      const result = await validator.validate(mockProposal);
-      expect(result).toEqual({ result: 'ignore' });
-    });
-
-    it('returns mid tolerance error if proposal has invalid signature', async () => {
-      const currentProposer = getSigner();
-      const header = makeHeader(1, 100, 100);
-      const mockProposal = await makeProposal({
-        blockHeader: header,
-        lastBlockHeader: header,
-        signer: currentProposer,
-      });
-
-      // Override getSender to return undefined (invalid signature)
-      jest.spyOn(mockProposal as any, 'getSender').mockReturnValue(undefined);
-
-      mockGetProposer(getAddress(currentProposer), getAddress());
-      const result = await validator.validate(mockProposal);
-      expect(result).toEqual({ result: 'reject', severity: PeerErrorSeverity.MidToleranceError });
-
-      // Should not try to resolve proposer if signature is invalid
-      expect(epochCache.getProposerAttesterAddressInSlot).not.toHaveBeenCalled();
-    });
-
-    it('returns mid tolerance error if proposer is not current proposer for current slot', async () => {
-      const currentProposer = getSigner();
-      const nextProposer = getSigner();
-      const invalidProposer = getSigner();
-      const header = makeHeader(1, 100, 100);
-      const mockProposal = await makeProposal({
-        blockHeader: header,
-        lastBlockHeader: header,
-        signer: invalidProposer,
-      });
-
-      mockGetProposer(getAddress(currentProposer), getAddress(nextProposer));
-      const result = await validator.validate(mockProposal);
-      expect(result).toEqual({ result: 'reject', severity: PeerErrorSeverity.MidToleranceError });
-    });
-
-    it('returns mid tolerance error if proposer is not next proposer for next slot', async () => {
-      const currentProposer = getSigner();
-      const nextProposer = getSigner();
-      const invalidProposer = getSigner();
-      const header = makeHeader(1, 101, 101);
-      const mockProposal = await makeProposal({
-        blockHeader: header,
-        lastBlockHeader: header,
-        signer: invalidProposer,
-      });
-
-      mockGetProposer(getAddress(currentProposer), getAddress(nextProposer));
-      const result = await validator.validate(mockProposal);
-      expect(result).toEqual({ result: 'reject', severity: PeerErrorSeverity.MidToleranceError });
-    });
-
-    it('returns mid tolerance error if proposer is current proposer but proposal is for next slot', async () => {
-      const currentProposer = getSigner();
-      const nextProposer = getSigner();
-      const header = makeHeader(1, 101, 101);
-      const mockProposal = await makeProposal({
-        blockHeader: header,
-        lastBlockHeader: header,
-        signer: currentProposer,
-      });
-
-      mockGetProposer(getAddress(currentProposer), getAddress(nextProposer));
-      const result = await validator.validate(mockProposal);
-      expect(result).toEqual({ result: 'reject', severity: PeerErrorSeverity.MidToleranceError });
-    });
-
-    it('accepts proposal when proposer is undefined (open committee)', async () => {
-      const currentProposer = getSigner();
-      const header = makeHeader(1, 100, 100);
-      const mockProposal = await makeProposal({
-        blockHeader: header,
-        lastBlockHeader: header,
-        signer: currentProposer,
-      });
-
-      epochCache.getProposerAttesterAddressInSlot.mockResolvedValue(undefined);
-      const result = await validator.validate(mockProposal);
-      expect(result).toEqual({ result: 'accept' });
-    });
-
-    it('returns low tolerance error when getProposerAttesterAddressInSlot throws NoCommitteeError', async () => {
-      const currentProposer = getSigner();
-      const header = makeHeader(1, 100, 100);
-      const mockProposal = await makeProposal({
-        blockHeader: header,
-        lastBlockHeader: header,
-        signer: currentProposer,
-      });
-
-      epochCache.getProposerAttesterAddressInSlot.mockRejectedValue(new NoCommitteeError());
-      const result = await validator.validate(mockProposal);
-      expect(result).toEqual({ result: 'reject', severity: PeerErrorSeverity.LowToleranceError });
-    });
-
-    it('returns undefined if proposal is valid for current slot and proposer', async () => {
-      const currentProposer = getSigner();
-      const nextProposer = getSigner();
-      const header = makeHeader(1, 100, 100);
-      const mockProposal = await makeProposal({
-        blockHeader: header,
-        lastBlockHeader: header,
-        signer: currentProposer,
-      });
-
-      mockGetProposer(getAddress(currentProposer), getAddress(nextProposer));
-      const result = await validator.validate(mockProposal);
-      expect(result).toEqual({ result: 'accept' });
-    });
-
-    it('returns undefined if proposal is valid for next slot and proposer', async () => {
-      const currentProposer = getSigner();
-      const nextProposer = getSigner();
-      const header = makeHeader(1, 101, 101);
-      const mockProposal = await makeProposal({ blockHeader: header, lastBlockHeader: header, signer: nextProposer });
-
-      mockGetProposer(getAddress(currentProposer), getAddress(nextProposer));
-      const result = await validator.validate(mockProposal);
-      expect(result).toEqual({ result: 'accept' });
-    });
-
-    describe('transaction permission validation', () => {
-      it('returns mid tolerance error if txs not permitted and proposal contains txHashes', async () => {
-        const currentProposer = getSigner();
-        const validatorWithTxsDisabled = validatorFactory(epochCache, { txsPermitted: false });
-        const header = makeHeader(1, 100, 100);
-        const mockProposal = await makeProposal({
-          blockHeader: header,
-          lastBlockHeader: header,
-          signer: currentProposer,
-          txHashes: getTxHashes(2),
-        });
-
-        mockGetProposer(getAddress(currentProposer), getAddress());
-        const result = await validatorWithTxsDisabled.validate(mockProposal);
-        expect(result).toEqual({ result: 'reject', severity: PeerErrorSeverity.MidToleranceError });
-      });
-
-      it('returns undefined if txs not permitted but proposal has no txHashes', async () => {
-        const currentProposer = getSigner();
-        const validatorWithTxsDisabled = validatorFactory(epochCache, { txsPermitted: false });
-        const header = makeHeader(1, 100, 100);
-        const mockProposal = await makeProposal({
-          blockHeader: header,
-          lastBlockHeader: header,
-          signer: currentProposer,
-          txHashes: getTxHashes(0),
-        });
-
-        mockGetProposer(getAddress(currentProposer), getAddress());
-        const result = await validatorWithTxsDisabled.validate(mockProposal);
-        expect(result).toEqual({ result: 'accept' });
-      });
-
-      it('returns undefined if txs permitted and proposal contains txHashes', async () => {
-        const currentProposer = getSigner();
-        const header = makeHeader(1, 100, 100);
-        const mockProposal = await makeProposal({
-          blockHeader: header,
-          lastBlockHeader: header,
-          signer: currentProposer,
-          txHashes: getTxHashes(2),
-        });
-
-        mockGetProposer(getAddress(currentProposer), getAddress());
-        const result = await validator.validate(mockProposal);
-        expect(result).toEqual({ result: 'accept' });
-      });
-    });
-
-    describe('embedded tx validation', () => {
-      it('returns mid tolerance error if embedded txs are not listed in txHashes', async () => {
-        const currentProposer = getSigner();
-        const txHashes = getTxHashes(2);
-        const header = makeHeader(1, 100, 100);
-        const mockProposal = await makeProposal({
-          blockHeader: header,
-          lastBlockHeader: header,
-          signer: currentProposer,
-          txHashes,
-        });
-
-        // Create a fake tx whose hash is NOT in txHashes
-        const fakeTxHash = getTxHashes(1)[0];
-        const fakeTx = { getTxHash: () => fakeTxHash, validateTxHash: () => Promise.resolve(true) };
-        Object.defineProperty(mockProposal, 'txs', { get: () => [fakeTx], configurable: true });
-
-        mockGetProposer(getAddress(currentProposer), getAddress());
-        const result = await validator.validate(mockProposal);
-        expect(result).toEqual({ result: 'reject', severity: PeerErrorSeverity.MidToleranceError });
-      });
-
-      it('returns low tolerance error if embedded tx has invalid tx hash', async () => {
-        const currentProposer = getSigner();
-        const txHashes = getTxHashes(2);
-        const header = makeHeader(1, 100, 100);
-        const mockProposal = await makeProposal({
-          blockHeader: header,
-          lastBlockHeader: header,
-          signer: currentProposer,
-          txHashes,
-        });
-
-        // Create a fake tx whose hash IS in txHashes but validateTxHash returns false
-        const fakeTx = { getTxHash: () => txHashes[0], validateTxHash: () => Promise.resolve(false) };
-        Object.defineProperty(mockProposal, 'txs', { get: () => [fakeTx], configurable: true });
-
-        mockGetProposer(getAddress(currentProposer), getAddress());
-        const result = await validator.validate(mockProposal);
-        expect(result).toEqual({ result: 'reject', severity: PeerErrorSeverity.LowToleranceError });
-      });
-    });
-
-    describe('maxTxsPerBlock validation', () => {
-      it('rejects proposal when txHashes exceed maxTxsPerBlock', async () => {
-        const validatorWithMaxTxs = validatorFactory(epochCache, { txsPermitted: true, maxTxsPerBlock: 2 });
-        const currentProposer = getSigner();
-        const header = makeHeader(1, 100, 100);
-        const mockProposal = await makeProposal({
-          blockHeader: header,
-          lastBlockHeader: header,
-          signer: currentProposer,
-          txHashes: getTxHashes(3),
-        });
-
-        mockGetProposer(getAddress(currentProposer), getAddress());
-        const result = await validatorWithMaxTxs.validate(mockProposal);
-        expect(result).toEqual({ result: 'reject', severity: PeerErrorSeverity.MidToleranceError });
-      });
-
-      it('accepts proposal when txHashes count equals maxTxsPerBlock', async () => {
-        const validatorWithMaxTxs = validatorFactory(epochCache, { txsPermitted: true, maxTxsPerBlock: 2 });
-        const currentProposer = getSigner();
-        const header = makeHeader(1, 100, 100);
-        const mockProposal = await makeProposal({
-          blockHeader: header,
-          lastBlockHeader: header,
-          signer: currentProposer,
-          txHashes: getTxHashes(2),
-        });
-
-        mockGetProposer(getAddress(currentProposer), getAddress());
-        const result = await validatorWithMaxTxs.validate(mockProposal);
-        expect(result).toEqual({ result: 'accept' });
-      });
-
-      it('accepts proposal when maxTxsPerBlock is not set (unlimited)', async () => {
-        // Default validator has no maxTxsPerBlock
-        const currentProposer = getSigner();
-        const header = makeHeader(1, 100, 100);
-        const mockProposal = await makeProposal({
-          blockHeader: header,
-          lastBlockHeader: header,
-          signer: currentProposer,
-          txHashes: getTxHashes(10),
-        });
-
-        mockGetProposer(getAddress(currentProposer), getAddress());
-        const result = await validator.validate(mockProposal);
-        expect(result).toEqual({ result: 'accept' });
-      });
-    });
-  });
-}