Skip to content

Modules

Jonathan Becker edited this page Jul 28, 2022 · 30 revisions

This page outlines the general documentation for all modules in the heimdall-rs toolkit.

Shared Options

These options are shared by nearly all modules on heimdall-rs, and have the same functionality across all modules.

Option Description
-v, --verbose More verbose output per occurrence
-r <RPC_URL>, --rpc-url <RPC_URL> The RPC provider to use when connecting to an RPC node
-o <OUTPUT>, --output <OUTPUT>
-h, --help Show the help message

Verbosity

The -v option can be used to increase the verbosity of heimdall-rs. This can be useful for debugging issues with heimdall-rs. The -v option can be used multiple times to increase the verbosity of heimdall-rs.

Option Level
-v Info
-vv Debug
-vvv Trace
-vvvv Full

RPC URL

The -r option can be used to specify the RPC URL to use when connecting to an RPC node. This RPC URL can theoretically be used on any EVM compatible chain, as long as the data it is fetching is from the same chain.

This option is used for interacting with the RPC node within the module.

Output

The -o option can be used to specify the output file or directory to use when writing output from heimdall-rs.


Modules

Config

This module allows you to display and edit the current configuration of heimdall-rs.

To view the current configuration of heimdall-rs, run heimdall config.

If you want to edit the configuration of heimdall-rs, run heimdall config <key> <value>. This will set the key to the value specified, if it's a valid configuration key.

Disassemble

This module allows you to convert raw EVM bytecode to opcodes.

Usage:

$ heimdall disassemble <TARGET> [OPTIONS]

Options

Option Description
TARGET The target to disassemble, either a file, bytecode, contract address, or ENS name

Decode

This module allows you to decode raw calldata into readable types, without the need for an ABI.

Usage:

$ heimdall decode <TARGET> [OPTIONS]

Options

Option Description
TARGET The target to decode, either a transaction hash or string of bytes
-d, --default When prompted, always select the default value

Clone this wiki locally