Timeboost mode for nitro-testnode #95

Tristan-Wilson · 2024-10-21T13:43:41Z

This PR adds support for timeboost mode on nitro-testnode. It starts the bid-validator, autonomous auctioneer, deploys the ExpressLaneAuction contract, and starts the sequencer in Timeboost mode.

Since Timeboost is not yet merged into the main nitro or contracts branches, currently you will need to follow the following steps to run nitro-testnode in Timeboost mode. (This will improve once things are merged in.)

checkout nitro, branch: express-lane-timeboost
In the nitro dir, go into the contracts submodule and check out express-lane-auction
- run yarn build:all inside this directory
In the nitro dir, go into the nitro-testnode submodule and check out timeboost-mode
- From this directory, run DEFAULT_NITRO_CONTRACTS_VERSION=bec7d629c5f4a9dc4ec786e9d6e99734a11d109b ./test-node.bash --init-force --dev --dev-contracts --l2-timeboost

When starting up, look for the line printing the token and contract address:

== Bidding token: $biddingTokenAddress, auction contract $auctionContractAddress

You can also find the auction contract and auctioneer address with the following command.

$ docker compose run --entrypoint sh sequencer -c "cat /config/sequencer_config.json" | jq .execution.sequencer
 ✔ Container nitro-testnode-geth-1  Running0.0s 
{
  "enable": true,
  "timeboost": {
    "enable": true,
    "auction-contract-address": "0x7DD3F2a3fAeF3B9F2364c335163244D3388Feb83",
    "auctioneer-address": "0x46225F4cee2b4A1d506C7f894bb3dAeB21BF1596"
  }
}

Users alice and bob have been pre-funded with some of the bidding token on L2 and can be used right away.

$ docker compose run scripts print-private-key --account user_alice
...
$ docker compose run scripts print-private-key --account user_bob
...

# make a deposit into the ExpressLaneAuction contract
$ docker compose run  --entrypoint /usr/local/bin/bidder-client timeboost-bid-validator --auction-contract-address 0x... --deposit-gwei 1000000000  --wallet.private-key <alice or bob private key, no 0x> --arbitrum-node-endpoint http://sequencer:8547

# make a bid for control of the next express lane round
$ docker compose run  --entrypoint /usr/local/bin/bidder-client timeboost-bid-validator --auction-contract-address 0x... --bid-gwei 1 --wallet.private-key <alice or bob private key, no 0x> --arbitrum-node-endpoint http://sequencer:8547 --bid-validator-endpoint http://timeboost-bid-validator:8547

Commands for sending express lane transactions will be provided in future, see implementation and spec .

This adds a command for deploying the ExpressLaneAuction contract: docker compose run scripts deploy-express-lane-auction Since the contracts branch with ExpressLaneAuction is not published to NPM this commit adds a way for it to be included from the local workspace into the scripts docker image with the --dev-contracts flag. The bash and docker logic here needs to be cleaned up so that it will use the NPM version when not using the --dev-contracts flag. The commit includes WIP code for initializing the contract.

Open ports and set up auth endpoint correctly on sequencer. Deploy auction contract with l2owner instead of auctioneer accounts (admin account on proxy contract cannot make calls on the proxied-to contract).

The default value in nitro should work.

Tristan-Wilson · 2024-10-22T15:05:00Z

Changed the recommended nitro branch to express-lane-timeboost for now since it will get fixes.

Even if using an nitro image that doesn't have timeboost enabled yet, nitro will still start after logging an error message. Unavailable modules in HTTP API list unavailable=[timeboost] available="[admin debug web3 eth txpool personal net arb arbdebug arbtrace]"

ReserveSubmissionSeconds represents a period BEFORE the auction closes that the reserve price may be updated for the next round. The previous setting of 45 seconds means that the reserve price could not be updated at all after the round started, coupled with the auction closing period of 15 seconds (round duration is 60 seconds).

Tristan-Wilson · 2024-11-21T21:15:16Z

Instructions updated for latest nitro express-lane-timeboost branch.

gzeoneth · 2024-11-26T07:57:40Z

test-node.bash

@@ -6,7 +6,7 @@ NITRO_NODE_VERSION=offchainlabs/nitro-node:v3.2.1-d81324d-dev
 BLOCKSCOUT_VERSION=offchainlabs/blockscout:v1.1.0-0e716c8

 # This commit matches v2.1.0 release of nitro-contracts, with additional support to set arb owner through upgrade executor
