Skip to main content

雷电网络

项目描述



雷电网页界面

开始联系

派皮 CircleCI 徽章 Codecov 徽章 代码风格:更漂亮 吉特雷电徽章

Raiden WebUI 是一个简单的 Web 应用程序,它利用 Raiden REST API 端点允许用户与代币网络交互、进行代币支付、查看开放通道的当前状态以及关闭和结算通道以命名一些功能。

目录

关于该项目

雷电网络是一种链下扩展解决方案,可实现近乎即时、低费用和可扩展的支付。它是对以太坊区块链的补充,可与任何兼容 ERC20 的代币一起使用。

雷电客户端代码可在此处获得,并已于 2020 年 5 月发布到主网,用于雷电网络的 Alderaan 版本。

雷电网页界面

Raiden WebUI 使用以下技术构建:

入门

了解雷电

如果您之前没有使用过 Raiden,您可以:

使用网页界面

如果您想了解如何使用 Raiden WebUI,更新的教程已发布在 Raiden 的新文档中。

先决条件

如果您只想使用 WebUI,您只需安装并运行 Raiden。每个 Raiden 版本都捆绑了一个 WebUI 版本,可以从http://127.0.0.1:5001.

有关如何轻松安装 Raiden 的详细信息:

阅读文档中的快速入门部分。

如果你想在 WebUI 代码库上工作,你需要:

  • 节点 >=10.13.0
  • 一个工作的雷电客户端
  • 用于版本控制的 Git。
  • Yarn v1 用于包管理。

发展

在开始使用 WebUI 之前,您需要安装 WebUI 依赖项。

yarn install

配置

在开始使用 WebUI 之前,您必须确保进行了正确的配置。检查代理配置是否与您的实际环境配置相对应。

由于您不会运行嵌入到 Raiden 中的 WebUI,因此您需要将 Ethereum RPC 端点和 Raiden REST API 端点提供给proxy.config.json.

默认情况下,配置如下所示:

{
    "/api": {
        "target": "http://localhost:5001",
        "proxyTimeout": 600000
    },
    "/web3": {
        "target": "http://localhost:8545",
        "pathRewrite": { "^/web3": "" },
        "changeOrigin": true,
        "proxyTimeout": 60000
    }
}

该配置假定 Ethereum RPC 端点正在侦听http://localhost:8545 并且 Raiden REST API 处于打开状态http://localhost:5001。如果您使用不同的配置,请确保更新配置中的相应字段。

例如,如果您在端口上运行 Raiden5002并使用 Infura 作为您的 RPC 提供程序,您将不得不修改proxy.config.json如下:

{
    "/api": {
        "target": "http://localhost:5002",
        "proxyTimeout": 600000
    },
    "/web3": {
        "target": "http://goerli.infura.io/v3/YOUR_API_KEY",
        "pathRewrite": { "^/web3": "" },
        "changeOrigin": true,
        "proxyTimeout": 60000
    }
}

信息:在开发模式下,无法保证raiden 和RPC 提供程序在同一条链上运行。您必须小心,因为如果您在 Rinkeby 上启动 Raiden 并将 Görli 作为 RPC 端点传递,WebUI 将无法工作。

重要提示:修改proxy.config.json确保永远不会成为您 PR 的一部分。

运行 Web 用户界面

完成配置后,您可以启动开发服务器:

yarn run serve

开发服务器启动后,您必须导航到http://localhost:4200/ui,才能使用 WebUI。

Python 包

WebUI 构建为 python 包,可在 PyPI 上使用。这个包被固定为对 Raiden 的依赖。PyPI 包提供了 WebUI 的预编译版本,它与 Raiden 捆绑在一起,可以开箱即用。

python包提供了一个静态变量,指向WebUI静态内容根目录的位置。这可以由raiden 导入以公开捆绑的WebUI 资源:

from raiden_webui import RAIDEN_WEBUI_PATH

该包可以通过调用来构建python包:

python setup.py build sdist bdist_wheel

该命令调用yarn build:prod以构建 WebUI 的静态生产版本,以便它可以包含在 python 包中。

如果您需要将软件包本地安装到您的开发虚拟环境,您可以通过运行:

python setup.py build install

如果您需要在虚拟环境中使用 WebUI 的调试版本,您还可以运行:

python setup.py compile_webui -D install

这将构建 WebUI 的调试版本以包含在您的包中。

贡献

贡献使开源社区成为学习、启发和创造的绝佳场所。非常感谢您所做的任何贡献。

另请参阅Raiden WebUI 开发指南以获取更多信息。

执照

根据MIT 许可证分发

接触

开发者聊天:Gitter

推特:@raiden_network

网站:雷电网络

邮箱:contact@raiden.network

项目链接:https ://github.com/raiden-network/light-client

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

raiden-webui-1.2.1.tar.gz (3.5 MB 查看哈希

已上传 source

内置分布

raiden_webui-1.2.1-py3-none-any.whl (2.8 MB 查看哈希

已上传 py3