@aztec/sequencer-client 0.0.0-test.0

package/dest/sequencer/sequencer.d.ts

@@ -0,0 +1,180 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { L2Block } from '@aztec/aztec.js';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import type { Signature } from '@aztec/foundation/eth-signature';
+import { Fr } from '@aztec/foundation/fields';
+import { type DateProvider, Timer } from '@aztec/foundation/timer';
+import type { P2P } from '@aztec/p2p';
+import type { BlockBuilderFactory } from '@aztec/prover-client/block-builder';
+import type { PublicProcessorFactory } from '@aztec/simulator/server';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { L2BlockSource } from '@aztec/stdlib/block';
+import type { ContractDataSource } from '@aztec/stdlib/contract';
+import type { L1RollupConstants } from '@aztec/stdlib/epoch-helpers';
+import { Gas } from '@aztec/stdlib/gas';
+import { type WorldStateSynchronizer } from '@aztec/stdlib/interfaces/server';
+import type { L1ToL2MessageSource } from '@aztec/stdlib/messaging';
+import { type GlobalVariables, Tx, type TxHash } from '@aztec/stdlib/tx';
+import { type TelemetryClient, type Tracer } from '@aztec/telemetry-client';
+import type { ValidatorClient } from '@aztec/validator-client';
+import type { GlobalVariableBuilder } from '../global_variable_builder/global_builder.js';
+import { type SequencerPublisher } from '../publisher/sequencer-publisher.js';
+import type { SlasherClient } from '../slasher/slasher_client.js';
+import type { SequencerConfig } from './config.js';
+import { SequencerTimetable } from './timetable.js';
+import { SequencerState } from './utils.js';
+export { SequencerState };
+type SequencerRollupConstants = Pick<L1RollupConstants, 'ethereumSlotDuration' | 'l1GenesisTime' | 'slotDuration'>;
+/**
+ * Sequencer client
+ * - Wins a period of time to become the sequencer (depending on finalized protocol).
+ * - Chooses a set of txs from the tx pool to be in the rollup.
+ * - Simulate the rollup of txs.
+ * - Adds proof requests to the request pool (not for this milestone).
+ * - Receives results to those proofs from the network (repeats as necessary) (not for this milestone).
+ * - Publishes L1 tx(s) to the rollup contract via RollupPublisher.
+ */
+export declare class Sequencer {
+    protected publisher: SequencerPublisher;
+    protected validatorClient: ValidatorClient | undefined;
+    protected globalsBuilder: GlobalVariableBuilder;
+    protected p2pClient: P2P;
+    protected worldState: WorldStateSynchronizer;
+    protected slasherClient: SlasherClient;
+    protected blockBuilderFactory: BlockBuilderFactory;
+    protected l2BlockSource: L2BlockSource;
+    protected l1ToL2MessageSource: L1ToL2MessageSource;
+    protected publicProcessorFactory: PublicProcessorFactory;
+    protected contractDataSource: ContractDataSource;
+    protected l1Constants: SequencerRollupConstants;
+    protected dateProvider: DateProvider;
+    protected config: SequencerConfig;
+    protected log: import("@aztec/aztec.js").Logger;
+    private runningPromise?;
+    private pollingIntervalMs;
+    private maxTxsPerBlock;
+    private minTxsPerBlock;
+    private maxL1TxInclusionTimeIntoSlot;
+    private _coinbase;
+    private _feeRecipient;
+    private state;
+    private allowedInSetup;
+    private maxBlockSizeInBytes;
+    private maxBlockGas;
+    private metrics;
+    private isFlushing;
+    /** The maximum number of seconds that the sequencer can be into a slot to transition to a particular state. */
+    protected timetable: SequencerTimetable;
+    protected enforceTimeTable: boolean;
+    constructor(publisher: SequencerPublisher, validatorClient: ValidatorClient | undefined, // During migration the validator client can be inactive
+    globalsBuilder: GlobalVariableBuilder, p2pClient: P2P, worldState: WorldStateSynchronizer, slasherClient: SlasherClient, blockBuilderFactory: BlockBuilderFactory, l2BlockSource: L2BlockSource, l1ToL2MessageSource: L1ToL2MessageSource, publicProcessorFactory: PublicProcessorFactory, contractDataSource: ContractDataSource, l1Constants: SequencerRollupConstants, dateProvider: DateProvider, config?: SequencerConfig, telemetry?: TelemetryClient, log?: import("@aztec/aztec.js").Logger);
+    get tracer(): Tracer;
+    /**
+     * Updates sequencer config.
+     * @param config - New parameters.
+     */
+    updateConfig(config: SequencerConfig): Promise<void>;
+    private setTimeTable;
+    /**
+     * Starts the sequencer and moves to IDLE state.
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the sequencer from processing txs and moves to STOPPED state.
+     */
+    stop(): Promise<void>;
+    /**
+     * Starts a previously stopped sequencer.
+     */
+    restart(): void;
+    /**
+     * Returns the current state of the sequencer.
+     * @returns An object with a state entry with one of SequencerState.
+     */
+    status(): {
+        state: SequencerState;
+    };
+    /** Forces the sequencer to bypass all time and tx count checks for the next block and build anyway. */
+    flush(): void;
+    /**
+     * @notice  Performs most of the sequencer duties:
+     *          - Checks if we are up to date
+     *          - If we are and we are the sequencer, collect txs and build a block
+     *          - Collect attestations for the block
+     *          - Submit block
+     *          - If our block for some reason is not included, revert the state
+     */
+    protected doRealWork(): Promise<void>;
+    protected work(): Promise<void>;
+    getForwarderAddress(): EthAddress;
+    /**
+     * Checks if we can propose at the next block and returns the slot number if we can.
+     * @param tipArchive - The archive of the previous block.
+     * @param proposalBlockNumber - The block number of the proposal.
+     * @returns The slot number if we can propose at the next block, otherwise undefined.
+     */
+    slotForProposal(tipArchive: Buffer, proposalBlockNumber: bigint): Promise<bigint | undefined>;
+    /**
+     * Sets the sequencer state and checks if we have enough time left in the slot to transition to the new state.
+     * @param proposedState - The new state to transition to.
+     * @param currentSlotNumber - The current slot number.
+     * @param force - Whether to force the transition even if the sequencer is stopped.
+     *
+     * @dev If the `currentSlotNumber` doesn't matter (e.g. transitioning to IDLE), pass in `0n`;
+     * it is only used to check if we have enough time left in the slot to transition to the new state.
+     */
+    setState(proposedState: SequencerState, currentSlotNumber: bigint, force?: boolean): void;
+    /**
+     * Build a block
+     *
+     * Shared between the sequencer and the validator for re-execution
+     *
+     * @param pendingTxs - The pending transactions to construct the block from
+     * @param newGlobalVariables - The global variables for the new block
+     * @param historicalHeader - The historical header of the parent
+     * @param opts - Whether to just validate the block as a validator, as opposed to building it as a proposal
+     */
+    protected buildBlock(pendingTxs: Iterable<Tx> | AsyncIterable<Tx>, newGlobalVariables: GlobalVariables, opts?: {
+        validateOnly?: boolean;
+    }): Promise<{
+        block: L2Block;
+        publicGas: Gas;
+        publicProcessorDuration: number;
+        numMsgs: number;
+        numTxs: number;
+        numFailedTxs: number;
+        blockBuildingTimer: Timer;
+    }>;
+    /**
+     * @notice  Build and propose a block to the chain
+     *
+     * @dev     MUST throw instead of exiting early to ensure that world-state
+     *          is being rolled back if the block is dropped.
+     *
+     * @param pendingTxs - Iterable of pending transactions to construct the block from
+     * @param proposalHeader - The partial header constructed for the proposal
+     */
+    private buildBlockAndEnqueuePublish;
+    protected collectAttestations(block: L2Block, txHashes: TxHash[]): Promise<Signature[] | undefined>;
+    /**
+     * Publishes the L2Block to the rollup contract.
+     * @param block - The L2Block to be published.
+     */
+    protected enqueuePublishL2Block(block: L2Block, attestations?: Signature[], txHashes?: TxHash[]): Promise<void>;
+    /**
+     * Returns whether all dependencies have caught up.
+     * We don't check against the previous block submitted since it may have been reorg'd out.
+     * @returns Boolean indicating if our dependencies are synced to the latest block.
+     */
+    protected getChainTip(): Promise<{
+        blockNumber: number;
+        archive: Fr;
+    } | undefined>;
+    private getSlotStartTimestamp;
+    private getSecondsIntoSlot;
+    get aztecSlotDuration(): number;
+    get coinbase(): EthAddress;
+    get feeRecipient(): AztecAddress;
+}
+//# sourceMappingURL=sequencer.d.ts.map

