Merge branch 'develop' into 08-16-fix_ci_Log_standard-verbose_for_go_tests_for_indexer

.circleci/config.yml

@@ -115,20 +115,23 @@ jobs:
           name: Restore PNPM Package Cache
           keys:
             - pnpm-packages-v2-{{ checksum "pnpm-lock.yaml" }}
-      - run:
-          name: Install dependencies
-          command: pnpm install --frozen-lockfile
+      # Fetch node_modules into the pnpm store
+      # This will cache node_modules based on pnpm-lock so other steps can instantly install them with `pnpm install --prefer-offline`
+      # --prefer-offline installs node_modules instantly by just reading from cache if it exists rather than fetching from network
+      # when installing node_modules pnpm simply adds symlinks instead of copying the files which is why it is pretty much instant to run --prefer-offline
+      # this allows a caching strategy of only checking pnpm-lockfile so we don't have to keep it in sync with our packages
+      # For more information see https://pnpm.io/cli/fetch
+      - run:
+          name: Fetch dependencies
+          command: pnpm fetch --frozen-lockfile --prefer-offline
       - save_cache:
           name: Save PNPM Package Cache
           key: pnpm-packages-v2-{{ checksum "pnpm-lock.yaml" }}
           paths:
             - "node_modules"
-            - "packages/chain-mon/node_modules"
-            - "packages/common-ts/node_modules"
-            - "packages/contracts-bedrock/node_modules"
-            - "packages/core-utils/node_modules"
-            - "packages/sdk/node_modules"
-            - "packages/contracts-ts/node_modules"
+      - run:
+          name: Install dependencies
+          command: pnpm install --frozen-lockfile --offline
       - run:
           name: print forge version
           command: forge --version
@@ -469,6 +472,10 @@ jobs:
           name: Restore PNPM Package Cache
           keys:
             - pnpm-packages-v2-{{ checksum "pnpm-lock.yaml" }}
+      # populate node modules from the cache
+      - run:
+          name: Install dependencies
+          command: pnpm install --frozen-lockfile --prefer-offline
       - check-changed:
           patterns: contracts-bedrock
       - run:
@@ -476,51 +483,6 @@ jobs:
           command: pnpm validate-spacers
           working_directory: packages/contracts-bedrock
 
-  bedrock-echidna-build:
-    docker:
-      - image: us-docker.pkg.dev/oplabs-tools-artifacts/images/ci-builder:latest
-    steps:
-      - checkout
-      - attach_workspace: { at: "." }
-      - check-changed:
-          patterns: contracts-bedrock
-      - run:
-          name: Compile with metadata hash
-          command: pnpm clean && pnpm build:with-metadata
-          working_directory: packages/contracts-bedrock
-      - persist_to_workspace:
-          root: .
-          paths:
-            - "node_modules"
-            - packages/contracts-bedrock
-
-  bedrock-echidna-run:
-    docker:
-      - image: us-docker.pkg.dev/oplabs-tools-artifacts/images/ci-builder:latest
-    parameters:
-      echidna_target:
-        description: Which echidna fuzz contract to run
-        type: string
-      size:
-        description: Custom resource class size for the run
-        type: string
-        default: large
-    resource_class: <<parameters.size>>
-    steps:
-      - checkout
-      - attach_workspace: { at: "." }
-      - restore_cache:
-          name: Restore PNPM Package Cache
-          keys:
-            - pnpm-packages-v2-{{ checksum "pnpm-lock.yaml" }}
-      - check-changed:
-          patterns: contracts-bedrock
-      - run:
-          name: Echidna Fuzz <<parameters.echidna_target>>
-          command: pnpm echidna:<<parameters.echidna_target>>
-          working_directory: packages/contracts-bedrock
-          no_output_timeout: 15m
-
   op-bindings-build:
     docker:
       - image: us-docker.pkg.dev/oplabs-tools-artifacts/images/ci-builder:latest
