Merge pull request #95 from OffchainLabs/timeboost-mode

Timeboost mode for nitro-testnode

Author: tsahee

docker-compose.yaml

@@ -166,7 +166,15 @@ services:
       - "l1keystore:/home/user/l1keystore"
       - "config:/config"
       - "tokenbridge-data:/tokenbridge-data"
-    command: --conf.file /config/sequencer_config.json --node.feed.output.enable --node.feed.output.port 9642  --http.api net,web3,eth,txpool,debug --node.seq-coordinator.my-url  ws://sequencer:8548 --graphql.enable --graphql.vhosts * --graphql.corsdomain *
+    command:
+      - --conf.file=/config/sequencer_config.json
+      - --node.feed.output.enable
+      - --node.feed.output.port=9642
+      - --http.api=net,web3,eth,txpool,debug,timeboost,auctioneer
+      - --node.seq-coordinator.my-url=http://sequencer:8547
+      - --graphql.enable
+      - --graphql.vhosts=*
+      - --graphql.corsdomain=*
     depends_on:
       - geth
 
@@ -180,7 +188,10 @@ services:
     volumes:
       - "seqdata_b:/home/user/.arbitrum/local/nitro"
       - "config:/config"
-    command: --conf.file /config/sequencer_config.json --node.seq-coordinator.my-url ws://sequencer_b:8548
+    command:
+      - --conf.file=/config/sequencer_config.json
+      - --node.seq-coordinator.my-url=http://sequencer_b:8547
+      - --http.api=net,web3,eth,txpool,debug,timeboost,auctioneer
     depends_on:
       - geth
       - redis
@@ -195,7 +206,10 @@ services:
     volumes:
       - "seqdata_c:/home/user/.arbitrum/local/nitro"
       - "config:/config"
-    command: --conf.file /config/sequencer_config.json --node.seq-coordinator.my-url ws://sequencer_c:8548
+    command:
+      - --conf.file=/config/sequencer_config.json
+      - --node.seq-coordinator.my-url=http://sequencer_c:8547
+      - --http.api=net,web3,eth,txpool,debug,timeboost,auctioneer
     depends_on:
       - geth
       - redis
@@ -210,7 +224,10 @@ services:
     volumes:
       - "seqdata_d:/home/user/.arbitrum/local/nitro"
       - "config:/config"
-    command: --conf.file /config/sequencer_config.json --node.seq-coordinator.my-url ws://sequencer_d:8548
+    command:
+      - --conf.file=/config/sequencer_config.json
+      - --node.seq-coordinator.my-url=http://sequencer_d:8547
+      - --http.api=net,web3,eth,txpool,debug,timeboost,auctioneer
     depends_on:
       - geth
       - redis
@@ -434,6 +451,37 @@ services:
     command:
       - --conf.file=/config/l2_das_mirror.json
 
+  timeboost-auctioneer:
+    pid: host # allow debugging
+    image: nitro-node-dev-testnode
+    entrypoint: /usr/local/bin/autonomous-auctioneer
+    volumes:
+      - "config:/config"
+      - "timeboost-auctioneer-data:/data"
+      - "l1keystore:/home/user/l1keystore"
+    command:
+      - --conf.file=/config/autonomous_auctioneer_config.json
+    depends_on:
+      - redis
+
+  timeboost-bid-validator:
+    pid: host # allow debugging
+    image: nitro-node-dev-testnode
+    entrypoint: /usr/local/bin/autonomous-auctioneer
+    ports:
+      - "127.0.0.1:9372:8547"
+    volumes:
+      - "config:/config"
+    command:
+      - --conf.file=/config/bid_validator_config.json
+      - --http.addr=0.0.0.0
+      - --http.vhosts=*
+      - --http.corsdomain=*
+      - --http.api=auctioneer
+      - --log-level=INFO
+    depends_on:
+      - redis
+
 volumes:
   l1data:
   consensus:
@@ -453,4 +501,5 @@ volumes:
   das-committee-a-data:
   das-committee-b-data:
   das-mirror-data:
+  timeboost-auctioneer-data:
   boldupgrader-data:

scripts/Dockerfile

@@ -1,7 +1,15 @@
-FROM node:18-bullseye-slim
+# Stage 1: Base build environment
+FROM node:18-bullseye-slim AS base
 WORKDIR /workspace
 COPY ./package.json ./yarn.lock ./
 RUN yarn
