@aztec/aztec-node 0.0.0-test.0 → 0.0.1-commit.001888fc

package/dest/sentinel/sentinel.js

@@ -0,0 +1,429 @@
+import { BlockNumber, SlotNumber } from '@aztec/foundation/branded-types';
+import { countWhile, filterAsync, fromEntries, getEntries, mapValues } from '@aztec/foundation/collection';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { createLogger } from '@aztec/foundation/log';
+import { RunningPromise } from '@aztec/foundation/running-promise';
+import { L2TipsMemoryStore } from '@aztec/kv-store/stores';
+import { OffenseType, WANT_TO_SLASH_EVENT } from '@aztec/slasher';
+import { L2BlockStream, getAttestationInfoFromPublishedCheckpoint } from '@aztec/stdlib/block';
+import { getEpochAtSlot, getSlotRangeForEpoch, getTimestampForSlot } from '@aztec/stdlib/epoch-helpers';
+import EventEmitter from 'node:events';
+/** Maps a validator status to its category: proposer or attestation. */ function statusToCategory(status) {
+    switch(status){
+        case 'attestation-sent':
+        case 'attestation-missed':
+            return 'attestation';
+        default:
+            return 'proposer';
+    }
+}
+export class Sentinel extends EventEmitter {
+    epochCache;
+    archiver;
+    p2p;
+    store;
+    config;
+    logger;
+    runningPromise;
+    blockStream;
+    l2TipsStore;
+    initialSlot;
+    lastProcessedSlot;
+    // eslint-disable-next-line aztec-custom/no-non-primitive-in-collections
+    slotNumberToCheckpoint;
+    constructor(epochCache, archiver, p2p, store, config, logger = createLogger('node:sentinel')){
+        super(), this.epochCache = epochCache, this.archiver = archiver, this.p2p = p2p, this.store = store, this.config = config, this.logger = logger, this.slotNumberToCheckpoint = new Map();
+        this.l2TipsStore = new L2TipsMemoryStore();
+        const interval = epochCache.getL1Constants().ethereumSlotDuration * 1000 / 4;
+        this.runningPromise = new RunningPromise(this.work.bind(this), logger, interval);
+    }
+    updateConfig(config) {
+        this.config = {
+            ...this.config,
+            ...config
+        };
+    }
+    async start() {
+        await this.init();
+        this.runningPromise.start();
+    }
+    /** Loads initial slot and initializes blockstream. We will not process anything at or before the initial slot. */ async init() {
+        this.initialSlot = this.epochCache.getEpochAndSlotNow().slot;
+        const startingBlock = BlockNumber(await this.archiver.getBlockNumber());
+        this.logger.info(`Starting validator sentinel with initial slot ${this.initialSlot} and block ${startingBlock}`);
+        this.blockStream = new L2BlockStream(this.archiver, this.l2TipsStore, this, this.logger, {
+            startingBlock
+        });
+    }
+    stop() {
+        return this.runningPromise.stop();
+    }
+    async handleBlockStreamEvent(event) {
+        await this.l2TipsStore.handleBlockStreamEvent(event);
+        if (event.type === 'chain-checkpointed') {
+            this.handleCheckpoint(event);
+        } else if (event.type === 'chain-proven') {
+            await this.handleChainProven(event);
+        }
+    }
+    handleCheckpoint(event) {
+        if (event.type !== 'chain-checkpointed') {
+            return;
+        }
+        const checkpoint = event.checkpoint;
+        // Store mapping from slot to archive, checkpoint number, and attestors
+        this.slotNumberToCheckpoint.set(checkpoint.checkpoint.header.slotNumber, {
+            checkpointNumber: checkpoint.checkpoint.number,
+            archive: checkpoint.checkpoint.archive.root.toString(),
+            attestors: getAttestationInfoFromPublishedCheckpoint(checkpoint).filter((a)=>a.status === 'recovered-from-signature').map((a)=>a.address)
+        });
+        // Prune the archive map to only keep at most N entries
+        const historyLength = this.store.getHistoryLength();
+        if (this.slotNumberToCheckpoint.size > historyLength) {
+            const toDelete = Array.from(this.slotNumberToCheckpoint.keys()).sort((a, b)=>Number(a - b)).slice(0, this.slotNumberToCheckpoint.size - historyLength);
+            for (const key of toDelete){
+                this.slotNumberToCheckpoint.delete(key);
+            }
+        }
+    }
+    async handleChainProven(event) {
+        if (event.type !== 'chain-proven') {
+            return;
+        }
+        const blockNumber = event.block.number;
+        const header = await this.archiver.getBlockHeader(blockNumber);
+        if (!header) {
+            this.logger.error(`Failed to get block header ${blockNumber}`);
+            return;
+        }
+        // TODO(palla/slash): We should only be computing proven performance if this is
+        // a full proof epoch and not a partial one, otherwise we'll end up with skewed stats.
+        const epoch = getEpochAtSlot(header.getSlot(), this.epochCache.getL1Constants());
+        this.logger.debug(`Computing proven performance for epoch ${epoch}`);
+        const performance = await this.computeProvenPerformance(epoch);
+        this.logger.info(`Computed proven performance for epoch ${epoch}`, performance);
+        await this.store.updateProvenPerformance(epoch, performance);
+        await this.handleProvenPerformance(epoch, performance);
+    }
+    async computeProvenPerformance(epoch) {
+        const [fromSlot, toSlot] = getSlotRangeForEpoch(epoch, this.epochCache.getL1Constants());
+        const { committee, isEscapeHatchOpen } = await this.epochCache.getCommittee(fromSlot);
+        if (isEscapeHatchOpen) {
+            this.logger.info(`Skipping proven performance for epoch ${epoch} - escape hatch is open`);
+            return {};
+        }
+        if (!committee) {
+            this.logger.trace(`No committee found for slot ${fromSlot}`);
+            return {};
+        }
+        const stats = await this.computeStats({
+            fromSlot,
+            toSlot,
+            validators: committee
+        });
+        this.logger.debug(`Stats for epoch ${epoch}`, {
+            ...stats,
+            fromSlot,
+            toSlot,
+            epoch
+        });
+        // Note that we are NOT using the total slots in the epoch as `total` here, since we only
+        // compute missed attestations over the blocks that had a proposal in them. So, let's say
+        // we have an epoch with 10 slots, but only 5 had a block proposal. A validator that was
+        // offline, assuming they were not picked as proposer, will then be reported as having missed
+        // 5/5 attestations. If we used the total, they'd be reported as 5/10, which would probably
+        // allow them to avoid being slashed.
+        return mapValues(stats.stats, (stat)=>({
+                missed: stat.missedAttestations.count + stat.missedProposals.count,
+                total: stat.missedAttestations.total + stat.missedProposals.total
+            }));
+    }
+    /**
+   * Checks if a validator has been inactive for the specified number of consecutive epochs for which we have data on it.
+   * @param validator The validator address to check
+   * @param currentEpoch Epochs strictly before the current one are evaluated only
+   * @param requiredConsecutiveEpochs Number of consecutive epochs required for slashing
+   */ async checkPastInactivity(validator, currentEpoch, requiredConsecutiveEpochs) {
+        if (requiredConsecutiveEpochs === 0) {
+            return true;
+        }
+        // Get all historical performance for this validator
+        const allPerformance = await this.store.getProvenPerformance(validator);
+        // Sort by epoch descending to get most recent first, keep only epochs strictly before the current one, and get the first N
+        const pastEpochs = allPerformance.sort((a, b)=>Number(b.epoch - a.epoch)).filter((p)=>p.epoch < currentEpoch);
+        // If we don't have enough historical data, don't slash
+        if (pastEpochs.length < requiredConsecutiveEpochs) {
+            this.logger.debug(`Not enough historical data for slashing ${validator} for inactivity (${allPerformance.length} epochs < ${requiredConsecutiveEpochs} required)`);
+            return false;
+        }
+        // Check that we have at least requiredConsecutiveEpochs and that all of them are above the inactivity threshold
+        return pastEpochs.slice(0, requiredConsecutiveEpochs).every((p)=>p.missed / p.total >= this.config.slashInactivityTargetPercentage);
+    }
+    async handleProvenPerformance(epoch, performance) {
+        if (this.config.slashInactivityPenalty === 0n) {
+            return;
+        }
+        const inactiveValidators = getEntries(performance).filter(([_, { missed, total }])=>missed / total >= this.config.slashInactivityTargetPercentage).map(([address])=>address);
+        this.logger.debug(`Found ${inactiveValidators.length} inactive validators in epoch ${epoch}`, {
+            inactiveValidators,
+            epoch,
+            inactivityTargetPercentage: this.config.slashInactivityTargetPercentage
+        });
+        const epochThreshold = this.config.slashInactivityConsecutiveEpochThreshold;
+        const criminals = await filterAsync(inactiveValidators, (address)=>this.checkPastInactivity(EthAddress.fromString(address), epoch, epochThreshold - 1));
+        const args = criminals.map((address)=>({
+                validator: EthAddress.fromString(address),
+                amount: this.config.slashInactivityPenalty,
+                offenseType: OffenseType.INACTIVITY,
+                epochOrSlot: BigInt(epoch)
+            }));
+        if (criminals.length > 0) {
+            this.logger.verbose(`Identified ${criminals.length} validators to slash due to inactivity in at least ${epochThreshold} consecutive epochs`, {
+                ...args,
+                epochThreshold
+            });
+            this.emit(WANT_TO_SLASH_EVENT, args);
+        }
+    }
+    /**
+   * Process data for two L2 slots ago.
+   * Note that we do not process historical data, since we rely on p2p data for processing,
+   * and we don't have that data if we were offline during the period.
+   */ async work() {
+        const { slot: currentSlot } = this.epochCache.getEpochAndSlotNow();
+        try {
+            // Manually sync the block stream to ensure we have the latest data.
+            // Note we never `start` the blockstream, so it loops at the same pace as we do.
+            await this.blockStream.sync();
+            // Check if we are ready to process data for two L2 slots ago.
+            const targetSlot = await this.isReadyToProcess(currentSlot);
+            // And process it if we are.
+            if (targetSlot !== false) {
+                await this.processSlot(targetSlot);
+            }
+        } catch (err) {
+            this.logger.error(`Failed to process slot ${currentSlot}`, err);
+        }
+    }
+    /**
+   * Check if we are ready to process data for two L2 slots ago, so we allow plenty of time for p2p to process all in-flight attestations.
+   * We also don't move past the archiver last synced L2 slot, as we don't want to process data that is not yet available.
+   * Last, we check the p2p is synced with the archiver, so it has pulled all attestations from it.
+   */ async isReadyToProcess(currentSlot) {
+        if (currentSlot < 2) {
+            this.logger.trace(`Current slot ${currentSlot} too early.`);
+            return false;
+        }
+        const targetSlot = SlotNumber(currentSlot - 2);
+        if (this.lastProcessedSlot && this.lastProcessedSlot >= targetSlot) {
+            this.logger.trace(`Already processed slot ${targetSlot}`, {
+                lastProcessedSlot: this.lastProcessedSlot
+            });
+            return false;
+        }
+        if (this.initialSlot === undefined) {
+            this.logger.error(`Initial slot not loaded.`);
+            return false;
+        }
+        if (targetSlot <= this.initialSlot) {
+            this.logger.trace(`Refusing to process slot ${targetSlot} given initial slot ${this.initialSlot}`);
+            return false;
+        }
+        const syncedSlot = await this.archiver.getSyncedL2SlotNumber();
+        if (syncedSlot === undefined || syncedSlot < targetSlot) {
+            this.logger.debug(`Waiting for archiver to sync with L2 slot ${targetSlot}`, {
+                syncedSlot,
+                targetSlot
+            });
+            return false;
+        }
+        const archiverLastBlockHash = await this.l2TipsStore.getL2Tips().then((tip)=>tip.proposed.hash);
+        const p2pLastBlockHash = await this.p2p.getL2Tips().then((tips)=>tips.proposed.hash);
+        const isP2pSynced = archiverLastBlockHash === p2pLastBlockHash;
+        if (!isP2pSynced) {
+            this.logger.debug(`Waiting for P2P client to sync with archiver`, {
+                archiverLastBlockHash,
+                p2pLastBlockHash
+            });
+            return false;
+        }
+        return targetSlot;
+    }
+    /**
+   * Gathers committee and proposer data for a given slot, computes slot stats,
+   * and updates overall stats.
+   */ async processSlot(slot) {
+        const { epoch, seed, committee, isEscapeHatchOpen } = await this.epochCache.getCommittee(slot);
+        if (isEscapeHatchOpen) {
+            this.logger.info(`Skipping slot ${slot} at epoch ${epoch} - escape hatch is open`);
+            this.lastProcessedSlot = slot;
+            return;
+        }
+        if (!committee || committee.length === 0) {
+            this.logger.trace(`No committee found for slot ${slot} at epoch ${epoch}`);
+            this.lastProcessedSlot = slot;
+            return;
+        }
+        const proposerIndex = this.epochCache.computeProposerIndex(slot, epoch, seed, BigInt(committee.length));
+        const proposer = committee[Number(proposerIndex)];
+        const stats = await this.getSlotActivity(slot, epoch, proposer, committee);
+        this.logger.verbose(`Updating L2 slot ${slot} observed activity`, stats);
+        await this.updateValidators(slot, stats);
+        this.lastProcessedSlot = slot;
+    }
+    /** Computes activity for a given slot. */ async getSlotActivity(slot, epoch, proposer, committee) {
+        this.logger.debug(`Computing stats for slot ${slot} at epoch ${epoch}`, {
+            slot,
+            epoch,
+            proposer,
+            committee
+        });
+        // Check if there is an L2 block in L1 for this L2 slot
+        // Here we get all checkpoint attestations for the checkpoint at the given slot,
+        // or all checkpoint attestations for all proposals in the slot if no checkpoint was mined.
+        // We gather from both p2p (contains the ones seen on the p2p layer) and archiver
+        // (contains the ones synced from mined checkpoints, which we may have missed from p2p).
+        const checkpoint = this.slotNumberToCheckpoint.get(slot);
+        const p2pAttested = await this.p2p.getCheckpointAttestationsForSlot(slot, checkpoint?.archive);
+        // Filter out attestations with invalid signatures
+        const p2pAttestors = p2pAttested.map((a)=>a.getSender()).filter((s)=>s !== undefined);
+        const attestors = new Set([
+            ...p2pAttestors.map((a)=>a.toString()),
+            ...checkpoint?.attestors.map((a)=>a.toString()) ?? []
+        ].filter((addr)=>proposer.toString() !== addr));
+        // We assume that there was a block proposal if at least one of the validators (other than the proposer) attested to it.
+        // It could be the case that every single validator failed, and we could differentiate it by having
+        // this node re-execute every block proposal it sees and storing it in the attestation pool.
+        // But we'll leave that corner case out to reduce pressure on the node.
+        // TODO(palla/slash): This breaks if a given node has more than one validator in the current committee,
+        // since they will attest to their own proposal it even if it's not re-executable.
+        let status;
+        if (checkpoint) {
+            status = 'checkpoint-mined';
+        } else if (attestors.size > 0) {
+            status = 'checkpoint-proposed';
+        } else {
+            // No checkpoint on L1 and no checkpoint attestations seen. Check if block proposals were sent for this slot.
+            const hasBlockProposals = await this.p2p.hasBlockProposalsForSlot(slot);
+            status = hasBlockProposals ? 'checkpoint-missed' : 'blocks-missed';
+        }
+        this.logger.debug(`Checkpoint status for slot ${slot}: ${status}`, {
+            ...checkpoint,
+            slot
+        });
+        // Get attestors that failed their checkpoint attestation duties, but only if there was a checkpoint proposed or mined
+        const missedAttestors = new Set(status === 'blocks-missed' || status === 'checkpoint-missed' ? [] : committee.filter((v)=>!attestors.has(v.toString()) && !proposer.equals(v)).map((v)=>v.toString()));
+        this.logger.debug(`Retrieved ${attestors.size} attestors out of ${committee.length} for slot ${slot}`, {
+            status,
+            proposer: proposer.toString(),
+            ...checkpoint,
+            slot,
+            attestors: [
+                ...attestors
+            ],
+            missedAttestors: [
+                ...missedAttestors
+            ],
+            committee: committee.map((c)=>c.toString())
+        });
+        // Compute the status for each validator in the committee
+        const statusFor = (who)=>{
+            if (who === proposer.toString()) {
+                return status;
+            } else if (attestors.has(who)) {
+                return 'attestation-sent';
+            } else if (missedAttestors.has(who)) {
+                return 'attestation-missed';
+            } else {
+                return undefined;
+            }
+        };
+        return Object.fromEntries(committee.map((v)=>v.toString()).map((who)=>[
+                who,
+                statusFor(who)
+            ]));
+    }
+    /** Push the status for each slot for each validator. */ updateValidators(slot, stats) {
+        return this.store.updateValidators(slot, stats);
+    }
+    /** Computes stats to be returned based on stored data. */ async computeStats({ fromSlot, toSlot, validators } = {}) {
+        const histories = validators ? fromEntries(await Promise.all(validators.map(async (v)=>[
+                v.toString(),
+                await this.store.getHistory(v)
+            ]))) : await this.store.getHistories();
+        const slotNow = this.epochCache.getEpochAndSlotNow().slot;
+        fromSlot ??= SlotNumber(Math.max((this.lastProcessedSlot ?? slotNow) - this.store.getHistoryLength(), 0));
+        toSlot ??= this.lastProcessedSlot ?? slotNow;
+        const stats = mapValues(histories, (history, address)=>this.computeStatsForValidator(address, history ?? [], fromSlot, toSlot));
+        return {
+            stats,
+            lastProcessedSlot: this.lastProcessedSlot,
+            initialSlot: this.initialSlot,
+            slotWindow: this.store.getHistoryLength()
+        };
+    }
+    /** Computes stats for a single validator. */ async getValidatorStats(validatorAddress, fromSlot, toSlot) {
+        const history = await this.store.getHistory(validatorAddress);
+        if (!history || history.length === 0) {
+            return undefined;
+        }
+        const slotNow = this.epochCache.getEpochAndSlotNow().slot;
+        const effectiveFromSlot = fromSlot ?? SlotNumber(Math.max((this.lastProcessedSlot ?? slotNow) - this.store.getHistoryLength(), 0));
+        const effectiveToSlot = toSlot ?? this.lastProcessedSlot ?? slotNow;
+        const historyLength = BigInt(this.store.getHistoryLength());
+        if (BigInt(effectiveToSlot) - BigInt(effectiveFromSlot) > historyLength) {
+            throw new Error(`Slot range (${BigInt(effectiveToSlot) - BigInt(effectiveFromSlot)}) exceeds history length (${historyLength}). ` + `Requested range: ${effectiveFromSlot} to ${effectiveToSlot}.`);
+        }
+        const validator = this.computeStatsForValidator(validatorAddress.toString(), history, effectiveFromSlot, effectiveToSlot);
+        return {
+            validator,
+            allTimeProvenPerformance: await this.store.getProvenPerformance(validatorAddress),
+            lastProcessedSlot: this.lastProcessedSlot,
+            initialSlot: this.initialSlot,
+            slotWindow: this.store.getHistoryLength()
+        };
+    }
+    computeStatsForValidator(address, allHistory, fromSlot, toSlot) {
+        let history = fromSlot ? allHistory.filter((h)=>BigInt(h.slot) >= fromSlot) : allHistory;
+        history = toSlot ? history.filter((h)=>BigInt(h.slot) <= toSlot) : history;
+        const lastProposal = history.filter((h)=>h.status === 'checkpoint-proposed' || h.status === 'checkpoint-mined').at(-1);
+        const lastAttestation = history.filter((h)=>h.status === 'attestation-sent').at(-1);
+        return {
+            address: EthAddress.fromString(address),
+            lastProposal: this.computeFromSlot(lastProposal?.slot),
+            lastAttestation: this.computeFromSlot(lastAttestation?.slot),
+            totalSlots: history.length,
+            missedProposals: this.computeMissed(history, 'proposer', [
+                'checkpoint-missed',
+                'blocks-missed'
+            ]),
+            missedAttestations: this.computeMissed(history, 'attestation', [
+                'attestation-missed'
+            ]),
+            history
+        };
+    }
+    computeMissed(history, computeOverCategory, filter) {
+        const relevantHistory = history.filter((h)=>!computeOverCategory || statusToCategory(h.status) === computeOverCategory);
+        const filteredHistory = relevantHistory.filter((h)=>filter.includes(h.status));
+        return {
+            currentStreak: countWhile([
+                ...relevantHistory
+            ].reverse(), (h)=>filter.includes(h.status)),
+            rate: relevantHistory.length === 0 ? undefined : filteredHistory.length / relevantHistory.length,
+            count: filteredHistory.length,
+            total: relevantHistory.length
+        };
+    }
+    computeFromSlot(slot) {
+        if (slot === undefined) {
+            return undefined;
+        }
+        const timestamp = getTimestampForSlot(slot, this.epochCache.getL1Constants());
+        return {
+            timestamp,
+            slot,
+            date: new Date(Number(timestamp) * 1000).toISOString()
+        };
+    }
+}