@@ -556,6 +518,10 @@ jobs:
             - pnpm-packages-v2-{{ checksum "pnpm-lock.yaml" }}
       - check-changed:
           patterns: <<parameters.package_name>>,<<parameters.dependencies>>
+      # populate node modules from the cache
+      - run:
+          name: Install dependencies
+          command: pnpm install --frozen-lockfile --prefer-offline
       - run:
           name: Lint
           command: pnpm lint && git diff --exit-code
@@ -581,6 +547,10 @@ jobs:
             - pnpm-packages-v2-{{ checksum "pnpm.lock.yaml" }}
       - check-changed:
           patterns: sdk,contracts-bedrock,contracts
+      # populate node modules from the cache
+      - run:
+          name: Install dependencies
+          command: pnpm install --frozen-lockfile --prefer-offline
       - run:
           name: Check generated and build
           command: pnpm generate:check
@@ -599,6 +569,10 @@ jobs:
             - pnpm-packages-v2-{{ checksum "pnpm.lock.yaml" }}
       - check-changed:
           patterns: sdk,contracts-bedrock,contracts
+      # populate node modules from the cache
+      - run:
+          name: Install dependencies
+          command: pnpm install --frozen-lockfile --prefer-offline
       - run:
           name: anvil-l1
           background: true
@@ -643,22 +617,13 @@ jobs:
       - checkout
       - check-changed:
           patterns: specs/(.*)\.md$
-      # TODO remove me after ci builder updated
       - run:
           name: Install pnpm package manager
           command: |
             npm i pnpm --global
-      # TODO remove me after ci builder updated
-      # A github dep clones-with-immutable-args is installed via github
-      # packages installed via npm via github automatically run postpack scripts
-      # their postpack script happens to use yarn so we need it here
-      - run:
-          name: Install yarn package manager
-          command: |
-            npm i yarn@1 --global
       - run:
           name: pnpm dev deps
-          command: pnpm install
+          command: pnpm install --frozen-lockfile --prefer-offline
       - run:
           name: specs toc
           command: pnpm lint:specs:toc && git diff --exit-code ./specs
@@ -671,7 +636,6 @@ jobs:
       image: ubuntu-2204:2022.07.1
     steps:
       - checkout
-      # TODO remove me after ci builder updated
       - run:
           name: Install pnpm package manager
           command: |
@@ -679,7 +643,7 @@ jobs:
       - run:
           name: Install node_modules
           command: |
-            pnpm install
+            pnpm install --frozen-lockfile --prefer-offline
       - run:
           name: Lint check
           command: |
@@ -981,7 +945,7 @@ jobs:
       - run:
           name: Install and build
           command: |
-            pnpm install && pnpm build
+            pnpm install --frozen-lockfile --prefer-offline && pnpm build
       - run:
           name: generate cannon prestate
           command: make cannon-prestate

CONTRIBUTING.md

