Metadata-Version: 2.1
Name: diligence-fuzzing
Version: 0.9.8
Summary: A command line interface for the Diligence Fuzzing API
Home-page: https://github.com/ConsenSys/diligence-fuzzing
Author: Dominik Muhs, João Santos
Author-email: joao.santos@consensys.net
License: Apache-2.0 License
Keywords: diligence-fuzzing
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Topic :: Security
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Terminals :: Terminal Emulators/X Terminals
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: PyPy
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst

====================================
A CLI for the Diligence Fuzzing API
====================================

This package aims to provide a simple to use command line interface for the `Diligence Fuzzing <https://consensys.net/diligence/fuzzing/>`_ smart contract
security analysis API.


What is Diligence Fuzzing?
--------------------------

Easy to use and powerful, Fuzzing as a Service enables users to find bugs immediately after writing their first specification!
Smart contracts are increasingly complex programs that often hold and manage large amounts of assets. Developers should use tools to analyze their smart contracts before deploying them to find vulnerabilities open to exploitation.


Usage
-----

.. code-block:: console

    $ Usage: fuzz [OPTIONS] COMMAND [ARGS]...

    Your CLI for interacting with https://fuzzing.diligence.tools

    Options:
      --debug            Provide additional debug output
      -c, --config PATH  YAML config file for default parameters
      --help             Show this message and exit.

    Commands:
      arm              Prepare the target files for Diligence Fuzzing API...
      auto             Automatically annotate test contracts
      disarm           Revert the target files to their original,...
      generate-config  Generate config file for fuzzing
      lesson           Manage fuzzing lessons
      run              Submit contracts to the Diligence Fuzzing API



Installation
------------

The Diligence Fuzzing CLI runs on Python 3.6+, including 3.8 and pypy3.

To get started, simply run

.. code-block:: console

    $ pip3 install diligence-fuzzing

Alternatively, clone the repository and run

.. code-block:: console

    $ pip3 install .

Or directly through Python's :code:`setuptools`:

.. code-block:: console

    $ python3 setup.py install


* Free software: Apache 2 license
* Documentation: https://fuzzing-docs.diligence.tools/getting-started/configuring-the-cli


=======
History
=======

0.9.7 (2022-08-24)
--------------------
- Add :code:`quickcheck` campaigns support
- Add support for the incremental fuzzing
- Add support for fuzzing lessons
- Fix various bugs

0.9.6 (2022-04-13)
--------------------
- Add :code:`time_limit` config option

0.9.5 (2022-04-05)
--------------------
- Add option to provide truffle executable path
- Add proper debugging to truffle errors
- Include raw results to an error output for truffle projects

0.9.4 (2022-03-11)
--------------------
- Improve error messages display
- Make :code:`no-assert` default option on config generator
- Improve api error handling for better error messages on subscriptions

0.9.3 (2022-03-08)
--------------------
- Add no subscription error message
- Improve error message for free trial
- Remove short form of corpus-target parameter at :code:`fuzz run`
- Add additional checks for a seed state generator
- Add :code:`--no-assert` flag to :code:`scribble arm` command

0.9.2 (2022-02-22)
--------------------
- Fix bugs

0.9.1 (2022-02-22)
--------------------
- Add :code:`requests` dependency to requirements
- Fix various bugs

0.9.0 (2022-02-10)
--------------------
- Add :code:`generate-config` command
- Improve development frameworks support
- Add :code:`dapptools` framework support

0.8.2 (2022-01-19)
--------------------
- Fix :code:`disarm` command related bugs

0.8.1 (2021-10-26)
--------------------
- Fix bugs
- Improve :code:`Hardhat` support

0.7.2 (2019-09-13)
--------------------
- Add new format API Key support
- Add :code:`project_name` config parameter

0.7.1 (2019-09-13)
--------------------
- Update Readme

0.6.22 (2021-08-20)
--------------------
- First release on PyPI.
