Help

.gitignore

@@ -1,11 +1,141 @@
-__pycache__
-*/__pycache__
-cache_code
-cache_pabi
-cache_pan
+__pycache__/
 cache
-cache_pan
 .DS_Store
-supplement.db
-supp2.db
-cache_*
+
+# Byte-compiled / optimized / DLL files
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

MANIFEST.in

@@ -0,0 +1 @@
+graft panoramix/data

README.md

@@ -1,6 +1,40 @@
-This is a fork of: https://github.com/eveem-org/panoramix.git
+Panoramix
+=========
+
+This is an EVM decompiler.
+
+It's is a fork of the Panoramix original repo that's not maintained actively by its author anymore: https://github.com/eveem-org/panoramix.git
 
 The goal of this fork is to maintain Panoramix in a decent shape, fix some crashes, implement missing opcodes...
+I also got rid of the "tilde" syntax that was using a custom python encoding and use vanilla Python instead. And I made it a proper python package that can be imported.
+There is also a better support of timeouts, as instead of stopping entirely we will fallback and print whatever we decompiled even if it's not complete.
+
+The code quality is still not great and the software is complex, it's mostly reserved for advanced users.
+
+## Installation
+
+```console
+$ pip install panoramix-decompiler
+```
+
+## Running
+
+You can specify a web3 provider using the environment variable `WEB3_PROVIDER_URI`. In this case a local provider was set.
+
+```console
+$ WEB3_PROVIDER_URI=http://localhost:7545 panoramix 0x0d94D81FD712126E7f320b5B10537D01d6a01563
+```
+
+You can also provide the bytecode for decompilation.
+
+```console
+$ panoramix 6004600d60003960046000f30011223344
+```
+
+## Examples
+
+I have decompiled all of mainnet, and make sure to decompile again on the latest Panoramix version from time to time.
+
+You can access decompilations using Oko: https://oko.palkeo.com/
 
-For now I only plan to implement very minor (but annoying fixes). If something is too complicated to understand or would require
-a non-negligible amount of time it won't be fixed.
+Here is an example for cryptokitties: https://oko.palkeo.com/0x06012c8cf97BEaD5deAe237070F9587f8E7A266d/code/