Skip to content

Commit aecdba3

Browse files
Jon-BeckerJon-Becker
committed
docs
1 parent 130e153 commit aecdba3

File tree

5 files changed

+140
-12
lines changed

5 files changed

+140
-12
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Bug report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please ensure that the bug has not already been filed in the issue tracker.
10+
11+
Thanks for taking the time to report this bug!
12+
- type: dropdown
13+
attributes:
14+
label: Component
15+
description: What component is the bug in?
16+
multiple: true
17+
options:
18+
- Installing bifrost
19+
- Installing heimdall
20+
- Heimdall CLI
21+
- Heimdall Config
22+
- Heimdall Modules
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Version
28+
description: Which version of heimdall is the bug in? (`heimdall -V`).
29+
validations:
30+
required: true
31+
- type: checkboxes
32+
attributes:
33+
label: Please check the following
34+
options:
35+
- label: This is not a duplicate issue
36+
- label: I have checked the wiki and tried troubleshooting the issue
37+
- type: dropdown
38+
attributes:
39+
label: Operating System
40+
description: What operating system are you on?
41+
options:
42+
- Windows
43+
- macOS (Intel)
44+
- macOS (Apple Silicon)
45+
- Linux
46+
- type: textarea
47+
attributes:
48+
label: Describe the issue you are facing
49+
description: Include all relevant information about the issue, including the steps to reproduce it, and the expected result.
50+
validations:
51+
required: true

‎.github/ISSUE_TEMPLATE/question.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Question
2+
description: Ask a general question about Heimdall
3+
title: "[Question]: "
4+
labels: ["question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please ensure that the question has not already been asked in the issue tracker, and that the wiki won't answer it.
10+
11+
Thank you!
12+
- type: textarea
13+
attributes:
14+
label: Version
15+
description: Which version of heimdall is the bug in? (`heimdall -V`).
16+
validations:
17+
required: true
18+
- type: checkboxes
19+
attributes:
20+
label: Please check the following
21+
options:
22+
- label: This is not a duplicate question
23+
- label: I have checked the wiki beforehand
24+
- type: dropdown
25+
attributes:
26+
label: Operating System
27+
description: What operating system are you on?
28+
options:
29+
- Windows
30+
- macOS (Intel)
31+
- macOS (Apple Silicon)
32+
- Linux
33+
- type: textarea
34+
attributes:
35+
label: Ask your question here
36+
validations:
37+
required: true

‎README.md

+43-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
1-
# heimdall-rs
2-
Heimdall is an advanced Ethereum smart contract toolkit for forensic and heuristic analysis.
1+
![Heimdall-RS](./preview.png?raw=true)
2+
3+
Heimdall is an advanced EVM toolkit which aims to make dealing with smart contracts on EVM based chains easier.
4+
5+
## Installation & Usage
6+
7+
Heimdall's update and installation manager, `bifrost`, can be installed using the following command:
8+
9+
```bash
10+
curl -L https://raw.githubusercontent.com/Jon-Becker/heimdall-rs/main/bifrost/install | bash
11+
```
12+
13+
If you want to manually install bifrost, you can download the latest release from [here](./bifrost/bifrost).
14+
15+
Once you have installed `bifrost`, you can use it to install Heimdall using the following command from a new terminal:
16+
17+
```bash
18+
# install heimdall. By default, it will be compiled from source, which may take some time.
19+
bifrost
20+
```
21+
22+
After compilation, the `heimdall` command will be available to use from a new terminal. For advanced options, see the [bifrost documentation]().
23+
24+
_Having trouble? Check out the [Troubleshooting]() section in the wiki._
25+
26+
## Documentation
27+
28+
Documentation for all of heimdall-rs is available in the [wiki](https://jbecker.dev/r/heimdall-rs/wiki).
29+
30+
## Contributing
31+
32+
If you'd like to contribute to Heimdall or add a module, please open a pull-request with your changes, as well as detailed information on what is changed, added, or improved.
33+
34+
For more detailed information, see the [contributing guide]().
35+
36+
## Issues
37+
38+
If you've found an issue or have a question, please open an issue [here](https://jbecker.dev/r/heimdall-rs/issues). All issues must follow their respective templates.
39+
40+
## Credits
41+
- Jonathan Becker \<[email protected]>
42+
43+
A list of all [contributors](https://jbecker.dev/r/heimdall-rs/wiki) can be found in the wiki.

‎common/src/ether/evm/types.rs

+9-10
Original file line numberDiff line numberDiff line change
@@ -137,23 +137,23 @@ pub fn display(inputs: Vec<Token>, prefix: &str) -> Vec<String> {
137137

138138
for input in inputs {
139139
match input {
140-
Token::Address(_) => output.push(format!("{prefix}{} 0x{input}", "address".dimmed().blue())),
141-
Token::Int(val) => output.push(format!("{prefix}{} {}", "int ".dimmed().blue(), val.to_string())),
142-
Token::Uint(val) => output.push(format!("{prefix}{} {}", "uint ".dimmed().blue(), val.to_string())),
143-
Token::String(val) => output.push(format!("{prefix}{} {val}", "string ".dimmed().blue())),
140+
Token::Address(_) => output.push(format!("{prefix}{} 0x{input}", "address".blue())),
141+
Token::Int(val) => output.push(format!("{prefix}{} {}", "int ".blue(), val.to_string())),
142+
Token::Uint(val) => output.push(format!("{prefix}{} {}", "uint ".blue(), val.to_string())),
143+
Token::String(val) => output.push(format!("{prefix}{} {val}", "string ".blue())),
144144
Token::Bool(val) => {
145-
if val { output.push(format!("{prefix}{} true", "bool ".dimmed().blue())); }
146-
else { output.push(format!("{prefix}{} false", "bool ".dimmed().blue())); }
145+
if val { output.push(format!("{prefix}{} true", "bool ".blue())); }
146+
else { output.push(format!("{prefix}{} false", "bool ".blue())); }
147147
},
148148
Token::FixedBytes(_) | Token::Bytes(_) => {
149149
let bytes = input.to_string().chars().collect::<Vec<char>>().chunks(64).map(|c| c.iter().collect::<String>()).collect::<Vec<String>>();
150150

151151
for (i, byte) in bytes.iter().enumerate() {
152152
if i == 0 {
153-
output.push(format!("{prefix}{} 0x{}", "bytes ".dimmed().blue(), byte));
153+
output.push(format!("{prefix}{} 0x{}", "bytes ".blue(), byte));
154154
}
155155
else {
156-
output.push(format!("{prefix}{} {}", " ".dimmed().blue(), byte));
156+
output.push(format!("{prefix}{} {}", " ".blue(), byte));
157157
}
158158
}
159159
},
@@ -175,8 +175,7 @@ pub fn display(inputs: Vec<Token>, prefix: &str) -> Vec<String> {
175175
output.push(format!("{prefix}("));
176176
output.extend(display(val.to_vec(), &format!("{prefix} ")));
177177
output.push(format!("{prefix})"));
178-
}
179-
178+
}
180179
},
181180
};
182181
}

‎preview.png

1.31 MB
Loading

0 commit comments

Comments
 (0)