Skip to content

Update Assembly rule #23

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update Assembly rule #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c58f84
Update Assembly
Aboudjem Jun 8, 2024
f996651
Update Assembly rule
Aboudjem Jun 8, 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
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,16 @@ Interfaces separate NatSpec from contract logic, requiring readers to do more wo

##### C. Avoid using assembly.

Assembly code is hard to read and audit. We should avoid it unless the gas savings are very consequential, e.g. > 25%.
Use inline assembly with extreme care. Ensure that it is well-documented with inline comments explaining what the assembly code does. Avoid using assembly unless it adds significant value (e.g., gas savings > 25%) and there are no better alternatives.

```solidity
function add(uint x, uint y) public pure returns (uint result) {
assembly {
// Add x and y and store the result in the `result` variable
result := add(x, y)
}
}
```

#### 4. Versioning

Expand Down