HiPer Core 对接文档

简介

HiPer Core 是基于HiPer底层网络框架研发的完全社区自协商点对点网络系统,其优点在于零成本、易操作、跨平台、依赖少、无残留、安全性高等等,其弱点在于对NAT3和极端网络情况的连通适配性不太理想。但从总体来看,是利大于弊的,特别在理想的网络环境下,可达到延迟低、速率高、无门限的上限传输效果。

入门

通过 HiPer Core 成品仓获取 HiPer Core 最新版本成品及依赖项(仅Windows)。

在Windows环境下启动 HiPer Core 需额外将wintun.dll放于运行目录下或system32目录下,

另外,Windows环境需要管理员权限其它操作系统需要Root权限,

后续操作步骤各操作系统均一致。

启动

启动前可通过参数初始化某些必要的值,这里我们主要讲到一些关键的值:

  • -cn.addr 配置网络地址段(注意这里使用的是CIDR的方式进行配置)

  • -cn.id 指定启动后立即加入的网络呼号(如果没有要加入的这里可以留空)

  • -cn.key 指定网络加密私钥(不指定也没事/系统会自动随机生成)

  • -deploy.script 启动脚本(启动后将逐行执行脚本里面的内容)

  • -http.addr 接口服务监听地址(默认监听本地8000端口)

  • -http.password 接口控制密码(默认将会随机生成,注意看日志,没有这个密码将无法通过接口传输指令)

  • -https.cert 和 https.key 主要用来配置接口的HTTPS证书的(一般用不到?)

开始

执行hiper-core程序进入初始化启动流程(这里我使用的是默认值启动,即没有带任何参数):

按这里提示即进入主菜单了,你可以通过菜单提供的终端进行配置,即 env 指令,当然也可以通过 start 开始服务,我们此时开启服务:

这里出现 [0015]  INFO Successful registration to DHT network即代表节点已经接入到DHT网络。

即本机创建了一个地址段为10.10.10.0 255.255.255.0 的虚拟网络,且本地地址为10.10.10.10。在网络中的呼号为 QmbH3dtx7eSTjYhwMRyx8vY2fCxM3szCr1gi4zRZ5RPnyy

加入

如果我们在此时需要加入其它网络,则需要通过指令 join 实现,具体如下:

指令:join 网络呼号 节点地址(自己的地址)

具体解释案例中的join指令,案例中我们给自己分配了10.10.10.11的地址去加入呼号为QmbH3dtx7eSTjYhwMRyx8vY2fCxM3szCr1gi4zRZ5RPnyy的网络。

停止

我们随时可以通过stop停止网络服务运行

配置

可通过 env 指令查询当前环境配置参数值

接口

资源下载: