Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Complex to simple language change in the Security section of the extending contract #5233

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
+1 −1
Open

Complex to simple language change in the Security section of the extending contract #5233

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bbc8668
Simple language changes in the Security section of the extending cont…
Shaykoo Sep 30, 2024
7f51161
Add changeset
Shaykoo Oct 1, 2024
7e2262b
Merge branch 'OpenZeppelin:master' into docs/language-improvement-sec…
Shaykoo Oct 1, 2024
31c6a6e
Delete .changeset/gorgeous-garlics-visit.md
Amxx Oct 1, 2024
7cb57cb
Revert "Add changeset"
Amxx Oct 1, 2024
57859e7
Changed the documentation language for easy readability
Shaykoo Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/extending-contracts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ NOTE: The same rule is implemented and extended in xref:api:access.adoc#AccessCo

The maintainers of OpenZeppelin Contracts are mainly concerned with the correctness and security of the code as published in the library, and the combinations of base contracts with the official extensions from the library.

Custom overrides, and those of hooks in particular, may break some important assumptions and introduce vulnerabilities in otherwise secure code. While we try to ensure the contracts remain secure in the face of a wide range of potential customizations, this is done in a best-effort manner. While we try to document all important assumptions, this should not be relied upon. Custom overrides should be carefully reviewed and checked against the source code of the contract they are customizing so as to fully understand their impact and guarantee their security.
Custom overrides, especially to hooks, can disrupt important assumptions and may introduce security risks in the code that was previously secure. While we try to ensure the contracts remain secure in the face of a wide range of potential customizations, this is done in a best-effort manner. While we try to document all important assumptions, this should not be relied upon. Custom overrides should be carefully reviewed and checked against the source code of the contract they are customizing so as to fully understand their impact and guarantee their security.

The way functions interact internally should not be assumed to stay stable across releases of the library. For example, a function that is used in one context in a particular release may not be used in the same context in the next release. Contracts that override functions should revalidate their assumptions when updating the version of OpenZeppelin Contracts they are built on.
Loading