Crate sol2seq

sol2seq

A library for generating sequence diagrams from Solidity smart contracts.

This crate can be used as:

• A library in your Rust projects
• A command-line tool for generating diagrams

Library Usage

use anyhow::Result;
use sol2seq::{generate_diagram_from_file, Config};

fn main() -> Result<()> {
    // Create a configuration
    let config = Config {
        light_colors: false,
        output_file: Some("diagram.md".into()),
    };

    // Generate diagram from AST file
    generate_diagram_from_file("path/to/ast.json", config)?;

    println!("Diagram generated successfully!");
    Ok(())
}

CLI Usage

# Generate a diagram from an AST JSON file
sol2seq path/to/ast.json output.md

# Use lighter colors
sol2seq --light-colors path/to/ast.json output.md

Structs

Config

Configuration for diagram generation

ContractInfo

Represents contract information

ContractRelationship

Relationship between contracts

DiagramData

Container for all extracted contract information

Interaction

Represents a diagram interaction between participants

Parameter

Represents a function parameter or return value

StateVariable

Represents a contract’s state variable

Enums

InteractionType

Represents a sequence diagram interaction

Functions

generate_diagram_from_file

Generate a sequence diagram from an AST JSON file

generate_diagram_from_sources

Generate a sequence diagram from Solidity source files

generate_sequence_diagram

Generate a Mermaid sequence diagram from AST JSON