Skip to main content

Woke is a Python-based development and testing framework for Solidity.

Project description

Woke

Woke is a Python-based development and testing framework for Solidity.

Features:

  • Vulnerability detectors

  • LSP server

  • Fuzzer - a property-based fuzzer for Solidity smart contracts that allows testers to write their fuzz tests in Python.

Dependencies

  • Python (version 3.7 or higher)

Installation

:warning: Woke has been moved from abch-woke PyPi package to woke.

via pip

pip3 install woke

Features

Vulnerability detectors

Vulnerability detectors can be run using:

woke detect

LSP server

Woke implements an LSP server for Solidity. The only currently supported communication channel is TCP.

Woke LSP server can be run using:

woke lsp

Or with an optional --port argument:

woke lsp --port 1234

All LSP server features can be found in the documentation.

Fuzzer

The property-based fuzzer can be installed as an extra dependency. Due to the dependency on eth-brownie, it is recommended to install it into a virtual environment.

pip3 install woke[fuzzer]

Documentation & Contribution

Woke documentation can be found here.

There you can also find a section on contributing.

License

This project is licensed under the ISC license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

woke-1.2.1.tar.gz (176.1 kB view hashes)

Uploaded Source

Built Distribution

woke-1.2.1-py3-none-any.whl (266.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page