Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/unpackdev/solgo

Solidity parser in Go, designed to transform Solidity code into a structured format for enhanced analysis, particularly beneficial for developers using Go to analyze Solidity smart contracts.
https://github.com/unpackdev/solgo

abi abstract-syntax-tree arbitrum binance-smart-chain bytecode-interpreter control-flow-analysis decompiler ethereum golang intermediate-representation optimism program-analysis smt solidity solidity-compiler solidity-contracts static-analysis syntatic-analysis syntax-analysis vulnerability-detection

Last synced: about 1 month ago
JSON representation

Solidity parser in Go, designed to transform Solidity code into a structured format for enhanced analysis, particularly beneficial for developers using Go to analyze Solidity smart contracts.

Awesome Lists containing this project

README 

        
![Build Status](https://github.com/unpackdev/solgo/actions/workflows/test.yml/badge.svg)

![Security Status](https://github.com/unpackdev/solgo/actions/workflows/gosec.yml/badge.svg)

[![Coverage Status](https://coveralls.io/repos/github/unpackdev/solgo/badge.svg?branch=main)](https://coveralls.io/github/unpackdev/solgo?branch=main)

[![Go Report Card](https://goreportcard.com/badge/github.com/unpackdev/solgo)](https://goreportcard.com/report/github.com/unpackdev/solgo)

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![PkgGoDev](https://pkg.go.dev/badge/github.com/unpackdev/solgo)](https://pkg.go.dev/github.com/unpackdev/solgo)

[![Discord](https://img.shields.io/discord/1109929011896909875.svg)](https://discord.gg/PdHVbuTQRX)



# Ethereum and Solidity Toolkit in Go: Parser and Analyzer



**SolGo** - a robust tool crafted in Go, designed to dissect and analyze Solidity's source code.



The parser is generated from a Solidity grammar file using **Antlr**, producing a lexer, parser, and listener using **AntlrGo**. This allows for the syntactic analysis of Solidity code, transforming it into a parse tree that offers a detailed syntactic representation of the code, allowing for intricate navigation and manipulation.



This project is ideal for those diving into data analysis, construction of robust APIs, developing advanced analysis tools, enhancing smart contract security, and anyone keen on harnessing Go for their Solidity endeavors.



## Solidity Version Support



**Currently, Solidity versions equal or higher to 0.6.0 are supported.**



Older versions may or may not work due to changes in syntax that is not currently supported by the grammar file. In the future, we have plans to support all versions of Solidity.



## Disclaimer



Please be aware that this project is still under active development. While it is approaching a state suitable for production use, there may still be undiscovered issues or limitations. Over the next few months, extensive testing will be conducted to evaluate its performance and stability. Additional tests and documentation will also be added during this phase.

Additionally, most of the interfaces will stay as is, however, there could be architectural changes that may break your build in the future. I'll try to change as little as possible and notify everyone about the change in release notes.



Once I am confident that the project is fully ready for production, this disclaimer will be removed. Until then, please use the software with caution and report any potential issues or feedback to help improve its quality.



## Documentation



The SolGo basic documentation is hosted on GitHub, ensuring it's always up-to-date with the latest changes and features. You can access the full documentation [here](https://github.com/unpackdev/solgo/wiki).



## Getting Started



Detailed examples of how to install and use this package can be found in the [Usage](https://github.com/unpackdev/solgo/wiki/Getting-Started) section.



### Need help?



Want to use this library but have issues, questions or just want to join the wagon and follow the ride?



You can join our [Discord](https://discord.com/invite/PdHVbuTQRX) server.



## Solidity Language Grammar



Latest Solidity language grammar higher overview and detailed description can be found [here](https://docs.soliditylang.org/en/v0.8.19/grammar.html).



## ANTLR Grammar



We are using grammar files that are maintained by the Solidity team.

Link to the grammar files can be found [here](https://github.com/ethereum/solidity/tree/develop/docs/grammar).



## ANTLR Go



We are using the ANTLR4 Go runtime library to generate the parser. Repository can be found [here](https://github.com/antlr4-go/antlr).



## Crytic Slither



We are using Slither to detect vulnerabilities in smart contracts. Repository can be found [here](https://github.com/crytic/slither).



Makes no sense to rewrite all of that hard work just to be written in Go. Therefore, a bit of python will not hurt. In the future we may change direction.



## Features



- **Protocol Buffers**: Utilizing [Protocol Buffers](https://github.com/unpackdev/protos), SolGo offers a structured data format, paving the way for enhanced analysis and facilitating a unified interface for diverse tools. Currently, it supports Go and Javascript, with plans to incorporate Rust and Python in upcoming versions.

- **Abstract Syntax Tree (AST) Generation:** Package `ast` is equipped with a dedicated builder that crafts an Abstract Syntax Tree (AST) tailored for Solidity code.

- **Intermediate Representation (IR) Generation**: From the AST, SolGo is adept at generating an Intermediate Representation (IR). `ir` package serves as a language-neutral depiction of the contract, encapsulating pivotal components like functions, state variables, and events, thus broadening the scope for intricate analysis and contract manipulation.

- **Control Flow Graph (CFG) Generation**: Building upon the IR, SolGo provides tools for constructing and visualizing Control Flow Graphs (CFGs) of Solidity contracts, aiding in the analysis of contract execution paths and potential bottlenecks.

- **Application Binary Interface (ABI) Generation:** SolGo's in-built `abi` package can interpret contract definitions, enabling the generation of ABI for a collective group of contracts or individual ones.

- **Opcode Tools**: The `opcode` package in SolGo demystifies bytecode by decompiling it into opcodes. Additionally, it provides tools for the creation and visualization of opcode execution trees, granting a holistic perspective of opcode sequences in smart contracts.

- **Library Integration**: SolGo is programmed to autonomously source and assimilate Solidity contracts from renowned libraries, notably [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts). This feature enables users to seamlessly import and utilize contracts from these libraries without the need for manual integration.

- **EIP & ERC Registry**: SolGo introduces a package `standards` exclusively for Ethereum Improvement Proposals (EIPs) and Ethereum Request for Comments (ERCs). This package streamlines interactions with diverse contract standards by encompassing functions, events, and a registry system optimized for proficient management.

- **Solidity Compiler Detection & Compilation:** SolGo intelligently identifies the Solidity version employed for contract compilation. This not only streamlines the process of determining the compiler version but also equips users with the capability to seamlessly compile contracts.

- **Security Audit Package**: Prioritizing security, SolGo has incorporated an `audit` package. This specialized package leverages [Slither](https://github.com/crytic/slither)'s sophisticated algorithms to scrutinize and pinpoint potential vulnerabilities in Solidity smart contracts, ensuring robust protection against adversarial threats.

- **Contract Bytecode Validation:** Enhanced `validation` package ensures the integrity and authenticity of contract bytecode. By comparing the bytecode of a deployed contract with the expected bytecode generated from its source code, SolGo can detect any discrepancies or potential tampering. This feature is crucial for verifying that a deployed contract's bytecode corresponds accurately to its source code, providing an added layer of security and trust for developers and users alike.



## External Projects / Extensions / Plugins



List of the projects that use SolGo:



- [{Un}pack](https://github.com/unpackdev/unpack) - Solidity (Ethereum) Smart Contracts Analysis Toolchain.

- [Solidity-Gas-Optimizoor](https://github.com/yongkangc/solidity-optimiser-app) - An high performance automated tool that optimizes gas usage in Solidity smart contracts, focusing on storage and function call efficiency.



If you wish to add your repository to the list, make sure to submit new PR :)



## Contributing



Contributions to SolGo are always welcome! Please visit [Contributing](https://github.com/unpackdev/solgo/wiki/Contributing) for more information on how to get started.



## License



SolGo is licensed under the Apache 2.0. See [LICENSE](LICENSE) for the full license text.