OpenViSTAI · Agents · Blockchain · Crypto
Submit a project
Menu
Developer Tools

Scribble

Scribble is a command-line tool for specifying and instrumenting Solidity smart contracts with runtime-verification checks. Those checks make contract properties available during property-based testing and use with off-the-shelf analysis tools.

Explore the practical guide ↓

Independent OpenViST project profile, based on linked sources.

Scribble — OpenViST project profile in Developer Tools.
OpenViST project illustration. See the linked sources for product details.
Understand the project

Practical overview

When it fits

Use Scribble when a Solidity testing workflow needs runtime checks for specified contract properties, particularly before property-based testing or analysis with compatible off-the-shelf tools.

Who it is for

  • Solidity developers adding explicit behavior or security properties to contract tests.
  • Smart-contract auditors and testing teams preparing instrumented source for fuzzing or analysis.

Documented uses

  • Express contract properties as Scribble specifications.
  • Instrument Solidity source so properties can be checked during testing.
  • Prepare contracts for property-based testing or analysis with tools such as Diligence Fuzzing or Mythril.
Before you choose

Requirements & limits

The project README documents npm installation for the CLI and identifies the project as Apache-2.0 licensed.

  • The documented primary interface is a CLI that accepts a Solidity source file.
  • Scribble handles specification and instrumentation; property-based testing or analysis is carried out as part of a broader workflow.
  • The project notes that some properties may be difficult or impossible to express.
  • VS Code syntax highlighting and hover hints are provided by a separate extension and repository.

Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.

Source-based practical guide

Install Scribble and instrument a Solidity file

Install the CLI and pass a Solidity source file to Scribble for instrumentation.

Before you start

  • npm
  • A Solidity source file, such as sample.sol

Steps

  1. Install the package globally with npm install -g eth-scribble.

  2. Run scribble sample.sol, replacing the example filename with the Solidity source file to use.

  3. Consult scribble --help for available CLI features.

Expected outcome

The documented CLI invocation applies Scribble to the supplied Solidity source file.

Guide limitations

  • The README does not specify the resulting file handling or a subsequent testing command.
  • Some properties may be difficult or impossible to express in Scribble.
Documentation 1 ↗
Evidence and transparency

Sources & review

Official repository ↗
Source record details
Source availability
Active
Sources checked
13 October 2026
Original website title
ConsenSysDiligence/scribble · Official homepage title · retained in its source language
How we review sourcesSuggest a correction