Scribble
  • Introduction
  • Scribble Generator
  • Tool
    • Installation
    • CLI Usage
      • Arm and disarm
    • Assertion Checking Modes
    • Instrumented Code
      • Debugging Instrumented Code
    • JSON output specification
    • FAQ
  • Language
    • Introduction
    • Annotations
      • Function Annotations
      • State Variable Annotations
      • Contract Invariants
      • Scribble Functions
      • Assert Annotations
      • Macros
      • Hints
    • Expressions
      • Quantification
  • Tutorials
    • Property Checking with Scribble and MythX
    • Property Checking with Scribble and Mythril
    • In-place testing with Scribble
Powered by GitBook
On this page
  • Tutorials
  • Documentation
  • Code

Was this helpful?

Introduction

Documentation for https://github.com/ConsenSys/Scribble

NextScribble Generator

Last updated 1 year ago

Was this helpful?

Scribble is a runtime verification tool for Solidity that transforms annotations in the into concrete assertions that check the specification. In other words, Scribble transforms existing contracts into contracts with equivalent behaviour, except that they also check properties. With these instrumented contracts, you can use testing, fuzzing or symbolic execution (for example using Mythril or the MythX service) to check if your properties can be violated.

Scribble is currently in beta, and both the tool and the language are still changing and under active development.

Tutorials

To get started quickly check out these tutorials:

Documentation

This documentation has two categories: Tool and Language.

Code

To get started using the Scribble CLI (Tool), check out the and pages.

Also be sure to check out the page on , which explains how to use Scribble to do "in place" instrumentation. For a deep dive into instrumentation, and to debug any issues, check out the and pages.

To get started learning about the Scribble specification language, start .

If you encounter any issues feel free to find us in the #scribble-spec-langauge channel of the , or file an on GitHub.

You can find the code on github - .

In-place testing with Scribble
Property Checking with Scribble and MythX
Property Checking with Scribble and Mythril
Installation
CLI Usage
arming and disarming
Instrumented Code
Debugging
here
MythX Discord Server
issue
https://github.com/ConsenSys/scribble
Scribble specification language
Scribble overview