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.

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

chore: documentation and linting overhaul #549

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

Jon-Becker
Copy link
Owner

Motivation

Closes #538

Solution

rust.missing_docs = "warn"
rust.unreachable_pub = "warn"
rust.unused_must_use = "deny"
rust.rust_2018_idioms = "deny"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [clippy] reported by reviewdog 🐶

error: lint group `rust_2018_idioms` has the same priority (0) as a lint
  --> Cargo.toml:48:6
   |
46 | rust.unreachable_pub = "warn"
   |      --------------- has the same priority as this lint
47 | rust.unused_must_use = "deny"
48 | rust.rust_2018_idioms = "deny"
   |      ^^^^^^^^^^^^^^^^   ------ has an implicit priority of 0
   |
   = note: the order of the lints in the table is ignored by Cargo
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#lint_groups_priority
   = note: `#[deny(clippy::lint_groups_priority)]` on by default
help: to have lints override the group set `rust_2018_idioms` to a lower priority
   |
48 | rust.rust_2018_idioms = { level = "deny", priority = -1 }
   |                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Copy link
Contributor

github-actions bot commented Jan 6, 2025

Benchmark for 5f8b5dd

Click to view benchmark
Test Base PR %
heimdall_cfg/complex 14.3±0.10ms 14.4±0.36ms +0.70%
heimdall_cfg/simple 2.2±0.04ms 2.2±0.11ms 0.00%
heimdall_decoder/seaport 40.4±1.99µs 39.4±1.58µs -2.48%
heimdall_decoder/transfer 3.0±0.33µs 3.0±0.27µs 0.00%
heimdall_decoder/uniswap 11.6±0.98µs 11.5±0.55µs -0.86%
heimdall_decompiler/abi_complex 62.3±0.90ms 60.2±0.49ms -3.37%
heimdall_decompiler/abi_simple 2.4±0.09ms 2.2±0.01ms -8.33%
heimdall_decompiler/sol_complex 76.3±2.92ms 73.5±1.22ms -3.67%
heimdall_decompiler/sol_simple 2.8±0.02ms 2.7±0.05ms -3.57%
heimdall_decompiler/yul_complex 65.7±0.96ms 63.6±1.06ms -3.20%
heimdall_decompiler/yul_simple 2.4±0.03ms 2.4±0.05ms 0.00%
heimdall_disassembler/complex 970.9±64.51µs 968.2±29.51µs -0.28%
heimdall_disassembler/simple 46.9±1.93µs 47.5±3.87µs +1.28%
heimdall_vm/erc20_transfer 343.9±14.86µs 333.6±11.04µs -3.00%
heimdall_vm/fib 788.0±6.77µs 831.4±5.91µs +5.51%
heimdall_vm/ten_thousand_hashes 4.8±0.03s 4.9±0.08s +2.08%

Copy link
Contributor

github-actions bot commented Jan 6, 2025

Benchmark for d26c14a

Click to view benchmark
Test Base PR %
heimdall_cfg/complex 46.4±11.20ms 17.7±2.01ms -61.85%
heimdall_cfg/simple 6.7±1.54ms 3.8±1.08ms -43.28%
heimdall_decoder/seaport 156.0±55.97µs 73.5±29.08µs -52.88%
heimdall_decoder/transfer 10.2±2.62µs 5.2±1.38µs -49.02%
heimdall_decoder/uniswap 42.9±12.02µs 19.7±5.85µs -54.08%
heimdall_decompiler/abi_complex 200.0±31.88ms 107.2±28.97ms -46.40%
heimdall_decompiler/abi_simple 8.3±2.41ms 3.7±0.97ms -55.42%
heimdall_decompiler/sol_complex 247.5±54.50ms 118.2±31.31ms -52.24%
heimdall_decompiler/sol_simple 9.7±2.12ms 4.1±0.51ms -57.73%
heimdall_decompiler/yul_complex 205.8±40.25ms 107.0±30.36ms -48.01%
heimdall_decompiler/yul_simple 8.0±3.14ms 3.8±0.86ms -52.50%
heimdall_disassembler/complex 3.8±1.49ms 1438.1±357.89µs -62.16%
heimdall_disassembler/simple 173.1±55.00µs 73.2±19.42µs -57.71%
heimdall_vm/erc20_transfer 1235.1±338.31µs 540.5±131.86µs -56.24%
heimdall_vm/fib 2.9±0.69ms 1482.9±429.47µs -48.87%
heimdall_vm/ten_thousand_hashes 9.9±3.56s 7.6±1.96s -23.23%

Copy link
Contributor

Benchmark for 20c125e

Click to view benchmark
Test Base PR %
heimdall_cfg/complex 21.0±3.32ms 17.4±3.05ms -17.14%
heimdall_cfg/simple 2.7±0.49ms 2.3±0.03ms -14.81%
heimdall_decoder/seaport 53.2±12.55µs 45.1±4.92µs -15.23%
heimdall_decoder/transfer 3.7±0.93µs 3.2±0.43µs -13.51%
heimdall_decoder/uniswap 15.8±4.01µs 12.9±1.59µs -18.35%
heimdall_decompiler/abi_complex 87.0±10.34ms 77.5±9.47ms -10.92%
heimdall_decompiler/abi_simple 2.7±0.37ms 2.6±0.20ms -3.70%
heimdall_decompiler/sol_complex 105.0±12.54ms 89.7±9.74ms -14.57%
heimdall_decompiler/sol_simple 3.4±0.48ms 3.0±0.22ms -11.76%
heimdall_decompiler/yul_complex 106.9±21.92ms 71.9±6.51ms -32.74%
heimdall_decompiler/yul_simple 2.9±0.34ms 2.8±0.24ms -3.45%
heimdall_disassembler/complex 1111.2±124.59µs 1096.7±145.65µs -1.30%
heimdall_disassembler/simple 62.2±15.58µs 56.1±10.75µs -9.81%
heimdall_vm/erc20_transfer 408.9±78.10µs 408.9±57.06µs 0.00%
heimdall_vm/fib 945.7±76.46µs 985.6±115.12µs +4.22%
heimdall_vm/ten_thousand_hashes 5.4±0.18s 5.3±0.19s -1.85%

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

chore: cargo docs
1 participant