minor updates for l1 contract deployments #810
Conversation
WalkthroughThe recent documentation updates enhance guidance on deploying OP Stack L1 smart contracts and managing deployment artifacts. Key changes include advising users to utilize only official contract releases for greater stability and clarifying the creation of a deployment configuration file within a monorepo. Additionally, a new section on preserving deployment artifacts has been added to promote best practices for developers, ensuring a more robust deployment process. Changes
Possibly related issues
Recent review detailsConfiguration used: .coderabbit.yaml Files selected for processing (1)
Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (3)
pages/builders/chain-operators/management/best-practices.mdx (1)
38-49: Use the imperative form and proper capitalization.The section should use the imperative form for consistency and clarity. Additionally, ensure proper capitalization for emphasis.
- After deploying your contracts on Ethereum, you should keep a record of all the deployment artifacts: + After deploying contracts on Ethereum, keep a record of all deployment artifacts: - * Contract release tag and commit hash - * Contract deployment directory with smart contract artifacts. This is created in [packages/contracts-bedrock/deployments](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/deployments) - * The rollup configuration file that you generated after the contract deployment - * The genesis file that you generated after the contract deployment + * Contract release tag and commit hash. + * Contract deployment directory with smart contract artifacts, created in [packages/contracts-bedrock/deployments](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/deployments). + * Rollup configuration file generated after contract deployment. + * Genesis file generated after contract deployment.pages/builders/chain-operators/deploy/smart-contracts.mdx (2)
25-28: Use the imperative form and ensure clarity.The text should use the imperative form for consistency and clarity.
- Deploying your OP Stack contracts requires creating a deployment configuration JSON file. You will create a new deployment configuration file in the following monorepo subdirectory: [packages/contracts-bedrock/deploy-config](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/deploy-config) For the full set of deployment configuration options and their meanings, you can see the [rollup deployment configuration page](/builders/chain-operators/configuration/rollup). + Deploy OP Stack contracts by creating a deployment configuration JSON file. Create a new deployment configuration file in the following monorepo subdirectory: [packages/contracts-bedrock/deploy-config](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/deploy-config). For the full set of deployment configuration options and their meanings, see the [rollup deployment configuration page](/builders/chain-operators/configuration/rollup).
Line range hint
30-36:
Use the imperative form and ensure clarity.The text should use the imperative form for consistency and clarity.
- Set the `ETHERSCAN_API_KEY` and add the `--verify` flag to verify your contracts. - `DEPLOYMENT_OUTFILE` will determine the filepath that the deployment artifact is written to on disk after the deployment. It comes in the form of a JSON file where keys are the names of the contracts and the values are the addresses the contract was deployed to. - `DEPLOY_CONFIG_PATH` is the path on the filesystem that points to a deployment config. The same deployment config JSON file should be used for L1 contracts deployment as when generating the L2 genesis allocs. See the [deploy-config](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/deploy-config) directory for examples and the [rollup configuration page](/builders/chain-operators/configuration/rollup) for descriptions of the values. - `IMPL_SALT` env var can be used to set the create2 salt for deploying the implementation contracts. + Set the `ETHERSCAN_API_KEY` and add the `--verify` flag to verify contracts. + `DEPLOYMENT_OUTFILE` determines the filepath where the deployment artifact is written on disk after the deployment. It comes in the form of a JSON file where keys are the names of the contracts and the values are the addresses the contract was deployed to. + `DEPLOY_CONFIG_PATH` is the path on the filesystem that points to a deployment config. Use the same deployment config JSON file for L1 contracts deployment as when generating the L2 genesis allocs. See the [deploy-config](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/deploy-config) directory for examples and the [rollup configuration page](/builders/chain-operators/configuration/rollup) for descriptions of the values. + `IMPL_SALT` environment variable can be used to set the create2 salt for deploying the implementation contracts.
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (4)
pages/builders/chain-operators/deploy/smart-contracts.mdx (4)
12-15: Separate "however" and fix the redundant phrase.The word "however" should be separated from the sentence. Additionally, the phrase "You can visit the see the" is redundant and needs correction. The link to the smart contract overview should be defined.
- The primary development branch is `develop`, however you should only deploy - official contract releases. You can visit the see the [smart contract overview](/stack/protocol/rollup/smart-contracts) + The primary development branch is `develop`. However, you should only deploy + official contract releases. You can visit the [smart contract overview](/stack/protocol/rollup/smart-contracts)Tools
LanguageTool
[typographical] ~12-~12: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... primary development branch isdevelop, however you should only deploy official contrac...(HOWEVER_SENTENCE)
25-28: Improve sentence structure for clarity.The instructions are clear, but the sentence structure can be improved for readability.
- JSON file. You will create a new deployment configuration file in the following - monorepo subdirectory: [packages/contracts-bedrock/deploy-config](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/deploy-config) + JSON file. Create a new deployment configuration file in the following + monorepo subdirectory: [packages/contracts-bedrock/deploy-config](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/deploy-config)
33-33: Improve sentence structure for conciseness.The sentence can be made more concise for better readability.
- and you can find the script's source code in the monorepo at - [packages/contracts-bedrock/scripts/deploy/Deploy.s.sol](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/scripts/deploy/Deploy.s.sol). + The script's source code is available in the monorepo at + [packages/contracts-bedrock/scripts/deploy/Deploy.s.sol](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/scripts/deploy/Deploy.s.sol).
Line range hint
83-83:
Use proper nouns instead of personal pronouns.The phrase "We're working on writing more documentation" should be updated to use a proper noun for consistency.
- We're working on writing more documentation to prepare OP Stack chain operators + The team is working on writing more documentation to prepare OP Stack chain operatorsTools
LanguageTool
[typographical] ~12-~12: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... primary development branch isdevelop, however you should only deploy official contrac...(HOWEVER_SENTENCE)
Description
Minor updates around best practices and deploying l1 contracts