mythx_cli package

Subpackages

• mythx_cli.formatter package
  • mythx_cli.formatter.base
  • mythx_cli.formatter.json
  • mythx_cli.formatter.simple_stdout
  • mythx_cli.formatter.tabular
• mythx_cli.payload package
  • mythx_cli.payload.bytecode
  • mythx_cli.payload.solidity
  • mythx_cli.payload.truffle

mythx_cli.cli

The main runtime of the MythX CLI.

mythx_cli.cli.find_solidity_files(project_dir)

Return all Solidity files in the given directory.

This will match all files with the .sol extension.

Parameters:project_dir – The directory to search in Returns:Solidity files in project_dir or None

mythx_cli.cli.find_truffle_artifacts(project_dir)

Look for a Truffle build folder and return all relevant JSON artifacts.

This function will skip the Migrations.json file and return all other files under <project-dir>/build/contracts/. If no files were found, None is returned.

Parameters:project_dir – The base directory of the Truffle project Returns:Files under <project-dir>/build/contracts/ or None

mythx_cli.cli.sanitize_paths(job)

Remove the common prefix from paths.

This method takes a job payload, iterates through all paths, and removes all their common prefixes. This is an effort to only submit information on a need-to-know basis to MythX. Unless it’s to distinguish between files, the API does not need to know the absolute path of a file. This may even leak user information and should be removed.

If a common prefix cannot be found (e.g. if there is just one element in the source list), the relative path from the current working directory will be returned.

This concerns the following fields: - sources - AST absolute path - legacy AST absolute path - source list - main source

Parameters:job – The payload to sanitize

mythx_cli.cli.walk_solidity_files(ctx, solc_version, base_path=None)

mythx_cli.cli.write_or_print(ctx, data: str)

mythx_cli.util