Add consistency check for standard versions (#768)

* add standard-version-consistency_test.go

* lint

* enhance consistency check to cover bytecode hashes

* pass tag down to getters

* update test

* update MIPS standard bytecodes and immutables

* validation: refactor TestStandardVersionConsistency

* validation: rename NetworkVersions to ContractVersions

* validation: rename func GetVersion to GetContractVersion

* validation: simplify struct in standard-versions-*.toml files

* validation: remove unused VersionTags struct

* just: remove -count=1 flag

* validation: add L1ContractBytecodeHashes unit tests

* update rc tags

---------

Co-authored-by: Samuel Stokes <[email protected]>

Author: geoknee

superchain/superchain.go

@@ -411,28 +411,30 @@ func (c ContractVersions) GetNonEmpty() []string {
 // VersionFor returns the version for the supplied contract name, if it exits
 // (and an error otherwise). Useful for slicing into the struct using a string.
 func (c ContractVersions) VersionFor(contractName string) (string, error) {
+	vc, err := c.VersionedContractFor(contractName)
+	if err != nil {
+		return "", err
+	}
+
+	if vc.Version == "" {
+		return "", ErrEmptyVersion
+	}
+	return vc.Version, nil
+}
+
+// VersionFor returns the version for the supplied contract name, if it exits
+// (and an error otherwise). Useful for slicing into the struct using a string.
+func (c ContractVersions) VersionedContractFor(contractName string) (VersionedContract, error) {
 	// Use reflection to get the value of the struct
 	val := reflect.ValueOf(c)
 	// Get the field by name (contractName)
 	field := val.FieldByName(contractName)
 
 	// Check if the field exists and is a struct
 	if !field.IsValid() {
-		return "", errors.New("no such contract name")
-	}
-
-	// Check if the struct contains the "Version" field
-	versionField := field.FieldByName("Version")
-	if !versionField.IsValid() || versionField.String() == "" {
-		return "", errors.New("no version specified")
+		return VersionedContract{}, errors.New("no such contract name")
 	}
-
-	// Return the version if it's a string
-	if versionField.Kind() == reflect.String {
-		return versionField.String(), nil
-	}
-
-	return "", errors.New("version is not a string")
+	return field.Interface().(VersionedContract), nil
 }
 
 // Check will sanity check the validity of the semantic version strings

validation/standard/init.go

@@ -28,12 +28,9 @@ func init() {
 		Config.Params[network] = new(Params)
 		decodeTOMLFileIntoConfig("standard-config-params-"+network+".toml", Config.Params[network])
 
-		var versions VersionTags = VersionTags{
-			Releases: make(map[Tag]superchain.ContractVersions, 0),
-		}
-
+		versions := make(map[Tag]superchain.ContractVersions)
 		decodeTOMLFileIntoConfig("standard-versions-"+network+".toml", &versions)
-		NetworkVersions[network] = versions
+		ContractVersions[network] = versions
 	}
 
 	decodeTOMLFileIntoConfig("standard-bytecodes.toml", &BytecodeHashes)
@@ -57,6 +54,9 @@ func decodeTOMLFileIntoConfig[
 	if err != nil {
 		panic(err)
 	}
+	if data == nil {
+		panic("empty data")
+	}
 	err = toml.Unmarshal(data, config)
 	if err != nil {
 		panic(err)

validation/standard/init_test.go

@@ -36,40 +36,38 @@ func TestConfigInitialization(t *testing.T) {
 		})
 
 		t.Run(fmt.Sprintf("MultisigRoles[%s]", network), func(t *testing.T) {
-			roles := Config.MultisigRoles[network]
-
 			// Ensure network MultisigRoles are populated
+			roles := Config.MultisigRoles[network]
 			require.NotNil(t, roles, "Config.MultisigRoles[%s] should not be nil", network)
-
 			require.NotZero(t, roles, "Config.MultisigRoles[%s] should not be zero value", network)
 
 			l1Roles := roles.KeyHandover.L1.Universal
 			require.NotNil(t, l1Roles, "Config.MultisigRoles[%s].KeyHandover.L1.Universal must be present", network)
 			require.NotEmpty(t, l1Roles["ProxyAdmin"]["owner()"], "Config.MultisigRoles[%s].ProxyAdmin.\"owner()\" must be set", network)
 		})
 
-		t.Run(fmt.Sprintf("NetworkVersions[%s]", network), func(t *testing.T) {
+		t.Run(fmt.Sprintf("ContractVersions[%s]", network), func(t *testing.T) {
 			// Ensure network Versions are populated
-			versions, ok := NetworkVersions[network]
-			require.True(t, ok, "NetworkVersions[%s] should exist", network)
-			require.NotNil(t, versions, "NetworkVersions[%s] should not be nil", network)
-			require.NotZero(t, len(versions.Releases), "NetworkVersions[%s].Releases should not be empty", network)
+			versions, ok := ContractVersions[network]
+			require.True(t, ok, "ContractVersions[%s] should exist", network)
+			require.NotNil(t, versions, "ContractVersions[%s] should not be nil", network)
+			require.NotZero(t, len(versions), "ContractVersions[%s] should not be empty", network)
 
-			_, ok = versions.Releases[Release]
-			require.True(t, ok, "NetworkVersions[%s].Releases[%s] should exist", network, Release)
+			_, ok = versions[Release]
+			require.True(t, ok, "ContractVersions[%s][%s] should exist", network, Release)
 
-			// Ensure release.ImplementationAddress and release.Address are correctly set
-			release, ok := versions.Releases["op-contracts/v1.6.0"]
-			require.True(t, ok, "NetworkVersions[%s].Releases[%s] should exist", network, "op-contracts/v1.6.0")
+			// Ensure ImplementationAddress/Address are correctly set
+			release, ok := versions["op-contracts/v1.6.0"]
+			require.True(t, ok, "ContractVersions[%s][%s] should exist", network, "op-contracts/v1.6.0")
 			if network == "mainnet" {
 				require.Equal(t, "0xe2F826324b2faf99E513D16D266c3F80aE87832B", release.OptimismPortal.ImplementationAddress.String(), "failed parsing release implementation_address")
 			} else {
 				require.Equal(t, "0x35028bAe87D71cbC192d545d38F960BA30B4B233", release.OptimismPortal.ImplementationAddress.String(), "failed parsing release implementation_address")
 			}
 			require.Nil(t, release.OptimismPortal.Address, "failed parsing release address")
 
-			_, ok = versions.Releases["fake-release"]
-			require.False(t, ok, "NetworkVersions[%s].Releases[%s] should not exist", network, Release)
+			_, ok = versions["fake-release"]
+			require.False(t, ok, "ContractVersions[%s][%s] should not exist", network, Release)
 		})
 	}
 }

validation/standard/standard-bytecodes.toml

@@ -1,4 +1,4 @@
-[releases."op-contracts/v1.8.0-rc.3"] # Holocene https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.8.0-rc.3
+["op-contracts/v1.8.0-rc.4"] # Holocene https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.8.0-rc.4
 # Updated in this release
 system_config = "0x165dece6291f3a071e602c804f4a3e89977a71ec866f46c85eb21448f22f6f9a"             # version 2.3.0
 fault_dispute_game = "0x1a81c5fe9fbbf68a0f75e987451e5181c4fc3e801f5c056d38f08942cefed349"        # version "1.3.1"
@@ -15,6 +15,7 @@ preimage_oracle = "0x2109eb20fb34703fe7ab0231bf0e93d972fe78423b72e7fb1f797f16821
 # for the contracts below which contain immutables, the hash is calculated from the masked bytecode (not the deployed bytecode as-is).
 # sections of the bytecode that contain the immutables are masked (set to 0) before computing the hash
 anchor_state_registry = "0x46e8ecc46fd27f178ada1c5a2168c09512e7ed2f7d4ac9a7c74123af26fd850c" # version "2.0.0"
+dispute_game_factory = "0x0d25ffc72ede825443defd6dfb435f5ddeb2e9ce0e3da3e40af069f3ba6bef0f"  # version "1.0.0"
 delayed_weth = "0xc4fb1a6fa54865937fda773735938b5374d23fcf556bb4c69686f23be96b3f97"          # version "1.1.0"
 
 
@@ -31,6 +32,7 @@ permissioned_dispute_game = "0x666d50416294caefc6a0a9c7c3803d75dbb76e9b85384c4aa
 # for the contracts below which contain immutables, the hash is calculated from the masked bytecode (not the deployed bytecode as-is).
 # sections of the bytecode that contain the immutables are masked (set to 0) before computing the hash
 anchor_state_registry = "0x46e8ecc46fd27f178ada1c5a2168c09512e7ed2f7d4ac9a7c74123af26fd850c" # version "2.0.0"
+dispute_game_factory = "0x0d25ffc72ede825443defd6dfb435f5ddeb2e9ce0e3da3e40af069f3ba6bef0f"  # version "1.0.0"
 delayed_weth = "0xc4fb1a6fa54865937fda773735938b5374d23fcf556bb4c69686f23be96b3f97"          # version "1.1.0"
 mips = "0x8f1cb311156fdc848bd99f26b08d88f0bec2c419bbca97533049907794390b4b"                  # version "1.1.0"
 fault_dispute_game = "0x94ded5b66802fe6287d2105fad9ab6c4c8f25275db55d997e07e2284c830595a"    # version "1.2.0"
@@ -49,6 +51,18 @@ permissioned_dispute_game = "0xb0a3aed0fb964b33445061d604e5fcfb952fb99dbff4d6f0c
 # for the contracts below which contain immutables, the hash is calculated from the masked bytecode (not the deployed bytecode as-is).
 # sections of the bytecode that contain the immutables are masked (set to 0) before computing the hash
 anchor_state_registry = "0x46e8ecc46fd27f178ada1c5a2168c09512e7ed2f7d4ac9a7c74123af26fd850c" # version "2.0.0"
-delayed_weth = "0x430b15595a625dc821f34b42c354676de32c2f112fbd89978b8196cf66d823d5"          # version "1.0.0"
+dispute_game_factory = "0x0d25ffc72ede825443defd6dfb435f5ddeb2e9ce0e3da3e40af069f3ba6bef0f"  # version "1.0.0"
+delayed_weth = "0x66cb5d2c98ecd6b1e8768bdee4abd7a66775beaa50d995af1ac24f0cd837d1a3"          # version "1.0.0"
 mips = "0xce7e7ce9dc98d151ecbbb02a548534ab33a59aa4091ad52be0a703dc6c4f3d39"                  # version "1.0.0"
 fault_dispute_game = "0x875e36fd4039b580b20051d25336a7db1ea982613edcc7b83f9d6406f8c84959"    # version "1.2.0"
+
+# MCP https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.3.0
+["op-contracts/v1.3.0"]
+address_manager = ""
+l1_cross_domain_messenger = "0xc919b535f7bbbaa57f32b602f26000e3997c22c933efbb92a36e053b20b2b4b1"       # version 2.3.0
+l1_erc721_bridge = "0xa1a3ea3996797cf5035dafff9335386f8b00c58ff22aaa4c34b02c4ae7cf5e8a"                # version 2.1.0
+l1_standard_bridge = "0x6894839591ba2aa1f6ba43526113e25fd795ec5c5a48202e664c931cd170aaee"              # version 2.1.0
+optimism_mintable_erc20_factory = "0xb8ec72533005496795f8fc0c71f0312578ff626f7b94699984e1add6dc2f3b88" # version 1.9.0
+optimism_portal = "0x3708314c65d3949911060cd82c167a5ace2921694c2bab2d9a60814bde3412d7"                 # version 3.10.0
+system_config = "0x72ba7f6fe9ce5e4bcc7145b3f0681112f2161b025618dedb74bb3ea15bbcbe90"                   # version 2.2.0
+l2_output_oracle = "0xc7a28a1f30fa6c5c10c7e164c4cb50015f99f91ccbbaa5c156ad5e4e20be80e2"

validation/standard/standard-immutables.toml

@@ -8,10 +8,10 @@
 #
 # "immutableReferences":{"85798":[{"start":178,"length":32},{"start":1771,"length":32}]}}
 #
-[releases."op-contracts/v1.8.0-rc.3"] # Holocene https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.8.0-rc.3
+["op-contracts/v1.8.0-rc.4"] # Holocene https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.8.0-rc.4
 # Updated in this release
 fault_dispute_game = '{"121231":[{"start":1926,"length":32},{"start":12628,"length":32}],"121234":[{"start":2891,"length":32},{"start":7484,"length":32},{"start":7822,"length":32},{"start":11526,"length":32},{"start":11660,"length":32},{"start":12171,"length":32},{"start":12470,"length":32}],"121237":[{"start":2724,"length":32},{"start":7283,"length":32},{"start":7577,"length":32},{"start":8183,"length":32},{"start":12437,"length":32},{"start":14230,"length":32},{"start":16139,"length":32},{"start":17960,"length":32},{"start":18262,"length":32},{"start":18519,"length":32},{"start":18732,"length":32}],"121241":[{"start":2673,"length":32},{"start":3936,"length":32},{"start":7722,"length":32},{"start":8329,"length":32},{"start":8424,"length":32},{"start":11254,"length":32},{"start":11320,"length":32}],"121245":[{"start":1204,"length":32},{"start":7866,"length":32},{"start":12866,"length":32},{"start":13719,"length":32}],"121249":[{"start":2189,"length":32},{"start":9639,"length":32},{"start":14792,"length":32}],"121253":[{"start":1319,"length":32},{"start":6476,"length":32},{"start":9344,"length":32},{"start":10730,"length":32},{"start":15892,"length":32}],"121257":[{"start":1555,"length":32},{"start":6026,"length":32},{"start":9704,"length":32}],"121260":[{"start":2590,"length":32},{"start":14649,"length":32}],"121264":[{"start":1723,"length":32},{"start":8123,"length":32},{"start":8230,"length":32},{"start":8281,"length":32}]}'
-mips = '{"92095":[{"start":178,"length":32},{"start":1869,"length":32}]}'
+mips = '{"106243":[{"start":178,"length":32},{"start":1869,"length":32}]}'
 # Unchanged in this release
 anchor_state_registry = '{"105981":[{"start":387,"length":32},{"start":828,"length":32},{"start":2296,"length":32}]}'
 delayed_weth = '{"110979":[{"start":831,"length":32},{"start":4133,"length":32}]}'
@@ -22,7 +22,6 @@ delayed_weth = '{"110979":[{"start":831,"length":32},{"start":4133,"length":32}]
 fault_dispute_game = '{"106803":[{"start":1926,"length":32},{"start":12628,"length":32}],"106806":[{"start":2891,"length":32},{"start":7484,"length":32},{"start":7822,"length":32},{"start":11526,"length":32},{"start":11660,"length":32},{"start":12171,"length":32},{"start":12470,"length":32}],"106809":[{"start":2724,"length":32},{"start":7283,"length":32},{"start":7577,"length":32},{"start":8183,"length":32},{"start":12437,"length":32},{"start":14230,"length":32},{"start":16139,"length":32},{"start":17960,"length":32},{"start":18262,"length":32},{"start":18519,"length":32},{"start":18732,"length":32}],"106813":[{"start":2673,"length":32},{"start":3936,"length":32},{"start":7722,"length":32},{"start":8329,"length":32},{"start":8424,"length":32},{"start":11254,"length":32},{"start":11320,"length":32}],"106817":[{"start":1204,"length":32},{"start":7866,"length":32},{"start":12866,"length":32},{"start":13719,"length":32}],"106821":[{"start":2189,"length":32},{"start":9639,"length":32},{"start":14792,"length":32}],"106825":[{"start":1319,"length":32},{"start":6476,"length":32},{"start":9344,"length":32},{"start":10730,"length":32},{"start":15892,"length":32}],"106829":[{"start":1555,"length":32},{"start":6026,"length":32},{"start":9704,"length":32}],"106832":[{"start":2590,"length":32},{"start":14649,"length":32}],"106836":[{"start":1723,"length":32},{"start":8123,"length":32},{"start":8230,"length":32},{"start":8281,"length":32}]}'
 mips = '{"92095":[{"start":178,"length":32},{"start":1771,"length":32}]}'
 
-
 ["op-contracts/v1.4.0"] # Fault Proof contract AST https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.4.0
 anchor_state_registry = '{"92829":[{"start":387,"length":32},{"start":828,"length":32},{"start":2296,"length":32}]}'
 delayed_weth = '{"97827":[{"start":831,"length":32},{"start":4133,"length":32}]}'

validation/standard/standard-version-consistency_test.go

@@ -0,0 +1,56 @@
+package standard_test
+
+import (
+	"context"
+	"testing"
+
+	. "github.com/ethereum-optimism/superchain-registry/superchain"
+	"github.com/ethereum-optimism/superchain-registry/validation"
+	"github.com/ethereum-optimism/superchain-registry/validation/standard"
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/ethclient"
+	"github.com/stretchr/testify/require"
+)
+
+// This test will check:
+// For each each superchain
+// For each contract release
+// For each contract version declaration which specifies an address
+// There is a contract at that address with the matching bytecode and semver.
+// This is a consistency check on the standard package itself, not any particular chain
+func TestStandardVersionConsistency(t *testing.T) {
+	for _, superchain := range []string{"sepolia", "mainnet"} {
+		rpcEndpoint := Superchains[superchain].Config.L1.PublicRPC
+		require.NotEmpty(t, rpcEndpoint)
+
+		client, err := ethclient.Dial(rpcEndpoint)
+		require.NoErrorf(t, err, "could not dial rpc endpoint %s", rpcEndpoint)
+
+		for tag, release := range standard.ContractVersions[superchain] {
+			for _, contract := range release.GetNonEmpty() {
+				vc, err := release.VersionedContractFor(contract)
+				require.NoError(t, err)
+				if vc.Address != nil && vc.ImplementationAddress != nil {
+					require.FailNow(t, "should not specify both address and implementation address")
+				}
+				addressToCheck := vc.Address
+				if vc.ImplementationAddress != nil {
+					addressToCheck = vc.ImplementationAddress
+				}
+				if addressToCheck != nil {
+					version, err := validation.GetContractVersion(context.Background(), common.Address(*addressToCheck), client)
+					require.NoErrorf(t, err, "could not get version for address %s, contract %s, superchain %s, release %s", addressToCheck, contract, superchain, tag)
+					require.Equal(t, vc.Version, version, "version mismatch for %s", addressToCheck)
+
+					dummyChainId := uint64(12345678) // we don't actually need a chain ID for this since we wouldn't ever pass a proxy here
+					bytecodeHash, err := validation.GetBytecodeHash(context.Background(), dummyChainId, contract, common.Address(*addressToCheck), client, tag)
+					require.NoError(t, err)
+
+					h, err := standard.BytecodeHashes[tag].GetBytecodeHashFor(contract)
+					require.NoErrorf(t, err, "could not get hash for contract %s, release %s", contract, tag)
+					require.Equal(t, h, bytecodeHash, "bytecode hash mismatch for ", contract, "release", tag, "superchain", superchain, "should be", bytecodeHash)
+				}
+			}
+		}
+	}
+}

validation/standard/standard-versions-mainnet.toml

@@ -1,12 +1,10 @@
-[releases]
-
 # Contracts which are
 #   * unproxied singletons: specify a standard "address"
 #   * proxied             : specify a standard "implementation_address"
 #   * neither             : specify neither a standard "address" nor "implementation_address"
 
-# Holocene https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.8.0-rc.3
-[releases."op-contracts/v1.8.0-rc.3"]
+# Holocene https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.8.0-rc.4
+["op-contracts/v1.8.0-rc.4"]
 # Updated in this release
 system_config = { version = "2.3.0", implementation_address = "0xAB9d6cB7A427c0765163A7f45BB91cAfe5f2D375" } # UPDATED IN THIS RELEASE
 fault_dispute_game = { version = "1.3.1" }                                                                   # UPDATED IN THIS RELEASE
@@ -25,7 +23,7 @@ l1_standard_bridge = { version = "2.1.0", implementation_address = "0x64B5a5Ed26
 optimism_mintable_erc20_factory = { version = "1.9.0", implementation_address = "0xE01efbeb1089D1d1dB9c6c8b135C934C0734c846" }
 
 # Fault Proofs https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.6.0
-[releases."op-contracts/v1.6.0"]
+["op-contracts/v1.6.0"]
 optimism_portal = { version = "3.10.0", implementation_address = "0xe2F826324b2faf99E513D16D266c3F80aE87832B" }
 system_config = { version = "2.2.0", implementation_address = "0xF56D96B2535B932656d3c04Ebf51baBff241D886" }
 anchor_state_registry = { version = "2.0.0" }
@@ -42,7 +40,7 @@ l1_standard_bridge = { version = "2.1.0", implementation_address = "0x64B5a5Ed26
 optimism_mintable_erc20_factory = { version = "1.9.0", implementation_address = "0xE01efbeb1089D1d1dB9c6c8b135C934C0734c846" }
 
 # Fault Proofs https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.4.0
-[releases."op-contracts/v1.4.0"]
+["op-contracts/v1.4.0"]
 optimism_portal = { version = "3.10.0", implementation_address = "0xe2F826324b2faf99E513D16D266c3F80aE87832B" }
 system_config = { version = "2.2.0", implementation_address = "0xF56D96B2535B932656d3c04Ebf51baBff241D886" }
 anchor_state_registry = { version = "1.0.0" }
@@ -54,7 +52,7 @@ mips = { version = "1.0.1", address = "0x0f8EdFbDdD3c0256A80AD8C0F2560B1807873C9
 preimage_oracle = { version = "1.0.0", address = "0xD326E10B8186e90F4E2adc5c13a2d0C137ee8b34" }
 
 # MCP https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.3.0
-[releases."op-contracts/v1.3.0"]
+["op-contracts/v1.3.0"]
 l1_cross_domain_messenger = { version = "2.3.0", implementation_address = "0xD3494713A5cfaD3F5359379DfA074E2Ac8C6Fd65" }
 l1_erc721_bridge = { version = "2.1.0", implementation_address = "0xAE2AF01232a6c4a4d3012C5eC5b1b35059caF10d" }
 l1_standard_bridge = { version = "2.1.0", implementation_address = "0x64B5a5Ed26DCb17370Ff4d33a8D503f0fbD06CfF" }