package/dest/sentinel/store.d.ts

@@ -0,0 +1,35 @@
+import { EpochNumber, SlotNumber } from '@aztec/foundation/branded-types';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import type { AztecAsyncKVStore } from '@aztec/kv-store';
+import type { ValidatorStatusHistory, ValidatorStatusInSlot, ValidatorsEpochPerformance } from '@aztec/stdlib/validators';
+export declare class SentinelStore {
+    private store;
+    private config;
+    static readonly SCHEMA_VERSION = 3;
+    private readonly historyMap;
+    private readonly provenMap;
+    constructor(store: AztecAsyncKVStore, config: {
+        historyLength: number;
+        historicProvenPerformanceLength: number;
+    });
+    getHistoryLength(): number;
+    getHistoricProvenPerformanceLength(): number;
+    updateProvenPerformance(epoch: EpochNumber, performance: ValidatorsEpochPerformance): Promise<void>;
+    getProvenPerformance(who: EthAddress): Promise<{
+        missed: number;
+        total: number;
+        epoch: EpochNumber;
+    }[]>;
+    private pushValidatorProvenPerformanceForEpoch;
+    updateValidators(slot: SlotNumber, statuses: Record<`0x${string}`, ValidatorStatusInSlot | undefined>): Promise<void>;
+    private pushValidatorStatusForSlot;
+    getHistories(): Promise<Record<`0x${string}`, ValidatorStatusHistory>>;
+    getHistory(address: EthAddress): Promise<ValidatorStatusHistory | undefined>;
+    private serializePerformance;
+    private deserializePerformance;
+    private serializeHistory;
+    private deserializeHistory;
+    private statusToNumber;
+    private statusFromNumber;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RvcmUuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9zZW50aW5lbC9zdG9yZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsV0FBVyxFQUFFLFVBQVUsRUFBRSxNQUFNLGlDQUFpQyxDQUFDO0FBQzFFLE9BQU8sRUFBRSxVQUFVLEVBQUUsTUFBTSwrQkFBK0IsQ0FBQztBQUUzRCxPQUFPLEtBQUssRUFBRSxpQkFBaUIsRUFBaUIsTUFBTSxpQkFBaUIsQ0FBQztBQUN4RSxPQUFPLEtBQUssRUFDVixzQkFBc0IsRUFDdEIscUJBQXFCLEVBQ3JCLDBCQUEwQixFQUMzQixNQUFNLDBCQUEwQixDQUFDO0FBRWxDLHFCQUFhLGFBQWE7SUFXdEIsT0FBTyxDQUFDLEtBQUs7SUFDYixPQUFPLENBQUMsTUFBTTtJQVhoQixnQkFBdUIsY0FBYyxLQUFLO0lBRzFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsVUFBVSxDQUF1QztJQUlsRSxPQUFPLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBdUM7SUFFakUsWUFDVSxLQUFLLEVBQUUsaUJBQWlCLEVBQ3hCLE1BQU0sRUFBRTtRQUFFLGFBQWEsRUFBRSxNQUFNLENBQUM7UUFBQywrQkFBK0IsRUFBRSxNQUFNLENBQUE7S0FBRSxFQUluRjtJQUVNLGdCQUFnQixXQUV0QjtJQUVNLGtDQUFrQyxXQUV4QztJQUVZLHVCQUF1QixDQUFDLEtBQUssRUFBRSxXQUFXLEVBQUUsV0FBVyxFQUFFLDBCQUEwQixpQkFNL0Y7SUFFWSxvQkFBb0IsQ0FBQyxHQUFHLEVBQUUsVUFBVSxHQUFHLE9BQU8sQ0FBQztRQUFFLE1BQU0sRUFBRSxNQUFNLENBQUM7UUFBQyxLQUFLLEVBQUUsTUFBTSxDQUFDO1FBQUMsS0FBSyxFQUFFLFdBQVcsQ0FBQTtLQUFFLEVBQUUsQ0FBQyxDQUduSDtZQUVhLHNDQUFzQztJQTZCdkMsZ0JBQWdCLENBQUMsSUFBSSxFQUFFLFVBQVUsRUFBRSxRQUFRLEVBQUUsTUFBTSxDQUFDLEtBQUssTUFBTSxFQUFFLEVBQUUscUJBQXFCLEdBQUcsU0FBUyxDQUFDLGlCQVFqSDtZQUVhLDBCQUEwQjtJQVEzQixZQUFZLElBQUksT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLE1BQU0sRUFBRSxFQUFFLHNCQUFzQixDQUFDLENBQUMsQ0FNbEY7SUFFWSxVQUFVLENBQUMsT0FBTyxFQUFFLFVBQVUsR0FBRyxPQUFPLENBQUMsc0JBQXNCLEdBQUcsU0FBUyxDQUFDLENBR3hGO0lBRUQsT0FBTyxDQUFDLG9CQUFvQjtJQU01QixPQUFPLENBQUMsc0JBQXNCO0lBYTlCLE9BQU8sQ0FBQyxnQkFBZ0I7SUFNeEIsT0FBTyxDQUFDLGtCQUFrQjtJQVcxQixPQUFPLENBQUMsY0FBYztJQXFCdEIsT0FBTyxDQUFDLGdCQUFnQjtDQWtCekIifQ==

package/dest/sentinel/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/sentinel/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAE3D,OAAO,KAAK,EAAE,iBAAiB,EAAiB,MAAM,iBAAiB,CAAC;AACxE,OAAO,KAAK,EACV,sBAAsB,EACtB,qBAAqB,EACrB,0BAA0B,EAC3B,MAAM,0BAA0B,CAAC;AAElC,qBAAa,aAAa;IAWtB,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,MAAM;IAXhB,gBAAuB,cAAc,KAAK;IAG1C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAuC;IAIlE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuC;IAEjE,YACU,KAAK,EAAE,iBAAiB,EACxB,MAAM,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,+BAA+B,EAAE,MAAM,CAAA;KAAE,EAInF;IAEM,gBAAgB,WAEtB;IAEM,kCAAkC,WAExC;IAEY,uBAAuB,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,0BAA0B,iBAM/F;IAEY,oBAAoB,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,WAAW,CAAA;KAAE,EAAE,CAAC,CAGnH;YAEa,sCAAsC;IA6BvC,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,KAAK,MAAM,EAAE,EAAE,qBAAqB,GAAG,SAAS,CAAC,iBAQjH;YAEa,0BAA0B;IAQ3B,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAAC,CAMlF;IAEY,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,GAAG,SAAS,CAAC,CAGxF;IAED,OAAO,CAAC,oBAAoB;IAM5B,OAAO,CAAC,sBAAsB;IAa9B,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,kBAAkB;IAW1B,OAAO,CAAC,cAAc;IAqBtB,OAAO,CAAC,gBAAgB;CAkBzB"}

package/dest/sentinel/store.js

@@ -0,0 +1,174 @@
+import { EpochNumber, SlotNumber } from '@aztec/foundation/branded-types';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { BufferReader, numToUInt8, numToUInt32BE, serializeToBuffer } from '@aztec/foundation/serialize';
+export class SentinelStore {
+    store;
+    config;
+    static SCHEMA_VERSION = 3;
+    // a map from validator address to their ValidatorStatusHistory
+    historyMap;
+    // a map from validator address to their historical proven epoch performance
+    // e.g. { validator: [{ epoch: 1, missed: 1, total: 10 }, { epoch: 2, missed: 3, total: 7 }, ...] }
+    provenMap;
+    constructor(store, config){
+        this.store = store;
+        this.config = config;
+        this.historyMap = store.openMap('sentinel-validator-status');
+        this.provenMap = store.openMap('sentinel-validator-proven');
+    }
+    getHistoryLength() {
+        return this.config.historyLength;
+    }
+    getHistoricProvenPerformanceLength() {
+        return this.config.historicProvenPerformanceLength;
+    }
+    async updateProvenPerformance(epoch, performance) {
+        await this.store.transactionAsync(async ()=>{
+            for (const [who, { missed, total }] of Object.entries(performance)){
+                await this.pushValidatorProvenPerformanceForEpoch({
+                    who: EthAddress.fromString(who),
+                    missed,
+                    total,
+                    epoch
+                });
+            }
+        });
+    }
+    async getProvenPerformance(who) {
+        const currentPerformanceBuffer = await this.provenMap.getAsync(who.toString());
+        return currentPerformanceBuffer ? this.deserializePerformance(currentPerformanceBuffer) : [];
+    }
+    async pushValidatorProvenPerformanceForEpoch({ who, missed, total, epoch }) {
+        const currentPerformance = await this.getProvenPerformance(who);
+        const existingIndex = currentPerformance.findIndex((p)=>p.epoch === epoch);
+        if (existingIndex !== -1) {
+            currentPerformance[existingIndex] = {
+                missed,
+                total,
+                epoch
+            };
+        } else {
+            currentPerformance.push({
+                missed,
+                total,
+                epoch
+            });
+        }
+        // This should be sorted by epoch, but just in case.
+        // Since we keep the size small, this is not a big deal.
+        currentPerformance.sort((a, b)=>Number(a.epoch - b.epoch));
+        // keep the most recent `historicProvenPerformanceLength` entries.
+        const performanceToKeep = currentPerformance.slice(-this.config.historicProvenPerformanceLength);
+        await this.provenMap.set(who.toString(), this.serializePerformance(performanceToKeep));
+    }
+    async updateValidators(slot, statuses) {
+        await this.store.transactionAsync(async ()=>{
+            for (const [who, status] of Object.entries(statuses)){
+                if (status) {
+                    await this.pushValidatorStatusForSlot(EthAddress.fromString(who), slot, status);
+                }
+            }
+        });
+    }
+    async pushValidatorStatusForSlot(who, slot, status) {
+        await this.store.transactionAsync(async ()=>{
+            const currentHistory = await this.getHistory(who) ?? [];
+            const newHistory = [
+                ...currentHistory,
+                {
+                    slot,
+                    status
+                }
+            ].slice(-this.config.historyLength);
+            await this.historyMap.set(who.toString(), this.serializeHistory(newHistory));
+        });
+    }
+    async getHistories() {
+        const histories = {};
+        for await (const [address, history] of this.historyMap.entriesAsync()){
+            histories[address] = this.deserializeHistory(history);
+        }
+        return histories;
+    }
+    async getHistory(address) {
+        const data = await this.historyMap.getAsync(address.toString());
+        return data && this.deserializeHistory(data);
+    }
+    serializePerformance(performance) {
+        return serializeToBuffer(performance.map((p)=>[
+                numToUInt32BE(Number(p.epoch)),
+                numToUInt32BE(p.missed),
+                numToUInt32BE(p.total)
+            ]));
+    }
+    deserializePerformance(buffer) {
+        const reader = new BufferReader(buffer);
+        const performance = [];
+        while(!reader.isEmpty()){
+            performance.push({
+                epoch: EpochNumber(reader.readNumber()),
+                missed: reader.readNumber(),
+                total: reader.readNumber()
+            });
+        }
+        return performance;
+    }
+    serializeHistory(history) {
+        return serializeToBuffer(history.map((h)=>[
+                numToUInt32BE(Number(h.slot)),
+                numToUInt8(this.statusToNumber(h.status))
+            ]));
+    }
+    deserializeHistory(buffer) {
+        const reader = new BufferReader(buffer);
+        const history = [];
+        while(!reader.isEmpty()){
+            const slot = SlotNumber(reader.readNumber());
+            const status = this.statusFromNumber(reader.readUInt8());
+            history.push({
+                slot,
+                status
+            });
+        }
+        return history;
+    }
+    statusToNumber(status) {
+        switch(status){
+            case 'checkpoint-mined':
+                return 1;
+            case 'checkpoint-proposed':
+                return 2;
+            case 'checkpoint-missed':
+                return 3;
+            case 'attestation-sent':
+                return 4;
+            case 'attestation-missed':
+                return 5;
+            case 'blocks-missed':
+                return 6;
+            default:
+                {
+                    const _exhaustive = status;
+                    throw new Error(`Unknown status: ${status}`);
+                }
+        }
+    }
+    statusFromNumber(status) {
+        switch(status){
+            case 1:
+                return 'checkpoint-mined';
+            case 2:
+                return 'checkpoint-proposed';
+            case 3:
+                return 'checkpoint-missed';
+            case 4:
+                return 'attestation-sent';
+            case 5:
+                return 'attestation-missed';
+            case 6:
+                return 'blocks-missed';
+            default:
+                throw new Error(`Unknown status: ${status}`);
+        }
+    }
+}