https://github.com/crytic/contract-explorer

Visual Studio Code integration for Slither, a Solidity static analysis framework

https://github.com/crytic/contract-explorer

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.4%) to scientific vocabulary

Keywords

ethereum solidity static-analysis visual-studio-code vscode-extension
Last synced: 5 months ago · JSON representation

Repository

Visual Studio Code integration for Slither, a Solidity static analysis framework

Basic Info
  • Host: GitHub
  • Owner: crytic
  • License: agpl-3.0
  • Language: TypeScript
  • Default Branch: master
  • Homepage:
  • Size: 926 KB
Statistics
  • Stars: 35
  • Watchers: 13
  • Forks: 11
  • Open Issues: 24
  • Releases: 2
Topics
ethereum solidity static-analysis visual-studio-code vscode-extension
Created almost 7 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Codeowners

README.md

Contract Explorer (Visual Studio Code Extension)

Visual Studio Code integration for Slither, a Solidity static analysis framework.

This extension offers Visual Studio Code integration for Slither, a Solidity static analysis framework written in Python 3. With Slither for Visual Studio Code, users can run a suite of vulnerability detectors on their Solidity smart contracts to annotate potentially dangerous code and receive suggested fixes.

Logo

Features

  • Analyze open workspaces
  • Explore results in a custom tree, sorted by issue type or severity
  • View results as native Visual Studio Code information/warnings/errors
  • See annotations for relevant source code for each issue
  • Print detailed issue description and recommendations
  • Filter issues by type (per workspace configuration)
  • Specify custom solc path (per workspace configuration)
  • Solidity Syntax Highlighting

Requirements

[!NOTE] slither-lsp must be accessible via the slither-lsp command in order for this extension to invoke it. Use pip install slither-lsp to install it.

Installation

From the Visual Studio Marketplace

Install Contract Explorer from the Visual Studio Marketplace within the Extensions tab of Visual Studio Code.

From source

sh git clone https://github.com/crytic/contract-explorer cd contract-explorer npm i npm install -g vsce vsce package

contract-explorer-X.X.X.vsix will be created.

Install the VSIX file in Visual Studio through Extensions, under the ... menu.

Getting Started

After installing the extension, simply open a workspace containing any Solidity (*.sol) files. The extension will activate, revealing the Slither logo on the action bar. Click it to reveal a settings pane, from which you will be able to select which detector results will be shown after a workspace folder has finished analysing.

Once analysis of a folder is done, you will be able to explore the codebase by using the familiar VSCode tools "Go to implementations", "Go to definitions", "Find all references", and showing call and type hierarchies.

License

AGPL-3.0

Owner

  • Name: Crytic
  • Login: crytic
  • Kind: organization
  • Email: opensource@trailofbits.com
  • Location: New York, NY

Blockchain Security, by @trailofbits

GitHub Events

Total
  • Issues event: 3
  • Watch event: 5
  • Issue comment event: 3
  • Pull request event: 1
Last Year
  • Issues event: 3
  • Watch event: 5
  • Issue comment event: 3
  • Pull request event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 38
  • Total pull requests: 20
  • Average time to close issues: about 1 month
  • Average time to close pull requests: about 1 month
  • Total issue authors: 18
  • Total pull request authors: 6
  • Average comments per issue: 0.63
  • Average comments per pull request: 0.2
  • Merged pull requests: 12
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: 3 days
  • Average time to close pull requests: N/A
  • Issue authors: 2
  • Pull request authors: 0
  • Average comments per issue: 1.5
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Xenomega (18)
  • frabert (3)
  • zarifpour (2)
  • anishnaik (1)
  • seanfoltz (1)
  • hacker-DOM (1)
  • JMariadlcs (1)
  • currenthandle (1)
  • ODeluxe (1)
  • RaoulSchaffranek (1)
  • vovikhangcdv (1)
  • gabkov (1)
  • tamzincad (1)
  • farazsth98 (1)
  • ameily (1)
Pull Request Authors
  • broccolirob (10)
  • frabert (6)
  • llllvvuu (2)
  • ggrieco-tob (1)
  • XonFire (1)
  • 0xDaedalus (1)
Top Labels
Issue Labels
enhancement (6) bug (4) investigation (2)
Pull Request Labels
enhancement (2)

Dependencies

package.json npm
  • @types/mocha ^2.2.42 development
  • @types/node ^8.10.25 development
  • @types/semver ^6.0.0 development
  • @types/shelljs ^0.8.1 development
  • @types/spark-md5 ^3.0.1 development
  • tslint ^5.8.0 development
  • typescript ^3.1.4 development
  • vscode ^1.1.25 development
  • semver ^6.0.0
  • shelljs ^0.8.3
  • spark-md5 ^3.0.0