chore: documentation and linting overhaul

[Jon-Becker]

Motivation

Closes #538

Solution

[github-actions]

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%

[github-actions]

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%

[github-actions]

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%

[github-actions]

Benchmark for 68e968e

Click to view benchmark

Test	Base	PR	%
heimdall_cfg/complex	15.4±1.77ms	14.1±0.68ms	-8.44%
heimdall_cfg/simple	2.2±0.05ms	2.2±0.02ms	0.00%
heimdall_decoder/seaport	50.3±11.12µs	41.0±2.30µs	-18.49%
heimdall_decoder/transfer	2.9±0.36µs	2.9±0.25µs	0.00%
heimdall_decoder/uniswap	12.9±1.92µs	12.0±1.55µs	-6.98%
heimdall_decompiler/abi_complex	62.1±1.18ms	70.8±8.64ms	+14.01%
heimdall_decompiler/abi_simple	2.3±0.04ms	2.4±0.13ms	+4.35%
heimdall_decompiler/sol_complex	75.7±2.14ms	82.7±7.34ms	+9.25%
heimdall_decompiler/sol_simple	3.0±0.28ms	2.9±0.13ms	-3.33%
heimdall_decompiler/yul_complex	84.9±19.95ms	67.8±2.95ms	-20.14%
heimdall_decompiler/yul_simple	3.4±0.80ms	2.5±0.09ms	-26.47%
heimdall_disassembler/complex	967.8±66.90µs	1068.2±163.98µs	+10.37%
heimdall_disassembler/simple	45.8±1.58µs	54.2±10.47µs	+18.34%
heimdall_vm/erc20_transfer	345.9±19.17µs	378.4±54.28µs	+9.40%
heimdall_vm/fib	823.8±6.88µs	909.5±130.24µs	+10.40%
heimdall_vm/ten_thousand_hashes	5.0±0.06s	5.1±0.09s	+2.00%

[github-actions]

Benchmark for 1e572bf

Click to view benchmark

Test	Base	PR	%
heimdall_cfg/complex	16.0±1.42ms	15.3±1.22ms	-4.37%
heimdall_cfg/simple	2.2±0.10ms	2.2±0.02ms	0.00%
heimdall_decoder/seaport	42.4±2.44µs	42.1±2.39µs	-0.71%
heimdall_decoder/transfer	2.8±0.20µs	2.8±0.19µs	0.00%
heimdall_decoder/uniswap	12.1±0.88µs	12.2±0.88µs	+0.83%
heimdall_decompiler/abi_complex	58.2±0.73ms	64.4±2.55ms	+10.65%
heimdall_decompiler/abi_simple	2.2±0.07ms	2.3±0.07ms	+4.55%
heimdall_decompiler/sol_complex	74.4±1.39ms	78.4±3.89ms	+5.38%
heimdall_decompiler/sol_simple	2.8±0.04ms	2.8±0.02ms	0.00%
heimdall_decompiler/yul_complex	65.1±5.95ms	65.0±1.78ms	-0.15%
heimdall_decompiler/yul_simple	2.4±0.06ms	2.5±0.03ms	+4.17%
heimdall_disassembler/complex	978.9±56.20µs	1024.8±116.96µs	+4.69%
heimdall_disassembler/simple	47.8±3.91µs	53.6±8.02µs	+12.13%
heimdall_vm/erc20_transfer	355.1±17.73µs	363.9±18.82µs	+2.48%
heimdall_vm/fib	844.9±6.37µs	887.8±64.60µs	+5.08%
heimdall_vm/ten_thousand_hashes	5.0±0.12s	5.4±0.11s	+8.00%

[github-actions]

Benchmark for 7f9581b

Click to view benchmark

Test	Base	PR	%
heimdall_cfg/complex	13.7±0.64ms	13.2±0.26ms	-3.65%
heimdall_cfg/simple	2.1±0.10ms	1941.7±14.11µs	-7.54%
heimdall_decoder/seaport	34.7±2.19µs	33.9±2.93µs	-2.31%
heimdall_decoder/transfer	3.6±0.29µs	3.7±0.32µs	+2.78%
heimdall_decoder/uniswap	10.8±0.59µs	11.1±1.11µs	+2.78%
heimdall_decompiler/abi_complex	55.9±0.91ms	60.7±6.31ms	+8.59%
heimdall_decompiler/abi_simple	1965.4±9.35µs	2.1±0.06ms	+6.85%
heimdall_decompiler/sol_complex	68.5±1.27ms	68.4±5.87ms	-0.15%
heimdall_decompiler/sol_simple	2.6±0.06ms	2.6±0.02ms	0.00%
heimdall_decompiler/yul_complex	66.3±2.67ms	60.6±4.10ms	-8.60%
heimdall_decompiler/yul_simple	2.3±0.05ms	2.3±0.02ms	0.00%
heimdall_disassembler/complex	766.8±25.28µs	849.9±111.50µs	+10.84%
heimdall_disassembler/simple	38.7±1.57µs	42.3±3.63µs	+9.30%
heimdall_vm/erc20_transfer	269.8±8.75µs	310.5±34.58µs	+15.09%
heimdall_vm/fib	705.3±12.25µs	739.3±76.20µs	+4.82%
heimdall_vm/ten_thousand_hashes	562.6±29.09ms	581.4±12.68ms	+3.34%