-
Notifications
You must be signed in to change notification settings - Fork 82
feat: Add smart accounts reference generation script and docs pages #716
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…t accounts versions <1.3.0 and all modules
…v1-5-0-contracts
Branch preview✅ Deployed successfully in branch deployment: |
Overall readability score: 36.34 (🔴 -0.08)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
…fe-docs into modules-reference
When v1.5.0 is released, there will be a new setModuleGuard function. How will the generation script handle this? |
…modules-reference
Thanks @nlordell for the thorough review! You raised valid points. I'm working on fixing the examples and sample values that you mentioned. For the NatSpec content, could it be considered that we create a new npm package release (like what was done for the reference module v0.3.0-1) which will contain the fixed NatSpec comments? So these mistakes are also fixed in the developers' IDEs? If yes we can then take all NatSpec-related feedback and discussion from this PR directly in the contracts repo, and park this PR until all these fixes are released 🙏 |
I think the NatSpec comment issues were for the Safe contracts and not the modules (although the modules may also contain issues, but I hope not - in any case I didn't see any on my first pass). I do not want to release a new version of contracts with corrected NatSpec documentation as this would lead changes to contract bytecode and break deterministic deployment. However, for future deployments we are taking NatSpec documentation more seriously and including proof reading it a part of our pre-release checklist. In particular, we are nearing the release of the Safe v1.5.0 contracts and will proof read the NatSpec documentation before cutting the release and starting the deployments. |
59e8ccb
to
17b2022
Compare
This PR adds a
smart-account-reference
section, generated with the latest Safe smart account versions, usingpnpm generate-smart-account-reference
.