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

[Hacken 2022-11-25 Low #4] Style Guide Violation #39

Closed
zhongfu opened this issue Dec 1, 2022 · 0 comments
Closed

[Hacken 2022-11-25 Low #4] Style Guide Violation #39

zhongfu opened this issue Dec 1, 2022 · 0 comments
Labels
sev:p3 Low sev type:enhancement Good-to-have features or fixes
Milestone
Hacken Audit 2022...

Comments

@zhongfu
Copy link
Contributor

zhongfu commented Dec 1, 2022

The project should follow the official code style guidelines. Inside each contract, library, or interface, use the following order:

  • Type declarations
  • State variables
  • Events
  • Modifiers
  • Functions

Path

./src/Funnel.sol

Functions should be grouped according to their visibility and ordered:

  • constructor
  • receive function (if exists)
  • fallback function (if exists)
  • external
  • public
  • internal
  • private

Within a grouping, place the view and pure functions at the end. Some contracts are not formatted correctly.

Paths

./src/Funnel.sol
./src/FunnelFactory.sol

Solidity style guidance defines a naming convention that should be followed. Some state variables are not in the mixed case.

Path

./src/Funnel.sol: INITIAL_CHAIN_ID, INITIAL_DOMAIN_SEPARATOR

Recommendation

The official Solidity style guidelines should be followed.

Status

New
@zhongfu zhongfu added type:enhancement Good-to-have features or fixes sev:p3 Low sev labels Dec 1, 2022
@zhongfu zhongfu added this to the Hacken Audit 2022-11-25 milestone Dec 1, 2022
edison0xyz added a commit that referenced this issue Dec 8, 2022
@edison0xyz
chore: closes #39 and #40
b6800ff
@edison0xyz edison0xyz mentioned this issue Dec 8, 2022
Merged
zlace0x added a commit that referenced this issue Dec 12, 2022
@edison0xyz @zlace0x
Chore/natspec (#53)
df333f1 
* style: grouped functions

* forge install: openzeppelin-contracts

* chore: updates to lib

* chore: natspec comments for contracts

* chore: closes #39 and #40

* chore: removed unused solmate

* refactor: moved saturatingAdd to mathUtil

* chore: cleanup

* Apply suggestions from code review

Co-authored-by: zlace0x <81418809+zlace0x@users.noreply.github.com>

* fix: resolve some comments

* doc: generated docs under doc/

* chore: cleanups on comments

* style: use custom errors instead (#56)

* style: use custom errors instead

* fix: structured files for custom errors

* style: change INITIAL values to upper-case

* Update src/Funnel.sol

Co-authored-by: zlace0x <81418809+zlace0x@users.noreply.github.com>

Co-authored-by: Edison <6057323+edison0x@users.noreply.github.com>
Co-authored-by: zlace0x <81418809+zlace0x@users.noreply.github.com>

* chore: fix comments slashes

* fix: apply linter version changes

Co-authored-by: Edison <6057323+edison0x@users.noreply.github.com>
Co-authored-by: zlace0x <zlace0x@gmail.com>
Co-authored-by: zlace0x <81418809+zlace0x@users.noreply.github.com>
zlace0x added a commit that referenced this issue Dec 12, 2022
@zlace0x @edison0xyz
Audit fixes 2 (#51)
9b97efa 
* fix: addresses #32, allowance() amount should reflect transferable amounts for transferFrom() and transfer()

* fix: comment contradition #43

* wip: added overflow test cases according to #30, identified area of overflow

* fix: potential fix for #30

* refactor: adhere to checks-effects-interaction pattern #35

* fix: make allowance() external #45

* fix: dropped virtual from permit, permitRenewable #44

* refactor: added require reason

* chore: added gas reports

* fix: solidity compiler for deploy script

* Chore/natspec (#53)

* style: grouped functions

* forge install: openzeppelin-contracts

* chore: updates to lib

* chore: natspec comments for contracts

* chore: closes #39 and #40

* chore: removed unused solmate

* refactor: moved saturatingAdd to mathUtil

* chore: cleanup

* Apply suggestions from code review

Co-authored-by: zlace0x <81418809+zlace0x@users.noreply.github.com>

* fix: resolve some comments

* doc: generated docs under doc/

* chore: cleanups on comments

* style: use custom errors instead (#56)

* style: use custom errors instead

* fix: structured files for custom errors

* style: change INITIAL values to upper-case

* Update src/Funnel.sol

Co-authored-by: zlace0x <81418809+zlace0x@users.noreply.github.com>

Co-authored-by: Edison <6057323+edison0x@users.noreply.github.com>
Co-authored-by: zlace0x <81418809+zlace0x@users.noreply.github.com>

* chore: fix comments slashes

* fix: apply linter version changes

Co-authored-by: Edison <6057323+edison0x@users.noreply.github.com>
Co-authored-by: zlace0x <zlace0x@gmail.com>
Co-authored-by: zlace0x <81418809+zlace0x@users.noreply.github.com>

Co-authored-by: Edison <6057323+edison0xyz@users.noreply.github.com>
Co-authored-by: Edison <6057323+edison0x@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
sev:p3 Low sev type:enhancement Good-to-have features or fixes
Projects
None yet
Milestone
Hacken Audit 2022-11-25
Development

No branches or pull requests
1 participant
@zhongfu