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

Update main readme #372

Open
wants to merge 8 commits into
base: default-do-not-use-scout-reserved
Choose a base branch
from
Open

Update main readme #372

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d5a1e53
Remove zero_address detector
tomasavola Sep 11, 2024
33f85e8
add token-interface-events detector
tomasavola Sep 11, 2024
43635a4
add integer-overflow-or-underflow detector
tomasavola Sep 11, 2024
9caba04
add storage-change-events detector
tomasavola Sep 11, 2024
63cbf4a
add front-running detector
tomasavola Sep 12, 2024
9100104
add token-interface-inference detector
tomasavola Sep 12, 2024
19b26c7
add unnecessary-admin-parameter detector
tomasavola Sep 12, 2024
9deb295
add dynamic-types-in-storage detector
tomasavola Sep 12, 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
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,14 @@ Currently Scout includes the following detectors.
| [dos-unexpected-revert-with-vector](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/dos-unexpected-revert-with-vector) | DoS due to improper storage. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/dos-unexpected-revert-with-vector/dos-unexpected-revert-with-vector-1), [2](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/dos-unexpected-revert-with-vector/dos-unexpected-revert-with-vector-2) | Medium |
| [unrestricted-transfer-from](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/unrestricted-transfer-from) | Avoid passing an user-defined parameter as a `from` field in transfer-from. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/unrestricted-transfer-from/unrestricted-transfer-from-1) | Critical |
| [unsafe-map-get](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/unsafe-map-get) | Inappropriate usage of the `get` method for `Map` in soroban | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/unsafe-map-get/unsafe-map-get-1) | Medium |
| [zero-or-test-address](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/zero-or-test-address) | Avoid zero or test address assignment to prevent contract control loss. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/zero-or-test-address/zero-or-test-address-1) | Medium |
| [incorrect-exponentation](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/incorrect-exponentiation) | Warns against incorrect usage of ´^´. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/incorrect-exponentiation/incorrect-exponentiation-1) | Critical |
| [integer-overflow-or-underflow](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/integer-overflow-or-underflow) | Warns if there’s any numerical overflow or underflow | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/integer-overflow-or-underflow/integer-overflow-or-underflow-1), [2](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/integer-overflow-or-underflow/integer-overflow-or-underflow-2), [3](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/integer-overflow-or-underflow/integer-overflow-or-underflow-3), [4](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/integer-overflow-or-underflow/integer-overflow-or-underflow-4), [5](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/integer-overflow-or-underflow/integer-overflow-or-underflow-5) | Critical |
| [storage-change-events](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/token-interface-events) | Warns if an event is not emitted when a change has occurred in the storage. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/storage-change-events/storage-change-events-1) | Minor |
| [token-interface-events](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/token-interface-events) | Warns if any of the token functions does not emit an event. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/token-interface-events/token-interface-events-1) | Medium |
[front-running](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/front-running) | Front-running attacks can be avoided by comparing the transfer amount with a minimum value. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/front-running/front-running-1) | Warning |
[token-interface-inference](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/token-interface-inference) | Recommend using the trait `soroban_sdk::token::TokenInterface` if a token contract does not implement it. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/token-interface-inference/token-interface-inference-1) | Best practices | |
[unnecessary-admin-parameter](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/unnecessary-admin-parameter) | Admin information should be retrieved from contract storage rather than passed as a parameter. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/unnecessary-admin-parameter/unnecessary-admin-parameter-1) | Medium ||
[dynamic-types-in-storage](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/dynamic-instance-storage) | Warns against the usage of `storage().persistent()` with dynamic types. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/dynamic-instance-storage/dynamic-instance-storage-1) | Critical |

## Output formats

Expand Down