{"dist":{"shasum":"edffc464c4e37f7069531df0045046a0fa34c0da","tarball":"https://registry.npmjs.org/@eth-optimism/contracts/-/contracts-0.0.0-20215180366.tgz","fileCount":818,"integrity":"sha512-QMZodzyW07ia6nQIf14x9dpZf0Xx7LijwXWaPGXZdn+ZK+jYKks07LvC0kzTGsTb0Gkef9v7j0ogz4WLUwwGRA==","signatures":[{"sig":"MEUCIDjd7BLGSoZ3oRHIqNFNyPhTXEq0cpV3JCoToLxu/SMhAiEAmao5J1KsavX3J+xbdfCssgH2howNZy3yYhXSQ+jWcQU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":13257344,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgy+qACRA9TVsSAnZWagAAZnMQAI7cYD8Gp9PmI7789Pon\nxMrwTHN/A2NK5w/4Xru/6Rs9tVvxACW1DqTqgt0HQFgSEd+QfZnkx8I8u7Yq\n9Y6qEonXuJR8bbog4s6Nxx/nUxCGSPSLR0DDcfQWIPxAUqvQz1YyRdcMmQJx\nDYQcongEqns7ufkXkq/g55yfSeqqKC19T9V/mPx4yd4nWb/Ma53lPGU8wb3u\nyQA5NLEiX602FXXxLMYp0dkmbw3CNtCtTiFbysm086lEO0fnfSBLyUpj5AlI\nAHF9oWHByizQw6a6VCvnUWaBvex3eVqlPtBgo6GSS5aIQNlnd+auTQHjUIRZ\nk/62cOfqfqBTBD1mYgUlRnRxgR1L2mJtso27reulYuwG+bLEdZ166QX1V0IZ\nhvCG3rVR5hUkJNt9PGzVv72BwAYPR8og64/yDLwuAbH5Nq0vuq4y2Gb1drVq\nc9rMsWxHvXbAopp541W+GRCtdSe2ie4tURKXgPIv2hg8hWd8rXL+HsHb8NjL\nIB7HIB8kE0v01/4QRFp9KajpEo2CFsNBZAWbpEPDvktkIotZbldCBrROM/75\nGxYqtC2FEdRGeaf0wcJW6cbU31ySn3AzYMB8MHZQzvaTjm8JMU7bEY6FsSxd\nnebhByH1lk7KIl+kpkJxqVQCAmPqgq72aOomd6aySiJUNbTQea3IXFRK97ks\nVL0y\r\n=BaRX\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index","name":"@eth-optimism/contracts","types":"dist/index","author":{"name":"Optimism PBC"},"readme":"[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR)](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## 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","license":"MIT","scripts":{"all":"yarn clean && yarn build && yarn test && yarn lint:fix && yarn lint","lint":"yarn lint:fix && yarn lint:check","test":"yarn run test:contracts","build":"./scripts/build.sh","clean":"rm -rf ./dist ./artifacts ./artifacts-ovm ./cache ./cache-ovm ./tsconfig.build.tsbuildinfo","serve":"./bin/serve_dump.sh","deploy":"ts-node \"./bin/deploy.ts\" && yarn generate-markdown","prepack":"yarn prepublishOnly","lint:fix":"yarn run lint:fix:typescript","postpack":"yarn postpublish","test:gas":"hardhat test \"test/contracts/OVM/execution/OVM_StateManager.gas-spec.ts\" --no-compile --show-stack-traces","build:dump":"ts-node \"bin/take-dump.ts\"","lint:check":"yarn run lint:typescript","build:kovan":"yarn run build:contracts && yarn run build:typescript && yarn run build:copy && CHAIN_ID=69 yarn run build:dump && yarn run build:typechain","postpublish":"rimraf OVM iOVM libraries mockOVM","test:slither":"slither .","build:mainnet":"yarn run build:contracts && yarn run build:typescript && yarn run build:copy && CHAIN_ID=10 yarn run build:dump && yarn run build:typechain","test:coverage":"NODE_OPTIONS=--max_old_space_size=8192 hardhat coverage","prepublishOnly":"yarn copyfiles -u 2 \"contracts/optimistic-ethereum/**/*\" ./","test:contracts":"hardhat test --show-stack-traces","build:contracts":"hardhat compile --show-stack-traces","build:typechain":"hardhat typechain","lint:typescript":"eslint -c .eslintrc.js --ext .ts --format stylish .","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","build:typescript":"tsc -p ./tsconfig.build.json","posttest:slither":"rm -f @openzeppelin && rm -f @ens && rm -f hardhat","generate-markdown":"node \"./scripts/generate-markdown.js\"","build:contracts:ovm":"hardhat compile --network optimism","build:typechain:ovm":"hardhat --network optimism typechain","lint:fix:typescript":"prettier --config .prettierrc.json --write \"hardhat.config.ts\" \"{src,test}/**/*.ts\""},"_npmUser":{"name":"karlfloersch","email":"karl@karl.tech"},"_npmVersion":"6.14.12","description":"[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR)](https://codecov.io/gh/ethereum-optimism/optimism)","directories":{},"maintainers":[{"name":"karlfloersch","email":"karl@karl.tech"},{"name":"ben-chain","email":"ben@optimism.io"},{"name":"will_optimism","email":"will@optimism.io"},{"name":"k-ho","email":"kevin@optimism.io"},{"name":"tynes","email":"tyneway12@gmail.com"},{"name":"kelvinfichter","email":"kelvinfichter@gmail.com"}],"_nodeVersion":"12.22.1","dependencies":{"glob":"^7.1.6","@eth-optimism/core-utils":"^0.4.5","@ethersproject/contracts":"^5.0.5","@ethersproject/abstract-signer":"^5.1.0","@ethersproject/abstract-provider":"^5.0.8"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rlp":"^2.2.6","chai":"^4.3.1","mocha":"^8.3.0","yargs":"^16.2.0","dotenv":"^8.2.0","eslint":"^7.27.0","ethers":"^5.0.31","lodash":"^4.17.20","mkdirp":"^1.0.4","hardhat":"^2.2.1","ts-node":"^9.1.1","prettier":"^2.2.1","copyfiles":"^2.3.0","typechain":"2.0.0","buffer-xor":"^2.0.2","@types/chai":"^4.2.17","@types/glob":"^7.1.3","@types/mocha":"^8.2.2","@types/yargs":"^16.0.1","ganache-core":"^2.13.2","merkletreejs":"^0.2.12","ts-generator":"0.0.8","@types/lodash":"^4.14.161","@types/mkdirp":"^1.0.1","directory-tree":"^2.2.7","hardhat-deploy":"^0.7.4","ethereum-waffle":"^3.3.0","@types/copyfiles":"^2.4.0","@types/buffer-xor":"^2.0.0","eslint-plugin-ban":"^1.5.2","random-bytes-seed":"^1.0.3","solidity-coverage":"^0.7.16","@codechecks/client":"0.1.10-beta","@typechain/hardhat":"^1.0.1","@eth-optimism/smock":"^0.0.0-20215180366","eslint-plugin-jsdoc":"^35.1.2","eslint-plugin-react":"^7.24.0","@typechain/ethers-v5":"1.0.0","eslint-plugin-import":"^2.23.4","hardhat-gas-reporter":"^1.0.4","merkle-patricia-tree":"^4.0.0","eslint-plugin-unicorn":"^32.0.1","eslint-config-prettier":"^8.3.0","@openzeppelin/contracts":"^3.3.0","@eth-optimism/hardhat-ovm":"^0.2.2","@nomiclabs/hardhat-ethers":"^2.0.1","@nomiclabs/hardhat-waffle":"^2.0.1","@typescript-eslint/parser":"^4.26.0","eslint-plugin-prefer-arrow":"^1.2.3","@typescript-eslint/eslint-plugin":"^4.26.0","@openzeppelin/contracts-upgradeable":"^3.3.0"},"peerDependencies":{"ethers":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/contracts_0.0.0-20215180366_1623976575846_0.0503346901196704","host":"s3://npm-registry-packages"},"_id":"@eth-optimism/contracts@0.0.0-20215180366","version":"0.0.0-20215180366"}