Merge pull request #6206 from ethereum-optimism/feat/port-contracts-p…

…eriphery

feat: port contracts periphery to contracts bedrock

.changeset/beige-masks-prove.md

@@ -0,0 +1,5 @@
+---
+'@eth-optimism/chain-mon': patch
+---
+
+Update import path for artifact

.changeset/seven-cameras-sip.md

@@ -0,0 +1,5 @@
+---
+'@eth-optimism/contracts-bedrock': minor
+---
+
+Migrate contracts periphery into bedrock

.circleci/config.yml

@@ -139,7 +139,6 @@ jobs:
             - "packages/chain-mon/node_modules"
             - "packages/common-ts/node_modules"
             - "packages/contracts-bedrock/node_modules"
-            - "packages/contracts-periphery/node_modules"
             - "packages/core-utils/node_modules"
             - "packages/fault-detector/node_modules"
             - "packages/hardhat-deploy-config/node_modules"
@@ -873,10 +872,6 @@ jobs:
           name: Check common-ts
           command: npx depcheck
           working_directory: packages/common-ts
-      - run:
-          name: Check contracts-periphery
-          command: npx depcheck
-          working_directory: packages/contracts-periphery
       - run:
           name: Check core-utils
           command: npx depcheck
@@ -1328,18 +1323,11 @@ workflows:
       - op-bindings-build:
           requires:
             - pnpm-monorepo
-      - js-lint-test:
-          name: contracts-periphery-tests
-          coverage_flag: contracts-periphery-tests
-          package_name: contracts-periphery
-          dependencies: "(contracts|contracts-bedrock|core-utils|hardhat-deploy-config)"
-          requires:
-            - pnpm-monorepo
       - js-lint-test:
           name: chain-mon-tests
           coverage_flag: chain-mon-tests
           package_name: chain-mon
-          dependencies: "(common-ts|contracts-periphery|core-utils|sdk)"
+          dependencies: "(common-ts|contracts-bedrock|core-utils|sdk)"
           requires:
             - pnpm-monorepo
       - js-lint-test:

.github/CODEOWNERS

@@ -2,7 +2,6 @@
 /packages/common-ts             @ethereum-optimism/typescript-reviewers
 /packages/contracts             @ethereum-optimism/contract-reviewers
 /packages/contracts-bedrock     @ethereum-optimism/contract-reviewers
-/packages/contracts-periphery   @ethereum-optimism/contract-reviewers
 /packages/core-utils            @ethereum-optimism/legacy-reviewers
 /packages/chain-mon             @smartcontracts
 /packages/fault-detector        @ethereum-optimism/devxpod

.gitignore

@@ -17,11 +17,6 @@ dist
 artifacts
 cache
 
-packages/contracts-periphery/coverage*
-packages/contracts-periphery/@openzeppelin*
-packages/contracts-periphery/hardhat*
-packages/contracts-periphery/forge-artifacts*
-
 packages/contracts-bedrock/deployments/devnetL1
 packages/contracts-bedrock/deployments/anvil
 

.vscode/settings.json

@@ -16,10 +16,6 @@
       "directory": "packages/contracts",
       "changeProcessCWD": true
     },
