Merge pull request #7535 from ethereum-optimism/feat/batch-no-calldata

op-chain-ops: option for skipping calldata encoding

op-chain-ops/safe/batch.go

@@ -6,6 +6,7 @@ package safe
 import (
 	"bytes"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"math/big"
 	"strings"
@@ -19,7 +20,12 @@ import (
 )
 
 // Batch represents a Safe tx-builder transaction.
+// SkipCalldata will skip adding the calldata to the BatchTransaction.
+// This is useful for when using the Safe UI because it prefers using
+// the raw calldata when both the calldata and ABIs with arguments are
+// present.
 type Batch struct {
+	SkipCalldata bool
 	Version      string             `json:"version"`
 	ChainID      *big.Int           `json:"chainId"`
 	CreatedAt    uint64             `json:"createdAt"`
@@ -29,7 +35,10 @@ type Batch struct {
 
 // AddCall will add a call to the batch. After a series of calls are
 // added to the batch, it can be serialized to JSON.
-func (b *Batch) AddCall(to common.Address, value *big.Int, sig string, args []any, iface abi.ABI) error {
+func (b *Batch) AddCall(to common.Address, value *big.Int, sig string, args []any, iface *abi.ABI) error {
+	if iface == nil {
+		return errors.New("abi cannot be nil")
+	}
 	// Attempt to pull out the signature from the top level methods.
 	// The abi package uses normalization that we do not want to be
 	// coupled to, so attempt to search for the raw name if the top
@@ -87,10 +96,13 @@ func (b *Batch) AddCall(to common.Address, value *big.Int, sig string, args []an
 		To:          to,
 		Value:       value,
 		Method:      contractMethod,
-		Data:        data,
 		InputValues: inputValues,
 	}
 
+	if !b.SkipCalldata {
+		batchTransaction.Data = data
+	}
+
 	b.Transactions = append(b.Transactions, batchTransaction)
 
 	return nil

op-chain-ops/safe/batch_test.go

@@ -58,7 +58,7 @@ func TestBatchAddCallFinalizeWithdrawalTransaction(t *testing.T) {
 	to := common.Address{19: 0x01}
 	value := big.NewInt(222)
 
-	require.NoError(t, batch.AddCall(to, value, sig, argument, portalABI))
+	require.NoError(t, batch.AddCall(to, value, sig, argument, &portalABI))
 	require.NoError(t, batch.Check())
 	require.Equal(t, batch.Transactions[0].Signature(), "finalizeWithdrawalTransaction((uint256,address,address,uint256,uint256,bytes))")
 
@@ -89,7 +89,7 @@ func TestBatchAddCallDespositTransaction(t *testing.T) {
 		[]byte{},
 	}
 
-	require.NoError(t, batch.AddCall(to, value, sig, argument, portalABI))
+	require.NoError(t, batch.AddCall(to, value, sig, argument, &portalABI))
 	require.NoError(t, batch.Check())
 	require.Equal(t, batch.Transactions[0].Signature(), "depositTransaction(address,uint256,uint64,bool,bytes)")
 

op-chain-ops/upgrades/l1.go

@@ -63,6 +63,7 @@ func L1CrossDomainMessenger(batch *safe.Batch, implementations superchain.Implem
 	if err != nil {
 		return err
 	}
+	calldata = append(initialize.ID, calldata...)
 
 	args := []any{
 		common.HexToAddress(list.L1CrossDomainMessengerProxy.String()),
@@ -72,7 +73,7 @@ func L1CrossDomainMessenger(batch *safe.Batch, implementations superchain.Implem
 
 	proxyAdmin := common.HexToAddress(list.ProxyAdmin.String())
 	sig := "upgradeAndCall(address,address,bytes)"
-	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, *proxyAdminABI); err != nil {
+	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, proxyAdminABI); err != nil {
 		return err
 	}
 
@@ -102,6 +103,7 @@ func L1ERC721Bridge(batch *safe.Batch, implementations superchain.Implementation
 	if err != nil {
 		return err
 	}
+	calldata = append(initialize.ID, calldata...)
 
 	args := []any{
 		common.HexToAddress(list.L1ERC721BridgeProxy.String()),
@@ -111,7 +113,7 @@ func L1ERC721Bridge(batch *safe.Batch, implementations superchain.Implementation
 
 	proxyAdmin := common.HexToAddress(list.ProxyAdmin.String())
 	sig := "upgradeAndCall(address,address,bytes)"
-	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, *proxyAdminABI); err != nil {
+	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, proxyAdminABI); err != nil {
 		return err
 	}
 
@@ -141,6 +143,7 @@ func L1StandardBridge(batch *safe.Batch, implementations superchain.Implementati
 	if err != nil {
 		return err
 	}
+	calldata = append(initialize.ID, calldata...)
 
 	args := []any{
 		common.HexToAddress(list.L1StandardBridgeProxy.String()),
@@ -150,7 +153,7 @@ func L1StandardBridge(batch *safe.Batch, implementations superchain.Implementati
 
 	proxyAdmin := common.HexToAddress(list.ProxyAdmin.String())
 	sig := "upgradeAndCall(address,address,bytes)"
-	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, *proxyAdminABI); err != nil {
+	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, proxyAdminABI); err != nil {
 		return err
 	}
 
@@ -219,6 +222,7 @@ func L2OutputOracle(batch *safe.Batch, implementations superchain.Implementation
 	if err != nil {
 		return err
 	}
+	calldata = append(initialize.ID, calldata...)
 
 	args := []any{
 		common.HexToAddress(list.L2OutputOracleProxy.String()),
@@ -228,7 +232,7 @@ func L2OutputOracle(batch *safe.Batch, implementations superchain.Implementation
 
 	proxyAdmin := common.HexToAddress(list.ProxyAdmin.String())
 	sig := "upgradeAndCall(address,address,bytes)"
-	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, *proxyAdminABI); err != nil {
+	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, proxyAdminABI); err != nil {
 		return err
 	}
 
@@ -258,6 +262,7 @@ func OptimismMintableERC20Factory(batch *safe.Batch, implementations superchain.
 	if err != nil {
 		return err
 	}
+	calldata = append(initialize.ID, calldata...)
 
 	args := []any{
 		common.HexToAddress(list.OptimismMintableERC20FactoryProxy.String()),
@@ -267,7 +272,7 @@ func OptimismMintableERC20Factory(batch *safe.Batch, implementations superchain.
 
 	proxyAdmin := common.HexToAddress(list.ProxyAdmin.String())
 	sig := "upgradeAndCall(address,address,bytes)"
-	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, *proxyAdminABI); err != nil {
+	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, proxyAdminABI); err != nil {
 		return err
 	}
 
@@ -315,6 +320,7 @@ func OptimismPortal(batch *safe.Batch, implementations superchain.Implementation
 	if err != nil {
 		return err
 	}
+	calldata = append(initialize.ID, calldata...)
 
 	args := []any{
 		common.HexToAddress(list.OptimismPortalProxy.String()),
@@ -324,7 +330,7 @@ func OptimismPortal(batch *safe.Batch, implementations superchain.Implementation
 
 	proxyAdmin := common.HexToAddress(list.ProxyAdmin.String())
 	sig := "upgradeAndCall(address,address,bytes)"
-	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, *proxyAdminABI); err != nil {
+	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, proxyAdminABI); err != nil {
 		return err
 	}
 
@@ -434,6 +440,7 @@ func SystemConfig(batch *safe.Batch, implementations superchain.ImplementationLi
 	if err != nil {
 		return err
 	}
+	calldata = append(initialize.ID, calldata...)
 
 	args := []any{
 		common.HexToAddress(chainConfig.SystemConfigAddr.String()),
@@ -443,7 +450,7 @@ func SystemConfig(batch *safe.Batch, implementations superchain.ImplementationLi
 
 	proxyAdmin := common.HexToAddress(list.ProxyAdmin.String())
 	sig := "upgradeAndCall(address,address,bytes)"
-	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, *proxyAdminABI); err != nil {
+	if err := batch.AddCall(proxyAdmin, common.Big0, sig, args, proxyAdminABI); err != nil {
 		return err
 	}