-
Notifications
You must be signed in to change notification settings - Fork 143
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
fix: add security contact to various contract NatSpecs (OZ N-03) #1028
Conversation
fix: add security contact to various contract NatSpecs (OZ N-03)
🚨 Report Summary
For more details view the full report in OpenZeppelin Code Inspector |
I'm unsure why this PR is failing the
the other PR 1029 passed all checks implying that I introduced an issue in this test specifically, rather than the issue already being part of the horizon branch that I'm trying to merge into. It appears the issue is with the test_RevertWhen_TheContractIsDeployedWithAnInvalidController where the test expects the function to revert but it's not reverting. |
Re-ran the test and it passed, so looks like a non-deterministic bug. First test run Highlighting part of the test-ci error message:
|
This PR will be marked as draft while we workout the security email contact. |
ba6024a
to
8ce493f
Compare
Motivation:
Title:
N-03 Lack of Security Contact
Details:
Providing a specific security contact (such as an email or ENS name) within a smart contract significantly simplifies the process for individuals to communicate if they identify a vulnerability in the code. This practice is quite beneficial as it permits the code owners to dictate the communication channel for vulnerability disclosure, eliminating the risk of miscommunication or failure to report due to a lack of knowledge on how to do so. In addition, if the contract incorporates third-party libraries and a bug surfaces in those, it becomes easier for their maintainers to contact the appropriate person about the problem and provide mitigation instructions.
Throughout the codebase, multiple instances of contracts without a security contact were identified:
The DisputeManager contract
The GraphPayments contract
The HorizonStaking contract
The HorizonStakingExtension contract
The PaymentsEscrow contract
The SubgraphService contract
The TAPCollector contract
Consider adding a NatSpec comment containing a security contact above each contract definition. Using the @Custom:security-contact convention is recommended as it has been adopted by the OpenZeppelin Wizard and the ethereum-lists.
Key changes