improve: [L03] Missing docstrings #253
Merged
Conversation
This file contains 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
## From Audit Throughout the codebase, there are several parts that do not have docstrings. In particular: AdapterInterface.sol , lines 13-20: the interface functions are undocumented. AbitrumAdapter.sol , lines 9-54: the ArbitrumL1InboxLike and ArbitrumL1ERC20GatewayLike interfaces and their functions are undocumented. LpTokenFactoryInterface.sol , lines 4-5: the interface and its functions are undocumented. • • • • • UMA Across V2 Incremental Audit − Low Severity − 8 Optimism_Adapter.sol , lines 15-16: the SynthetixBridgeToOptimism interface and its function are undocumented. Polygon_Adapter.sol , lines 10-30: the IRootChainManager , IFxStateSender , and DepositManager interfaces and their functions are undocumented. Polygon_SpokePool.sol , line 11: the processMessageFromRoot function is undocumented. SpokePool.sol , lines 169-196: the RelayExecution , RelayExecutionInfo , and DepositUpdate structs have undocumented members. Succinct_SpokePool.sol , line 57: the initialize function has no docstring. Succinct_SpokePool.sol , line 57: the handleTelepathy function has no docstring. WETH9Interface.sol , lines 4-11: the interface and its functions are undocumented. ZkSync_Adapter.sol , lines 13-30: the ZkSyncLike and ZkBridgeLike interfaces and their functions are undocumented. ZkSync_SpokePool.sol , lines 6-12: the ZkBridgeLike interface and its function are undocumented. Consider thoroughly documenting all functions (and their parameters) that are part of any contract's public API. Functions implementing sensitive functionality, even if not public, should be clearly documented as well. When writing docstrings, consider following the Ethereum Natural Specification Format (NatSpec). ## Developer response All suggested comments are implemented except for `ZkSync_` contracts which were out of audit scope and are still in progress and not live.
nicholaspai
added
the
OZ Audit - March 2023
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.
From Audit
Throughout the codebase, there are several parts that do not have docstrings. In particular:
AbitrumAdapter.sol , lines 9-54: the ArbitrumL1InboxLike and
ArbitrumL1ERC20GatewayLike interfaces and their functions are undocumented.
undocumented.
and its function are undocumented.
undocumented.
undocumented.
and DepositUpdate structs have undocumented members.
docstring.
interfaces and their functions are undocumented.
are undocumented.
Consider thoroughly documenting all functions (and their parameters) that are part of any
contract's public API. Functions implementing sensitive functionality, even if not public, should
be clearly documented as well. When writing docstrings, consider following the Ethereum
Natural Specification Format (NatSpec).
Developer response
All suggested comments are implemented except for
ZkSync_contracts which were out of audit scope and are still in progress and not live.