package/dest/sequencer/sequencer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sequencer.d.ts","sourceRoot":"","sources":["../../src/sequencer/sequencer.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAG/C,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAG9C,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,EAAW,MAAM,yBAAyB,CAAC;AAC5E,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AACxC,OAAO,EAGL,KAAK,sBAAsB,EAE5B,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAInE,OAAO,EAGL,KAAK,eAAe,EAEpB,EAAE,EACF,KAAK,MAAM,EACZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAc,KAAK,eAAe,EAAE,KAAK,MAAM,EAAiC,MAAM,yBAAyB,CAAC;AACvH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE/D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8CAA8C,CAAC;AAC1F,OAAO,EAAE,KAAK,kBAAkB,EAAY,MAAM,qCAAqC,CAAC;AACxF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAGlE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD,OAAO,EAAE,kBAAkB,EAAyB,MAAM,gBAAgB,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAqB,MAAM,YAAY,CAAC;AAE/D,OAAO,EAAE,cAAc,EAAE,CAAC;AAE1B,KAAK,wBAAwB,GAAG,IAAI,CAAC,iBAAiB,EAAE,sBAAsB,GAAG,eAAe,GAAG,cAAc,CAAC,CAAC;AAEnH;;;;;;;;GAQG;AACH,qBAAa,SAAS;IAsBlB,SAAS,CAAC,SAAS,EAAE,kBAAkB;IACvC,SAAS,CAAC,eAAe,EAAE,eAAe,GAAG,SAAS;IACtD,SAAS,CAAC,cAAc,EAAE,qBAAqB;IAC/C,SAAS,CAAC,SAAS,EAAE,GAAG;IACxB,SAAS,CAAC,UAAU,EAAE,sBAAsB;IAC5C,SAAS,CAAC,aAAa,EAAE,aAAa;IACtC,SAAS,CAAC,mBAAmB,EAAE,mBAAmB;IAClD,SAAS,CAAC,aAAa,EAAE,aAAa;IACtC,SAAS,CAAC,mBAAmB,EAAE,mBAAmB;IAClD,SAAS,CAAC,sBAAsB,EAAE,sBAAsB;IACxD,SAAS,CAAC,kBAAkB,EAAE,kBAAkB;IAChD,SAAS,CAAC,WAAW,EAAE,wBAAwB;IAC/C,SAAS,CAAC,YAAY,EAAE,YAAY;IACpC,SAAS,CAAC,MAAM,EAAE,eAAe;IAEjC,SAAS,CAAC,GAAG;IApCf,OAAO,CAAC,cAAc,CAAC,CAAiB;IACxC,OAAO,CAAC,iBAAiB,CAAgB;IACzC,OAAO,CAAC,cAAc,CAAM;IAC5B,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,4BAA4B,CAAK;IAEzC,OAAO,CAAC,SAAS,CAAmB;IACpC,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,KAAK,CAA0B;IACvC,OAAO,CAAC,cAAc,CAAwB;IAC9C,OAAO,CAAC,mBAAmB,CAAuB;IAClD,OAAO,CAAC,WAAW,CAA8B;IACjD,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,UAAU,CAAkB;IAEpC,+GAA+G;IAC/G,SAAS,CAAC,SAAS,EAAG,kBAAkB,CAAC;IAEzC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAS;gBAGhC,SAAS,EAAE,kBAAkB,EAC7B,eAAe,EAAE,eAAe,GAAG,SAAS,EAAE,wDAAwD;IACtG,cAAc,EAAE,qBAAqB,EACrC,SAAS,EAAE,GAAG,EACd,UAAU,EAAE,sBAAsB,EAClC,aAAa,EAAE,aAAa,EAC5B,mBAAmB,EAAE,mBAAmB,EACxC,aAAa,EAAE,aAAa,EAC5B,mBAAmB,EAAE,mBAAmB,EACxC,sBAAsB,EAAE,sBAAsB,EAC9C,kBAAkB,EAAE,kBAAkB,EACtC,WAAW,EAAE,wBAAwB,EACrC,YAAY,EAAE,YAAY,EAC1B,MAAM,GAAE,eAAoB,EACtC,SAAS,GAAE,eAAsC,EACvC,GAAG,mCAA4B;IAW3C,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;OAGG;IACU,YAAY,CAAC,MAAM,EAAE,eAAe;IAgDjD,OAAO,CAAC,YAAY;IAYpB;;OAEG;IACU,KAAK;IAQlB;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAUlC;;OAEG;IACI,OAAO;IAOd;;;OAGG;IACI,MAAM;;;IAIb,uGAAuG;IAChG,KAAK;IAIZ;;;;;;;OAOG;cACa,UAAU;cA6FV,IAAI;IAeb,mBAAmB;IAI1B;;;;;OAKG;IACG,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAiBnG;;;;;;;;OAQG;IACH,QAAQ,CAAC,aAAa,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,EAAE,KAAK,GAAE,OAAe;IAWzF;;;;;;;;;OASG;cACa,UAAU,CACxB,UAAU,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC,EAC5C,kBAAkB,EAAE,eAAe,EACnC,IAAI,GAAE;QAAE,YAAY,CAAC,EAAE,OAAO,CAAA;KAAO;;;;;;;;;IAgIvC;;;;;;;;OAQG;YAIW,2BAA2B;cAkEzB,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,GAAG,SAAS,CAAC;IA6CzG;;;OAGG;cAIa,qBAAqB,CACnC,KAAK,EAAE,OAAO,EACd,YAAY,CAAC,EAAE,SAAS,EAAE,EAC1B,QAAQ,CAAC,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;OAIG;cACa,WAAW,IAAI,OAAO,CAAC;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,EAAE,CAAA;KAAE,GAAG,SAAS,CAAC;IAsDxF,OAAO,CAAC,qBAAqB;IAI7B,OAAO,CAAC,kBAAkB;IAK1B,IAAI,iBAAiB,WAEpB;IAED,IAAI,QAAQ,IAAI,UAAU,CAEzB;IAED,IAAI,YAAY,IAAI,YAAY,CAE/B;CACF"}