ApePay

为自动化服务管理构建的智能合约支付系统

关于

查看博客文章了解更多关于ApePay的信息！

文档

即将推出！

贡献

ApePay是开源的，我们欢迎所有贡献者！请查看以下信息以开始。

TODOs

• 初始实现
• 文档
• 在Sepolia上进行实时测试
• 在Arbitrum上进行生产部署
• 前端管理控制台，用于管理订阅

设置（Python）

首先，安装Ape。

其次，确保安装插件

$ ape plugins install . --upgrade

接下来，在安装SDK包之前，您需要编译项目

$ ape compile

The SDK package relies on a soft link in [`./sdk/py/apepay/manifest.json`](./sdk/py/apepay/manifest.json)

最后，通过以下方式安装SDK包：

$ pip install .

或进行交互式安装：

$ pip install -e .

然后您就可以开始贡献了！

设置（JS）

为了对JS包做出贡献，您需要首先遵循Python设置说明以编译智能合约包。

接下来，您需要安装开发所需的节点包

$ npm install

为了在React组件库上工作，您需要编译JS SDK

$ npm run build --workspace=sdk/js

为了处理Demo应用程序，您需要编译JS SDK（如上所述）以及编译React组件库

$ npm run build --workspace=ui/lib

然后您就可以开始贡献了！

要在开发模式下运行demo应用程序，请执行以下操作

$ npm run dev --workspace=ui/app

为了生产环境构建demo应用程序，请按照以下步骤操作

$ npm run build --workspace=ui/app

测试

要运行测试，只需使用Ape

$ ape test

要查看gas使用情况，请添加--gas标志

$ ape test --gas

脚本

要部署StreamManager（用于测试目的），请运行

$ ape run deploy manager [TOKEN_ADDRESS [...]]
# Or if `ape tokens` is installed (with a valid tokenlist)
$ ape run deploy manager [TOKEN_SYMBOL [...]]

要部署StreamFactory（用于生产使用），请运行

$ ape run deploy factory

要部署Token（仅用于测试），请运行

$ ape run deploy token

This test token has an unauthenticated mint, please do not use in production!

要运行demo ApePay集群守护进程，首先运行一个节点，例如anvil

$ anvil --block-time 1 --prune-history

然后运行示例Silverback应用程序

$ silverback run bots.example:app

之后，建议启动ape console并创建一个流以监视守护进程的反应。

我们还提供了一种可以使用的方法来模拟

$ ape run demo

发布

考虑到单一代码库结构，分发此代码库中的所有包更具挑战性。

合同

待定

Python SDK

要发布Python包，有4个步骤。

# 1. Install everything
$ pip install .[dev]
# 2. Compile the package manifest
$ ape compile -f
# 3. Build the Python SDK with twine
$ twine build
# 4. Publish the package
$ twine publish

JavaScript SDK和React组件库

要发布JS SDK，请执行以下操作

# 1. Install everything
$ npm install --all-workspaces
# 2. Build SDK
$ npm run build --workspace=sdk/js
# 3. Publish SDK
$ npm publish --workspace=sdk/js

注意：在发布前一定要检查修订版本，否则会失败。

要发布React组件库，与SDK的操作相同，但请使用ui/lib工作空间。

演示应用程序和管理控制台

如果您需要从头开始将演示应用程序部署到生产环境，只需创建一个新的Heroku项目，并从Heroku CLI（或直接在Heroku仪表板上）添加这些构建包

$ heroku buildpacks:clear
$ heroku buildpacks:add heroku/python
$ heroku buildpacks:add heroku/nodejs

然后只需运行

$ git push heroku main

许可证

ApePay遵循Apache 2.0许可证