Skip to main content

A Solidity parser for Python built on top of a robust ANTLR4 grammar

Project description


A Solidity parser for Python built on top of a robust ANTLR4 grammar

This is a python3 port of the javascript antlr parser maintained by @federicobond. Interfaces are intentionally following the javascript impelementation and therefore not pep8 compliant.


#> pip3 install solidity_parser
#> python3 -m solidity_parser <path_to_contract.sol>   # prettyprints tree


import sys
import pprint

from solidity_parser import parser

sourceUnit = parser.parse_file(sys.argv[1])


{'type': 'SourceUnit',
 'children': [{'type': 'PragmaDirective',
               'name': 'solidity',
               'value': '^0.4.22'},
              {'type': 'ContractDefinition'},
               'baseContracts': [],
               'kind': 'contract',
               'name': 'SimpleAuction',
               'subNodes': [{'initialValue': None,
                             'type': 'StateVariableDeclaration',
                             'variables': [{'expression': None,
                                            'isDeclaredConst': False,
                                            'isIndexed': False,
                                            'isStateVar': True,
                                            'name': 'beneficiary',
                                            'type': 'VariableDeclaration',
                                            'typeName': {'name': 'address',
                                                         'type': 'ElementaryTypeName'},
                                            'visibility': 'public'}]},


parse nodes can be accessed like dictionaries or object attributes. Nodes always carry a type field to denote the type of information provided. The first node is of type sourceUnit.

Generate the parser

Update the grammar in ./solidity-antlr4/Solidity.g4 and run the antlr generator script to create the parser classes in solidity_parser/solidity_antlr4.

#> bash script/

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

solidity-parser-0.0.1.tar.gz (55.9 kB view hashes)

Uploaded Source

Built Distributions

solidity_parser-0.0.1-py3.7.egg (18.7 kB view hashes)

Uploaded Source

solidity_parser-0.0.1-py3-none-any.whl (67.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page