@cyfrin/aderyn 0.6.6 → 0.6.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -27
- package/npm-shrinkwrap.json +2 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -42,53 +42,48 @@ code with ease.
|
|
|
42
42
|
|
|
43
43
|
## Features
|
|
44
44
|
|
|
45
|
-
-
|
|
46
|
-
-
|
|
47
|
-
-
|
|
48
|
-
-
|
|
45
|
+
- Runs without need for any configuration support for Foundry and Hardhat projects.
|
|
46
|
+
- Creates Markdown, JSON and Sarif reports.
|
|
47
|
+
- Powers our officially supported [VSCode extension](https://github.com/Cyfrin/vscode-aderyn/) (1800+ downloads)
|
|
48
|
+
- List of [supported detectors](https://cyfrin.gitbook.io/cyfrin-docs/project-configuration/list-of-supported-detectors)
|
|
49
|
+
- Contributor Friendly
|
|
50
|
+
- Downloaded more than 45K times.
|
|
49
51
|
|
|
50
52
|
## Installation
|
|
51
53
|
|
|
52
54
|
> **NOTE** Windows users must have WSL installed
|
|
53
55
|
|
|
54
|
-
|
|
56
|
+
#### Cyfrinup - All in one cross platform installation manager for Cyfrin tools.
|
|
55
57
|
|
|
56
|
-
|
|
58
|
+
[One time setup](https://github.com/Cyfrin/up). - Run `cyfrinup`
|
|
57
59
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
Run `aderyn --version` to check the installation.
|
|
61
|
-
|
|
62
|
-
Run `cyfrinup` to upgrade everything to the latest version.
|
|
63
|
-
|
|
64
|
-
### Using curl
|
|
60
|
+
Re-run `cyfrinup` to upgrade all Cyfrin tools to the latest version.
|
|
65
61
|
|
|
62
|
+
#### Curl
|
|
63
|
+
Once installed, run `aderyn-update` to upgrade.
|
|
66
64
|
```sh
|
|
67
65
|
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/cyfrin/aderyn/releases/latest/download/aderyn-installer.sh | bash
|
|
68
66
|
```
|
|
69
67
|
|
|
70
|
-
##### Upgrade older versions by running: `aderyn-update`
|
|
71
|
-
|
|
72
|
-
### Using Homebrew
|
|
73
68
|
|
|
69
|
+
#### Homebrew
|
|
70
|
+
Once installed, run `brew upgrade cyfrin/tap/aderyn` to upgrade.
|
|
74
71
|
```sh
|
|
75
72
|
brew install cyfrin/tap/aderyn
|
|
76
73
|
```
|
|
77
74
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
### Using npm
|
|
81
|
-
|
|
75
|
+
#### npm
|
|
76
|
+
Once installed, re-run `npm install @cyfrin/aderyn -g` to upgrade.
|
|
82
77
|
```sh
|
|
83
78
|
npm install @cyfrin/aderyn -g
|
|
84
79
|
```
|
|
85
80
|
|
|
86
|
-
##### Upgrade older versions by (re)running: `npm install @cyfrin/aderyn -g`
|
|
87
|
-
|
|
88
81
|
If you are installing with Curl or Homebrew or npm, ensure that the correct version of Aderyn in your path comes from either the Homebrew or npm global packages directory. If an older version exists at `~/.cyfrin/bin/aderyn`, remove it using `rm -f ~/.cyfrin/bin/aderyn`, as this is no longer the default installation location.
|
|
89
82
|
|
|
90
83
|
## Quick Start
|
|
91
84
|
|
|
85
|
+
Run `aderyn --version` to check if Aderyn is installed successfully.
|
|
86
|
+
|
|
92
87
|
[Quick Start](https://cyfrin.gitbook.io/cyfrin-docs/aderyn-cli/quickstart) example with video guide.
|
|
93
88
|
|
|
94
89
|
```
|
|
@@ -105,7 +100,7 @@ See examples using more CLI options [here](https://cyfrin.gitbook.io/cyfrin-docs
|
|
|
105
100
|
Officially supported [VSCode extension](https://github.com/Cyfrin/vscode-aderyn/) for Aderyn.
|
|
106
101
|
Download from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Cyfrin.aderyn&ssr=false#overview)
|
|
107
102
|
|
|
108
|
-
##
|
|
103
|
+
## Github Action
|
|
109
104
|
|
|
110
105
|
Checkout [Aderyn CI Assistant](https://github.com/marketplace/actions/aderyn-ci-assistant) in the marketplace.
|
|
111
106
|
Performs Static analysis on Solidity codebases in CI to catch potential vulnerabilities before committing code.
|
|
@@ -115,12 +110,8 @@ Performs Static analysis on Solidity codebases in CI to catch potential vulnerab
|
|
|
115
110
|
Help us build Aderyn 🦜 Please see our [contribution guidelines](./CONTRIBUTING.md) for in-depth developer environment setup and PR approval process.
|
|
116
111
|
Aderyn is an open-source software licensed under the [GPL-3.0 License](./LICENSE).
|
|
117
112
|
|
|
118
|
-
## Building a custom Aderyn detector
|
|
119
|
-
|
|
120
|
-
Aderyn makes it easy to build Static Analysis detectors that can adapt to any Solidity codebase and protocol. This guide will teach you how to build, test, and run your custom Aderyn detectors.
|
|
121
113
|
To learn how to create your custom Aderyn detectors, [checkout the official docs](https://cyfrin.gitbook.io/cyfrin-docs/aderyn-cli/detectors-quickstart)
|
|
122
114
|
|
|
123
|
-
## Solidity AST Generation Backend
|
|
124
115
|
Aderyn relies on a [custom backend](https://github.com/Cyfrin/solidity-ast-rs) to generate AST for Solidity codebases.
|
|
125
116
|
It leverages [foundry-compilers](https://github.com/foundry-rs/compilers)
|
|
126
117
|
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"hasInstallScript": true,
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"name": "@cyfrin/aderyn",
|
|
26
|
-
"version": "0.6.
|
|
26
|
+
"version": "0.6.7"
|
|
27
27
|
},
|
|
28
28
|
"node_modules/@isaacs/balanced-match": {
|
|
29
29
|
"engines": {
|
|
@@ -515,5 +515,5 @@
|
|
|
515
515
|
}
|
|
516
516
|
},
|
|
517
517
|
"requires": true,
|
|
518
|
-
"version": "0.6.
|
|
518
|
+
"version": "0.6.7"
|
|
519
519
|
}
|
package/package.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"artifactDownloadUrl": "https://github.com/cyfrin/aderyn/releases/download/aderyn-v0.6.
|
|
2
|
+
"artifactDownloadUrl": "https://github.com/cyfrin/aderyn/releases/download/aderyn-v0.6.7",
|
|
3
3
|
"author": "Cyfrin <aderyn@cyfrin.io>",
|
|
4
4
|
"bin": {
|
|
5
5
|
"aderyn": "run-aderyn.js"
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
"zipExt": ".tar.xz"
|
|
64
64
|
}
|
|
65
65
|
},
|
|
66
|
-
"version": "0.6.
|
|
66
|
+
"version": "0.6.7",
|
|
67
67
|
"volta": {
|
|
68
68
|
"node": "18.14.1",
|
|
69
69
|
"npm": "9.5.0"
|