Merge pull request #6260 from ethereum-optimism/07-11-feat_Add_ts_contract_package_for_TS

feat: Add ts contract package for TS

.changeset/config.json

@@ -3,7 +3,7 @@
   "changelog": ["@changesets/changelog-github", { "repo": "ethereum-optimism/optimism" }],
   "commit": false,
   "fixed": [],
-  "linked": [],
+  "linked": [["contracts-bedrock", "contracts-ts"]],
   "access": "public",
   "baseBranch": "develop",
   "updateInternalDependencies": "patch",

.circleci/config.yml

@@ -143,6 +143,7 @@ jobs:
             - "packages/fault-detector/node_modules"
             - "packages/replica-healthcheck/node_modules"
             - "packages/sdk/node_modules"
+            - "packages/contracts-ts/node_modules"
       - run:
           name: print forge version
           command: forge --version
@@ -709,6 +710,24 @@ jobs:
           name: Upload coverage
           command: codecov --verbose --clean --flags <<parameters.coverage_flag>>
 
+  contracts-ts-tests:
+    docker:
+      - image: us-docker.pkg.dev/oplabs-tools-artifacts/images/ci-builder:latest
+    resource_class: large
+    steps:
+      - checkout
+      - attach_workspace: { at: "." }
+      - restore_cache:
+          name: Restore pnpm Package Cache
+          keys:
+            - pnpm-packages-v2-{{ checksum "pnpm.lock.yaml" }}
+      - check-changed:
+          patterns: sdk,contracts-bedrock,contracts
+      - run:
+          name: Check generated and build
+          command: pnpm generate:check
+          working_directory: packages/contracts-ts
+
   sdk-next-tests:
     docker:
       - image: us-docker.pkg.dev/oplabs-tools-artifacts/images/ci-builder:latest
@@ -1336,6 +1355,13 @@ workflows:
           dependencies: "(common-ts|core-utils|sdk)"
           requires:
             - pnpm-monorepo
+      - js-lint-test:
+          name: contracts-ts-tests
+          coverage_flag: contracts-ts-tests
+          package_name: contracts-ts
+          dependencies: '(contracts-bedrock|contracts-ts)'
+          requires:
+            - pnpm-monorepo
       - js-lint-test:
           name: sdk-next-tests
           coverage_flag: sdk-next-tests

nx.json

@@ -56,6 +56,9 @@
       "inputs": ["default", "testing", "^production"],
       "dependsOn": ["^build"]
     },
