{"_id":"@bobanetwork/core_contracts","_rev":"2-9f9853bdf39b819e8a244f6519c095b5","name":"@bobanetwork/core_contracts","dist-tags":{"latest":"0.5.13"},"versions":{"0.5.11":{"name":"@bobanetwork/core_contracts","version":"0.5.11","description":"[Optimism and Boba Network] L1 and L2 smart contracts for Optimism and Boba Network","main":"dist/index","types":"dist/index","scripts":{"deploy":"ts-node bin/deploy.ts","build":"yarn build:contracts && yarn autogen:artifacts && yarn build:typescript","build:typescript":"tsc -p ./tsconfig.json","build:contracts":"hardhat compile --show-stack-traces","build:dump":"ts-node bin/take-dump.ts","autogen:markdown":"ts-node scripts/generate-markdown.ts","autogen:artifacts":"ts-node scripts/generate-artifacts.ts && ts-node scripts/generate-deployed-artifacts.ts","test":"yarn test:contracts","test:contracts":"hardhat test --show-stack-traces","test:coverage":"NODE_OPTIONS=--max_old_space_size=8192 hardhat coverage && istanbul check-coverage --statements 79 --branches 63 --functions 71 --lines 79","test:slither":"slither .","pretest:slither":"rm -f @openzeppelin && rm -f @ens && rm -f hardhat && ln -s ../../node_modules/@openzeppelin @openzeppelin && ln -s ../../node_modules/@ens @ens && ln -s ../../node_modules/hardhat hardhat","posttest:slither":"rm -f @openzeppelin && rm -f @ens && rm -f hardhat","lint:ts:check":"eslint . --max-warnings=0","lint:contracts:check":"yarn solhint -f table 'contracts/**/*.sol'","lint:check":"yarn lint:contracts:check && yarn lint:ts:check","lint:ts:fix":"eslint --fix .","lint:contracts:fix":"yarn prettier --write 'contracts/**/*.sol'","lint:fix":"yarn lint:contracts:fix && yarn lint:ts:fix","lint":"yarn lint:fix && yarn lint:check","clean":"rm -rf ./dist ./artifacts ./cache ./coverage ./tsconfig.tsbuildinfo","prepublishOnly":"yarn copyfiles -u 1 -e \"**/test-*/**/*\" \"contracts/**/*\" ./","postpublish":"rimraf chugsplash L1 L2 libraries standards","prepack":"yarn prepublishOnly","postpack":"yarn postpublish","pre-commit":"lint-staged","validateDocs":"hardhat validateOutput"},"keywords":["optimism","ethereum","contracts","solidity"],"homepage":"https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts#readme","license":"MIT","author":{"name":"Optimism PBC"},"repository":{"type":"git","url":"https://github.com/ethereum-optimism/optimism.git"},"dependencies":{"@eth-optimism/core-utils":"0.8.1","@ethersproject/abstract-provider":"^5.5.0","@ethersproject/abstract-signer":"^5.5.0","@ethersproject/hardware-wallets":"^5.5.0"},"devDependencies":{"@boba/turing-hybrid-compute":"^0.2.0","@openzeppelin/contracts":"4.3.2","@openzeppelin/contracts-upgradeable":"4.3.2","@codechecks/client":"^0.1.11","@defi-wonderland/smock":"^2.0.2","@nomiclabs/hardhat-ethers":"^2.0.2","@nomiclabs/hardhat-etherscan":"^3.1.0","@nomiclabs/hardhat-waffle":"^2.0.1","@typechain/ethers-v5":"^10.1.0","@typechain/hardhat":"^6.1.2","@types/chai":"^4.2.18","@types/lodash":"^4.14.168","@types/mocha":"^8.2.2","@types/node":"^17.0.21","chai":"^4.3.4","copyfiles":"^2.3.0","directory-tree":"^2.2.7","dotenv":"^10.0.0","eslint":"^7.27.0","@babel/eslint-parser":"^7.18.2","@typescript-eslint/eslint-plugin":"^5.45.1","@typescript-eslint/parser":"^5.45.1","eslint-config-prettier":"^8.3.0","eslint-plugin-jsdoc":"^46.2.6","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-import":"^2.26.0","eslint-plugin-prettier":"^3.4.0","eslint-plugin-react":"^7.24.0","eslint-plugin-unicorn":"^32.0.1","ethereum-waffle":"^3.3.0","ethers":"^5.5.4","glob":"^7.1.6","hardhat":"^2.12.5","hardhat-deploy":"^0.11.12","hardhat-gas-reporter":"^1.0.4","hardhat-output-validator":"^0.1.18","istanbul":"^0.4.5","lint-staged":"11.0.0","lodash":"^4.17.21","merkle-patricia-tree":"^4.0.0","merkletreejs":"^0.2.18","mkdirp":"^3.0.1","mocha":"^8.4.0","prettier":"^2.3.1","prettier-plugin-solidity":"^1.0.0-beta.18","random-bytes-seed":"^1.0.3","rlp":"^2.2.6","solhint":"^3.3.6","solhint-plugin-prettier":"^0.0.5","solidity-coverage":"^0.7.17","ts-generator":"0.1.1","ts-node":"10.9.1","typechain":"^8.1.0","typescript":"^4.3.5","yargs":"^17.7.2"},"peerDependencies":{"ethers":"^5.5.4"},"licenseText":"(The MIT License)\n\nCopyright 2020-2021 Optimism\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","_id":"@bobanetwork/core_contracts@0.5.11","dist":{"shasum":"4c219d8d43294aa91976825ed3da06dc983c727d","integrity":"sha512-9JK67iVNgrlr6B3xxiUzYm22/q5cG9VrrrOC4Bzu3HeNroFLoDjVAHf669kUx9Wf9lsSz2NFAifPsOCIcMGbgQ==","tarball":"https://registry.npmjs.org/@bobanetwork/core_contracts/-/core_contracts-0.5.11.tgz","fileCount":692,"unpackedSize":3667675,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICahk/g4szy/ne2tjXQQAGY5InZKe4i3DnYfyzNubOZIAiAnUw3bLv5Jv2iYNy2YZpiczTOYcjjgrII3Vm8ZeAppyw=="}]},"_npmUser":{"name":"boba.network","email":"chaininfra@boba.foundation"},"directories":{},"maintainers":[{"name":"boba.network","email":"chaininfra@boba.foundation"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/core_contracts_0.5.11_1695915921208_0.25997534478725925"},"_hasShrinkwrap":false},"0.5.12":{"name":"@bobanetwork/core_contracts","version":"0.5.12","description":"[Optimism and Boba Network] L1 and L2 smart contracts for Optimism and Boba Network","main":"dist/index","types":"dist/index","scripts":{"deploy":"ts-node bin/deploy.ts","build":"yarn build:contracts && yarn autogen:artifacts && yarn build:typescript","build:typescript":"tsc -p ./tsconfig.json","build:contracts":"hardhat compile --show-stack-traces","build:dump":"ts-node bin/take-dump.ts","autogen:markdown":"ts-node scripts/generate-markdown.ts","autogen:artifacts":"ts-node scripts/generate-artifacts.ts && ts-node scripts/generate-deployed-artifacts.ts","test":"yarn test:contracts","test:contracts":"hardhat test --show-stack-traces","test:coverage":"NODE_OPTIONS=--max_old_space_size=8192 hardhat coverage && istanbul check-coverage --statements 79 --branches 63 --functions 71 --lines 79","test:slither":"slither .","pretest:slither":"rm -f @openzeppelin && rm -f @ens && rm -f hardhat && ln -s ../../node_modules/@openzeppelin @openzeppelin && ln -s ../../node_modules/@ens @ens && ln -s ../../node_modules/hardhat hardhat","posttest:slither":"rm -f @openzeppelin && rm -f @ens && rm -f hardhat","lint:ts:check":"eslint . --max-warnings=0","lint:contracts:check":"yarn solhint -f table 'contracts/**/*.sol'","lint:check":"yarn lint:contracts:check && yarn lint:ts:check","lint:ts:fix":"eslint --fix .","lint:contracts:fix":"yarn prettier --write 'contracts/**/*.sol'","lint:fix":"yarn lint:contracts:fix && yarn lint:ts:fix","lint":"yarn lint:fix && yarn lint:check","clean":"rm -rf ./dist ./artifacts ./cache ./coverage ./tsconfig.tsbuildinfo","prepublishOnly":"yarn copyfiles -u 1 -e \"**/test-*/**/*\" \"contracts/**/*\" ./","postpublish":"rimraf chugsplash L1 L2 libraries standards","prepack":"yarn prepublishOnly","postpack":"yarn postpublish","pre-commit":"lint-staged","validateDocs":"hardhat validateOutput"},"keywords":["optimism","ethereum","contracts","solidity"],"homepage":"https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts#readme","license":"MIT","author":{"name":"Optimism PBC"},"repository":{"type":"git","url":"https://github.com/ethereum-optimism/optimism.git"},"dependencies":{"@eth-optimism/core-utils":"0.8.1","@ethersproject/abstract-provider":"^5.5.0","@ethersproject/abstract-signer":"^5.5.0","@ethersproject/hardware-wallets":"^5.5.0"},"devDependencies":{"@boba/turing-hybrid-compute":"^0.2.0","@openzeppelin/contracts":"4.3.2","@openzeppelin/contracts-upgradeable":"4.3.2","@codechecks/client":"^0.1.11","@defi-wonderland/smock":"^2.0.2","@nomiclabs/hardhat-ethers":"^2.0.2","@nomiclabs/hardhat-etherscan":"^3.1.0","@nomiclabs/hardhat-waffle":"^2.0.1","@typechain/ethers-v5":"^10.1.0","@typechain/hardhat":"^6.1.2","@types/chai":"^4.2.18","@types/lodash":"^4.14.168","@types/mocha":"^8.2.2","@types/node":"^17.0.21","chai":"^4.3.4","copyfiles":"^2.3.0","directory-tree":"^2.2.7","dotenv":"^10.0.0","eslint":"^7.27.0","@babel/eslint-parser":"^7.18.2","@typescript-eslint/eslint-plugin":"^5.45.1","@typescript-eslint/parser":"^5.45.1","eslint-config-prettier":"^8.3.0","eslint-plugin-jsdoc":"^46.2.6","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-import":"^2.26.0","eslint-plugin-prettier":"^3.4.0","eslint-plugin-react":"^7.24.0","eslint-plugin-unicorn":"^32.0.1","ethereum-waffle":"^3.3.0","ethers":"^5.5.4","glob":"^7.1.6","hardhat":"^2.12.5","hardhat-deploy":"^0.11.12","hardhat-gas-reporter":"^1.0.4","hardhat-output-validator":"^0.1.18","istanbul":"^0.4.5","lint-staged":"11.0.0","lodash":"^4.17.21","merkle-patricia-tree":"^4.0.0","merkletreejs":"^0.2.18","mkdirp":"^3.0.1","mocha":"^8.4.0","prettier":"^2.3.1","prettier-plugin-solidity":"^1.0.0-beta.18","random-bytes-seed":"^1.0.3","rlp":"^2.2.6","solhint":"^3.3.6","solhint-plugin-prettier":"^0.0.5","solidity-coverage":"^0.7.17","ts-generator":"0.1.1","ts-node":"10.9.1","typechain":"^8.1.0","typescript":"^4.3.5","yargs":"^17.7.2"},"peerDependencies":{"ethers":"^5.5.4"},"licenseText":"(The MIT License)\n\nCopyright 2020-2021 Optimism\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","_id":"@bobanetwork/core_contracts@0.5.12","dist":{"shasum":"e77fd7701451ae245aa78971d11312e5bfbb04d0","integrity":"sha512-8c000xMwHJSkWMU0XvYNIqDewAcENUNDeA+pS7CmzW8mFY9ZZ2wNAvtI13RYkhaQEAZEVGYR37FE8NjXAVpFKg==","tarball":"https://registry.npmjs.org/@bobanetwork/core_contracts/-/core_contracts-0.5.12.tgz","fileCount":859,"unpackedSize":17141386,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGFwZR3FubMt1bM+He5VP1eHzwZkgjz1xgW1aL8j6KBHAiEAoRjx1MK9CDoYMQKZ7Zt1GIK14TN3ahlNDNkWIfWArFw="}]},"_npmUser":{"name":"boba.network","email":"chaininfra@boba.foundation"},"directories":{},"maintainers":[{"name":"boba.network","email":"chaininfra@boba.foundation"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/core_contracts_0.5.12_1695982283897_0.9624893974948339"},"_hasShrinkwrap":false},"0.5.13":{"name":"@bobanetwork/core_contracts","version":"0.5.13","description":"[Optimism and Boba Network] L1 and L2 smart contracts for Optimism and Boba Network","main":"dist/index","types":"dist/index","scripts":{"deploy":"ts-node bin/deploy.ts","build":"yarn build:contracts && yarn autogen:artifacts && yarn build:typescript","build:typescript":"tsc -p ./tsconfig.json","build:contracts":"hardhat compile --show-stack-traces","build:dump":"ts-node bin/take-dump.ts","autogen:markdown":"ts-node scripts/generate-markdown.ts","autogen:artifacts":"ts-node scripts/generate-artifacts.ts && ts-node scripts/generate-deployed-artifacts.ts","test":"yarn test:contracts","test:contracts":"hardhat test --show-stack-traces","test:coverage":"NODE_OPTIONS=--max_old_space_size=8192 hardhat coverage && istanbul check-coverage --statements 79 --branches 63 --functions 71 --lines 79","test:slither":"slither .","pretest:slither":"rm -f @openzeppelin && rm -f @ens && rm -f hardhat && ln -s ../../node_modules/@openzeppelin @openzeppelin && ln -s ../../node_modules/@ens @ens && ln -s ../../node_modules/hardhat hardhat","posttest:slither":"rm -f @openzeppelin && rm -f @ens && rm -f hardhat","lint:ts:check":"eslint . --max-warnings=0","lint:contracts:check":"yarn solhint -f table 'contracts/**/*.sol'","lint:check":"yarn lint:contracts:check && yarn lint:ts:check","lint:ts:fix":"eslint --fix .","lint:contracts:fix":"yarn prettier --write 'contracts/**/*.sol'","lint:fix":"yarn lint:contracts:fix && yarn lint:ts:fix","lint":"yarn lint:fix && yarn lint:check","clean":"rm -rf ./dist ./artifacts ./cache ./coverage ./tsconfig.tsbuildinfo","prepublishOnly":"yarn copyfiles -u 1 -e \"**/test-*/**/*\" \"contracts/**/*\" ./","postpublish":"rimraf chugsplash L1 L2 libraries standards","prepack":"yarn prepublishOnly","postpack":"yarn postpublish","pre-commit":"lint-staged","validateDocs":"hardhat validateOutput"},"keywords":["optimism","ethereum","contracts","solidity"],"homepage":"https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts#readme","license":"MIT","author":{"name":"Optimism PBC"},"repository":{"type":"git","url":"https://github.com/ethereum-optimism/optimism.git"},"dependencies":{"@eth-optimism/core-utils":"0.8.1","@ethersproject/abstract-provider":"^5.5.0","@ethersproject/abstract-signer":"^5.5.0","@ethersproject/hardware-wallets":"^5.5.0"},"devDependencies":{"@boba/turing-hybrid-compute":"^0.2.0","@openzeppelin/contracts":"4.3.2","@openzeppelin/contracts-upgradeable":"4.3.2","@codechecks/client":"^0.1.11","@defi-wonderland/smock":"^2.0.2","@nomiclabs/hardhat-ethers":"^2.0.2","@nomiclabs/hardhat-etherscan":"^3.1.0","@nomiclabs/hardhat-waffle":"^2.0.1","@typechain/ethers-v5":"^10.1.0","@typechain/hardhat":"^6.1.2","@types/chai":"^4.2.18","@types/lodash":"^4.14.168","@types/mocha":"^8.2.2","@types/node":"^17.0.21","chai":"^4.3.4","copyfiles":"^2.3.0","directory-tree":"^2.2.7","dotenv":"^10.0.0","eslint":"^7.27.0","@babel/eslint-parser":"^7.18.2","@typescript-eslint/eslint-plugin":"^5.45.1","@typescript-eslint/parser":"^5.45.1","eslint-config-prettier":"^8.3.0","eslint-plugin-jsdoc":"^46.2.6","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-import":"^2.26.0","eslint-plugin-prettier":"^3.4.0","eslint-plugin-react":"^7.24.0","eslint-plugin-unicorn":"^32.0.1","ethereum-waffle":"^3.3.0","ethers":"^5.5.4","glob":"^7.1.6","hardhat":"^2.12.5","hardhat-deploy":"^0.11.12","hardhat-gas-reporter":"^1.0.4","hardhat-output-validator":"^0.1.18","istanbul":"^0.4.5","lint-staged":"11.0.0","lodash":"^4.17.21","merkle-patricia-tree":"^4.0.0","merkletreejs":"^0.2.18","mkdirp":"^3.0.1","mocha":"^8.4.0","prettier":"^2.3.1","prettier-plugin-solidity":"^1.0.0-beta.18","random-bytes-seed":"^1.0.3","rlp":"^2.2.6","solhint":"^3.3.6","solhint-plugin-prettier":"^0.0.5","solidity-coverage":"^0.7.17","ts-generator":"0.1.1","ts-node":"10.9.1","typechain":"^8.1.0","typescript":"^4.3.5","yargs":"^17.7.2"},"peerDependencies":{"ethers":"^5.5.4"},"licenseText":"(The MIT License)\n\nCopyright 2020-2021 Optimism\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","_id":"@bobanetwork/core_contracts@0.5.13","dist":{"shasum":"af445c7f8a34f0e0c1700daf555b67474665a999","integrity":"sha512-oCA/28/ZAeT0g+oPfd5c/U8UTGWSjFT9HP3CILJ7jlNzGjhx9w7Bg+fvMv+QwphuS8BMgSDdnw8Q/fiJizwT6w==","tarball":"https://registry.npmjs.org/@bobanetwork/core_contracts/-/core_contracts-0.5.13.tgz","fileCount":909,"unpackedSize":17372498,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDBuA+MnHFczKjerjP0d5wj8nXs4ouMPlArKxg2LvbksAiEA1hl/qQfAcC0sZ5i/JKfmOFrpEiL6azIsv2K0JmG1Se0="}]},"_npmUser":{"name":"boba.network","email":"chaininfra@boba.foundation"},"directories":{},"maintainers":[{"name":"boba.network","email":"chaininfra@boba.foundation"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/core_contracts_0.5.13_1695982688098_0.9854303656144587"},"_hasShrinkwrap":false}},"time":{"created":"2023-09-28T15:45:21.086Z","0.5.11":"2023-09-28T15:45:21.622Z","modified":"2023-09-29T10:18:08.688Z","0.5.12":"2023-09-29T10:11:24.117Z","0.5.13":"2023-09-29T10:18:08.448Z"},"maintainers":[{"name":"boba.network","email":"chaininfra@boba.foundation"}],"description":"[Optimism and Boba Network] L1 and L2 smart contracts for Optimism and Boba Network","homepage":"https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts#readme","keywords":["optimism","ethereum","contracts","solidity"],"repository":{"type":"git","url":"https://github.com/ethereum-optimism/optimism.git"},"author":{"name":"Optimism PBC"},"license":"MIT","readme":"[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR&flag=contracts)](https://codecov.io/gh/ethereum-optimism/optimism)\n\n# Optimistic Ethereum Smart Contracts\n\n`@eth-optimism/contracts` contains the various Solidity smart contracts used within the Optimistic Ethereum system.\nSome of these contracts are deployed on Ethereum (\"Layer 1\"), while others are meant to be deployed to Optimistic Ethereum (\"Layer 2\").\n\nWithin each contract file you'll find a comment that lists:\n1. The compiler with which a contract is intended to be compiled, `solc` or `optimistic-solc`.\n2. The network upon to which the contract will be deployed, `OVM` or `EVM`.\n\nA more detailed overview of these contracts can be found on the [community hub](http://community.optimism.io/docs/protocol/protocol.html#system-overview).\n\n<!-- TODO: Add link to final contract docs here when finished. -->\n\n## Usage (npm)\nIf your development stack is based on Node/npm:\n\n```shell\nnpm install @eth-optimism/contracts\n```\n\nWithin your contracts:\n\n```solidity\nimport { SomeContract } from \"@eth-optimism/contracts/SomeContract.sol\";\n```\n\n## Guide for Developers\n### Setup\nInstall the following:\n- [`Node.js` (14+)](https://nodejs.org/en/)\n- [`npm`](https://www.npmjs.com/get-npm)\n- [`yarn`](https://classic.yarnpkg.com/en/docs/install/)\n\nClone the repo:\n\n```shell\ngit clone https://github.com/ethereum-optimism/contracts.git\ncd contracts\n```\n\nInstall `npm` packages:\n```shell\nyarn install\n```\n\n### Running Tests\nTests are executed via `yarn`:\n```shell\nyarn test\n```\n\nRun specific tests by giving a path to the file you want to run:\n```shell\nyarn test ./test/path/to/my/test.spec.ts\n```\n\n### Measuring test coverage:\n```shell\nyarn test:coverage\n```\n\nThe output is most easily viewable by opening the html file in your browser:\n```shell\nopen ./coverage/index.html\n```\n\n### Compiling and Building\nEasiest way is to run the primary build script:\n```shell\nyarn build\n```\n\nRunning the full build command will perform the following actions:\n1. `build:contracts` - Compile all Solidity contracts with both the EVM and OVM compilers.\n2. `build:typescript` - Builds the typescript files that are used to export utilities into js.\n3. `build:copy` - Copies various other files into the dist folder.\n4. `build:dump` - Generates a genesis state from the contracts that L2 geth will use.\n5. `build:typechain` - Generates [TypeChain](https://github.com/ethereum-ts/TypeChain) artifacts.\n\nYou can also build specific components as follows:\n```shell\nyarn build:contracts\n```\n\n### Deploying the Contracts\nTo deploy the contracts first clone, install, and build the contracts package.\n\nNext set the following env vars:\n\n```bash\nCONTRACTS_TARGET_NETWORK=...\nCONTRACTS_DEPLOYER_KEY=...\nCONTRACTS_RPC_URL=...\n```\n\nThen to perform the actual deployment run:\n\n```bash\nnpx hardhat deploy \\\n  --network ... \\  # `network` MUST equal your env var `CONTRACTS_TARGET_NETWORK`\n  --ovm-address-manager-owner ... \\\n  --ovm-proposer-address ... \\\n  --ovm-relayer-address ... \\\n  --ovm-sequencer-address ... \\\n  --scc-fraud-proof-window ... \\\n  --scc-sequencer-publish-window ...\n```\n\nThis will deploy the contracts to the network specified in your env and create\nan artifacts directory in `./deployments`.\n\nTo view all deployment options run:\n\n```bash\nnpx hardhat deploy --help\n\nHardhat version 2.2.1\n\nUsage: hardhat [GLOBAL OPTIONS] deploy [--ctc-force-inclusion-period-seconds <INT>] [--ctc-max-transaction-gas-limit <INT>] --deploy-scripts <STRING> [--em-max-gas-per-queue-per-epoch <INT>] [--em-max-transaction-gas-limit <INT>] [--em-min-transaction-gas-limit <INT>] [--em-ovm-chain-id <INT>] [--em-seconds-per-epoch <INT>] --export <STRING> --export-all <STRING> --gasprice <STRING> [--l1-block-time-seconds <INT>] [--no-compile] [--no-impersonation] --ovm-address-manager-owner <STRING> --ovm-proposer-address <STRING> --ovm-relayer-address <STRING> --ovm-sequencer-address <STRING> [--reset] [--scc-fraud-proof-window <INT>] [--scc-sequencer-publish-window <INT>] [--silent] --tags <STRING> [--watch] --write <BOOLEAN>\n\nOPTIONS:\n\n  --ctc-force-inclusion-period-seconds  Number of seconds that the sequencer has to include transactions before the L1 queue. (default: 2592000)\n  --ctc-max-transaction-gas-limit       Max gas limit for L1 queue transactions. (default: 9000000)\n  --deploy-scripts                      override deploy script folder path\n  --em-max-gas-per-queue-per-epoch      Maximum gas allowed in a given queue for each epoch. (default: 250000000)\n  --em-max-transaction-gas-limit        Maximum allowed transaction gas limit. (default: 9000000)\n  --em-min-transaction-gas-limit        Minimum allowed transaction gas limit. (default: 50000)\n  --em-ovm-chain-id                     Chain ID for the L2 network. (default: 420)\n  --em-seconds-per-epoch                Number of seconds in each epoch. (default: 0)\n  --export                              export current network deployments\n  --export-all                          export all deployments into one file\n  --gasprice                            gas price to use for transactions\n  --l1-block-time-seconds               Number of seconds on average between every L1 block. (default: 15)\n  --no-compile                          disable pre compilation\n  --no-impersonation                    do not impersonate unknown accounts\n  --ovm-address-manager-owner           Address that will own the Lib_AddressManager. Must be provided or this deployment will fail.\n  --ovm-proposer-address                Address of the account that will propose state roots. Must be provided or this deployment will fail.\n  --ovm-relayer-address                 Address of the message relayer. Must be provided or this deployment will fail.\n  --ovm-sequencer-address               Address of the sequencer. Must be provided or this deployment will fail.\n  --reset                               whether to delete deployments files first\n  --scc-fraud-proof-window              Number of seconds until a transaction is considered finalized. (default: 604800)\n  --scc-sequencer-publish-window        Number of seconds that the sequencer is exclusively allowed to post state roots. (default: 1800)\n  --silent                              whether to remove log\n  --tags                                specify which deploy script to execute via tags, separated by commas\n  --watch                               redeploy on every change of contract or deploy script\n  --write                               whether to write deployments to file\n\ndeploy: Deploy contracts\n\nFor global options help run: hardhat help\n```\n\n### Verifying Deployments on Etherscan\nIf you are using a network which Etherscan supports you can verify your contracts with:\n\n```bash\nnpx hardhat etherscan-verify --api-key ... --network ...\n```\n\n### Other hardhat tasks\n\nTo whitelist deployers on Mainnet you must have the whitelist Owner wallet connected, then run:\n```bash\nnpx hardhat whitelist \\\n  --use-ledger true \\\n  --contracts-rpc-url https://mainnet.optimism.io \\\n  --address ... \\ # address to whitelist\n```\n\nTo withdraw ETH fees to L1 on Mainnet, run:\n```bash\nnpx hardhat withdraw-fees \\\n  --use-ledger \\  # The ledger to withdraw fees with. Ensure this wallet has ETH on L2 to pay the tx fee.\n  --contracts-rpc-url https://mainnet.optimism.io \\\n```\n\n\n## Security\nPlease refer to our [Security Policy](https://github.com/ethereum-optimism/.github/security/policy) for information about how to disclose security issues with this code.\n","readmeFilename":"README.md"}