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

Uploaded Source

Built Distribution

woke-1.3.1-py3-none-any.whl (269.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: woke-1.3.1.tar.gz
  • Upload date:
  • Size: 178.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.3.1.tar.gz
Algorithm Hash digest
SHA256 0867df9b751f5f00a975a911fcb0a5ed3279aa0c37ef0d082344d7c713826b4e
MD5 513c4f20a0be4fb3b879471129370d13
BLAKE2b-256 1b6af9554d1d26b3292d4d9fb9166209002a453648c5a50432dffd35410f7691

See more details on using hashes here.

File details

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

File metadata

  • Download URL: woke-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 269.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.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 04fc24c1c4112776a8948d04ecebe71c4c3ccdd52ef981ab34ab515666ded6d3
MD5 7478b7ec7d7eac95e3a1317dd655570e
BLAKE2b-256 2b5624053317612445b211bac1ed0a3af6c26a212354b2a1f80946d7fcbbf493

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