Add support for deploying erc20-based rollup

.gitmodules

@@ -13,7 +13,7 @@
 [submodule "contracts"]
 	path = contracts
 	url = https://github.com/OffchainLabs/nitro-contracts.git
-	branch = develop
+	branch = feature-orbit-bridge
 [submodule "blockscout"]
 	path = blockscout
         url = https://github.com/OffchainLabs/blockscout.git

arbnode/node.go

@@ -103,6 +103,19 @@ func deployBridgeCreator(ctx context.Context, l1Reader *headerreader.HeaderReade
 	return bridgeCreatorAddr, nil
 }
 
+func deployERC20BridgeCreator(ctx context.Context, l1Reader *headerreader.HeaderReader, auth *bind.TransactOpts) (common.Address, error) {
+	client := l1Reader.Client()
+
+	bridgeCreatorAddr, tx, _, err := rollupgen.DeployERC20BridgeCreator(auth, client)
+
+	err = andTxSucceeded(ctx, l1Reader, tx, err)
+	if err != nil {
+		return common.Address{}, fmt.Errorf("erc20 bridge creator deploy error: %w", err)
+	}
+
+	return bridgeCreatorAddr, nil
+}
+
 func deployChallengeFactory(ctx context.Context, l1Reader *headerreader.HeaderReader, auth *bind.TransactOpts) (common.Address, common.Address, error) {
 	client := l1Reader.Client()
 	osp0, tx, _, err := ospgen.DeployOneStepProver0(auth, client)
@@ -144,45 +157,85 @@ func deployChallengeFactory(ctx context.Context, l1Reader *headerreader.HeaderRe
 	return ospEntryAddr, challengeManagerAddr, nil
 }
 
-func deployRollupCreator(ctx context.Context, l1Reader *headerreader.HeaderReader, auth *bind.TransactOpts) (*rollupgen.RollupCreator, common.Address, common.Address, common.Address, error) {
-	bridgeCreator, err := deployBridgeCreator(ctx, l1Reader, auth)
-	if err != nil {
-		return nil, common.Address{}, common.Address{}, common.Address{}, err
-	}
-
+func deployRollupDependencies(ctx context.Context, l1Reader *headerreader.HeaderReader, auth *bind.TransactOpts) (common.Address, common.Address, common.Address, common.Address, common.Address, common.Address, error) {
 	ospEntryAddr, challengeManagerAddr, err := deployChallengeFactory(ctx, l1Reader, auth)
 	if err != nil {
-		return nil, common.Address{}, common.Address{}, common.Address{}, err
+		return common.Address{}, common.Address{}, common.Address{}, common.Address{}, common.Address{}, common.Address{}, err
 	}
 
 	rollupAdminLogic, tx, _, err := rollupgen.DeployRollupAdminLogic(auth, l1Reader.Client())
 	err = andTxSucceeded(ctx, l1Reader, tx, err)
 	if err != nil {
-		return nil, common.Address{}, common.Address{}, common.Address{}, fmt.Errorf("rollup admin logic deploy error: %w", err)
+		return common.Address{}, common.Address{}, common.Address{}, common.Address{}, common.Address{}, common.Address{}, fmt.Errorf("rollup admin logic deploy error: %w", err)
 	}
 
 	rollupUserLogic, tx, _, err := rollupgen.DeployRollupUserLogic(auth, l1Reader.Client())
 	err = andTxSucceeded(ctx, l1Reader, tx, err)
 	if err != nil {
-		return nil, common.Address{}, common.Address{}, common.Address{}, fmt.Errorf("rollup user logic deploy error: %w", err)
+		return common.Address{}, common.Address{}, common.Address{}, common.Address{}, common.Address{}, common.Address{}, fmt.Errorf("rollup user logic deploy error: %w", err)
+	}
+
+	validatorUtils, tx, _, err := rollupgen.DeployValidatorUtils(auth, l1Reader.Client())
+	err = andTxSucceeded(ctx, l1Reader, tx, err)
+	if err != nil {
+		return common.Address{}, common.Address{}, common.Address{}, common.Address{}, common.Address{}, common.Address{}, fmt.Errorf("validator utils deploy error: %w", err)
+	}
+
+	validatorWalletCreator, tx, _, err := rollupgen.DeployValidatorWalletCreator(auth, l1Reader.Client())
+	err = andTxSucceeded(ctx, l1Reader, tx, err)
+	if err != nil {
+		return common.Address{}, common.Address{}, common.Address{}, common.Address{}, common.Address{}, common.Address{}, fmt.Errorf("validator wallet creator deploy error: %w", err)
 	}
 
+	return ospEntryAddr, challengeManagerAddr, rollupAdminLogic, rollupUserLogic, validatorUtils, validatorWalletCreator, nil
+}
+
+func deployRollupCreator(ctx context.Context, l1Reader *headerreader.HeaderReader, auth *bind.TransactOpts) (*rollupgen.RollupCreator, common.Address, common.Address, common.Address, error) {
+	ospEntryAddr, challengeManagerAddr, rollupAdminLogic, rollupUserLogic, validatorUtils, validatorWalletCreator, err := deployRollupDependencies(ctx, l1Reader, auth)
+	if err != nil {
+		return nil, common.Address{}, common.Address{}, common.Address{}, err
+	}
+	bridgeCreator, err := deployBridgeCreator(ctx, l1Reader, auth)
+	if err != nil {
+		return nil, common.Address{}, common.Address{}, common.Address{}, err
+	}
 	rollupCreatorAddress, tx, rollupCreator, err := rollupgen.DeployRollupCreator(auth, l1Reader.Client())
 	err = andTxSucceeded(ctx, l1Reader, tx, err)
 	if err != nil {
 		return nil, common.Address{}, common.Address{}, common.Address{}, fmt.Errorf("rollup creator deploy error: %w", err)
 	}
 
-	validatorUtils, tx, _, err := rollupgen.DeployValidatorUtils(auth, l1Reader.Client())
+	tx, err = rollupCreator.SetTemplates(
+		auth,
+		bridgeCreator,
+		ospEntryAddr,
+		challengeManagerAddr,
+		rollupAdminLogic,
+		rollupUserLogic,
+		validatorUtils,
+		validatorWalletCreator,
+	)
 	err = andTxSucceeded(ctx, l1Reader, tx, err)
 	if err != nil {
-		return nil, common.Address{}, common.Address{}, common.Address{}, fmt.Errorf("validator utils deploy error: %w", err)
+		return nil, common.Address{}, common.Address{}, common.Address{}, fmt.Errorf("rollup set template error: %w", err)
 	}
 
-	validatorWalletCreator, tx, _, err := rollupgen.DeployValidatorWalletCreator(auth, l1Reader.Client())
+	return rollupCreator, rollupCreatorAddress, validatorUtils, validatorWalletCreator, nil
+}
+
+func deployERC20RollupCreator(ctx context.Context, l1Reader *headerreader.HeaderReader, auth *bind.TransactOpts, nativeERC20Token common.Address) (*rollupgen.ERC20RollupCreator, common.Address, common.Address, common.Address, error) {
+	ospEntryAddr, challengeManagerAddr, rollupAdminLogic, rollupUserLogic, validatorUtils, validatorWalletCreator, err := deployRollupDependencies(ctx, l1Reader, auth)
+	if err != nil {
+		return nil, common.Address{}, common.Address{}, common.Address{}, err
+	}
+	bridgeCreator, err := deployERC20BridgeCreator(ctx, l1Reader, auth)
+	if err != nil {
+		return nil, common.Address{}, common.Address{}, common.Address{}, err
+	}
+	rollupCreatorAddress, tx, rollupCreator, err := rollupgen.DeployERC20RollupCreator(auth, l1Reader.Client())
 	err = andTxSucceeded(ctx, l1Reader, tx, err)
 	if err != nil {
-		return nil, common.Address{}, common.Address{}, common.Address{}, fmt.Errorf("validator wallet creator deploy error: %w", err)
+		return nil, common.Address{}, common.Address{}, common.Address{}, fmt.Errorf("rollup creator deploy error: %w", err)
 	}
 
 	tx, err = rollupCreator.SetTemplates(
@@ -230,7 +283,7 @@ func GenerateRollupConfig(prod bool, wasmModuleRoot common.Hash, rollupOwner com
 	}
 }
 
-func DeployOnL1(ctx context.Context, l1client arbutil.L1Interface, deployAuth *bind.TransactOpts, sequencer common.Address, authorizeValidators uint64, readerConfig headerreader.ConfigFetcher, config rollupgen.Config) (*chaininfo.RollupAddresses, error) {
+func DeployOnL1(ctx context.Context, l1client arbutil.L1Interface, deployAuth *bind.TransactOpts, sequencer common.Address, authorizeValidators uint64, readerConfig headerreader.ConfigFetcher, config rollupgen.Config, nativeERC20Token common.Address) (*chaininfo.RollupAddresses, error) {
 	l1Reader, err := headerreader.New(ctx, l1client, readerConfig)
 	if err != nil {
 		return nil, err
@@ -242,28 +295,70 @@ func DeployOnL1(ctx context.Context, l1client arbutil.L1Interface, deployAuth *b
 		return nil, errors.New("no machine specified")
 	}
 
-	rollupCreator, _, validatorUtils, validatorWalletCreator, err := deployRollupCreator(ctx, l1Reader, deployAuth)
-	if err != nil {
-		return nil, fmt.Errorf("error deploying rollup creator: %w", err)
-	}
+	var validatorUtils, validatorWalletCreator, bridgeAddr, inboxAddr, sequencerInboxAddr, rollupAddr common.Address
+	var tx *types.Transaction
+	var deployedAt uint64
 
-	tx, err := rollupCreator.CreateRollup(
-		deployAuth,
-		config,
-	)
-	if err != nil {
-		return nil, fmt.Errorf("error submitting create rollup tx: %w", err)
-	}
-	receipt, err := l1Reader.WaitForTxApproval(ctx, tx)
-	if err != nil {
-		return nil, fmt.Errorf("error executing create rollup tx: %w", err)
-	}
-	info, err := rollupCreator.ParseRollupCreated(*receipt.Logs[len(receipt.Logs)-1])
-	if err != nil {
-		return nil, fmt.Errorf("error parsing rollup created log: %w", err)
+	if nativeERC20Token == (common.Address{}) {
+		/// deploy standard Eth rollup
+		rollupCreator, _, _validatorUtils, _validatorWalletCreator, err := deployRollupCreator(ctx, l1Reader, deployAuth)
+		if err != nil {
+			return nil, fmt.Errorf("error deploying rollup creator: %w", err)
+		}
+		validatorUtils, validatorWalletCreator = _validatorUtils, _validatorWalletCreator
+
+		tx, err := rollupCreator.CreateRollup(
+			deployAuth,
+			config,
+		)
+		if err != nil {
+			return nil, fmt.Errorf("error submitting create rollup tx: %w", err)
+		}
+
+		receipt, err := l1Reader.WaitForTxApproval(ctx, tx)
+		if err != nil {
+			return nil, fmt.Errorf("error executing create rollup tx: %w", err)
+		}
+		deployedAt = receipt.BlockNumber.Uint64()
+
+		info, err := rollupCreator.ParseRollupCreated(*receipt.Logs[len(receipt.Logs)-1])
+		if err != nil {
+			return nil, fmt.Errorf("error parsing rollup created log: %w", err)
+		}
+
+		bridgeAddr, inboxAddr, sequencerInboxAddr, rollupAddr = info.Bridge, info.InboxAddress, info.SequencerInbox, info.RollupAddress
+	} else {
+		/// deploy ERC20 rollup
+		rollupCreator, _, _validatorUtils, _validatorWalletCreator, err := deployERC20RollupCreator(ctx, l1Reader, deployAuth, nativeERC20Token)
+		if err != nil {
+			return nil, fmt.Errorf("error deploying rollup creator: %w", err)
+		}
+		validatorUtils, validatorWalletCreator = _validatorUtils, _validatorWalletCreator
+
+		tx, err := rollupCreator.CreateRollup(
+			deployAuth,
+			config,
+			nativeERC20Token,
+		)
+		if err != nil {
+			return nil, fmt.Errorf("error submitting create erc20 rollup tx: %w", err)
+		}
+
+		receipt, err := l1Reader.WaitForTxApproval(ctx, tx)
+		if err != nil {
+			return nil, fmt.Errorf("error executing create rollup tx: %w", err)
+		}
+		deployedAt = receipt.BlockNumber.Uint64()
+
+		info, err := rollupCreator.ParseRollupCreated(*receipt.Logs[len(receipt.Logs)-1])
+		if err != nil {
+			return nil, fmt.Errorf("error parsing rollup created log: %w", err)
+		}
+
+		bridgeAddr, inboxAddr, sequencerInboxAddr, rollupAddr = info.Bridge, info.InboxAddress, info.SequencerInbox, info.RollupAddress
 	}
 
-	sequencerInbox, err := bridgegen.NewSequencerInbox(info.SequencerInbox, l1client)
+	sequencerInbox, err := bridgegen.NewSequencerInbox(sequencerInboxAddr, l1client)
 	if err != nil {
 		return nil, fmt.Errorf("error getting sequencer inbox: %w", err)
 	}
@@ -284,7 +379,7 @@ func DeployOnL1(ctx context.Context, l1client arbutil.L1Interface, deployAuth *b
 		allowValidators = append(allowValidators, true)
 	}
 	if len(validatorAddrs) > 0 {
-		rollup, err := rollupgen.NewRollupAdminLogic(info.RollupAddress, l1client)
+		rollup, err := rollupgen.NewRollupAdminLogic(rollupAddr, l1client)
 		if err != nil {
 			return nil, fmt.Errorf("error getting rollup admin: %w", err)
 		}
@@ -296,13 +391,14 @@ func DeployOnL1(ctx context.Context, l1client arbutil.L1Interface, deployAuth *b
 	}
 
 	return &chaininfo.RollupAddresses{
-		Bridge:                 info.Bridge,
-		Inbox:                  info.InboxAddress,
-		SequencerInbox:         info.SequencerInbox,
-		DeployedAt:             receipt.BlockNumber.Uint64(),
-		Rollup:                 info.RollupAddress,
+		Bridge:                 bridgeAddr,
+		Inbox:                  inboxAddr,
+		SequencerInbox:         sequencerInboxAddr,
+		DeployedAt:             deployedAt,
+		Rollup:                 rollupAddr,
 		ValidatorUtils:         validatorUtils,
 		ValidatorWalletCreator: validatorWalletCreator,
+		NativeERC20Token:       nativeERC20Token,
 	}, nil
 }
 

cmd/chaininfo/chain_info.go

@@ -106,6 +106,7 @@ type RollupAddresses struct {
 	Inbox                  common.Address `json:"inbox"`
 	SequencerInbox         common.Address `json:"sequencer-inbox"`
 	Rollup                 common.Address `json:"rollup"`
+	NativeERC20Token       common.Address `json:"native-erc20-token"`
 	ValidatorUtils         common.Address `json:"validator-utils"`
 	ValidatorWalletCreator common.Address `json:"validator-wallet-creator"`
 	DeployedAt             uint64         `json:"deployed-at"`

cmd/deploy/deploy.go

@@ -38,6 +38,7 @@ func main() {
 	deployAccount := flag.String("l1DeployAccount", "", "l1 seq account to use (default is first account in keystore)")
 	ownerAddressString := flag.String("ownerAddress", "", "the rollup owner's address")
 	sequencerAddressString := flag.String("sequencerAddress", "", "the sequencer's address")
+	nativeERC20TokenAddressString := flag.String("nativeERC20TokenAddress", "", "address of ERC20 token which is used as native L2 currency")
 	loserEscrowAddressString := flag.String("loserEscrowAddress", "", "the address which half of challenge loser's funds accumulate at")
 	wasmmoduleroot := flag.String("wasmmoduleroot", "", "WASM module root hash")
 	wasmrootpath := flag.String("wasmrootpath", "", "path to machine folders")
@@ -125,6 +126,7 @@ func main() {
 		panic(fmt.Errorf("failed to deserialize chain config: %w", err))
 	}
 
+	nativeERC20Token := common.HexToAddress(*nativeERC20TokenAddressString)
 	deployedAddresses, err := arbnode.DeployOnL1(
 		ctx,
 		l1client,
@@ -133,6 +135,7 @@ func main() {
 		*authorizevalidators,
 		func() *headerreader.Config { return &headerReaderConfig },
 		arbnode.GenerateRollupConfig(*prod, moduleRoot, ownerAddress, &chainConfig, chainConfigJson, loserEscrowAddress),
+		nativeERC20Token,
 	)
 	if err != nil {
 		flag.Usage()

system_tests/common_test.go

@@ -473,6 +473,7 @@ func DeployOnTestL1(
 		0,
 		func() *headerreader.Config { return &headerreader.TestConfig },
 		arbnode.GenerateRollupConfig(false, locator.LatestWasmModuleRoot(), l1info.GetAddress("RollupOwner"), chainConfig, serializedChainConfig, common.Address{}),
+		common.Address{},
 	)
 	Require(t, err)
 	l1info.SetContract("Bridge", addresses.Bridge)

test-node.bash

@@ -39,6 +39,7 @@ consensusclient=false
 redundantsequencers=0
 dev_build_nitro=false
 dev_build_blockscout=false
+erc20rollup=false
 batchposters=1
 devprivkey=b6b15c8cb491557369f3c7d2c287b053eb229daa9c22138887752191c9520659
 l1chainid=1337
@@ -98,6 +99,10 @@ while [[ $# -gt 0 ]]; do
             detach=true
             shift
             ;;
+        --erc20-rollup)
+            erc20rollup=true
+            shift
+            ;;
         --batchposters)
             batchposters=$2
             if ! [[ $batchposters =~ [0-3] ]] ; then
@@ -131,6 +136,7 @@ while [[ $# -gt 0 ]]; do
             echo --init:            remove all data, rebuild, deploy new rollup
             echo --pos:             l1 is a proof-of-stake chain \(using prysm for consensus\)
             echo --validate:        heavy computation, validating all blocks in WASM
+            echo --erc20rollup:     deploys rollup in erc20 mode where token is used as L2 native currency
             echo --batchposters:    batch posters [0-3]
             echo --redundantsequencers redundant sequencers [0-3]
             echo --detach:          detach from nodes after running them
@@ -284,11 +290,18 @@ if $force_init; then
     echo == Writing l2 chain config
     docker-compose run testnode-scripts write-l2-chain-config
 
-    echo == Deploying L2
     sequenceraddress=`docker-compose run testnode-scripts print-address --account sequencer | tail -n 1 | tr -d '\r\n'`
+    deployL2Command="docker-compose run --entrypoint /usr/local/bin/deploy poster --l1conn ws://geth:8546 --l1keystore /home/user/l1keystore --sequencerAddress $sequenceraddress --ownerAddress $sequenceraddress --l1DeployAccount $sequenceraddress --l1deployment /config/deployment.json --authorizevalidators 10 --wasmrootpath /home/user/target/machines --l1chainid=$l1chainid --l2chainconfig /config/l2_chain_config.json --l2chainname arb-dev-test --l2chaininfo /config/deployed_chain_info.json"
+    if $erc20rollup; then
+        echo == Deploying token
+        nativeTokenAddress=`docker-compose run testnode-scripts create-erc20 --deployerKey $devprivkey --mintTo user_l1user | tail -n 1 | awk '{ print $NF }'`
+        deployL2Command+=" --nativeERC20TokenAddress $nativeTokenAddress"
+    fi
 
-    docker-compose run --entrypoint /usr/local/bin/deploy poster --l1conn ws://geth:8546 --l1keystore /home/user/l1keystore --sequencerAddress $sequenceraddress --ownerAddress $sequenceraddress --l1DeployAccount $sequenceraddress --l1deployment /config/deployment.json --authorizevalidators 10 --wasmrootpath /home/user/target/machines --l1chainid=$l1chainid --l2chainconfig /config/l2_chain_config.json --l2chainname arb-dev-test --l2chaininfo /config/deployed_chain_info.json
+    echo == Deploying L2
+    eval $deployL2Command
     docker-compose run --entrypoint sh poster -c "jq [.[]] /config/deployed_chain_info.json > /config/l2_chain_info.json"
+
     echo == Writing configs
     docker-compose run testnode-scripts write-config
 
@@ -297,7 +310,9 @@ if $force_init; then
 
     echo == Funding l2 funnel
     docker-compose up -d $INITIAL_SEQ_NODES
-    docker-compose run testnode-scripts bridge-funds --ethamount 100000 --wait
+    if ! $erc20rollup; then
+        docker-compose run testnode-scripts bridge-funds --ethamount 100000 --wait
+    fi
 
     if $tokenbridge; then
         echo == Deploying token bridge