Skip to main content

Select Documentation

Enterprise Feature

This additional context documentation feature is exclusively available to the Enterprise plan.

Overview​

After you've finished selecting your repository, branch and contracts, you can enhance your audit by providing additional documentation context. This feature allows you to include relevant documentation that can help in producing more accurate and context-aware results.

How to Use​

  1. Browse through the list of available documentation files (currently limited to readme files)
  2. Use the search box to quickly find specific documents
  3. Select the files you want to include in your audit
  4. Click "Next" to proceed
info

Make sure to stay below the authorized characters limit!

Select Docs

Enhance Your Audit with Questions​

To provide even better context for your scan, you can answer a serie of targeted questions about your smart contracts. This will help AuditAgent to:

  • Better understand your contract's purpose and functionality
  • Focus on specific areas of concern
  • Provide more relevant and accurate findings
  • Identify potential vulnerabilities based on your use case
  • Exclude per-design findings from the report

Questions Interface

Next Steps​

When you are ready, click on the "Scan code" button to initiate the scanning process. Once completed:

  • You'll be redirected to the results page
  • A detailed audit report will be sent to your email
info

A scan can take up to 10 minutes. But you do not need to wait for it to complete. You can simply close the page and wait for the report to be sent by email.