@@ -185,3 +185,37 @@ cd packages/contracts
 pip3 install slither-analyzer
 pnpm test:slither
 ```
+
+## Labels
+
+Labels are divided into categories with their descriptions annotated as `<Category Name>: <description>`.
+
+The following are a comprehensive list of label categories.
+
+- **Area labels** ([`A-`][area]): Denote the general area for the related issue or PR changes.
+- **Category labels** ([`C-`][category]): Contextualize the type of issue or change.
+- **Meta labels** ([`M-`][meta]): These add context to the issues or prs themselves primarily relating to process.
+- **Difficulty labels** ([`D-`][difficulty]): Describe the associated implementation's difficulty level.
+- **Status labels** ([`S-`][status]): Specify the status of an issue or pr.
+
+Labels also provide a versatile filter for finding tickets that need help or are open for assignment.
+This makes them a great tool for contributors!
+
+[area]: https://github.com/ethereum-optimism/optimism/labels?q=a-
+[category]: https://github.com/ethereum-optimism/optimism/labels?q=c-
+[meta]: https://github.com/ethereum-optimism/optimism/labels?q=m-
+[difficulty]: https://github.com/ethereum-optimism/optimism/labels?q=d-
+[status]: https://github.com/ethereum-optimism/optimism/labels?q=s-
+
+#### Filtering for Work
+
+To find tickets available for external contribution, take a look at the [`M-community`][M-community] label.
+
+You can filter by the [`D-good-first-issue`][D-good-first-issue]
+label to find issues that are intended to be easy to implement or fix.
+
+Also, all labels can be seen by visiting the [labels page][labels]
+
+[labels]: https://github.com/ethereum-optimism/optimism/labels
+[M-community]: https://github.com/ethereum-optimism/optimism/labels/M-community
+[D-good-first-issue]: https://github.com/ethereum-optimism/optimism/labels/D-good-first-issue

go.mod

@@ -11,6 +11,7 @@ require (
 	github.com/ethereum/go-ethereum v1.12.0
 	github.com/fsnotify/fsnotify v1.6.0
 	github.com/go-chi/chi/v5 v5.0.10
+	github.com/go-chi/docgen v1.2.0
 	github.com/golang/snappy v0.0.5-0.20220116011046-fa5810519dcb
 	github.com/google/go-cmp v0.5.9
 	github.com/google/gofuzz v1.2.1-0.20220503160820-4a35382e8fc8

go.sum

@@ -192,8 +192,12 @@ github.com/gin-gonic/gin v1.8.1 h1:4+fr/el88TOO3ewCmQr8cx/CtZ/umlIRIs5M4NTNjf8=
 github.com/gliderlabs/ssh v0.1.1/go.mod h1:U7qILu1NlMHj9FlMhZLlkCdDnU1DBEAqr0aevW3Awn0=
 github.com/go-check/check v0.0.0-20180628173108-788fd7840127/go.mod h1:9ES+weclKsC9YodN5RgxqK/VD9HM9JsCSh7rNhMZE98=
 github.com/go-chi/chi/v5 v5.0.0/go.mod h1:BBug9lr0cqtdAhsu6R4AAdvufI0/XBzAQSsUqJpoZOs=
+github.com/go-chi/chi/v5 v5.0.1/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
 github.com/go-chi/chi/v5 v5.0.10 h1:rLz5avzKpjqxrYwXNfmjkrYYXOyLJd37pz53UFHC6vk=
 github.com/go-chi/chi/v5 v5.0.10/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
+github.com/go-chi/docgen v1.2.0 h1:da0Nq2PKU9W9pSOTUfVrKI1vIgTGpauo9cfh4Iwivek=
+github.com/go-chi/docgen v1.2.0/go.mod h1:G9W0G551cs2BFMSn/cnGwX+JBHEloAgo17MBhyrnhPI=
+github.com/go-chi/render v1.0.1/go.mod h1:pq4Rr7HbnsdaeHagklXub+p6Wd16Af5l9koip1OvJns=
 github.com/go-errors/errors v1.0.1/go.mod h1:f4zRHt4oKfwPJE5k8C9vpYG+aDHdBFUsgrm6/TyX73Q=
 github.com/go-errors/errors v1.4.2 h1:J6MZopCL4uSllY1OfXM374weqZFFItUbrImctkmUxIA=
 github.com/go-kit/log v0.1.0/go.mod h1:zbhenjAZHb184qTLMA9ZjW7ThYL0H2mk7Q6pNt4vbaY=

indexer/api/api.go

@@ -21,7 +21,7 @@ func NewApi(bv database.BridgeTransfersView, logger log.Logger) *Api {
 
 	r := chi.NewRouter()
 
-	h := routes.NewRoutes(logger, bv)
+	h := routes.NewRoutes(logger, bv, r)
 
 	api := &Api{Router: r}
 

indexer/api/routes/docs.go

+package routes
+
+import (
+	"net/http"
+
+	"github.com/go-chi/docgen"
+)
+
+func (h Routes) DocsHandler(w http.ResponseWriter, r *http.Request) {
+	w.Header().Set("Content-Type", "text/plain")
+	w.WriteHeader(http.StatusOK)
+	docs := docgen.MarkdownRoutesDoc(h.Router, docgen.MarkdownOpts{
+		ProjectPath: "github.com/ethereum-optimism/optimism/indexer",
+		// Intro text included at the top of the generated markdown file.
+		Intro: "Generated documentation for Optimism indexer",
+	})
+	_, err := w.Write([]byte(docs))
+	if err != nil {
+		h.Logger.Error("error writing docs", "err", err)
+		http.Error(w, "Internal server error fetching docs", http.StatusInternalServerError)
+	}
+}

indexer/api/routes/routes.go

@@ -3,16 +3,19 @@ package routes
 import (
 	"github.com/ethereum-optimism/optimism/indexer/database"
 	"github.com/ethereum/go-ethereum/log"
+	"github.com/go-chi/chi/v5"
 )
 
 type Routes struct {
 	Logger              log.Logger
 	BridgeTransfersView database.BridgeTransfersView
+	Router              *chi.Mux
 }
 
-func NewRoutes(logger log.Logger, bv database.BridgeTransfersView) Routes {
+func NewRoutes(logger log.Logger, bv database.BridgeTransfersView, r *chi.Mux) Routes {
 	return Routes{
 		Logger:              logger,
 		BridgeTransfersView: bv,
+		Router:              r,
 	}
 }

indexer/database/bridge_transfers.go

@@ -125,6 +125,7 @@ l1_bridge_deposits.*,
 l1_contract_events.transaction_hash AS l1_transaction_hash,
 l1_transaction_deposits.l2_transaction_hash`)
 
