Trick or Treat
First Flight #27
Beginner FriendlyFoundry
100 EXP
View results
Previous Next
Submission Details
Severity: low
Invalid

Documentation Incomplete and Inaccurate

nstap

Summary

The protocol documentation is to a large extent non-existent and some of the documentation that does exist is wrong. There is no natspec used for any function in the protocol. Every function should have at least minimal natspec.

Function SpookySwap::trickOrTreat is the main function of the protocol. It contains the following comment:

// User needs to call fellForTrick() to finish the transaction

This comment referts to a function that does not exist in the protocol

Vulnerability Details

The is no vulnerability per se but poor documentation can lead to potential bugs

Impact

no funds will be compromised by this fault. However, it could potentially lead to bugs

Tools Used

n/a

Recommendations

  1. Change the comment fellForTrick() to resolveTrick in SpookySwap::trickOrTreat

- // User needs to call fellForTrick() to finish the transaction
+// User needs to call resolveTrick() to finish the transaction

  1. Add natspec for all functions

Updates

Appeal created

bube Lead Judge 7 months ago
Submission Judgement Published
Invalidated
Reason: Non-acceptable severity
Assigned finding tags:

[invalid] Wrong comment

This is an informational issue.

Support

FAQs

Can't find an answer? Chat with us on Discord, Twitter or Linkedin.