abi2human 1.0.3

Zero-dependency CLI tool to convert Ethereum ABI JSON to human-readable format
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Commands

### Build
```bash
# Debug build
cargo build

# Release build (optimized)
cargo build --release
```

### Test
```bash
# Run all tests
cargo test

# Run tests with output
cargo test -- --nocapture

# Run specific test
cargo test test_name
```

### Lint & Format
```bash
# Format code
cargo fmt

# Check formatting without applying
cargo fmt -- --check

# Run clippy for linting
cargo clippy

# Run clippy with all targets
cargo clippy --all-targets --all-features
```

### Run
```bash
# Run debug version
cargo run -- [args]

# Run release version
cargo run --release -- [args]

# Or use the compiled binary
./target/release/abi2human [args]
```

## Architecture

This is a zero-dependency Rust CLI tool that converts Ethereum ABI JSON to human-readable format. The codebase is modular with clear separation of concerns:

### Core Modules

- **`abi.rs`**: Defines ABI data structures (`AbiItem`, `AbiInput`, `AbiOutput`) and implements their Display traits for human-readable formatting
- **`json_parser.rs`**: Custom JSON parser that handles ABI parsing without external dependencies
- **`converter.rs`**: Orchestrates the conversion process - parses ABI content and formats output
- **`file_ops.rs`**: Handles all file I/O operations including single file, directory, and stdin/stdout processing
- **`main.rs`**: CLI entry point with argument parsing and command routing
- **`tests.rs`**: Comprehensive test suite

### Key Design Patterns

1. **Zero Dependencies**: All JSON parsing and formatting is implemented from scratch to avoid supply chain risks
2. **Stream Processing**: The tool can process stdin to stdout for pipeline integration
3. **Batch Operations**: Supports converting entire directories with pattern matching
4. **Multiple Output Formats**: JSON array, raw text, or compact JSON

### Data Flow

1. Input (file/directory/stdin) → 
2. JSON Parser (converts to ABI structures) → 
3. Converter (formats to human-readable) → 
4. Output (file/stdout with chosen format)

The tool is designed to be fast, secure, and easily auditable with no external dependencies.