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-2.0.0rc1.tar.gz (247.0 kB view details)

Uploaded Source

Built Distribution

woke-2.0.0rc1-py3-none-any.whl (349.8 kB view details)

Uploaded Python 3

File details

Details for the file woke-2.0.0rc1.tar.gz.

File metadata

  • Download URL: woke-2.0.0rc1.tar.gz
  • Upload date:
  • Size: 247.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.12

File hashes

Hashes for woke-2.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 2fd9caab9bf4e1f986db0413909be1f56258aeb0bda9a693c49324fe7877b176
MD5 a509db22bc4ae3a407464962bf47f30c
BLAKE2b-256 2232702bd09d6805240816e489e569f286ded3a9278c53b3f75f68500e9a50ce

See more details on using hashes here.

File details

Details for the file woke-2.0.0rc1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for woke-2.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 0861cc219481572dd4a28b89b75ee11f270d2611019aac4f8aa2064f8db06f5b
MD5 f02da12cab5a9a09afa1c96281ddd54c
BLAKE2b-256 221d4e6f4b3bfb9da3e00f3a17714caf66a3815ebd8db4b844dedaefdfb674e3

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