Peek Contract

Peek Contract is a VS Code extension designed specifically for Solidity auditors, this extension helps the process of understanding and auditing contracts by generating a simplified view of the contract directory.

What is this simplified view of contract directory?

The extension generates a modified version of the source directory with:

• Function symbols
• Inline comments
• NatSpec comments
• Interface/struct definitions
• Everything except the implementation/logic details of functions in contracts

Why?

This clean, organized view allows you to quickly grasp the structure and purpose of the codebase, making it easier to ask any LLM "WHAT" questions about the code, such as what a specific file does or the big picture of the codebase. Perfect for Solidity auditors and developers who want to get cozy with new codebases without getting lost in the weeds!

Installation

• Open VS Code.
• Go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window or by pressing Ctrl+Shift+X.
• Search for "Peek Contract" and click Install.

Usage

• Open a dapp project in VS Code.
• Run the command Peek Contract from the Command Palette (Ctrl+Shift+P).
• When prompted, enter the path to the directory containing your smart contracts (e.g., src/contracts).
• The extension will create a modified directory named "peekContract"