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.0.tar.gz (176.0 kB view details)

Uploaded Source

Built Distribution

woke-1.2.0-py3-none-any.whl (266.4 kB view details)

Uploaded Python 3

File details

Details for the file woke-1.2.0.tar.gz.

File metadata

  • Download URL: woke-1.2.0.tar.gz
  • Upload date:
  • Size: 176.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.12

File hashes

Hashes for woke-1.2.0.tar.gz
Algorithm Hash digest
SHA256 7ba1248c4d829792f2d1e23ded5f0af164b0177c8eb5728e587485f72c1e72ec
MD5 6d9128e49247c5178ccb66571356cbf5
BLAKE2b-256 e442b3bb32c887e501a9e743f1aa77e695b723a7b41ac9d01dd66275b34cfb0f

See more details on using hashes here.

File details

Details for the file woke-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: woke-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 266.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.12

File hashes

Hashes for woke-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f8fd2ab6d3d4e8486d703187ab3521626f6389746f3aff1207b5f08ef26e0794
MD5 4340aa042c1075775c313f03d05850e4
BLAKE2b-256 bd3d5715b0f39a5aee075cb381bfa7758753eca692adb55d420ef752fa405279

See more details on using hashes here.

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