+    "generate": {
+      "dependsOn": ["^build"]
+    },
     "build:contracts": {
       "inputs": [
         "configsProject",

op-bindings/README.md

@@ -28,3 +28,7 @@ $ make devtools
 ```
 
 The geth docs for `abigen` can be found [here](https://geth.ethereum.org/docs/dapp/native-bindings).
+
+## See also
+
+TypeScript bindings are also generated in [@eth-optimism/contracts-ts](../packages/contracts-ts/)

op-bindings/predeploys/addresses.go

@@ -2,6 +2,9 @@ package predeploys
 
 import "github.com/ethereum/go-ethereum/common"
 
+// TODO - we should get a single toml yaml or json file source of truth in @eth-optimism/bedrock package
+// This needs to be kept in sync with @eth-optimism/contracts-ts/wagmi.config.ts which also specifies this
+// To improve robustness and maintainability contracts-bedrock should export all addresses
 const (
 	L2ToL1MessagePasser           = "0x4200000000000000000000000000000000000016"
 	DeployerWhitelist             = "0x4200000000000000000000000000000000000002"

package.json

@@ -10,6 +10,7 @@
   },
   "scripts": {
     "clean": "npx nx run-many --target=clean",
+    "bindings": "nx bindings @eth-optimism/contracts-bedrock",
     "build": "npx nx run-many --target=build",
     "test": "npx nx run-many --target=test",
     "lint": "npx nx run-many --target=lint",

packages/contracts-bedrock/package.json

@@ -9,8 +9,10 @@
     "contracts/**/*.sol"
   ],
   "scripts": {
-    "bindings": "cd ../../op-bindings && make",
-    "build": "npx nx build:contracts",
+    "bindings": "pnpm bindings:ts && pnpm bindings:go",
+    "bindings:ts": "pnpm generate:addresses && nx generate @eth-optimism/contracts-ts",
+    "bindings:go": "cd ../../op-bindings && make",
+    "build": "nx build:contracts",
     "prebuild:contracts": "./scripts/verify-foundry-install.sh",
     "build:contracts": "pnpm build:forge",
     "build:forge": "forge build",

packages/contracts-ts/.gitignore

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

packages/contracts-ts/.prettierignore

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

packages/contracts-ts/.prettierrc.cjs

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

packages/contracts-ts/CODE_GEN.md

+# Code gen
+
+Summary -
+
+- This package is generated from [contracts-bedrock](../contracts-bedrock/)
+- It's version is kept in sync with contracts bedrock via the [changeset config](../../.changeset/config.json) e.g. if contracts-bedrock is `4.2.0` this package will have the same version.
+
+## Code gen instructions
+
+To run the code gen run the `generate` script from [package.json](./package.json). Make sure node modules is installed.
+
+```bash
+pnpm i && pnpm generate
+```

packages/contracts-ts/LICENSE

+MIT License
+
+Copyright (c) 2022 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/contracts-ts/README.md

+## Contracts TS
+
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=contracts-bedrock-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
+
+ABI and Address constants + generated code from [@eth-optimism/contracts-bedrock/](../contracts-bedrock/) for use in TypeScript.
+
+Much of this package is generated. See [CODE_GEN.md](./CODE_GEN.md) for instructions on how to generate.
+
+#### @eth-optimism/contracts-ts
+
+The main entrypoint exports constants related to contracts bedrock as const. As const allows it to be [used in TypeScript with stronger typing than importing JSON](https://github.com/microsoft/TypeScript/issues/32063).
+
+- Exports contract abis.
+- Exports contract addresses
+
+```typescript
+import {
+  l2OutputOracleProxyABI,
+  l2OutputOracleAddresses,
+} from '@eth-optimism/contracts-ts'
+
+console.log(l2OutputOracleAddresses[10], abi)
+```
+
+Addresses are also exported as an object for convenience.
+
+```typescript
+import { addresses } from '@eth-optimism/contracts-ts'
+
+console.log(addresses.l2OutputOracle[10])
+```
+
+#### @eth-optimism/contracts-ts/react
+
+- All [React hooks](https://wagmi.sh/cli/plugins/react) `@eth-optimism/contracts-ts/react`
+
+```typescript
+import { useAddressManagerAddress } from '@eth-optimism/contracts-ts/react'
+
+const component = () => {
+  const { data, error, loading } = useAddressManagerAddress()
+  if (loading) {
+    return <div>Loading</div>
+  }
+  if (err) {
+    return <div>Error</div>
+  }
+  return <div>{data}</div>
+}
+```
+
+#### @eth-optimism/contracts-ts/actions
+
+- All [wagmi actions](https://wagmi.sh/react/actions) for use in Vanilla JS or non react code
+
+```typescript
+import { readSystemConfig } from '@eth-optimism/contracts-ts/actions'
+console.log(await readSystemConfig())
+```
+
+#### See Also
+
+- [Contracts bedrock specs](../../specs/)
+- [Wagmi](https://wagmi.sh)

packages/contracts-ts/addresses.json

+{
+  "AddressManager": {
+    "1": "0xdE1FCfB0851916CA5101820A69b13a4E276bd81F",
+    "5": "0xa6f73589243a6A7a9023b1Fa0651b1d89c177111"
+  },
+  "AssetReceiver": {
+    "1": "0x15DdA60616Ffca20371ED1659dBB78E888f65556",
+    "10": "0x15DdA60616Ffca20371ED1659dBB78E888f65556"
+  },
+  "CheckBalanceHigh": {
+    "1": "0x7eC64a8a591bFf829ff6C8be76074D540ACb813F",
+    "5": "0x7eC64a8a591bFf829ff6C8be76074D540ACb813F",
+    "420": "0x5d7103853f12109A7d27F118e54BbC654ad847E9"
+  },
+  "CheckBalanceLow": {
+    "1": "0x381a4eFC2A2C914eA1889722bB4B44Fa6BD5b640",
+    "5": "0x381a4eFC2A2C914eA1889722bB4B44Fa6BD5b640",
+    "420": "0x7Ce13D154FAEE5C8B3E6b19d4Add16f21d884474"
+  },
+  "CheckGelatoLow": {
+    "1": "0x4f7CFc43f6D262a085F3b946cAC69E7a8E39BBAa",
+    "5": "0x4f7CFc43f6D262a085F3b946cAC69E7a8E39BBAa",
+    "420": "0xF9c8a4Cb4021f57F9f6d69799cA9BefF64524862"
+  },
+  "CheckTrue": {
+    "1": "0x5c741a38cb11424711231777D71689C458eE835D",
+    "5": "0x5c741a38cb11424711231777D71689C458eE835D",
+    "420": "0x47443D0C184e022F19BD1578F5bca6B8a9F58E32"
+  },
+  "Drippie": {
+    "1": "0x44b3A2a040057eBafC601A78647e805fd58B1f50"
+  },
+  "Drippie_goerli": {
+    "5": "0x44b3A2a040057eBafC601A78647e805fd58B1f50"
+  },
+  "Drippie_optimism-goerli": {
+    "420": "0x8D8d533C16D23847EB04EEB0925be8900Dd3af86"
+  },
+  "L1CrossDomainMessenger": {
+    "1": "0x25ace71c97B33Cc4729CF772ae268934F7ab5fA1",
+    "5": "0x5086d1eEF304eb5284A0f6720f79403b4e9bE294"
+  },
+  "L1ERC721Bridge": {
+    "1": "0x5a7749f83b81B301cAb5f48EB8516B986DAef23D",
+    "5": "0x8DD330DdE8D9898d43b4dc840Da27A07dF91b3c9"
+  },
+  "L1StandardBridge": {
+    "1": "0x99C9fc46f92E8a1c0deC1b1747d010903E884bE1",
+    "5": "0x636Af16bf2f682dD3109e60102b8E1A089FedAa8"
+  },
+  "L2OutputOracle": {
+    "1": "0xdfe97868233d1aa22e815a266982f2cf17685a27",
+    "5": "0xE6Dfba0953616Bacab0c9A8ecb3a9BBa77FC15c0"
+  },
+  "OptimismMintableERC20Factory": {
+    "1": "0x4200000000000000000000000000000000000012",
+    "5": "0x4200000000000000000000000000000000000012",
+    "420": "0x4200000000000000000000000000000000000012"
+  },
+  "OptimismPortal": {
+    "1": "0xbEb5Fc579115071764c7423A4f12eDde41f106Ed",
+    "5": "0x5b47E1A08Ea6d985D6649300584e6722Ec4B1383"
+  },
+  "PortalSender": {
+    "1": "0x0A893d9576b9cFD9EF78595963dc973238E78210",
+    "5": "0xe7FACd39531ee3C313330E93B4d7a8B8A3c84Aa4"
+  },
+  "ProxyAdmin": {
+    "1": "0x4200000000000000000000000000000000000018",
+    "5": "0x4200000000000000000000000000000000000018"
+  },
+  "SystemConfig": {
+    "1": "0x229047fed2591dbec1eF1118d64F7aF3dB9EB290",
+    "5": "0xAe851f927Ee40dE99aaBb7461C00f9622ab91d60"
+  },
+  "SystemDictator": {
+    "1": "0xB4453CEb33d2e67FA244A24acf2E50CEF31F53cB"
+  },
+  "SystemDictator_goerli": {
+    "5": "0x1f0613A44c9a8ECE7B3A2e0CdBdF0F5B47A50971"
+  },
+  "TeleportrWithdrawer": {
+    "1": "0x78A25524D90E3D0596558fb43789bD800a5c3007"
+  },
+  "AttestationStation": {
+    "10": "0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77",
+    "420": "0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77"
+  },
+  "L2ERC721Bridge": {
+    "10": "0x4200000000000000000000000000000000000014",
+    "420": "0x4200000000000000000000000000000000000014"
+  },
+  "MintManager": {
+    "10": "0x5C4e7Ba1E219E47948e6e3F55019A647bA501005",
+    "420": "0x038a8825A3C3B0c08d52Cc76E5E361953Cf6Dc76"
+  },
+  "OptimismMintableERC721Factory": {
+    "10": "0x4200000000000000000000000000000000000017"
+  },
+  "OptimismMintableERC721Factory_optimism-goerli": {
+    "420": "0x4200000000000000000000000000000000000017"
+  },
+  "Optimist": {
+    "10": "0x2335022c740d17c2837f9C884Bfe4fFdbf0A95D5",
+    "420": "0x2335022c740d17c2837f9C884Bfe4fFdbf0A95D5"
+  },
+  "OptimistAllowlist": {
+    "10": "0x482b1945D58f2E9Db0CEbe13c7fcFc6876b41180",
+    "420": "0x482b1945D58f2E9Db0CEbe13c7fcFc6876b41180"
+  },
+  "OptimistInviter": {
+    "10": "0x073031A1E1b8F5458Ed41Ce56331F5fd7e1de929",
+    "420": "0x073031A1E1b8F5458Ed41Ce56331F5fd7e1de929"
+  },
+  "BaseFeeVault": {
+    "420": "0x4200000000000000000000000000000000000019"
+  },
+  "GasPriceOracle": {
+    "420": "0x420000000000000000000000000000000000000F"
+  },
+  "L1Block": {
+    "420": "0x4200000000000000000000000000000000000015"
+  },
+  "L1FeeVault": {
+    "420": "0x420000000000000000000000000000000000001a"
+  },
+  "L2CrossDomainMessenger": {
+    "420": "0x4200000000000000000000000000000000000007"
+  },
+  "L2StandardBridge": {
+    "420": "0x4200000000000000000000000000000000000010"
+  },
+  "L2ToL1MessagePasser": {
+    "420": "0x4200000000000000000000000000000000000016"
+  },
+  "SequencerFeeVault": {
+    "420": "0x4200000000000000000000000000000000000011"
+  }
+}

packages/contracts-ts/example.env

+VITE_RPC_URL_L2_GOERLI=
+VITE_RPC_URL_L2_MAINNET=
+VITE_RPC_URL_L1_GOERLI=
+VITE_RPC_URL_L1_MAINNET=
+

packages/contracts-ts/package.json

+{
+  "name": "@eth-optimism/contracts-ts",
+  "version": "0.15.0",
+  "description": "TypeScript interface for Contracts Bedrock",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ethereum-optimism/optimism.git",
+    "directory": "packages/contracts-ts"
+  },
+  "homepage": "https://optimism.io",
+  "type": "module",
+  "main": "dist/constants.js",
+  "module": "dist/constants.mjs",
+  "types": "src/constants.ts",
+  "exports": {
+    ".": {
+      "types": "./src/constants.ts",
+      "import": "./dist/constants.js",
+      "require": "./dist/constants.cjs"
+    },
+    "./actions": {
+      "types": "./src/actions.ts",
+      "import": "./dist/actions.js",
+      "require": "./dist/actions.cjs"
+    },
+    "./react": {
+      "types": "./src/react.ts",
+      "import": "./dist/react.js",
+      "require": "./dist/react.cjs"
+    }
+  },
+  "files": [
+    "dist/",
+    "src/"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "generate": "wagmi generate && pnpm build && pnpm lint:fix",
+    "generate:check": "pnpm generate && git diff --exit-code ./addresses.json && git diff --exit-code ./abis.json",
+    "lint": "prettier --check .",
+    "lint:fix": "prettier --write .",
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@eth-optimism/contracts-bedrock": "workspace:*",
+    "@testing-library/jest-dom": "^5.17.0",
+    "@testing-library/react-hooks": "^8.0.1",
+    "@types/glob": "^8.1.0",
+    "@vitest/coverage-istanbul": "^0.33.0",
+    "@wagmi/cli": "^1.3.0",
+    "@wagmi/core": "^1.3.8",
+    "abitype": "^0.9.2",
+    "glob": "^10.3.3",
+    "isomorphic-fetch": "^3.0.0",
+    "jest-dom": "link:@types/@testing-library/jest-dom",
+    "jsdom": "^22.1.0",
+    "tsup": "^7.1.0",
+    "typescript": "^5.1.6",
+    "vite": "^4.4.4",
+    "vitest": "^0.33.0"
+  },
+  "peerDependencies": {
+    "@wagmi/core": ">1.0.0",
+    "wagmi": ">1.0.0"
+  },
+  "peerDependenciesMeta": {
+    "wagmi": {
+      "optional": true
+    },
+    "@wagmi/core": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@testing-library/react": "^14.0.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "viem": "^1.3.0"
+  }
+}

packages/contracts-ts/setupVitest.ts

+import fetch from 'isomorphic-fetch'
+
+// viem needs this
+global.fetch = fetch

packages/contracts-ts/src/constants.spec.ts

+import { test, expect } from 'vitest'
+import { addresses } from './constants'
+import { readFileSync } from 'fs'
+import { join } from 'path'
+
+const jsonAddresses = JSON.parse(
+  readFileSync(join(__dirname, '../addresses.json'), 'utf8')
+)
+
+test('should have generated addresses', () => {
+  expect(addresses).toEqual(jsonAddresses)
+})

packages/contracts-ts/src/react.spec.tsx

+import matchers from '@testing-library/jest-dom/matchers'
+import { cleanup, waitFor } from '@testing-library/react'
+import { renderHook } from '@testing-library/react-hooks'
+import { afterEach, expect, test } from 'vitest'
+import { useMintManagerOwner } from './react'
+import { configureChains, createConfig, WagmiConfig } from 'wagmi'
+import * as React from 'react'
+import { optimism } from 'viem/chains'
+import { jsonRpcProvider } from 'wagmi/providers/jsonRpc'
+
+expect.extend(matchers)
+
+afterEach(() => {
+  cleanup()
+})
+
+const { publicClient } = configureChains(
+  [optimism],
+  [
+    jsonRpcProvider({
+      rpc: () => ({
+        http:
+          import.meta.env.VITE_RPC_URL_L2_MAINNET ??
+          'https://mainnet.optimism.io',
+      }),
+    }),
+  ]
+)
+
+const config = createConfig({
+  publicClient: ({ chainId }) => publicClient({ chainId }),
+})
+
+const blockNumber = BigInt(106806163)
+
+test('react hooks should work', async () => {
+  const hook = renderHook(
+    () => useMintManagerOwner({ chainId: 10, blockNumber }),
+    {
+      wrapper: ({ children }) => (
+        <WagmiConfig config={config}>{children}</WagmiConfig>
+      ),
+    }
+  )
+  await waitFor(() => {
+    hook.rerender()
+    if (hook.result.current.error) throw hook.result.current.error
+    expect(hook.result.current?.data).toBeDefined()
+  })
+  const normalizedResult = {
+    ...hook.result.current,
+    internal: {
+      ...hook.result.current.internal,
+      dataUpdatedAt: 'SNAPSHOT_TEST_REMOVED!!!',
+    },
+  }
+  expect(normalizedResult).toMatchInlineSnapshot(`
+    {
+      "data": "0x2A82Ae142b2e62Cb7D10b55E323ACB1Cab663a26",
+      "error": null,
+      "fetchStatus": "idle",
+      "internal": {
+        "dataUpdatedAt": "SNAPSHOT_TEST_REMOVED!!!",
+        "errorUpdatedAt": 0,
+        "failureCount": 0,
+        "isFetchedAfterMount": true,
+        "isLoadingError": false,
+        "isPaused": false,
+        "isPlaceholderData": false,
+        "isPreviousData": false,
+        "isRefetchError": false,
+        "isStale": true,
+        "remove": [Function],
+      },
+      "isError": false,
+      "isFetched": true,
+      "isFetchedAfterMount": true,
+      "isFetching": false,
+      "isIdle": false,
+      "isLoading": false,
+      "isRefetching": false,
+      "isSuccess": true,
+      "refetch": [Function],
+      "status": "success",
+    }
+  `)
+})

packages/contracts-ts/src/vite-env.d.ts

+/// <reference types="vite/client" />

packages/contracts-ts/tsconfig.json

+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "baseUrl": "./src",
+    "strict": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "jsx": "react",
+    "target": "ESNext",
+    "noEmit": true
+  },
+  "include": ["./src"]
+}

packages/contracts-ts/tsup.config.ts

+import { defineConfig } from 'tsup'
+import packageJson from './package.json'
+
+export default defineConfig({
+  name: packageJson.name,
+  entry: ['src/constants.ts', 'src/actions.ts', 'src/react.ts'],
+  outDir: 'dist',
+  format: ['esm', 'cjs'],
+  splitting: false,
+  sourcemap: true,
+  clean: false,
+})

packages/contracts-ts/vite.config.ts

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