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

Uploaded Source

Built Distribution

woke-1.0.1-py3-none-any.whl (249.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for woke-1.0.1.tar.gz
Algorithm Hash digest
SHA256 0c74f2ef763a30c3ecd16b380951b24e854c6a801a20b388e5151ab270810ff7
MD5 e33ed79651756a978b7fa87baf096f14
BLAKE2b-256 0406e512491dafe229c6ef3c024667f287f367a48c3ddf824a889f8bfd368d27

See more details on using hashes here.

File details

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

File metadata

  • Download URL: woke-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 249.7 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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ae8ff64c7623d36a989888d2fa15c3e6be9d30f108ba4b3225fd88ab6dd6d528
MD5 95d6f8cf10304e06d566d364a389dd9d
BLAKE2b-256 0fceccd27526bd8cfbc6f4ccbe4b0dcdbfccc7ab97f48e5d4758fcb9c2cca268

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