traverse-solidity 0.1.4

Solidity language parser and AST for code analysis
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

# traverse-solidity

Core Solidity parsing and analysis functionality for the Traverse suite.

## Overview

This crate provides the foundational Solidity parsing capabilities using tree-sitter, enabling syntactic analysis of smart contracts. It serves as the backbone for all Traverse tools that need to understand Solidity code structure.

## Features

- Fast, incremental parsing using tree-sitter
- Complete Solidity syntax support
- AST traversal utilities
- Source location tracking
- Comment preservation

## Usage

```rust
use traverse_solidity::parse_solidity;

fn main() {
    let source_code = r#"
        contract Example {
            function hello() public pure returns (string memory) {
                return "Hello, World!";
            }
        }
    "#;
    
    let tree = parse_solidity(source_code);
    // Process the syntax tree
}
```

## Tree-sitter Grammar

This crate uses a customized tree-sitter grammar for Solidity that provides comprehensive coverage of Solidity syntax including:
- All contract types (contracts, interfaces, libraries, abstract contracts)
- Solidity 0.8+ features
- Inline assembly (Yul)
- NatSpec comments

## Part of Traverse

This crate is part of the [Traverse](https://github.com/calltrace/traverse) suite of tools for Solidity code analysis, visualization, and test generation.

## License

MIT OR Apache-2.0