Skip to content

Commit

Permalink
Fix: readme links
Browse files Browse the repository at this point in the history
  • Loading branch information
0xKitsune committed Dec 7, 2023
1 parent db5476e commit 88d7769
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[gha]: https://github.com/0xKitsune/sstan/actions
[gha-badge]: https://github.com/0xKitsune/sstan/actions/workflows/ci.yml/badge.svg

`sstan` is a Solidity static analyzer specifically designed for the [Code4Arena Bot Races](https://code4rena.com/register/bot). With the constantly changing landscape of the bot races, this design prioritizes DevX, using an [Extractor pattern](https://github.com/0xKitsune/sstan/blob/docs/Contributing.md#extractors) and macros to enable extremely quick development times when implementing new patterns. `sstan` comes "out of the box" with patterns to identify 50+ optimizations, vulnerabilities and QA patterns.
`sstan` is a Solidity static analyzer specifically designed for the [Code4Arena Bot Races](https://code4rena.com/register/bot). With the constantly changing landscape of the bot races, this design prioritizes DevX, using an [Extractor pattern](https://github.com/0xKitsune/sstan/blob/main/docs/Contributing.md#extractors) and macros to enable extremely quick development times when implementing new patterns. `sstan` comes "out of the box" with patterns to identify 50+ optimizations, vulnerabilities and QA patterns.

# Table of Contents
- [Installation](#installation)
Expand All @@ -29,7 +29,7 @@ cargo install --path .
# Usage
Now that you have `sstan` installed, you can use the `sstan` command from anywhere in your terminal. By default, sstan looks for a `./src` directory and analyzes every file within the folder. If you would like to specify the directory `sstan` should target, you can pass the `--path` flag (ex. `sstan --path <path_to_dir>`).

In the default configuration, sstan runs analysis for every [currently included optimization, vulnerability and QA pattern](https://github.com/0xKitsune/sstan#currently-identified-optimizations-vulnerabilities-and-qa), however if you would like to run analysis for select patterns, you can create a `.toml` file for your custom configuration. You can use the [default sstan.toml configuration](https://github.com/0xKitsune/sstan/blob/main/sstan.toml) for reference. After creating a custom `.toml` file, make sure to pass the `--toml` flag when running `sstan` (ex. `sstan --toml <path_to_toml_file>`).
In the default configuration, `sstan` runs analysis for every [currently included optimization, vulnerability and QA pattern](https://github.com/0xKitsune/sstan#currently-identified-optimizations-vulnerabilities-and-qa), however if you would like to run analysis for select patterns, you can create a `.toml` file for your custom configuration. You can use the [default sstan.toml configuration](https://github.com/0xKitsune/sstan/blob/main/sstan.toml) for reference. After creating a custom `.toml` file, make sure to pass the `--toml` flag when running `sstan` (ex. `sstan --toml <path_to_toml_file>`).

```
Usage: sstan [OPTIONS]
Expand Down
2 changes: 1 addition & 1 deletion docs/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The repository can seem a little dense in some parts but adding a new optimizati
<br>


### Extractors
## Extractors
`sstan` uses "Extractors" to extract target nodes from the AST generated from a Solidity file. There are two types of extractors; primitive and compound. Primitive extractors extract a simple type from the AST like a `FunctionDefinition`, `FunctionCall` or `StructDefinition`. Compound extractors extract complex types, typically utilizing one or more primitive extractors under the hood. For example, The `ConstructorExtractor` extracts all constructors from a Solidity file. The `ConstructorExtractor` first uses the `FunctionExtractor` to get all functions from the file, then filtering all functions except for the constructors.

```rust
Expand Down

0 comments on commit 88d7769

Please sign in to comment.