ExtPay 开源项目使用教程

ExtPay 开源项目使用教程

ExtPay The JavaScript library for ExtensionPay.com — payments for your browser extensions, no server needed. 项目地址: https://gitcode.com/gh_mirrors/ex/ExtPay

1. 项目的目录结构及介绍

ExtPay 是一个用于浏览器扩展的支付解决方案，其项目目录结构如下：

• /.github/: 存放 GitHub 用的模板文件。
• /dist/: 包含编译后的 JavaScript 文件，如 ExtPay.js。
• /sample-extension-mv2/: 一个示例扩展项目，使用 Manifest V2。
• /sample-extension-mv3/: 一个示例扩展项目，使用 Manifest V3。
• /docs/: 可能包含项目的文档文件。
• /.gitignore: 定义了 Git 忽略的文件和目录。
• /CHANGELOG.md: 记录了项目的更新历史。
• /LICENSE: 项目的许可文件。
• /README.md: 项目的说明文件。
• /package-lock.json: npm 的依赖锁文件。
• /package.json: npm 的项目配置文件。
• /rollup.config.dev.js: Rollup 的开发配置文件。
• /rollup.config.release.js: Rollup 的发布配置文件。
• /types.d.ts: TypeScript 的类型定义文件。

2. 项目的启动文件介绍

项目的启动文件通常是 background.js，它是浏览器扩展的后台脚本。以下是启动文件的介绍：

• 在 Manifest V3 中，background.js 通常作为服务工人（service worker）运行。
• 在 Manifest V2 中，background.js 是一个常规的背景脚本。
• 在 background.js 中，你需要引入 ExtPay 库，并使用你的扩展 ID 初始化它。
• 调用 extpay.startBackground() 方法来启动 ExtPay 服务。

例如：

// background.js
importScripts('ExtPay.js'); // 或者使用 `import` / `require` 如果你在使用打包工具
var extpay = ExtPay('sample-extension');
extpay.startBackground();

3. 项目的配置文件介绍

项目的配置文件主要包括 manifest.json 和 package.json。

• manifest.json 是浏览器扩展的配置文件，定义了扩展的名称、版本、权限等。对于 ExtPay，你需要在 manifest.json 中添加 storage 权限，并且可能需要添加 https://extensionpay.com/* 到权限列表中，以确保 ExtPay 可以正常工作。
• package.json 是 Node.js 项目的配置文件，定义了项目的依赖、脚本和元数据。对于 ExtPay，你需要在 package.json 中添加 extpay 作为依赖。

例如，manifest.json 可能如下所示：

{
  "manifest_version": 3,
  "name": "Your Extension",
  "version": "1.0",
  "permissions": ["storage", "https://extensionpay.com/*"],
  "background": {
    "service_worker": "background.js"
  }
  // 其他配置...
}

而 package.json 可能如下所示：

{
  "name": "your-extension",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "start": "node index.js"
  },
  "dependencies": {
    "extpay": "^1.0.0"
  }
  // 其他配置...
}

请根据这些指南进行配置，以使 ExtPay 在你的浏览器扩展中正常工作。

ExtPay The JavaScript library for ExtensionPay.com — payments for your browser extensions, no server needed. 项目地址: https://gitcode.com/gh_mirrors/ex/ExtPay