Add sequencer orderings (FIFO, LIFO, HighestValue, Random) (#62)

* Add sequencer orderings (FIFO, LIFO, HighestValue, Random) * Add sequencer order in config * Add configurable sequencer orderings * Format code
l2beat · Oct 15, 2023 · 6dd75d8 · 6dd75d8
1 parent 38d3b39
commit 6dd75d8
Show file tree

Hide file tree

Showing 8 changed files with 408 additions and 3 deletions.
diff --git a/packages/node/src/Application.ts b/packages/node/src/Application.ts
@@ -90,6 +90,7 @@ export class Application {
       logger,
       calculateTransactionLimit(config.batchPoster.gasLimit),
       config.batchPoster.intervalMs,
+      config.batchPoster.sequencerOrder,
     )
 
     const routers: AppRouters = {

diff --git a/packages/node/src/config/Config.ts b/packages/node/src/config/Config.ts
@@ -14,6 +14,7 @@ export interface Config {
   readonly batchPoster: {
     readonly intervalMs: number
     readonly gasLimit: number
+    readonly sequencerOrder: string
   }
   readonly privateKey: Hex
   readonly genesisState: Record<string, number>

diff --git a/packages/node/src/config/config.local.ts b/packages/node/src/config/config.local.ts
@@ -22,6 +22,7 @@ export function getLocalConfig(): Config {
     batchPoster: {
       intervalMs: 10_000,
       gasLimit: 3_000_000,
+      sequencerOrder: env.string('SEQUENCER_ORDER', 'FEE'),
     },
     privateKey: Hex(
       '0x47e179ec197488593b187f80a00eb0da91f1b9d0b13f8733639f19c30a34926a',

diff --git a/packages/node/src/config/config.production.ts b/packages/node/src/config/config.production.ts
@@ -33,6 +33,7 @@ export function getProductionConfig(): Config {
     batchPoster: {
       intervalMs: 10_000,
       gasLimit: 3_000_000,
+      sequencerOrder: env.string('SEQUENCER_ORDER', 'FEE'),
     },
     privateKey: Hex(env.string('PRIVATE_KEY')),
     genesisState: GENESIS_STATE,

diff --git a/packages/node/src/core/BatchPoster.test.ts b/packages/node/src/core/BatchPoster.test.ts
@@ -61,6 +61,7 @@ describe(BatchPoster.name, () => {
 
   const FLUSH_PERIOD_MS = 1_000
   const TRANSACTION_LIMIT = 100
+  const SEQUENCER_ORDER = 'FEE'
 
   describe(BatchPoster.prototype.start.name, () => {
     it('submits transactions where every one applies every flush period seconds', async () => {
@@ -103,6 +104,7 @@ describe(BatchPoster.name, () => {
         Logger.SILENT,
         TRANSACTION_LIMIT,
         FLUSH_PERIOD_MS,
+        SEQUENCER_ORDER,
       )
       batchPoster.start()
       await time.tickAsync(FLUSH_PERIOD_MS * 3)
@@ -160,6 +162,7 @@ describe(BatchPoster.name, () => {
         Logger.SILENT,
         TRANSACTION_LIMIT,
         FLUSH_PERIOD_MS,
+        SEQUENCER_ORDER,
       )
       batchPoster.start()
       await time.tickAsync(FLUSH_PERIOD_MS * 3)
@@ -213,6 +216,7 @@ describe(BatchPoster.name, () => {
         Logger.SILENT,
         TRANSACTION_LIMIT,
         FLUSH_PERIOD_MS,
+        SEQUENCER_ORDER,
       )
       batchPoster.start()
       await time.tickAsync(FLUSH_PERIOD_MS * 3)
@@ -263,6 +267,7 @@ describe(BatchPoster.name, () => {
         Logger.SILENT,
         TRANSACTION_LIMIT,
         FLUSH_PERIOD_MS,
+        SEQUENCER_ORDER,
       )
       batchPoster.start()
       await time.tickAsync(FLUSH_PERIOD_MS * 3)
@@ -320,6 +325,7 @@ describe(BatchPoster.name, () => {
         Logger.SILENT,
         TRANSACTION_LIMIT,
         FLUSH_PERIOD_MS,
+        SEQUENCER_ORDER,
       )
       batchPoster.start()
       await time.tickAsync(FLUSH_PERIOD_MS * 3)
@@ -369,6 +375,7 @@ describe(BatchPoster.name, () => {
         Logger.SILENT,
         TRANSACTION_LIMIT,
         FLUSH_PERIOD_MS,
+        SEQUENCER_ORDER,
       )
       batchPoster.start()
       await time.tickAsync(FLUSH_PERIOD_MS * 3)
@@ -420,6 +427,7 @@ describe(BatchPoster.name, () => {
         Logger.SILENT,
         TRANSACTION_LIMIT,
         FLUSH_PERIOD_MS,
+        SEQUENCER_ORDER,
       )
       batchPoster.start()
       await time.tickAsync(FLUSH_PERIOD_MS * 3)
@@ -436,5 +444,65 @@ describe(BatchPoster.name, () => {
         modelTx2SerializedHex,
       )
     })
+
+    it('submits transactions every flush period seconds with different sequencer ordering', async () => {
+      const stateUpdater = mockObject<StateUpdater>({
+        getState: mockFn()
+          .returnsOnce({
+            '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266': {
+              balance: 100n,
+              nonce: 0n,
+            },
+            '0x70997970C51812dc3A010C7d01b50e0d17dc79C8': {
+              balance: 500n,
+              nonce: 0n,
+            },
+          })
+          .returnsOnce({
+            '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266': {
+              balance: 88n,
+              nonce: 1n,
+            },
+            '0x70997970C51812dc3A010C7d01b50e0d17dc79C8': {
+              balance: 0n,
+              nonce: 1n,
+            },
+          }),
+      })
+      const client = mockObject<EthereumPrivateClient>({
+        writeToInputsContract: mockFn()
+          .throwsOnce(new Error('failed'))
+          .returns(null),
+      })
+      const mempool = mockObject<Mempool>({
+        popNFIFO: mockFn()
+          .returnsOnce([modelSignedTx1])
+          .returnsOnce([modelSignedTx2]),
+        empty: mockFn().returns(null),
+      })
+      const batchPoster = new BatchPoster(
+        stateUpdater,
+        client,
+        mempool,
+        Logger.SILENT,
+        TRANSACTION_LIMIT,
+        FLUSH_PERIOD_MS,
+        'FIFO',
+      )
+      batchPoster.start()
+      await time.tickAsync(FLUSH_PERIOD_MS * 3)
+
+      expect(mempool.empty).toHaveBeenCalledTimes(0)
+      expect(mempool.popNFIFO).toHaveBeenCalledTimes(2)
+      expect(client.writeToInputsContract).toHaveBeenCalledTimes(2)
+      expect(client.writeToInputsContract).toHaveBeenNthCalledWith(
+        1,
+        modelTx1SerializedHex,
+      )
+      expect(client.writeToInputsContract).toHaveBeenNthCalledWith(
+        2,
+        modelTx2SerializedHex,
+      )
+    })
   })
 })
diff --git a/packages/node/src/core/BatchPoster.ts b/packages/node/src/core/BatchPoster.ts
@@ -15,6 +15,7 @@ export class BatchPoster {
     private readonly logger: Logger,
     private readonly transactionLimit: number,
     private readonly intervalMs: number,
+    private readonly sequencerOrder: string,
   ) {
     this.logger = logger.for(this)
   }
@@ -29,9 +30,39 @@ export class BatchPoster {
   }
 
   private async postBatch(): Promise<void> {
-    const candidateTransactions = this.mempool.popNHighestFee(
-      this.transactionLimit,
-    )
+    let candidateTransactions
+    switch (this.sequencerOrder) {
+      case 'FEE': {
+        candidateTransactions = this.mempool.popNHighestFee(
+          this.transactionLimit,
+        )
+        break
+      }
+      case 'FIFO': {
+        candidateTransactions = this.mempool.popNFIFO(this.transactionLimit)
+        break
+      }
+      case 'LIFO': {
+        candidateTransactions = this.mempool.popNLIFO(this.transactionLimit)
+        break
+      }
+      case 'RANDOM': {
+        candidateTransactions = this.mempool.popNRandom(this.transactionLimit)
+        break
+      }
+      case 'VALUE': {
+        candidateTransactions = this.mempool.popNHighestValue(
+          this.transactionLimit,
+        )
+        break
+      }
+      default: {
+        candidateTransactions = this.mempool.popNHighestFee(
+          this.transactionLimit,
+        )
+      }
+    }
+
     if (candidateTransactions.length === 0) {
       return
     }