+
+# Stage 2: Copy files and run build
+FROM base AS pre-build
 COPY ./*.ts ./tsconfig.json ./
+RUN echo "Intermediate image created before yarn build"
+
+# Stage 3: Final build
+FROM pre-build AS final
 RUN yarn build
 ENTRYPOINT ["node", "index.js"]

scripts/accounts.ts

@@ -5,7 +5,7 @@ import * as crypto from "crypto";
 import { runStress } from "./stress";
 const path = require("path");
 
-const specialAccounts = 6;
+const specialAccounts = 7;
 
 async function writeAccounts() {
   for (let i = 0; i < specialAccounts; i++) {
@@ -47,6 +47,9 @@ export function namedAccount(
   if (name == "l2owner") {
     return specialAccount(5);
   }
+  if (name == "auctioneer") {
+    return specialAccount(6);
+  }
   if (name.startsWith("user_")) {
     return new ethers.Wallet(
       ethers.utils.sha256(ethers.utils.toUtf8Bytes(name))
@@ -85,7 +88,8 @@ export function namedAddress(
 
 export const namedAccountHelpString =
   "Valid account names:\n" +
-  "  funnel | sequencer | validator | l2owner - known keys used by l2\n" +
+  "  funnel | sequencer | validator | l2owner\n" +
+  "    | auctioneer                           - known keys used by l2\n" +
   "  l3owner | l3sequencer                    - known keys used by l3\n" +
   "  user_[Alphanumeric]                      - key will be generated from username\n" +
   "  threaduser_[Alphanumeric]                - same as user_[Alphanumeric]_thread_[thread-id]\n" +

scripts/config.ts

@@ -202,7 +202,7 @@ function writeConfigs(argv: any) {
                 "dangerous": {
                     "without-block-validator": false
                 },
-                "parent-chain-wallet" : {
+                "parent-chain-wallet": {
                     "account": namedAddress("validator"),
                     "password": consts.l1passphrase,
                     "pathname": consts.l1keystore,
@@ -236,7 +236,7 @@ function writeConfigs(argv: any) {
                 "redis-url": argv.redisUrl,
                 "max-delay": "30s",
                 "l1-block-bound": "ignore",
-                "parent-chain-wallet" : {
+                "parent-chain-wallet": {
                     "account": namedAddress("sequencer"),
                     "password": consts.l1passphrase,
                     "pathname": consts.l1keystore,
@@ -268,7 +268,7 @@ function writeConfigs(argv: any) {
         },
         "execution": {
             "sequencer": {
-                "enable": false,
+                "enable": false
             },
             "forwarding-target": "null",
         },
@@ -320,6 +320,13 @@ function writeConfigs(argv: any) {
         sequencerConfig.node["seq-coordinator"].enable = true
         sequencerConfig.execution["sequencer"].enable = true
         sequencerConfig.node["delayed-sequencer"].enable = true
+        if (argv.timeboost) {
+          sequencerConfig.execution.sequencer.dangerous = {};
+          sequencerConfig.execution.sequencer.dangerous.timeboost = {
+             "enable": true,
+             "redis-url": argv.redisUrl
+          };
+        }
         fs.writeFileSync(path.join(consts.configpath, "sequencer_config.json"), JSON.stringify(sequencerConfig))
 
         let posterConfig = JSON.parse(baseConfJSON)
@@ -396,7 +403,7 @@ function writeL2ChainConfig(argv: any) {
             "EnableArbOS": true,
             "AllowDebugPrecompiles": true,
             "DataAvailabilityCommittee": argv.anytrust,
-            "InitialArbOSVersion": 32,
+            "InitialArbOSVersion": 32, // TODO For Timeboost, this still needs to be set to 31
             "InitialChainOwner": argv.l2owner,
             "GenesisBlockNum": 0
         }
@@ -525,14 +532,67 @@ function dasBackendsJsonConfig(argv: any) {
     return backends
 }
 
+export const writeTimeboostConfigsCommand = {
+  command: "write-timeboost-configs",
+  describe: "writes configs for the timeboost autonomous auctioneer and bid validator",
+  builder: {
+    "auction-contract": {
+      string: true,
+      describe: "auction contract address",
+      demandOption: true
+    },
+  },
+  handler: (argv: any) => {
+    writeAutonomousAuctioneerConfig(argv)
+    writeBidValidatorConfig(argv)
+  }
+}
+
+function writeAutonomousAuctioneerConfig(argv: any) {
+  const autonomousAuctioneerConfig = {
+    "auctioneer-server": {
+      "auction-contract-address": argv.auctionContract,
+      "db-directory": "/data",
+      "redis-url": "redis://redis:6379",
+      "use-redis-coordinator": true,
+      "redis-coordinator-url": "redis://redis:6379",
+      "wallet":  {
+        "account": namedAddress("auctioneer"),
+        "password": consts.l1passphrase,
+        "pathname": consts.l1keystore
+      },
+    },
+    "bid-validator": {
+      "enable": false
+    }
+  }
+  const autonomousAuctioneerConfigJSON = JSON.stringify(autonomousAuctioneerConfig)
+  fs.writeFileSync(path.join(consts.configpath, "autonomous_auctioneer_config.json"), autonomousAuctioneerConfigJSON)
+}
+
+function writeBidValidatorConfig(argv: any) {
+  const bidValidatorConfig = {
+    "auctioneer-server": {
+      "enable": false
+    },
+    "bid-validator": {
+      "auction-contract-address": argv.auctionContract,
+      "redis-url": "redis://redis:6379",
+      "sequencer-endpoint": "http://sequencer:8547"
+    }
+  }
+  const bidValidatorConfigJSON = JSON.stringify(bidValidatorConfig)
+  fs.writeFileSync(path.join(consts.configpath, "bid_validator_config.json"), bidValidatorConfigJSON)
+}
+
 export const writeConfigCommand = {
     command: "write-config",
     describe: "writes config files",
     builder: {
         simple: {
-          boolean: true,
-          describe: "simple config (sequencer is also poster, validator)",
-          default: false,
+            boolean: true,
+            describe: "simple config (sequencer is also poster, validator)",
+            default: false,
         },
         anytrust: {
             boolean: true,
@@ -549,8 +609,12 @@ export const writeConfigCommand = {
             describe: "DAS committee member B BLS pub key",
             default: ""
         },
-
-      },
+        timeboost: {
+            boolean: true,
+            describe: "run sequencer in timeboost mode",
+            default: false
+        },
+    },
     handler: (argv: any) => {
         writeConfigs(argv)
     }
@@ -626,8 +690,9 @@ export const writeL2DASKeysetConfigCommand = {
             describe: "DAS committee member B BLS pub key",
             default: ""
         },
-      },
+    },
     handler: (argv: any) => {
-       writeL2DASKeysetConfig(argv)
+        writeL2DASKeysetConfig(argv)
     }
 }
+

scripts/ethcommands.ts

@@ -8,6 +8,8 @@ import * as ERC20 from "@openzeppelin/contracts/build/contracts/ERC20.json";
 import * as TestWETH9 from "@arbitrum/token-bridge-contracts/build/contracts/contracts/tokenbridge/test/TestWETH9.sol/TestWETH9.json";
 import * as fs from "fs";
 import { ARB_OWNER } from "./consts";
+import * as TransparentUpgradeableProxy from "@openzeppelin/contracts/build/contracts/TransparentUpgradeableProxy.json"
+import * as ExpressLaneAuctionContract from "@arbitrum/nitro-contracts/build/contracts/src/express-lane-auction/ExpressLaneAuction.sol/ExpressLaneAuction.json"
 const path = require("path");
 
 async function sendTransaction(argv: any, threadId: number) {
@@ -302,7 +304,8 @@ export const createERC20Command = {
   builder: {
     deployer: {
       string: true,
-      describe: "account (see general help)"
+      describe: "account (see general help)",
+      demandOption: true
     },
     bridgeable: {
       boolean: true,
@@ -382,6 +385,62 @@ export const createERC20Command = {
   },
 };
 
+export const deployExpressLaneAuctionContractCommand = {
+  command: "deploy-express-lane-auction",
+  describe: "Deploy the ExpressLaneAuction contract",
+  builder: {
+    "bidding-token": {
+      string: true,
+      describe: "bidding token address",
+      demandOption: true
+    },
+    "auctioneer": {
+      string: true,
+      describe: "account name to set as auctioneer and admin on contract (default auctioneer)",
+      default: "auctioneer"
+    }
+  },
+  handler: async (argv: any) => {
+    console.log("deploy ExpressLaneAuction contract");
+    argv.provider = new ethers.providers.WebSocketProvider(argv.l2url);
+    const l2OwnerWallet = namedAccount("l2owner").connect(argv.provider)
+    const contractFactory = new ContractFactory(ExpressLaneAuctionContract.abi, ExpressLaneAuctionContract.bytecode, l2OwnerWallet)
+
+    const contract = await contractFactory.deploy();
+    await contract.deployTransaction.wait();
+    console.log("ExpressLaneAuction contract deployed at address:", contract.address);
+
+    const auctioneerAddr = namedAddress(argv.auctioneer)
+    const initIface = new ethers.utils.Interface(["function initialize((address,address,address,(int64,uint64,uint64,uint64),uint256,address,address,address,address,address,address,address))"])
+    const initData = initIface.encodeFunctionData("initialize", [[
+      auctioneerAddr, //_auctioneer
+      argv.biddingToken, //_biddingToken
+      auctioneerAddr, //_beneficiary
+      [
+        Math.round(Date.now() / 60000) * 60,  // offsetTimestamp - most recent minute
+        60, // roundDurationSeconds
+        15, // auctionClosingSeconds
+        15  // reserveSubmissionSeconds
+      ],// RoundTiminginfo
+      1, // _minReservePrice
+      auctioneerAddr, //_auctioneerAdmin
+      auctioneerAddr, //_minReservePriceSetter,
+      auctioneerAddr, //_reservePriceSetter,
+      auctioneerAddr, //_reservePriceSetterAdmin,
+      auctioneerAddr, //_beneficiarySetter,
+      auctioneerAddr, //_roundTimingSetter,
+      auctioneerAddr //_masterAdmin
+    ]]);
+
+    const proxyFactory = new ethers.ContractFactory(TransparentUpgradeableProxy.abi, TransparentUpgradeableProxy.bytecode, l2OwnerWallet)
+    const proxy = await proxyFactory.deploy(contract.address, namedAddress("l2owner"), initData)
+    await proxy.deployed()
+    console.log("Proxy(ExpressLaneAuction) contract deployed at address:", proxy.address);
+
+    argv.provider.destroy();
+  }
+};
+
 // Will revert if the keyset is already valid.
 async function setValidKeyset(argv: any, upgradeExecutorAddr: string, sequencerInboxAddr: string, keyset: string){
     const innerIface = new ethers.utils.Interface(["function setValidKeyset(bytes)"])