Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coinfabrik/stacy
Stacy is an extensible open-source tool intended to assist developers and auditors of the Stacks ecosystem detect common issues in Clarity smart contracts.
https://github.com/coinfabrik/stacy
Last synced: about 9 hours ago
JSON representation
Stacy is an extensible open-source tool intended to assist developers and auditors of the Stacks ecosystem detect common issues in Clarity smart contracts.
- Host: GitHub
- URL: https://github.com/coinfabrik/stacy
- Owner: CoinFabrik
- License: mit
- Created: 2024-06-03T13:33:07.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-18T16:36:41.000Z (6 months ago)
- Last Synced: 2025-01-08T09:58:37.597Z (4 days ago)
- Language: Python
- Homepage:
- Size: 121 KB
- Stars: 27
- Watchers: 4
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# STACY - Stacks Static Analyzer for Clarity
Stacy is an open-source static analyzer for Clarity smart contracts. It is intended to assist Clarity smart contract developers and auditors detect common security issues and deviations from best practices.
This tool will help developers write secure and more robust smart contracts.
## Install
```shell
pip install git+https://github.com/xlittlerag/tree-sitter-clarity@6eb27feb
pip install stacy-analyzer
```
## Documentation
- [Vulnerabilities](https://github.com/CoinFabrik/stacy/tree/main/docs/vulnerabilities)
## Detectors
Severities are based on worst case scenarios and the detector's finding may vary depending on the context.
| Detector ID | What it Detects | Test Cases | Severity |
|--------------------------------------------------------------------------------------------------------------------------------| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [assert-block-height](https://github.com/CoinFabrik/stacy/blob/main/docs/vulnerabilities/1-assert-block-height.md) | Usage of `block-height` as time tracker. | [1](https://github.com/CoinFabrik/stacy/tree/main/tests/assert_block_height) | Critical |
| [call-inside-as-contract](https://github.com/CoinFabrik/stacy/blob/main/docs/vulnerabilities/2-call-inside-as-contract.md) | Calling another contract losing the first contract's context. | [1](https://github.com/CoinFabrik/stacy/tree/main/tests/call_inside_as_contract) | Critical |
| [divide-before-multiply](https://github.com/CoinFabrik/stacy/blob/main/docs/vulnerabilities/3-divide-before-multiply.md) | Performing a division operation before a multiplication, leading to loss of precision. | [1](https://github.com/CoinFabrik/stacy/tree/main/tests/divide_before_multiply) | Critical |
| [private-function-not-used](https://github.com/CoinFabrik/stacy/blob/main/docs/vulnerabilities/4-private-function-not-used.md) | Dead code(private functions) inside the smart contract. | [1](https://github.com/CoinFabrik/stacy/tree/main/tests/private_function_not_used) | Enhancement |
| [todo-comment](https://github.com/CoinFabrik/stacy/blob/main/docs/vulnerabilities/5-todo-comment.md) | TODO comments left in the smart contract. | [1](https://github.com/CoinFabrik/stacy/tree/main/tests/todo_comment) | Enhancement |
| [tx-sender-in-assert](https://github.com/CoinFabrik/stacy/blob/main/docs/vulnerabilities/6-tx-sender-in-assert.md) | Usage of tx-sender in assert is truly intended. | [1](https://github.com/CoinFabrik/stacy/tree/main/tests/tx_sender_in_assert) | High |
| [unwrap-panic-usage](https://github.com/CoinFabrik/stacy/blob/main/docs/vulnerabilities/7-unwrap-panic-usage.md) | Inappropriate usage of the `unwrap-panic` method, causing unexpected program crashes. | [1](https://github.com/CoinFabrik/stacy/tree/main/tests/unwrap_panic_usage) | Enhancement |
| [var-could-be-constant](https://github.com/CoinFabrik/stacy/blob/main/docs/vulnerabilities/8-var-could-be-constant.md) | Code that does not change and could be re-define. | [1](https://github.com/CoinFabrik/stacy/tree/main/tests/var_could_be_constant) | Enhancement |
| [updated-functions](https://github.com/CoinFabrik/stacy/blob/main/docs/vulnerabilities/9-updated-functions.md) | Old functions. | [1](https://github.com/CoinFabrik/stacy/tree/main/tests/updated_functions) | Enhancement |
| [unused-arguments](https://github.com/CoinFabrik/stacy/blob/main/docs/vulnerabilities/10-unused-arguments.md) | Arguments passed but not used. | [1](https://github.com/CoinFabrik/stacy/tree/main/tests/unused_arguments) | Enhancement |
| [unused-let-variables](https://github.com/CoinFabrik/stacy/blob/main/docs/vulnerabilities/11-unused-let-variables.md) | Local variables declared but not used. | [1](https://github.com/CoinFabrik/stacy/tree/main/tests/unused_let_variables) | Enhancement |
## Contribution guidelines
You can find our contribution guidelines [here](https://github.com/CoinFabrik/stacy/tree/main/docs/contribution_guidelines/contribute.md)
## Testing Stacy
You can run Stacy over all the test contracts by running the following command:
```shell
stacy-analyzer lint tests
```
It will recursively search for all the `.clar` files in the `tests` directory and run Stacy over them. With this command, you won't need to specify the path to each smart contract.
This should print the errors in the vulnerable examples, and nothing in the remediated ones!
## About CoinFabrik
We - [CoinFabrik](https://www.coinfabrik.com/) - are a research and development company specialized in Web3, with a strong background in cybersecurity. Founded in 2014, we have worked on over 180 blockchain-related projects, EVM based and also for Solana, Algorand, and Polkadot. Beyond development, we offer security audits through a dedicated in-house team of senior cybersecurity professionals, currently working on code in Substrate, Solidity, Clarity, Rust, and TEAL.
Our team has an academic background in computer science and mathematics, with work experience focused on cybersecurity and software development, including academic publications, patents turned into products, and conference presentations. Furthermore, we have an ongoing collaboration on knowledge transfer and open-source projects with the University of Buenos Aires.
## License
Stacy is licensed and distributed under a MIT license. [Contact us](https://www.coinfabrik.com/) if you're looking for an exception to the terms.