Remove broadcast directory #8
Open
Conversation
This file contains hidden or 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
Merged
squadgazzz
approved these changes
Jun 2, 2025
Contributor
squadgazzz
left a comment
squadgazzz
left a comment
There was a problem hiding this comment.
Makes sense. I think the .gitignore file needs to be updated
anxolin
approved these changes
Jun 6, 2025
anxolin
left a comment
anxolin
left a comment
There was a problem hiding this comment.
Great! works with me. Can you make sure we use this as a reference in the Template (we could link this PR)
| | select(.transactionType == "CREATE2") | ||
| | select(.hash != null) | ||
| | {($chainId): {address: .contractAddress, transactionHash: .hash }} | ||
| ' <"./broadcast/DeployableVM.s.sol/${chain_id}/run-latest.json" |
There was a problem hiding this comment.
Given its complexity, do you think is worth it to move to a script?
| After successfully deploying the contracts, a deployment file is automatically generated in the [./broadcast/DeployableVM.s.sol](broadcast/DeployableVM.s.sol) directory under the relevant chain subdirectory. Make sure to commit this file to the repository. | ||
|
|
||
| ### 8. Deployment addresses | ||
| ### 7. Deployment addresses |
There was a problem hiding this comment.
All sections use the imperative form to command the reader to do something
I would suggest to use a verb here. i.e. Update deployment addresses
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The files in
/broadcastcontain mostly information that can be recovered from on-chain data.Sometimes there's no easy way to programmatically get the information on the file, for example if the deployment script hasn't been used to deploy the contract on a specific chain. This means either that the broadcast file is absent (and so
networks.jsoncannot be automatically generated) or that it should be manually created (which takes time and so there is the risk of introducing errors that are hard to verify).As far as I know, there's no concrete use for the broadcast files except for getting the transaction hash and the addresses.
For all these reasons, this PR drops these (and related) files from this repository.
Instead, we just keep the
networks.jsonfile: the address is handy to make sure a specific deployment is official, while the transaction hash allows to recover most of the information from the broadcast file.How to test
Check out that the readme is updated with the new deployment documentation process.