-    {
-      "directory": "packages/contracts-periphery",
-      "changeProcessCWD": true
-    },
     {
       "directory": "packages/chain-mon",
       "changeProcessCWD": true

README.md

@@ -52,7 +52,6 @@ Refer to the Directory Structure section below to understand which packages are
 ├── <a href="./packages">packages</a>
 │   ├── <a href="./packages/common-ts">common-ts</a>: Common tools for building apps in TypeScript
 │   ├── <a href="./packages/contracts-bedrock">contracts-bedrock</a>: Bedrock smart contracts.
-│   ├── <a href="./packages/contracts-periphery">contracts-periphery</a>: Peripheral contracts for Optimism
 │   ├── <a href="./packages/core-utils">core-utils</a>: Low-level utilities that make building Optimism easier
 │   ├── <a href="./packages/chain-mon">chain-mon</a>: Chain monitoring services
 │   ├── <a href="./packages/fault-detector">fault-detector</a>: Service for detecting Sequencer faults
@@ -79,7 +78,6 @@ Refer to the Directory Structure section below to understand which packages are
 ~~ Pre-BEDROCK ~~
 ├── <a href="./packages">packages</a>
 │   ├── <a href="./packages/common-ts">common-ts</a>: Common tools for building apps in TypeScript
-│   ├── <a href="./packages/contracts-periphery">contracts-periphery</a>: Peripheral contracts for Optimism
 │   ├── <a href="./packages/core-utils">core-utils</a>: Low-level utilities that make building Optimism easier
 │   ├── <a href="./packages/chain-mon">chain-mon</a>: Chain monitoring services
 │   ├── <a href="./packages/fault-detector">fault-detector</a>: Service for detecting Sequencer faults

codecov.yml

@@ -33,7 +33,6 @@ flag_management:
     - name: common-ts-tests
     - name: contracts-tests
     - name: core-utils-tests
-    - name: contracts-periphery-tests
     - name: dtl-tests
     - name: chain-mon-tests
     - name: fault-detector-tests

op-bindings/Makefile

@@ -1,7 +1,8 @@
 SHELL := /bin/bash
 
 pkg := bindings
-contracts-dir := ../packages/contracts-bedrock
+monorepo-base := $(shell dirname $(realpath .))
+contracts-dir := $(monorepo-base)/packages/contracts-bedrock
 
 all: version mkdir bindings
 
@@ -17,11 +18,12 @@ bindings: compile bindings-build
 
 bindings-build:
 	go run ./gen/main.go \
-		-forge-artifacts ../packages/contracts-bedrock/forge-artifacts \
+		-forge-artifacts $(contracts-dir)/forge-artifacts \
 		-out ./bindings \
 		-contracts ./artifacts.json \
 		-source-maps MIPS,PreimageOracle \
-		-package $(pkg)
+		-package $(pkg) \
+		-monorepo-base $(monorepo-base)
 
 mkdir:
 	mkdir -p $(pkg)

op-bindings/ast/canonicalize.go

@@ -1,6 +1,7 @@
 package ast
 
 import (
+	"path/filepath"
 	"regexp"
 	"sort"
 	"strconv"
@@ -33,7 +34,7 @@ type typeRemapping struct {
 // inefficiency comes from replaceType, which performs a linear
 // search of all replacements when performing substring matches of
 // composite types.
-func CanonicalizeASTIDs(in *solc.StorageLayout) *solc.StorageLayout {
+func CanonicalizeASTIDs(in *solc.StorageLayout, monorepoBase string) *solc.StorageLayout {
 	lastId := uint(1000)
 	astIDRemappings := make(map[uint]uint)
 	typeRemappings := make(map[string]string)
@@ -83,9 +84,18 @@ func CanonicalizeASTIDs(in *solc.StorageLayout) *solc.StorageLayout {
 		Types: make(map[string]solc.StorageLayoutType),
 	}
 	for _, slot := range in.Storage {
+		contract := slot.Contract
+
+		// Normalize the name of the contract since absolute paths
+		// are used when there are 2 contracts imported with the same
+		// name
+		if filepath.IsAbs(contract) {
+			contract = strings.TrimPrefix(strings.Replace(contract, monorepoBase, "", 1), "/")
+		}
+
 		outLayout.Storage = append(outLayout.Storage, solc.StorageLayoutEntry{
 			AstId:    astIDRemappings[slot.AstId],
-			Contract: slot.Contract,
+			Contract: contract,
 			Label:    slot.Label,
 			Offset:   slot.Offset,
 			Slot:     slot.Slot,

op-bindings/ast/canonicalize_test.go

@@ -49,7 +49,7 @@ func TestCanonicalize(t *testing.T) {
 			// Run 100 times to make sure that we aren't relying
 			// on random map iteration order.
 			for i := 0; i < 100; i++ {
-				require.Equal(t, testData.Out, CanonicalizeASTIDs(testData.In))
+				require.Equal(t, testData.Out, CanonicalizeASTIDs(testData.In, ""))
 			}
 		})
 	}