@aztec/epoch-cache 0.0.0-test.1 → 0.0.1-commit.023c3e5
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/dest/config.d.ts +4 -3
- package/dest/config.d.ts.map +1 -1
- package/dest/config.js +2 -1
- package/dest/epoch_cache.d.ts +97 -51
- package/dest/epoch_cache.d.ts.map +1 -1
- package/dest/epoch_cache.js +227 -91
- package/dest/index.d.ts +1 -1
- package/dest/test/index.d.ts +2 -0
- package/dest/test/index.d.ts.map +1 -0
- package/dest/test/index.js +1 -0
- package/dest/test/test_epoch_cache.d.ts +76 -0
- package/dest/test/test_epoch_cache.d.ts.map +1 -0
- package/dest/test/test_epoch_cache.js +150 -0
- package/package.json +21 -18
- package/src/config.ts +3 -12
- package/src/epoch_cache.ts +277 -130
- package/src/test/index.ts +1 -0
- package/src/test/test_epoch_cache.ts +169 -0
- package/dest/timestamp_provider.d.ts +0 -2
- package/dest/timestamp_provider.d.ts.map +0 -1
- package/dest/timestamp_provider.js +0 -0
- package/src/timestamp_provider.ts +0 -0
package/dest/config.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { type L1ContractsConfig
|
|
2
|
-
|
|
1
|
+
import { type L1ContractsConfig } from '@aztec/ethereum/config';
|
|
2
|
+
import { type L1ReaderConfig } from '@aztec/ethereum/l1-reader';
|
|
3
|
+
export type EpochCacheConfig = Pick<L1ReaderConfig & L1ContractsConfig, 'l1RpcUrls' | 'l1ChainId' | 'viemPollingIntervalMS' | 'ethereumSlotDuration'>;
|
|
3
4
|
export declare function getEpochCacheConfigEnvVars(): EpochCacheConfig;
|
|
4
|
-
//# sourceMappingURL=
|
|
5
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvY29uZmlnLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxLQUFLLGlCQUFpQixFQUErQixNQUFNLHdCQUF3QixDQUFDO0FBQzdGLE9BQU8sRUFBRSxLQUFLLGNBQWMsRUFBNEIsTUFBTSwyQkFBMkIsQ0FBQztBQUUxRixNQUFNLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxDQUNqQyxjQUFjLEdBQUcsaUJBQWlCLEVBQ2xDLFdBQVcsR0FBRyxXQUFXLEdBQUcsdUJBQXVCLEdBQUcsc0JBQXNCLENBQzdFLENBQUM7QUFFRix3QkFBZ0IsMEJBQTBCLElBQUksZ0JBQWdCLENBRTdEIn0=
|
package/dest/config.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,iBAAiB,EAA+B,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,KAAK,cAAc,EAA4B,MAAM,2BAA2B,CAAC;AAE1F,MAAM,MAAM,gBAAgB,GAAG,IAAI,CACjC,cAAc,GAAG,iBAAiB,EAClC,WAAW,GAAG,WAAW,GAAG,uBAAuB,GAAG,sBAAsB,CAC7E,CAAC;AAEF,wBAAgB,0BAA0B,IAAI,gBAAgB,CAE7D"}
|
package/dest/config.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { getL1ContractsConfigEnvVars
|
|
1
|
+
import { getL1ContractsConfigEnvVars } from '@aztec/ethereum/config';
|
|
2
|
+
import { getL1ReaderConfigFromEnv } from '@aztec/ethereum/l1-reader';
|
|
2
3
|
export function getEpochCacheConfigEnvVars() {
|
|
3
4
|
return {
|
|
4
5
|
...getL1ReaderConfigFromEnv(),
|
package/dest/epoch_cache.d.ts
CHANGED
|
@@ -1,87 +1,133 @@
|
|
|
1
|
-
|
|
2
|
-
import {
|
|
1
|
+
import { RollupContract } from '@aztec/ethereum/contracts';
|
|
2
|
+
import { EpochNumber, SlotNumber } from '@aztec/foundation/branded-types';
|
|
3
3
|
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
4
4
|
import { DateProvider } from '@aztec/foundation/timer';
|
|
5
5
|
import { type L1RollupConstants } from '@aztec/stdlib/epoch-helpers';
|
|
6
|
-
import { EventEmitter } from 'node:events';
|
|
7
6
|
import { type EpochCacheConfig } from './config.js';
|
|
8
|
-
type EpochAndSlot = {
|
|
9
|
-
epoch:
|
|
10
|
-
slot:
|
|
7
|
+
export type EpochAndSlot = {
|
|
8
|
+
epoch: EpochNumber;
|
|
9
|
+
slot: SlotNumber;
|
|
11
10
|
ts: bigint;
|
|
12
11
|
};
|
|
12
|
+
export type EpochCommitteeInfo = {
|
|
13
|
+
committee: EthAddress[] | undefined;
|
|
14
|
+
seed: bigint;
|
|
15
|
+
epoch: EpochNumber;
|
|
16
|
+
/** True if the epoch is within an open escape hatch window. */
|
|
17
|
+
isEscapeHatchOpen: boolean;
|
|
18
|
+
};
|
|
19
|
+
export type SlotTag = 'now' | 'next' | SlotNumber;
|
|
13
20
|
export interface EpochCacheInterface {
|
|
14
|
-
getCommittee(
|
|
15
|
-
getEpochAndSlotNow(): EpochAndSlot
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
21
|
+
getCommittee(slot: SlotTag | undefined): Promise<EpochCommitteeInfo>;
|
|
22
|
+
getEpochAndSlotNow(): EpochAndSlot & {
|
|
23
|
+
nowMs: bigint;
|
|
24
|
+
};
|
|
25
|
+
getEpochAndSlotInNextL1Slot(): EpochAndSlot & {
|
|
26
|
+
now: bigint;
|
|
27
|
+
};
|
|
28
|
+
getProposerIndexEncoding(epoch: EpochNumber, slot: SlotNumber, seed: bigint): `0x${string}`;
|
|
29
|
+
computeProposerIndex(slot: SlotNumber, epoch: EpochNumber, seed: bigint, size: bigint): bigint;
|
|
30
|
+
getCurrentAndNextSlot(): {
|
|
31
|
+
currentSlot: SlotNumber;
|
|
32
|
+
nextSlot: SlotNumber;
|
|
33
|
+
};
|
|
34
|
+
getProposerAttesterAddressInSlot(slot: SlotNumber): Promise<EthAddress | undefined>;
|
|
35
|
+
getRegisteredValidators(): Promise<EthAddress[]>;
|
|
36
|
+
isInCommittee(slot: SlotTag, validator: EthAddress): Promise<boolean>;
|
|
37
|
+
filterInCommittee(slot: SlotTag, validators: EthAddress[]): Promise<EthAddress[]>;
|
|
25
38
|
}
|
|
26
39
|
/**
|
|
27
40
|
* Epoch cache
|
|
28
41
|
*
|
|
29
42
|
* This class is responsible for managing traffic to the l1 node, by caching the validator set.
|
|
43
|
+
* Keeps the last N epochs in cache.
|
|
30
44
|
* It also provides a method to get the current or next proposer, and to check who is in the current slot.
|
|
31
45
|
*
|
|
32
|
-
* If the epoch changes, then we update the stored validator set.
|
|
33
|
-
*
|
|
34
46
|
* Note: This class is very dependent on the system clock being in sync.
|
|
35
47
|
*/
|
|
36
|
-
export declare class EpochCache
|
|
37
|
-
committeeChanged: [EthAddress[], bigint];
|
|
38
|
-
}> implements EpochCacheInterface {
|
|
48
|
+
export declare class EpochCache implements EpochCacheInterface {
|
|
39
49
|
private rollup;
|
|
40
50
|
private readonly l1constants;
|
|
41
51
|
private readonly dateProvider;
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
52
|
+
protected readonly config: {
|
|
53
|
+
cacheSize: number;
|
|
54
|
+
validatorRefreshIntervalSeconds: number;
|
|
55
|
+
};
|
|
56
|
+
protected cache: Map<EpochNumber, EpochCommitteeInfo>;
|
|
57
|
+
private allValidators;
|
|
58
|
+
private lastValidatorRefresh;
|
|
45
59
|
private readonly log;
|
|
46
|
-
constructor(rollup: RollupContract,
|
|
47
|
-
|
|
60
|
+
constructor(rollup: RollupContract, l1constants: L1RollupConstants & {
|
|
61
|
+
lagInEpochsForValidatorSet: number;
|
|
62
|
+
lagInEpochsForRandao: number;
|
|
63
|
+
}, dateProvider?: DateProvider, config?: {
|
|
64
|
+
cacheSize: number;
|
|
65
|
+
validatorRefreshIntervalSeconds: number;
|
|
66
|
+
});
|
|
67
|
+
static create(rollupOrAddress: EthAddress | RollupContract, config?: EpochCacheConfig, deps?: {
|
|
48
68
|
dateProvider?: DateProvider;
|
|
49
69
|
}): Promise<EpochCache>;
|
|
50
|
-
|
|
51
|
-
getEpochAndSlotNow(): EpochAndSlot
|
|
52
|
-
|
|
70
|
+
getL1Constants(): L1RollupConstants;
|
|
71
|
+
getEpochAndSlotNow(): EpochAndSlot & {
|
|
72
|
+
nowMs: bigint;
|
|
73
|
+
};
|
|
74
|
+
nowInSeconds(): bigint;
|
|
75
|
+
private getEpochAndSlotAtSlot;
|
|
76
|
+
getEpochAndSlotInNextL1Slot(): EpochAndSlot & {
|
|
77
|
+
now: bigint;
|
|
78
|
+
};
|
|
53
79
|
private getEpochAndSlotAtTimestamp;
|
|
80
|
+
getCommitteeForEpoch(epoch: EpochNumber): Promise<EpochCommitteeInfo>;
|
|
54
81
|
/**
|
|
55
|
-
*
|
|
82
|
+
* Returns whether the escape hatch is open for the given epoch.
|
|
83
|
+
*
|
|
84
|
+
* Uses the already-cached EpochCommitteeInfo when available. If not cached, it will fetch
|
|
85
|
+
* the epoch committee info (which includes the escape hatch flag) and return it.
|
|
86
|
+
*/
|
|
87
|
+
isEscapeHatchOpen(epoch: EpochNumber): Promise<boolean>;
|
|
88
|
+
/**
|
|
89
|
+
* Returns whether the escape hatch is open for the epoch containing the given slot.
|
|
56
90
|
*
|
|
91
|
+
* This is a lightweight helper intended for callers that already have a slot number and only
|
|
92
|
+
* need the escape hatch flag (without pulling full committee info).
|
|
93
|
+
*/
|
|
94
|
+
isEscapeHatchOpenAtSlot(slot?: SlotTag): Promise<boolean>;
|
|
95
|
+
/**
|
|
96
|
+
* Get the current validator set
|
|
57
97
|
* @param nextSlot - If true, get the validator set for the next slot.
|
|
58
98
|
* @returns The current validator set.
|
|
59
99
|
*/
|
|
60
|
-
getCommittee(
|
|
100
|
+
getCommittee(slot?: SlotTag): Promise<EpochCommitteeInfo>;
|
|
101
|
+
private getEpochAndTimestamp;
|
|
102
|
+
private computeCommittee;
|
|
61
103
|
/**
|
|
62
104
|
* Get the ABI encoding of the proposer index - see ValidatorSelectionLib.sol computeProposerIndex
|
|
63
105
|
*/
|
|
64
|
-
getProposerIndexEncoding(epoch:
|
|
65
|
-
computeProposerIndex(slot:
|
|
106
|
+
getProposerIndexEncoding(epoch: EpochNumber, slot: SlotNumber, seed: bigint): `0x${string}`;
|
|
107
|
+
computeProposerIndex(slot: SlotNumber, epoch: EpochNumber, seed: bigint, size: bigint): bigint;
|
|
108
|
+
/** Returns the current and next L2 slot numbers. */
|
|
109
|
+
getCurrentAndNextSlot(): {
|
|
110
|
+
currentSlot: SlotNumber;
|
|
111
|
+
nextSlot: SlotNumber;
|
|
112
|
+
};
|
|
66
113
|
/**
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
* can be the next slot. If this is the case, then it will send proposals early.
|
|
71
|
-
*
|
|
72
|
-
* If we are at an epoch boundary, then we can update the cache for the next epoch, this is the last check
|
|
73
|
-
* we do in the validator client, so we can update the cache here.
|
|
114
|
+
* Get the proposer attester address in the given L2 slot
|
|
115
|
+
* @returns The proposer attester address. If the committee does not exist, we throw a NoCommitteeError.
|
|
116
|
+
* If the committee is empty (i.e. target committee size is 0, and anyone can propose), we return undefined.
|
|
74
117
|
*/
|
|
75
|
-
|
|
76
|
-
currentProposer: EthAddress;
|
|
77
|
-
nextProposer: EthAddress;
|
|
78
|
-
currentSlot: bigint;
|
|
79
|
-
nextSlot: bigint;
|
|
80
|
-
}>;
|
|
118
|
+
getProposerAttesterAddressInSlot(slot: SlotNumber): Promise<EthAddress | undefined>;
|
|
81
119
|
/**
|
|
82
|
-
*
|
|
120
|
+
* Get the proposer attester address in the next slot
|
|
121
|
+
* @returns The proposer attester address. If the committee does not exist, we throw a NoCommitteeError.
|
|
122
|
+
* If the committee is empty (i.e. target committee size is 0, and anyone can propose), we return undefined.
|
|
83
123
|
*/
|
|
84
|
-
|
|
124
|
+
getProposerAttesterAddressInNextSlot(): Promise<EthAddress | undefined>;
|
|
125
|
+
private getProposerAttesterAddressAt;
|
|
126
|
+
getProposerFromEpochCommittee(epochCommitteeInfo: EpochCommitteeInfo, slot: SlotNumber): EthAddress | undefined;
|
|
127
|
+
/** Check if a validator is in the given slot's committee */
|
|
128
|
+
isInCommittee(slot: SlotTag, validator: EthAddress): Promise<boolean>;
|
|
129
|
+
/** From the set of given addresses, return all that are on the committee for the given slot */
|
|
130
|
+
filterInCommittee(slot: SlotTag, validators: EthAddress[]): Promise<EthAddress[]>;
|
|
131
|
+
getRegisteredValidators(): Promise<EthAddress[]>;
|
|
85
132
|
}
|
|
86
|
-
|
|
87
|
-
//# sourceMappingURL=epoch_cache.d.ts.map
|
|
133
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXBvY2hfY2FjaGUuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9lcG9jaF9jYWNoZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEVBQW9CLGNBQWMsRUFBRSxNQUFNLDJCQUEyQixDQUFDO0FBQzdFLE9BQU8sRUFBRSxXQUFXLEVBQUUsVUFBVSxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDMUUsT0FBTyxFQUFFLFVBQVUsRUFBRSxNQUFNLCtCQUErQixDQUFDO0FBRTNELE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQztBQUN2RCxPQUFPLEVBQ0wsS0FBSyxpQkFBaUIsRUFPdkIsTUFBTSw2QkFBNkIsQ0FBQztBQUlyQyxPQUFPLEVBQUUsS0FBSyxnQkFBZ0IsRUFBOEIsTUFBTSxhQUFhLENBQUM7QUFFaEYsTUFBTSxNQUFNLFlBQVksR0FBRztJQUN6QixLQUFLLEVBQUUsV0FBVyxDQUFDO0lBQ25CLElBQUksRUFBRSxVQUFVLENBQUM7SUFDakIsRUFBRSxFQUFFLE1BQU0sQ0FBQztDQUNaLENBQUM7QUFFRixNQUFNLE1BQU0sa0JBQWtCLEdBQUc7SUFDL0IsU0FBUyxFQUFFLFVBQVUsRUFBRSxHQUFHLFNBQVMsQ0FBQztJQUNwQyxJQUFJLEVBQUUsTUFBTSxDQUFDO0lBQ2IsS0FBSyxFQUFFLFdBQVcsQ0FBQztJQUNuQiwrREFBK0Q7SUFDL0QsaUJBQWlCLEVBQUUsT0FBTyxDQUFDO0NBQzVCLENBQUM7QUFFRixNQUFNLE1BQU0sT0FBTyxHQUFHLEtBQUssR0FBRyxNQUFNLEdBQUcsVUFBVSxDQUFDO0FBRWxELE1BQU0sV0FBVyxtQkFBbUI7SUFDbEMsWUFBWSxDQUFDLElBQUksRUFBRSxPQUFPLEdBQUcsU0FBUyxHQUFHLE9BQU8sQ0FBQyxrQkFBa0IsQ0FBQyxDQUFDO0lBQ3JFLGtCQUFrQixJQUFJLFlBQVksR0FBRztRQUFFLEtBQUssRUFBRSxNQUFNLENBQUE7S0FBRSxDQUFDO0lBQ3ZELDJCQUEyQixJQUFJLFlBQVksR0FBRztRQUFFLEdBQUcsRUFBRSxNQUFNLENBQUE7S0FBRSxDQUFDO0lBQzlELHdCQUF3QixDQUFDLEtBQUssRUFBRSxXQUFXLEVBQUUsSUFBSSxFQUFFLFVBQVUsRUFBRSxJQUFJLEVBQUUsTUFBTSxHQUFHLEtBQUssTUFBTSxFQUFFLENBQUM7SUFDNUYsb0JBQW9CLENBQUMsSUFBSSxFQUFFLFVBQVUsRUFBRSxLQUFLLEVBQUUsV0FBVyxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsSUFBSSxFQUFFLE1BQU0sR0FBRyxNQUFNLENBQUM7SUFDL0YscUJBQXFCLElBQUk7UUFBRSxXQUFXLEVBQUUsVUFBVSxDQUFDO1FBQUMsUUFBUSxFQUFFLFVBQVUsQ0FBQTtLQUFFLENBQUM7SUFDM0UsZ0NBQWdDLENBQUMsSUFBSSxFQUFFLFVBQVUsR0FBRyxPQUFPLENBQUMsVUFBVSxHQUFHLFNBQVMsQ0FBQyxDQUFDO0lBQ3BGLHVCQUF1QixJQUFJLE9BQU8sQ0FBQyxVQUFVLEVBQUUsQ0FBQyxDQUFDO0lBQ2pELGFBQWEsQ0FBQyxJQUFJLEVBQUUsT0FBTyxFQUFFLFNBQVMsRUFBRSxVQUFVLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ3RFLGlCQUFpQixDQUFDLElBQUksRUFBRSxPQUFPLEVBQUUsVUFBVSxFQUFFLFVBQVUsRUFBRSxHQUFHLE9BQU8sQ0FBQyxVQUFVLEVBQUUsQ0FBQyxDQUFDO0NBQ25GO0FBRUQ7Ozs7Ozs7O0dBUUc7QUFDSCxxQkFBYSxVQUFXLFlBQVcsbUJBQW1CO0lBUWxELE9BQU8sQ0FBQyxNQUFNO0lBQ2QsT0FBTyxDQUFDLFFBQVEsQ0FBQyxXQUFXO0lBSTVCLE9BQU8sQ0FBQyxRQUFRLENBQUMsWUFBWTtJQUM3QixTQUFTLENBQUMsUUFBUSxDQUFDLE1BQU07Ozs7SUFaM0IsU0FBUyxDQUFDLEtBQUssRUFBRSxHQUFHLENBQUMsV0FBVyxFQUFFLGtCQUFrQixDQUFDLENBQWE7SUFDbEUsT0FBTyxDQUFDLGFBQWEsQ0FBMEI7SUFDL0MsT0FBTyxDQUFDLG9CQUFvQixDQUFLO0lBQ2pDLE9BQU8sQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUF1QztJQUUzRCxZQUNVLE1BQU0sRUFBRSxjQUFjLEVBQ2IsV0FBVyxFQUFFLGlCQUFpQixHQUFHO1FBQ2hELDBCQUEwQixFQUFFLE1BQU0sQ0FBQztRQUNuQyxvQkFBb0IsRUFBRSxNQUFNLENBQUM7S0FDOUIsRUFDZ0IsWUFBWSxHQUFFLFlBQWlDLEVBQzdDLE1BQU07OztLQUF5RCxFQUtuRjtJQUVELE9BQWEsTUFBTSxDQUNqQixlQUFlLEVBQUUsVUFBVSxHQUFHLGNBQWMsRUFDNUMsTUFBTSxDQUFDLEVBQUUsZ0JBQWdCLEVBQ3pCLElBQUksR0FBRTtRQUFFLFlBQVksQ0FBQyxFQUFFLFlBQVksQ0FBQTtLQUFPLHVCQWdEM0M7SUFFTSxjQUFjLElBQUksaUJBQWlCLENBRXpDO0lBRU0sa0JBQWtCLElBQUksWUFBWSxHQUFHO1FBQUUsS0FBSyxFQUFFLE1BQU0sQ0FBQTtLQUFFLENBSTVEO0lBRU0sWUFBWSxJQUFJLE1BQU0sQ0FFNUI7SUFFRCxPQUFPLENBQUMscUJBQXFCO0lBTXRCLDJCQUEyQixJQUFJLFlBQVksR0FBRztRQUFFLEdBQUcsRUFBRSxNQUFNLENBQUE7S0FBRSxDQUluRTtJQUVELE9BQU8sQ0FBQywwQkFBMEI7SUFTM0Isb0JBQW9CLENBQUMsS0FBSyxFQUFFLFdBQVcsR0FBRyxPQUFPLENBQUMsa0JBQWtCLENBQUMsQ0FHM0U7SUFFRDs7Ozs7T0FLRztJQUNVLGlCQUFpQixDQUFDLEtBQUssRUFBRSxXQUFXLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQU9uRTtJQUVEOzs7OztPQUtHO0lBQ1UsdUJBQXVCLENBQUMsSUFBSSxHQUFFLE9BQWUsR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLENBUzVFO0lBRUQ7Ozs7T0FJRztJQUNVLFlBQVksQ0FBQyxJQUFJLEdBQUUsT0FBZSxHQUFHLE9BQU8sQ0FBQyxrQkFBa0IsQ0FBQyxDQW9CNUU7SUFFRCxPQUFPLENBQUMsb0JBQW9CO1lBVWQsZ0JBQWdCO0lBa0I5Qjs7T0FFRztJQUNILHdCQUF3QixDQUFDLEtBQUssRUFBRSxXQUFXLEVBQUUsSUFBSSxFQUFFLFVBQVUsRUFBRSxJQUFJLEVBQUUsTUFBTSxHQUFHLEtBQUssTUFBTSxFQUFFLENBUzFGO0lBRU0sb0JBQW9CLENBQUMsSUFBSSxFQUFFLFVBQVUsRUFBRSxLQUFLLEVBQUUsV0FBVyxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsSUFBSSxFQUFFLE1BQU0sR0FBRyxNQUFNLENBTXBHO0lBRUQsb0RBQW9EO0lBQzdDLHFCQUFxQixJQUFJO1FBQUUsV0FBVyxFQUFFLFVBQVUsQ0FBQztRQUFDLFFBQVEsRUFBRSxVQUFVLENBQUE7S0FBRSxDQVFoRjtJQUVEOzs7O09BSUc7SUFDSSxnQ0FBZ0MsQ0FBQyxJQUFJLEVBQUUsVUFBVSxHQUFHLE9BQU8sQ0FBQyxVQUFVLEdBQUcsU0FBUyxDQUFDLENBR3pGO0lBRUQ7Ozs7T0FJRztJQUNJLG9DQUFvQyxJQUFJLE9BQU8sQ0FBQyxVQUFVLEdBQUcsU0FBUyxDQUFDLENBRzdFO1lBUWEsNEJBQTRCO0lBYW5DLDZCQUE2QixDQUNsQyxrQkFBa0IsRUFBRSxrQkFBa0IsRUFDdEMsSUFBSSxFQUFFLFVBQVUsR0FDZixVQUFVLEdBQUcsU0FBUyxDQVl4QjtJQUVELDREQUE0RDtJQUN0RCxhQUFhLENBQUMsSUFBSSxFQUFFLE9BQU8sRUFBRSxTQUFTLEVBQUUsVUFBVSxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FNMUU7SUFFRCwrRkFBK0Y7SUFDekYsaUJBQWlCLENBQUMsSUFBSSxFQUFFLE9BQU8sRUFBRSxVQUFVLEVBQUUsVUFBVSxFQUFFLEdBQUcsT0FBTyxDQUFDLFVBQVUsRUFBRSxDQUFDLENBT3RGO0lBRUssdUJBQXVCLElBQUksT0FBTyxDQUFDLFVBQVUsRUFBRSxDQUFDLENBU3JEO0NBQ0YifQ==
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"epoch_cache.d.ts","sourceRoot":"","sources":["../src/epoch_cache.ts"],"names":[],"mappings":";
|
|
1
|
+
{"version":3,"file":"epoch_cache.d.ts","sourceRoot":"","sources":["../src/epoch_cache.ts"],"names":[],"mappings":"AACA,OAAO,EAAoB,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAE3D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EACL,KAAK,iBAAiB,EAOvB,MAAM,6BAA6B,CAAC;AAIrC,OAAO,EAAE,KAAK,gBAAgB,EAA8B,MAAM,aAAa,CAAC;AAEhF,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,WAAW,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,WAAW,CAAC;IACnB,+DAA+D;IAC/D,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,CAAC;AAElD,MAAM,WAAW,mBAAmB;IAClC,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACrE,kBAAkB,IAAI,YAAY,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACvD,2BAA2B,IAAI,YAAY,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9D,wBAAwB,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,MAAM,EAAE,CAAC;IAC5F,oBAAoB,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/F,qBAAqB,IAAI;QAAE,WAAW,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE,UAAU,CAAA;KAAE,CAAC;IAC3E,gCAAgC,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IACpF,uBAAuB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IACjD,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACtE,iBAAiB,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;CACnF;AAED;;;;;;;;GAQG;AACH,qBAAa,UAAW,YAAW,mBAAmB;IAQlD,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,QAAQ,CAAC,WAAW;IAI5B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,SAAS,CAAC,QAAQ,CAAC,MAAM;;;;IAZ3B,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAa;IAClE,OAAO,CAAC,aAAa,CAA0B;IAC/C,OAAO,CAAC,oBAAoB,CAAK;IACjC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAuC;IAE3D,YACU,MAAM,EAAE,cAAc,EACb,WAAW,EAAE,iBAAiB,GAAG;QAChD,0BAA0B,EAAE,MAAM,CAAC;QACnC,oBAAoB,EAAE,MAAM,CAAC;KAC9B,EACgB,YAAY,GAAE,YAAiC,EAC7C,MAAM;;;KAAyD,EAKnF;IAED,OAAa,MAAM,CACjB,eAAe,EAAE,UAAU,GAAG,cAAc,EAC5C,MAAM,CAAC,EAAE,gBAAgB,EACzB,IAAI,GAAE;QAAE,YAAY,CAAC,EAAE,YAAY,CAAA;KAAO,uBAgD3C;IAEM,cAAc,IAAI,iBAAiB,CAEzC;IAEM,kBAAkB,IAAI,YAAY,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAI5D;IAEM,YAAY,IAAI,MAAM,CAE5B;IAED,OAAO,CAAC,qBAAqB;IAMtB,2BAA2B,IAAI,YAAY,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAInE;IAED,OAAO,CAAC,0BAA0B;IAS3B,oBAAoB,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAG3E;IAED;;;;;OAKG;IACU,iBAAiB,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAOnE;IAED;;;;;OAKG;IACU,uBAAuB,CAAC,IAAI,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,CAAC,CAS5E;IAED;;;;OAIG;IACU,YAAY,CAAC,IAAI,GAAE,OAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAoB5E;IAED,OAAO,CAAC,oBAAoB;YAUd,gBAAgB;IAkB9B;;OAEG;IACH,wBAAwB,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,MAAM,EAAE,CAS1F;IAEM,oBAAoB,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAMpG;IAED,oDAAoD;IAC7C,qBAAqB,IAAI;QAAE,WAAW,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE,UAAU,CAAA;KAAE,CAQhF;IAED;;;;OAIG;IACI,gCAAgC,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAGzF;IAED;;;;OAIG;IACI,oCAAoC,IAAI,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAG7E;YAQa,4BAA4B;IAanC,6BAA6B,CAClC,kBAAkB,EAAE,kBAAkB,EACtC,IAAI,EAAE,UAAU,GACf,UAAU,GAAG,SAAS,CAYxB;IAED,4DAA4D;IACtD,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,CAM1E;IAED,+FAA+F;IACzF,iBAAiB,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAOtF;IAEK,uBAAuB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CASrD;CACF"}
|
package/dest/epoch_cache.js
CHANGED
|
@@ -1,105 +1,200 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { createEthereumChain } from '@aztec/ethereum/chain';
|
|
2
|
+
import { NoCommitteeError, RollupContract } from '@aztec/ethereum/contracts';
|
|
2
3
|
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
3
4
|
import { createLogger } from '@aztec/foundation/log';
|
|
4
5
|
import { DateProvider } from '@aztec/foundation/timer';
|
|
5
|
-
import {
|
|
6
|
-
import { EventEmitter } from 'node:events';
|
|
6
|
+
import { getEpochAtSlot, getEpochNumberAtTimestamp, getSlotAtTimestamp, getSlotRangeForEpoch, getTimestampForSlot, getTimestampRangeForEpoch } from '@aztec/stdlib/epoch-helpers';
|
|
7
7
|
import { createPublicClient, encodeAbiParameters, fallback, http, keccak256 } from 'viem';
|
|
8
8
|
import { getEpochCacheConfigEnvVars } from './config.js';
|
|
9
9
|
/**
|
|
10
10
|
* Epoch cache
|
|
11
11
|
*
|
|
12
12
|
* This class is responsible for managing traffic to the l1 node, by caching the validator set.
|
|
13
|
+
* Keeps the last N epochs in cache.
|
|
13
14
|
* It also provides a method to get the current or next proposer, and to check who is in the current slot.
|
|
14
15
|
*
|
|
15
|
-
* If the epoch changes, then we update the stored validator set.
|
|
16
|
-
*
|
|
17
16
|
* Note: This class is very dependent on the system clock being in sync.
|
|
18
|
-
*/ export class EpochCache
|
|
17
|
+
*/ export class EpochCache {
|
|
19
18
|
rollup;
|
|
20
19
|
l1constants;
|
|
21
20
|
dateProvider;
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
21
|
+
config;
|
|
22
|
+
// eslint-disable-next-line aztec-custom/no-non-primitive-in-collections
|
|
23
|
+
cache;
|
|
24
|
+
allValidators;
|
|
25
|
+
lastValidatorRefresh;
|
|
25
26
|
log;
|
|
26
|
-
constructor(rollup,
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
this.
|
|
31
|
-
|
|
32
|
-
|
|
27
|
+
constructor(rollup, l1constants, dateProvider = new DateProvider(), config = {
|
|
28
|
+
cacheSize: 12,
|
|
29
|
+
validatorRefreshIntervalSeconds: 60
|
|
30
|
+
}){
|
|
31
|
+
this.rollup = rollup;
|
|
32
|
+
this.l1constants = l1constants;
|
|
33
|
+
this.dateProvider = dateProvider;
|
|
34
|
+
this.config = config;
|
|
35
|
+
this.cache = new Map();
|
|
36
|
+
this.allValidators = new Set();
|
|
37
|
+
this.lastValidatorRefresh = 0;
|
|
38
|
+
this.log = createLogger('epoch-cache');
|
|
39
|
+
this.log.debug(`Initialized EpochCache`, {
|
|
40
|
+
l1constants
|
|
33
41
|
});
|
|
34
|
-
this.cachedEpoch = getEpochNumberAtTimestamp(this.nowInSeconds(), this.l1constants);
|
|
35
42
|
}
|
|
36
|
-
static async create(
|
|
43
|
+
static async create(rollupOrAddress, config, deps = {}) {
|
|
37
44
|
config = config ?? getEpochCacheConfigEnvVars();
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
45
|
+
// Load the rollup contract if we were given an address
|
|
46
|
+
let rollup;
|
|
47
|
+
if ('address' in rollupOrAddress) {
|
|
48
|
+
rollup = rollupOrAddress;
|
|
49
|
+
} else {
|
|
50
|
+
const chain = createEthereumChain(config.l1RpcUrls, config.l1ChainId);
|
|
51
|
+
const publicClient = createPublicClient({
|
|
52
|
+
chain: chain.chainInfo,
|
|
53
|
+
transport: fallback(config.l1RpcUrls.map((url)=>http(url, {
|
|
54
|
+
batch: false
|
|
55
|
+
}))),
|
|
56
|
+
pollingInterval: config.viemPollingIntervalMS
|
|
57
|
+
});
|
|
58
|
+
rollup = new RollupContract(publicClient, rollupOrAddress.toString());
|
|
59
|
+
}
|
|
60
|
+
const [l1StartBlock, l1GenesisTime, proofSubmissionEpochs, slotDuration, epochDuration, lagInEpochsForValidatorSet, lagInEpochsForRandao] = await Promise.all([
|
|
46
61
|
rollup.getL1StartBlock(),
|
|
47
62
|
rollup.getL1GenesisTime(),
|
|
48
|
-
rollup.
|
|
49
|
-
rollup.
|
|
63
|
+
rollup.getProofSubmissionEpochs(),
|
|
64
|
+
rollup.getSlotDuration(),
|
|
65
|
+
rollup.getEpochDuration(),
|
|
66
|
+
rollup.getLagInEpochsForValidatorSet(),
|
|
67
|
+
rollup.getLagInEpochsForRandao()
|
|
50
68
|
]);
|
|
51
69
|
const l1RollupConstants = {
|
|
52
70
|
l1StartBlock,
|
|
53
71
|
l1GenesisTime,
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
72
|
+
proofSubmissionEpochs: Number(proofSubmissionEpochs),
|
|
73
|
+
slotDuration: Number(slotDuration),
|
|
74
|
+
epochDuration: Number(epochDuration),
|
|
75
|
+
ethereumSlotDuration: config.ethereumSlotDuration,
|
|
76
|
+
lagInEpochsForValidatorSet: Number(lagInEpochsForValidatorSet),
|
|
77
|
+
lagInEpochsForRandao: Number(lagInEpochsForRandao)
|
|
78
|
+
};
|
|
79
|
+
return new EpochCache(rollup, l1RollupConstants, deps.dateProvider);
|
|
80
|
+
}
|
|
81
|
+
getL1Constants() {
|
|
82
|
+
return this.l1constants;
|
|
83
|
+
}
|
|
84
|
+
getEpochAndSlotNow() {
|
|
85
|
+
const nowMs = BigInt(this.dateProvider.now());
|
|
86
|
+
const nowSeconds = nowMs / 1000n;
|
|
87
|
+
return {
|
|
88
|
+
...this.getEpochAndSlotAtTimestamp(nowSeconds),
|
|
89
|
+
nowMs
|
|
57
90
|
};
|
|
58
|
-
return new EpochCache(rollup, initialValidators.map((v)=>EthAddress.fromString(v)), sampleSeed, l1RollupConstants, deps.dateProvider);
|
|
59
91
|
}
|
|
60
92
|
nowInSeconds() {
|
|
61
93
|
return BigInt(Math.floor(this.dateProvider.now() / 1000));
|
|
62
94
|
}
|
|
63
|
-
|
|
64
|
-
|
|
95
|
+
getEpochAndSlotAtSlot(slot) {
|
|
96
|
+
const epoch = getEpochAtSlot(slot, this.l1constants);
|
|
97
|
+
const ts = getTimestampRangeForEpoch(epoch, this.l1constants)[0];
|
|
98
|
+
return {
|
|
99
|
+
epoch,
|
|
100
|
+
ts,
|
|
101
|
+
slot
|
|
102
|
+
};
|
|
65
103
|
}
|
|
66
|
-
|
|
67
|
-
const
|
|
68
|
-
|
|
104
|
+
getEpochAndSlotInNextL1Slot() {
|
|
105
|
+
const now = this.nowInSeconds();
|
|
106
|
+
const nextSlotTs = now + BigInt(this.l1constants.ethereumSlotDuration);
|
|
107
|
+
return {
|
|
108
|
+
...this.getEpochAndSlotAtTimestamp(nextSlotTs),
|
|
109
|
+
now
|
|
110
|
+
};
|
|
69
111
|
}
|
|
70
112
|
getEpochAndSlotAtTimestamp(ts) {
|
|
113
|
+
const slot = getSlotAtTimestamp(ts, this.l1constants);
|
|
71
114
|
return {
|
|
72
115
|
epoch: getEpochNumberAtTimestamp(ts, this.l1constants),
|
|
73
|
-
|
|
74
|
-
|
|
116
|
+
ts: getTimestampForSlot(slot, this.l1constants),
|
|
117
|
+
slot
|
|
75
118
|
};
|
|
76
119
|
}
|
|
120
|
+
getCommitteeForEpoch(epoch) {
|
|
121
|
+
const [startSlot] = getSlotRangeForEpoch(epoch, this.l1constants);
|
|
122
|
+
return this.getCommittee(startSlot);
|
|
123
|
+
}
|
|
77
124
|
/**
|
|
78
|
-
*
|
|
125
|
+
* Returns whether the escape hatch is open for the given epoch.
|
|
126
|
+
*
|
|
127
|
+
* Uses the already-cached EpochCommitteeInfo when available. If not cached, it will fetch
|
|
128
|
+
* the epoch committee info (which includes the escape hatch flag) and return it.
|
|
129
|
+
*/ async isEscapeHatchOpen(epoch) {
|
|
130
|
+
const cached = this.cache.get(epoch);
|
|
131
|
+
if (cached) {
|
|
132
|
+
return cached.isEscapeHatchOpen;
|
|
133
|
+
}
|
|
134
|
+
const info = await this.getCommitteeForEpoch(epoch);
|
|
135
|
+
return info.isEscapeHatchOpen;
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* Returns whether the escape hatch is open for the epoch containing the given slot.
|
|
79
139
|
*
|
|
140
|
+
* This is a lightweight helper intended for callers that already have a slot number and only
|
|
141
|
+
* need the escape hatch flag (without pulling full committee info).
|
|
142
|
+
*/ async isEscapeHatchOpenAtSlot(slot = 'now') {
|
|
143
|
+
const epoch = slot === 'now' ? this.getEpochAndSlotNow().epoch : slot === 'next' ? this.getEpochAndSlotInNextL1Slot().epoch : getEpochAtSlot(slot, this.l1constants);
|
|
144
|
+
return await this.isEscapeHatchOpen(epoch);
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* Get the current validator set
|
|
80
148
|
* @param nextSlot - If true, get the validator set for the next slot.
|
|
81
149
|
* @returns The current validator set.
|
|
82
|
-
*/ async getCommittee(
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
150
|
+
*/ async getCommittee(slot = 'now') {
|
|
151
|
+
const { epoch, ts } = this.getEpochAndTimestamp(slot);
|
|
152
|
+
if (this.cache.has(epoch)) {
|
|
153
|
+
return this.cache.get(epoch);
|
|
154
|
+
}
|
|
155
|
+
const epochData = await this.computeCommittee({
|
|
156
|
+
epoch,
|
|
157
|
+
ts
|
|
158
|
+
});
|
|
159
|
+
// If the committee size is 0 or undefined, then do not cache
|
|
160
|
+
if (!epochData.committee || epochData.committee.length === 0) {
|
|
161
|
+
return epochData;
|
|
162
|
+
}
|
|
163
|
+
this.cache.set(epoch, epochData);
|
|
164
|
+
const toPurge = Array.from(this.cache.keys()).sort((a, b)=>Number(b - a)).slice(this.config.cacheSize);
|
|
165
|
+
toPurge.forEach((key)=>this.cache.delete(key));
|
|
166
|
+
return epochData;
|
|
167
|
+
}
|
|
168
|
+
getEpochAndTimestamp(slot = 'now') {
|
|
169
|
+
if (slot === 'now') {
|
|
170
|
+
return this.getEpochAndSlotNow();
|
|
171
|
+
} else if (slot === 'next') {
|
|
172
|
+
return this.getEpochAndSlotInNextL1Slot();
|
|
173
|
+
} else {
|
|
174
|
+
return this.getEpochAndSlotAtSlot(slot);
|
|
101
175
|
}
|
|
102
|
-
|
|
176
|
+
}
|
|
177
|
+
async computeCommittee(when) {
|
|
178
|
+
const { ts, epoch } = when;
|
|
179
|
+
const [committee, seedBuffer, l1Timestamp, isEscapeHatchOpen] = await Promise.all([
|
|
180
|
+
this.rollup.getCommitteeAt(ts),
|
|
181
|
+
this.rollup.getSampleSeedAt(ts),
|
|
182
|
+
this.rollup.client.getBlock({
|
|
183
|
+
includeTransactions: false
|
|
184
|
+
}).then((b)=>b.timestamp),
|
|
185
|
+
this.rollup.isEscapeHatchOpen(epoch)
|
|
186
|
+
]);
|
|
187
|
+
const { lagInEpochsForValidatorSet, epochDuration, slotDuration } = this.l1constants;
|
|
188
|
+
const sub = BigInt(lagInEpochsForValidatorSet) * BigInt(epochDuration) * BigInt(slotDuration);
|
|
189
|
+
if (ts - sub > l1Timestamp) {
|
|
190
|
+
throw new Error(`Cannot query committee for future epoch ${epoch} with timestamp ${ts} (current L1 time is ${l1Timestamp}). Check your Ethereum node is synced.`);
|
|
191
|
+
}
|
|
192
|
+
return {
|
|
193
|
+
committee,
|
|
194
|
+
seed: seedBuffer.toBigInt(),
|
|
195
|
+
epoch,
|
|
196
|
+
isEscapeHatchOpen
|
|
197
|
+
};
|
|
103
198
|
}
|
|
104
199
|
/**
|
|
105
200
|
* Get the ABI encoding of the proposer index - see ValidatorSelectionLib.sol computeProposerIndex
|
|
@@ -118,47 +213,88 @@ import { getEpochCacheConfigEnvVars } from './config.js';
|
|
|
118
213
|
name: 'seed'
|
|
119
214
|
}
|
|
120
215
|
], [
|
|
121
|
-
epoch,
|
|
122
|
-
slot,
|
|
216
|
+
BigInt(epoch),
|
|
217
|
+
BigInt(slot),
|
|
123
218
|
seed
|
|
124
219
|
]);
|
|
125
220
|
}
|
|
126
221
|
computeProposerIndex(slot, epoch, seed, size) {
|
|
222
|
+
// if committe size is 0, then mod 1 is 0
|
|
223
|
+
if (size === 0n) {
|
|
224
|
+
return 0n;
|
|
225
|
+
}
|
|
127
226
|
return BigInt(keccak256(this.getProposerIndexEncoding(epoch, slot, seed))) % size;
|
|
128
227
|
}
|
|
129
|
-
/**
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
* We return the next proposer as the node will check if it is the proposer at the next ethereum block, which
|
|
133
|
-
* can be the next slot. If this is the case, then it will send proposals early.
|
|
134
|
-
*
|
|
135
|
-
* If we are at an epoch boundary, then we can update the cache for the next epoch, this is the last check
|
|
136
|
-
* we do in the validator client, so we can update the cache here.
|
|
137
|
-
*/ async getProposerInCurrentOrNextSlot() {
|
|
138
|
-
// Validators are sorted by their index in the committee, and getValidatorSet will cache
|
|
139
|
-
const committee = await this.getCommittee();
|
|
140
|
-
const { slot: currentSlot, epoch: currentEpoch } = this.getEpochAndSlotNow();
|
|
141
|
-
const { slot: nextSlot, epoch: nextEpoch } = this.getEpochAndSlotInNextSlot();
|
|
142
|
-
// Compute the proposer in this and the next slot
|
|
143
|
-
const proposerIndex = this.computeProposerIndex(currentSlot, this.cachedEpoch, this.cachedSampleSeed, BigInt(committee.length));
|
|
144
|
-
// Check if the next proposer is in the next epoch
|
|
145
|
-
if (nextEpoch !== currentEpoch) {
|
|
146
|
-
await this.getCommittee(/*next slot*/ true);
|
|
147
|
-
}
|
|
148
|
-
const nextProposerIndex = this.computeProposerIndex(nextSlot, this.cachedEpoch, this.cachedSampleSeed, BigInt(committee.length));
|
|
149
|
-
const currentProposer = committee[Number(proposerIndex)];
|
|
150
|
-
const nextProposer = committee[Number(nextProposerIndex)];
|
|
228
|
+
/** Returns the current and next L2 slot numbers. */ getCurrentAndNextSlot() {
|
|
229
|
+
const current = this.getEpochAndSlotNow();
|
|
230
|
+
const next = this.getEpochAndSlotInNextL1Slot();
|
|
151
231
|
return {
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
currentSlot,
|
|
155
|
-
nextSlot
|
|
232
|
+
currentSlot: current.slot,
|
|
233
|
+
nextSlot: next.slot
|
|
156
234
|
};
|
|
157
235
|
}
|
|
158
236
|
/**
|
|
159
|
-
*
|
|
160
|
-
|
|
161
|
-
|
|
237
|
+
* Get the proposer attester address in the given L2 slot
|
|
238
|
+
* @returns The proposer attester address. If the committee does not exist, we throw a NoCommitteeError.
|
|
239
|
+
* If the committee is empty (i.e. target committee size is 0, and anyone can propose), we return undefined.
|
|
240
|
+
*/ getProposerAttesterAddressInSlot(slot) {
|
|
241
|
+
const epochAndSlot = this.getEpochAndSlotAtSlot(slot);
|
|
242
|
+
return this.getProposerAttesterAddressAt(epochAndSlot);
|
|
243
|
+
}
|
|
244
|
+
/**
|
|
245
|
+
* Get the proposer attester address in the next slot
|
|
246
|
+
* @returns The proposer attester address. If the committee does not exist, we throw a NoCommitteeError.
|
|
247
|
+
* If the committee is empty (i.e. target committee size is 0, and anyone can propose), we return undefined.
|
|
248
|
+
*/ getProposerAttesterAddressInNextSlot() {
|
|
249
|
+
const epochAndSlot = this.getEpochAndSlotInNextL1Slot();
|
|
250
|
+
return this.getProposerAttesterAddressAt(epochAndSlot);
|
|
251
|
+
}
|
|
252
|
+
/**
|
|
253
|
+
* Get the proposer attester address at a given epoch and slot
|
|
254
|
+
* @param when - The epoch and slot to get the proposer attester address at
|
|
255
|
+
* @returns The proposer attester address. If the committee does not exist, we throw a NoCommitteeError.
|
|
256
|
+
* If the committee is empty (i.e. target committee size is 0, and anyone can propose), we return undefined.
|
|
257
|
+
*/ async getProposerAttesterAddressAt(when) {
|
|
258
|
+
const { epoch, slot } = when;
|
|
259
|
+
const { committee, seed } = await this.getCommittee(slot);
|
|
260
|
+
if (!committee) {
|
|
261
|
+
throw new NoCommitteeError();
|
|
262
|
+
} else if (committee.length === 0) {
|
|
263
|
+
return undefined;
|
|
264
|
+
}
|
|
265
|
+
const proposerIndex = this.computeProposerIndex(slot, epoch, seed, BigInt(committee.length));
|
|
266
|
+
return committee[Number(proposerIndex)];
|
|
267
|
+
}
|
|
268
|
+
getProposerFromEpochCommittee(epochCommitteeInfo, slot) {
|
|
269
|
+
if (!epochCommitteeInfo.committee || epochCommitteeInfo.committee.length === 0) {
|
|
270
|
+
return undefined;
|
|
271
|
+
}
|
|
272
|
+
const proposerIndex = this.computeProposerIndex(slot, epochCommitteeInfo.epoch, epochCommitteeInfo.seed, BigInt(epochCommitteeInfo.committee.length));
|
|
273
|
+
return epochCommitteeInfo.committee[Number(proposerIndex)];
|
|
274
|
+
}
|
|
275
|
+
/** Check if a validator is in the given slot's committee */ async isInCommittee(slot, validator) {
|
|
276
|
+
const { committee } = await this.getCommittee(slot);
|
|
277
|
+
if (!committee) {
|
|
278
|
+
return false;
|
|
279
|
+
}
|
|
162
280
|
return committee.some((v)=>v.equals(validator));
|
|
163
281
|
}
|
|
282
|
+
/** From the set of given addresses, return all that are on the committee for the given slot */ async filterInCommittee(slot, validators) {
|
|
283
|
+
const { committee } = await this.getCommittee(slot);
|
|
284
|
+
if (!committee) {
|
|
285
|
+
return [];
|
|
286
|
+
}
|
|
287
|
+
const committeeSet = new Set(committee.map((v)=>v.toString()));
|
|
288
|
+
return validators.filter((v)=>committeeSet.has(v.toString()));
|
|
289
|
+
}
|
|
290
|
+
async getRegisteredValidators() {
|
|
291
|
+
const validatorRefreshIntervalMs = this.config.validatorRefreshIntervalSeconds * 1000;
|
|
292
|
+
const validatorRefreshTime = this.lastValidatorRefresh + validatorRefreshIntervalMs;
|
|
293
|
+
if (validatorRefreshTime < this.dateProvider.now()) {
|
|
294
|
+
const currentSet = await this.rollup.getAttesters();
|
|
295
|
+
this.allValidators = new Set(currentSet.map((v)=>v.toString()));
|
|
296
|
+
this.lastValidatorRefresh = this.dateProvider.now();
|
|
297
|
+
}
|
|
298
|
+
return Array.from(this.allValidators.keys()).map((v)=>EthAddress.fromString(v));
|
|
299
|
+
}
|
|
164
300
|
}
|
package/dest/index.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
export * from './epoch_cache.js';
|
|
2
2
|
export * from './config.js';
|
|
3
|
-
//# sourceMappingURL=
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLGtCQUFrQixDQUFDO0FBQ2pDLGNBQWMsYUFBYSxDQUFDIn0=
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './test_epoch_cache.js';
|