-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add ts contract package for TS
different package nah do it right
- Loading branch information
Will Cory
authored and
Will Cory
committed
Jul 12, 2023
1 parent
8087e2b
commit 5fb79b4
Showing
14 changed files
with
36,659 additions
and
222 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
| "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json", | ||
| "changelog": "@changesets/cli/changelog", | ||
| "commit": false, | ||
| "linked": [], | ||
| "linked": [["contracts-bedrock", "contracts-ts"]], | ||
| "access": "public", | ||
| "baseBranch": "master", | ||
| "updateInternalDependencies": "patch", | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| artifacts | ||
| cache | ||
| typechain | ||
| .deps | ||
| .envrc | ||
| .env | ||
| /dist/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| ## Contracts TS | ||
|
|
||
| [](https://codecov.io/gh/ethereum-optimism/optimism) | ||
|
|
||
| ABI and Address constants + generated code from [@eth-optimism/contracts-bedrock/](../contracts-bedrock/) for use in TypeScript. Generated using [@wagmi/cli](https://wagmi.sh/cli) | ||
|
|
||
| #### @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) | ||
| ``` | ||
|
|
||
| #### @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) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| { | ||
| "AddressManager": { | ||
| "1": "0xdE1FCfB0851916CA5101820A69b13a4E276bd81F", | ||
| "5": "0xa6f73589243a6A7a9023b1Fa0651b1d89c177111" | ||
| }, | ||
| "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": "0xB4453CEb33d2e67FA244A24acf2E50CEF31F53cB", | ||
| "SystemDictator_goerli": "0x1f0613A44c9a8ECE7B3A2e0CdBdF0F5B47A50971", | ||
| "MintManager": { | ||
| "10": "0x5C4e7Ba1E219E47948e6e3F55019A647bA501005", | ||
| "420": "0x038a8825A3C3B0c08d52Cc76E5E361953Cf6Dc76" | ||
| }, | ||
| "OptimismMintableERC721Factory": "0x4200000000000000000000000000000000000017", | ||
| "OptimismMintableERC721Factory_optimism-goerli": "0x4200000000000000000000000000000000000017", | ||
| "BaseFeeVault": { | ||
| "420": "0x4200000000000000000000000000000000000019" | ||
| }, | ||
| "GasPriceOracle": { | ||
| "420": "0x420000000000000000000000000000000000000F" | ||
| }, | ||
| "L1Block": { | ||
| "420": "0x4200000000000000000000000000000000000015" | ||
| }, | ||
| "L1FeeVault": { | ||
| "420": "0x420000000000000000000000000000000000001a" | ||
| }, | ||
| "L2CrossDomainMessenger": { | ||
| "420": "0x4200000000000000000000000000000000000007" | ||
| }, | ||
| "L2ERC721Bridge": { | ||
| "420": "0x4200000000000000000000000000000000000014" | ||
| }, | ||
| "L2StandardBridge": { | ||
| "420": "0x4200000000000000000000000000000000000010" | ||
| }, | ||
| "L2ToL1MessagePasser": { | ||
| "420": "0x4200000000000000000000000000000000000016" | ||
| }, | ||
| "SequencerFeeVault": { | ||
| "420": "0x4200000000000000000000000000000000000011" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| { | ||
| "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/index.js", | ||
| "module": "dist/index.mjs", | ||
| "types": "src/index.ts", | ||
| "exports": { | ||
| ".": { | ||
| "types": "./src/index.ts", | ||
| "import": "./dist/index.js", | ||
| "require": "./dist/index.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", | ||
| "test": "NODE_OPTIONS=--experimental-fetch vitest" | ||
| }, | ||
| "devDependencies": { | ||
| "@eth-optimism/contracts-bedrock": "workspace:0.15.0", | ||
| "@types/glob": "^8.1.0", | ||
| "@typescript-eslint/eslint-plugin": "^5.60.1", | ||
| "@typescript-eslint/parser": "^5.60.1", | ||
| "@wagmi/cli": "^1.3.0", | ||
| "abitype": "^0.9.0", | ||
| "ds-test": "github:dapphub/ds-test#c9ce3f25bde29fc5eb9901842bf02850dfd2d084", | ||
| "forge-std": "github:foundry-rs/forge-std#e8a047e3f40f13fa37af6fe14e6e06283d9a060e", | ||
| "glob": "^7.2.3", | ||
| "solhint": "^3.4.1", | ||
| "solhint-plugin-prettier": "^0.0.5", | ||
| "ts-node": "^10.9.1", | ||
| "tsup": "^7.1.0", | ||
| "typescript": "^4.9.3" | ||
| }, | ||
| "peerDependencies": { | ||
| "@wagmi/core": ">1.0.0", | ||
| "wagmi": ">1.0.0" | ||
| }, | ||
| "peerDependenciesMeta": { | ||
| "wagmi": { | ||
| "optional": true | ||
| }, | ||
| "@wagmi/core": { | ||
| "optional": true | ||
| } | ||
| }, | ||
| "dependencies": { | ||
| "viem": "^0.3.30", | ||
| "vitest": "^0.28.3" | ||
| } | ||
| } |
Oops, something went wrong.