+	// TODO join with l1_tokens and l2_tokens
 	depositsQuery = depositsQuery.Joins("INNER JOIN l1_transaction_deposits ON l1_bridge_deposits.transaction_source_hash = l1_transaction_deposits.source_hash")
 	depositsQuery = depositsQuery.Joins("INNER JOIN l1_contract_events ON l1_transaction_deposits.initiated_l1_event_guid = l1_contract_events.guid")
 

indexer/migrations/20230523_create_schema.sql

@@ -84,6 +84,31 @@ CREATE TABLE IF NOT EXISTS output_proposals (
  * BRIDGING DATA
  */
 
+ /**
+ * TOKEN DATA
+ */
+
+-- L1 Token table
+CREATE TABLE IF NOT EXISTS l1_tokens (
+    address   VARCHAR PRIMARY KEY,
+    bridge_address  VARCHAR NOT NULL,
+    l2_token_address VARCHAR NOT NULL,
+    name            VARCHAR NOT NULL,
+    symbol          VARCHAR NOT NULL,
+    decimals        INTEGER NOT NULL CHECK (decimals >= 0 AND decimals <= 18)
+);
+
+-- L2 Token table
+CREATE TABLE IF NOT EXISTS l2_tokens (
+    address   VARCHAR PRIMARY KEY,
+    bridge_address  VARCHAR NOT NULL,
+    l1_token_address VARCHAR REFERENCES l1_tokens(address),
+    name            VARCHAR NOT NULL,
+    symbol          VARCHAR NOT NULL,
+    decimals        INTEGER NOT NULL CHECK (decimals >= 0 AND decimals <= 18)
+);
+
+
 -- OptimismPortal/L2ToL1MessagePasser
 CREATE TABLE IF NOT EXISTS l1_transaction_deposits (
     source_hash         VARCHAR NOT NULL PRIMARY KEY,
@@ -170,8 +195,8 @@ CREATE TABLE IF NOT EXISTS l1_bridge_deposits (
     -- Deposit information
 	from_address     VARCHAR NOT NULL,
 	to_address       VARCHAR NOT NULL,
-	l1_token_address VARCHAR NOT NULL,
-	l2_token_address VARCHAR NOT NULL,
+    l1_token_address VARCHAR NOT NULL, -- REFERENCES l1_tokens(address), uncomment me in future pr
+    l2_token_address VARCHAR NOT NULL, -- REFERENCES l2_tokens(address), uncomment me in future pr
 	amount           UINT256 NOT NULL,
 	data             VARCHAR NOT NULL,
     timestamp        INTEGER NOT NULL CHECK (timestamp > 0)
@@ -186,8 +211,8 @@ CREATE TABLE IF NOT EXISTS l2_bridge_withdrawals (
     -- Withdrawal information
 	from_address     VARCHAR NOT NULL,
 	to_address       VARCHAR NOT NULL,
-	l1_token_address VARCHAR NOT NULL,
-	l2_token_address VARCHAR NOT NULL,
+    l1_token_address VARCHAR NOT NULL, -- REFERENCES l1_tokens(address), uncomment me in future pr
+    l2_token_address VARCHAR NOT NULL, -- REFERENCES l2_tokens(address), uncomment me in future pr
 	amount           UINT256 NOT NULL,
 	data             VARCHAR NOT NULL,
     timestamp        INTEGER NOT NULL CHECK (timestamp > 0)

packages/contracts-bedrock/.gas-snapshot

@@ -401,6 +401,7 @@ MintManager_mint_Test:test_mint_moreThanCap_reverts() (gas: 142523)
 MintManager_upgrade_Test:test_upgrade_fromNotOwner_reverts() (gas: 10974)
 MintManager_upgrade_Test:test_upgrade_fromOwner_succeeds() (gas: 23434)
 MintManager_upgrade_Test:test_upgrade_toZeroAddress_reverts() (gas: 11003)
+Multichain:test_script_succeeds() (gas: 3078)
 OptimismMintableERC20_Test:test_bridge_succeeds() (gas: 7621)
 OptimismMintableERC20_Test:test_burn_notBridge_reverts() (gas: 11164)
 OptimismMintableERC20_Test:test_burn_succeeds() (gas: 50996)
@@ -517,8 +518,6 @@ OptimistTest:test_supportsInterface_returnsCorrectInterfaceForERC721_succeeds()
 OptimistTest:test_tokenIdOfAddress_returnsOwnerID_succeeds() (gas: 63730)
 OptimistTest:test_tokenURI_returnsCorrectTokenURI_succeeds() (gas: 195908)
 OptimistTest:test_transferFrom_soulbound_reverts() (gas: 75512)
-PostSherlockL1:test_script_succeeds() (gas: 3078)
-PostSherlockL2:test_script_succeeds() (gas: 3078)
 PreimageOracle_Test:test_keccak256PreimageKey_succeeds() (gas: 319)
 PreimageOracle_Test:test_loadKeccak256PreimagePart_outOfBoundsOffset_reverts() (gas: 8993)
 PreimageOracle_Test:test_loadKeccak256PreimagePart_succeeds() (gas: 76098)

packages/contracts-bedrock/deploy-config/getting-started.json

@@ -52,5 +52,7 @@
   "l2GenesisRegolithTimeOffset": "0x0",
 
   "eip1559Denominator": 50,
-  "eip1559Elasticity": 10
+  "eip1559Elasticity": 10,
+
+  "systemConfigStartBlock": 0
 }

packages/contracts-bedrock/deploy-config/hardhat.json

@@ -38,5 +38,6 @@
   "numDeployConfirmations": 1,
   "eip1559Denominator": 50,
   "eip1559Elasticity": 10,
-  "l2GenesisRegolithTimeOffset": "0x0"
+  "l2GenesisRegolithTimeOffset": "0x0",
+  "systemConfigStartBlock": 0
 }

packages/contracts-bedrock/package.json

@@ -16,7 +16,7 @@
     "prebuild": "./scripts/verify-foundry-install.sh",
     "build:differential": "go build -o ./scripts/differential-testing/differential-testing ./scripts/differential-testing",
     "build:fuzz": "(cd test-case-generator && go build ./cmd/fuzz.go)",
-    "autogen:invariant-docs": "tsx scripts/invariant-doc-gen.ts",
+    "autogen:invariant-docs": "npx tsx scripts/invariant-doc-gen.ts",
     "test": "pnpm build:differential && pnpm build:fuzz && forge test",
     "coverage": "pnpm build:differential && pnpm build:fuzz && forge coverage",
     "coverage:lcov": "pnpm build:differential && pnpm build:fuzz && forge coverage --report lcov",
@@ -32,7 +32,7 @@
     "pre-pr": "pnpm clean && pnpm gas-snapshot && pnpm storage-snapshot && pnpm semver-lock && pnpm autogen:invariant-docs && pnpm lint && (cd ../../op-bindings && make)",
     "pre-pr:full": "pnpm test && pnpm slither && pnpm validate-deploy-configs && pnpm validate-spacers && pnpm pre-pr",
     "lint:ts:check": "eslint . --max-warnings=0",
-    "lint:forge-tests:check": "tsx scripts/forge-test-names.ts",
+    "lint:forge-tests:check": "npx tsx scripts/forge-test-names.ts",
     "lint:contracts:check": "pnpm lint:fix && git diff --exit-code",
     "lint:check": "pnpm lint:contracts:check && pnpm lint:ts:check",
     "lint:ts:fix": "eslint --fix .",

packages/contracts-bedrock/scripts/Deployer.sol

@@ -65,13 +65,20 @@ abstract contract Deployer is Script {
     ///        bytes32(uint256(keccak256('eip1967.proxy.admin')) - 1)
     bytes32 internal constant OWNER_KEY = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;
 
-    /// @notice Create the global variables and set up the filesystem
+    /// @notice Create the global variables and set up the filesystem.
+    ///         Forge script will create a file where the prefix is the
+    ///         name of the function that runs with the suffix `-latest.json`.
+    ///         By default, `run()` is called. Allow the user to use the SIG
+    ///         env var to specify what function signature was called so that
+    ///         the `sync()` method can be used to create hardhat deploy style
+    ///         artifacts.
     function setUp() public virtual {
         string memory root = vm.projectRoot();
         deployScript = vm.envOr("DEPLOY_SCRIPT", name());
 
         deploymentContext = _getDeploymentContext();
-        string memory deployFile = vm.envOr("DEPLOY_FILE", string("run-latest.json"));
+        string memory sig = vm.envOr("SIG", string("run"));
+        string memory deployFile = vm.envOr("DEPLOY_FILE", string.concat(sig, "-latest.json"));
         uint256 chainId = vm.envOr("CHAIN_ID", block.chainid);
         deployPath = string.concat(root, "/broadcast/", deployScript, ".s.sol/", vm.toString(chainId), "/", deployFile);
 

packages/contracts-bedrock/scripts/outputs/DeleteOutput.s.sol

@@ -97,7 +97,7 @@ contract DeleteOutput is SafeBuilder {
         _postCheck();
     }
 
-    function buildCalldata(address _proxyAdmin) internal view override returns (bytes memory) {
+    function buildCalldata(address) internal view override returns (bytes memory) {
         IMulticall3.Call3[] memory calls = new IMulticall3.Call3[](1);
 
         calls[0] = IMulticall3.Call3({

packages/contracts-bedrock/scripts/universal/SafeBuilder.sol

@@ -56,7 +56,13 @@ abstract contract SafeBuilder is EnhancedScript, GlobalConstants {
         if (block.chainid == OP_GOERLI) {
             safe = 0xE534ccA2753aCFbcDBCeB2291F596fc60495257e;
             proxyAdmin = 0x4200000000000000000000000000000000000018;
+        } else if (block.chainid == GOERLI) {
+            safe = 0xBc1233d0C3e6B5d53Ab455cF65A6623F6dCd7e4f;
+            proxyAdmin = 0x01d3670863c3F4b24D7b107900f0b75d4BbC6e0d;
         }
+        console.log("ChainID: %s", block.chainid);
+        console.log("Using Safe: %s", safe);
+        console.log("Using ProxyAdmin: %s", proxyAdmin);
         return run(safe, proxyAdmin);
     }
 

packages/web3js-plugin/.prettierignore

+artifacts
+cache
+typechain
+.deps
+.envrc
+.env 
+/dist/

packages/web3js-plugin/.prettierrc.cjs

+module.exports = {
+  ...require('../../.prettierrc.js'),
+}

packages/web3js-plugin/LICENSE

+MIT License
+
+Copyright (c) 2023 Optimism
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/web3js-plugin/package.json

+{
+  "name": "@eth-optimism/web3.js-plugin",
+  "version": "0.1.0",
+  "description": "A Web3.js plugin for doing OP-Chain gas estimation",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ethereum-optimism/optimism.git",
+    "directory": "packages/web3js-plugin"
+  },
+  "homepage": "https://optimism.io",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/plugin.js",
+      "require": "./dist/plugin.cjs",
+      "default": "./dist/plugin.js",
+      "types": "./src/plugin.d.ts"
+    }
+  },
+  "types": "dist/plugin.d.ts",
+  "files": [
+    "dist/",
+    "src/"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "lint": "prettier --check .",
+    "lint:fix": "prettier --write .",
+    "test": "vitest --coverage",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@eth-optimism/contracts-ts": "workspace:^",
+    "@swc/core": "^1.3.76",
+    "@vitest/coverage-istanbul": "^0.34.1",
+    "tsup": "^7.2.0",
+    "typescript": "^5.1.6",
+    "viem": "^1.6.0",
+    "vite": "^4.4.9",
+    "vitest": "^0.34.1",
+    "zod": "^3.22.0"
+  },
+  "dependencies": {
+    "@ethereumjs/rlp": "^5.0.0",
+    "web3-eth": "^4.0.3",
+    "web3-eth-accounts": "^4.0.3"
+  },
+  "peerDependencies": {
+    "web3": ">= 4.0.3 < 5.x"
+  }
+}

packages/web3js-plugin/tsconfig.json

+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "baseUrl": "./src",
+    "noEmit": true,
+    "target": "ESNext",
+    "lib": ["esnext"],
+    "module": "esnext",
+    "moduleResolution": "Node",
+    "isolatedModules": true,
+    "allowUnreachableCode": false,
+    "skipLibCheck": false,
+    "allowUnusedLabels": false,
+    "alwaysStrict": true,
+    "exactOptionalPropertyTypes": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitOverride": true,
+    "noImplicitThis": true,
+    "forceConsistentCasingInFileNames": true,
+    "verbatimModuleSyntax": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "strict": true
+  },
+  "include": ["./src"]
+}

packages/web3js-plugin/tsup.config.ts

+import { defineConfig } from 'tsup'
+import packageJson from './package.json'
+
+// @see https://tsup.egoist.dev/
+export default defineConfig({
+  name: packageJson.name,
+  entry: ['src/plugin.ts'],
+  outDir: 'dist',
+  format: ['esm', 'cjs'],
+  splitting: false,
+  sourcemap: true,
+  clean: false,
+  dts: true
+})

packages/web3js-plugin/vite.config.ts

+import { defineConfig } from 'vitest/config'
+
+// @see https://vitest.dev/config/
+export default defineConfig({
+  test: {
+    environment: 'jsdom',
+    coverage: {
+      provider: 'istanbul',
+    },
+  },
+})