Skip to main content

Debugging Errors

Sometimes, scans may fail due to common issues that can be easily resolved. This guide will walk you through the most frequent problems and how to fix them to ensure successful scans with CodeHound. Please make sure to report any and all errors to our email. If you have been unfairly decredited lines of code, make sure to contact us to get those lines of code back with a bonus.

File Archive

1. Incorrect Project Structure​

One of the main reasons for a failed scan is an incorrect project structure. CodeHound compiles your Solidity code server-side, so the code must be structured in a way that allows it to be compiled without errors.

Standalone File Errors​

If you are uploading standalone .sol files, make sure:

  • Each file is flattened (i.e., no imports).
  • Every file contains a pragma solidity version declaration at the top.

If the files are not independent or rely on each other without proper flattening, the scan will fail.

Project Structure Errors​

If you are uploading a Hardhat, Truffle, or Foundry project, ensure:

  • The package.json file is included.
  • Other configuration files like hardhat.config.js or foundry.toml are present.
  • The folder structure resembles:
Project Folder
  ├── contracts/
      ├── Token.sol
      └── somethingElse.sol
  ├── package.json
  ├── foundry.toml (or hardhat.config.js in the case of hardhat, typescript is also accepted)

Without a valid structure and the necessary configuration files, the server-side compilation will fail, leading to an incomplete scan.

As CodeHound is in an early beta stage, certain features may still be improving, and sometimes the AI may run into issues that cause the scan to fail unexpectedly. These issues may include:

  • Misinterpretation of some parts of the code.
  • Handling certain code patterns incorrectly.

If your scan fails and the project structure is correct, it might be due to a temporary AI-related issue. In these cases:

  • Retry the scan—small adjustments in the process can resolve the issue.
  • If the problem persists, contact support for further assistance.

3. General Troubleshooting Steps​

Here are some additional steps you can take to troubleshoot errors:

  • Double-check the pragma solidity version in standalone files.
  • Ensure that the package.json file and configuration files are in the root of your project folder.
  • Try uploading a simplified version of the project to isolate the issue.
  • If using a smart contract address (EVM), ensure that it is correctly formatted and the chain is supported.

By following these tips and ensuring your code meets the requirements, you'll increase the chances of running successful scans. If you encounter persistent issues, don't hesitate to reach out to our support team.