Polkadot-js Extension 开源项目教程

Polkadot-js Extension 开源项目教程

本教程基于 Polkadot-js/extension 开源项目，旨在帮助开发者了解其目录结构、启动文件以及配置文件，以便更好地进行定制与开发。

1. 项目目录结构及介绍

Polkadot-js 扩展项目遵循了现代前端工程化的结构，主要由以下几个关键部分构成：

• 根目录：

  • docs: 文档资料，包含了关于如何使用该扩展的详细说明。
  • packages: 核心功能模块，拆分为多个npm包，包括主逻辑（extension）、UI组件（extension-ui）、与DApp交互的便利封装（extension-dapp）等。
  • scripts: 构建和管理脚本。
  • src: 主要的源代码文件夹，但在实际操作中，核心逻辑通常分布在各独立的包内。
  • .gitignore, editorconfig, license, prettierrc, yarnrc.yml 等常规配置文件。

• 关键子目录与文件:

  • /packages/extension: 包含扩展的核心逻辑，如背景处理逻辑和注入到页面的Signer对象。
  • /packages/extension-ui: 提供用于构建扩展弹出窗口的UI组件。
  • manifest_chrome.json, manifest_firefox.json: 分别是Chrome和Firefox扩展的清单文件，定义了扩展的基本信息、权限等。

2. 项目的启动文件介绍

该项目并未直接指定单一的“启动文件”，而是通过Yarn命令来管理不同的构建和开发任务。关键的开发与构建流程通过以下命令控制：

• 开发环境启动:
  • 对于Chrome: 运行 yarn build:chrome 紧接着在浏览器的chrome://extensions/页面选择“加载已解压的扩展程序”指向packages/extension/build。
  • 针对Firefox: 使用 yarn build:ff，然后通过about:debugging#addons 加载临时扩展至packages/extension/build目录。

这些命令背后涉及到的入口点并不直接作为“启动文件”，而是Yarn脚本定义了一系列构建与热更新过程。

3. 项目的配置文件介绍

• manifest_[chrome|firefox].json: 关键的配置文件，定义了浏览器扩展的基础信息，比如名称、描述、允许的权限、浏览器界面图标等。这是每个浏览器扩展必须具有的，以适应Chrome和Firefox的不同要求。
• package.json: 含有项目的元数据，包括依赖项、脚本命令（如构建、测试命令），是Node.js项目的核心配置文件。
• yarn.lock/yarnrc.yml: 确保项目依赖的版本一致性，yarnrc.yml配置了Yarn的工作方式。
• tsconfig.json: TypeScript编译配置，定义了类型检查和编译选项。

总结，Polkadot-js Extension项目通过高度模块化的方式组织代码，配置主要分散在上述提到的各个JSON配置文件和TypeScript编译配置中。开发者应关注packages下的具体包及其对应的readme文件、manifest.json文件以及全局的构建和脚本指令来深入了解并参与项目开发或自定义配置。