Ethereum decompiler - Panoramix 使用教程

1. 项目目录结构及介绍

Panoramix 是一个基于 Python 的 Ethereum 虚拟机（EVM）的反编译器。以下是项目的目录结构及其说明：

panoramix/
├── .flake8             # flake8 Python 代码风格配置文件
├── .gitignore          # Git 忽略文件配置
├── LICENSE             # 项目使用的 MIT 许可证
├── MANIFEST.in         # 打包时包含的文件列表
├── OPCODES.md          # EVM 指令集文档
├── README.md           # 项目说明文件
├── TODO.md             # 待办事项列表
├── poetry.lock         # Poetry 依赖管理锁文件
├── pyproject.toml      # Poetry 项目配置文件
└── ...                # 其他源代码文件

• .flake8：配置 flake8 工具对 Python 代码进行风格检查的规则。
• .gitignore：定义哪些文件和目录应该被 Git 忽略。
• LICENSE：项目使用的 MIT 许可证文本。
• MANIFEST.in：指定在打包发布项目时应该包含哪些文件。
• OPCODES.md：提供 EVM 指令集的详细信息。
• README.md：提供项目的基本信息和说明。
• TODO.md：列出项目开发中需要完成的任务。
• poetry.lock 和 pyproject.toml：使用 Poetry 作为依赖管理工具的配置文件。

2. 项目的启动文件介绍

项目的启动主要通过命令行工具进行。虽然没有明确的单个启动文件，但是可以通过以下命令来使用 Panoramix：

pip install panoramix-decompiler

安装完成后，可以使用以下命令来启动反编译过程：

panoramix <合约地址>

或者，如果需要提供字节码进行反编译，可以使用：

panoramix <字节码>

3. 项目的配置文件介绍

在 Panoramix 中，主要的配置是通过环境变量来实现的。例如，可以通过设置环境变量 WEB3_PROVIDER_URI 来指定 Web3 提供者的 URI：

export WEB3_PROVIDER_URI=http://localhost:7545

此外，项目的配置还可以通过修改 pyproject.toml 文件来进行，例如，添加或修改依赖项。

pyproject.toml 示例：

[tool.poetry]
name = "panoramix"
version = "0.5.0"
description = "An EVM decompiler"
authors = ["Your Name"]

[tool.poetry.dependencies]
python = "^3.8"

[tool.poetry.dev-dependencies]
pytest = "^6.2"

在这个文件中，可以定义项目名称、版本、描述、作者和依赖项。通过 Poetry，可以轻松地管理和更新项目的依赖。