-DEFAULT_NITRO_CONTRACTS_VERSION="99c07a7db2fcce75b751c5a2bd4936e898cda065"
+DEFAULT_NITRO_CONTRACTS_VERSION="bec7d629c5f4a9dc4ec786e9d6e99734a11d109b"


you can use this release with timeboost contracts now

Suggested change

DEFAULT_NITRO_CONTRACTS_VERSION="bec7d629c5f4a9dc4ec786e9d6e99734a11d109b"

DEFAULT_NITRO_CONTRACTS_VERSION="v2.1.1"

gzeoneth · 2024-11-26T08:00:08Z

scripts/package.json

@@ -6,6 +6,7 @@
  "author": "Offchain Labs, Inc.",
  "license": "Apache-2.0",
  "dependencies": {
+    "@arbitrum/nitro-contracts": "^2.1.0",


This version would have the timeboost contracts and you don't need to do the dev-contract hack

Suggested change

"@arbitrum/nitro-contracts": "^2.1.0",

"@arbitrum/nitro-contracts": "^2.1.1",

Tristan-Wilson added 9 commits October 10, 2024 12:16

Initial cut of timeboost app and account config

f56756d

Initiailize Auction contract via proxy

e04b9f2

--l2-timeboost mode, write auctioneer and val conf

41905df

Start auctioneer + bid validator, set up usr accts

2bf4141

Bounce sequencer w changed conf to start timeboost

b5d2b03

Fixes to get timeboost working e2e

2723090

Open ports and set up auth endpoint correctly on sequencer. Deploy auction contract with l2owner instead of auctioneer accounts (admin account on proxy contract cannot make calls on the proxied-to contract).

Non-dev contracts workaround

53c2236

Set default contracts back to version on master

e3c0ac9

Tristan-Wilson requested review from gvladika, tsahee and gzeoneth October 21, 2024 13:43

cla-bot bot added the s label Oct 21, 2024

Tristan-Wilson added 3 commits October 21, 2024 15:45

Note about writeL2ChainConfig timeboost arbos vers

690c96e

Make inclusion of auction contract optional

57e2925

Remove setting sequencer-http-endpoint in yaml

9214877

The default value in nitro should work.

Tristan-Wilson marked this pull request as ready for review October 21, 2024 15:19

Tristan-Wilson added 2 commits October 22, 2024 12:25

Fix scripts dockerfile contracts existence check

a4dedcb

Fix timeboost seq conf, initally must be false

bad7cdc

Tristan-Wilson mentioned this pull request Oct 30, 2024

Fix timeboost auction resolution queue handling OffchainLabs/nitro#2764

Merged

Fix vhosts for timeboost-bid-validator

3580743

Tristan-Wilson requested review from ganeshvanahalli and diegoximenes November 13, 2024 13:39

Set correct contracts version, new init iface

78a369a

gzeoneth reviewed Nov 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Timeboost mode for nitro-testnode #95

Timeboost mode for nitro-testnode #95

Tristan-Wilson commented Oct 21, 2024 •

edited

Loading

Tristan-Wilson commented Oct 22, 2024

Tristan-Wilson commented Nov 21, 2024

gzeoneth Nov 26, 2024

gzeoneth Nov 26, 2024

	DEFAULT_NITRO_CONTRACTS_VERSION="bec7d629c5f4a9dc4ec786e9d6e99734a11d109b"
	DEFAULT_NITRO_CONTRACTS_VERSION="v2.1.1"

	"@arbitrum/nitro-contracts": "^2.1.0",
	"@arbitrum/nitro-contracts": "^2.1.1",

Timeboost mode for nitro-testnode #95

Are you sure you want to change the base?

Timeboost mode for nitro-testnode #95

Conversation

Tristan-Wilson commented Oct 21, 2024 • edited Loading

Tristan-Wilson commented Oct 22, 2024

Tristan-Wilson commented Nov 21, 2024

gzeoneth Nov 26, 2024

Choose a reason for hiding this comment

gzeoneth Nov 26, 2024

Choose a reason for hiding this comment

Tristan-Wilson commented Oct 21, 2024 •

edited

Loading