Skip to content

Latest commit

 

History

History
361 lines (263 loc) · 12.2 KB

README_CN.md

File metadata and controls

361 lines (263 loc) · 12.2 KB
Raw

Ontology

Version 1.0

GoDoc Go Report Card Travis Discord

English | 中文

欢迎来到Ontology的源码库！

Ontology致力于创建一个组件化、可自由配置、跨链支持、高性能、横向可扩展的区块链底层基础设施。 让部署及调用去中心化应用变得更加非常简单。

目前代码还处于内部测试阶段，但处于快速的开发过程中，master代码可能是不稳定的，稳定的版本可以在releases中下载。

公开的测试网可以在下面找到，也非常欢迎及希望能有更多的开发者加入到Ontology中来。

特性

  • 可扩展的轻量级通用智能合约
  • 可扩展的WASM合约的支持
  • 跨链交互协议（进行中）
  • 多种加密算法支持
  • 高度优化的交易处理速度
  • P2P连接链路加密(可选择模块)
  • 多种共识算法支持 (VBFT/DBFT/SBFT/PoW/SOLO...)
  • 快速的区块生成时间

目录

构建开发环境

成功编译ontology需要以下准备：

  • Golang版本在1.9及以上
  • 安装第三方包管理工具glide
  • 正确的Go语言开发环境
  • Golang所支持的操作系统

获取ontology

从源码获取

克隆ontology仓库到 $GOPATH/src/github.com/ontio 目录

$ git clone https://github.com/ontio/ontology.git

或者

$ go get github.com/ontio/ontology

用第三方包管理工具glide拉取依赖库

$ cd $GOPATH/src/github.com/ontio/ontology
$ glide install

用make编译源码

$ make all

成功编译后会生成两个可以执行程序

  • ontology: 节点程序/以命令行方式提供的节点控制程序
  • tools/sigsvr: (可选)签名服务 - sigsvr是一个签名服务的server以满足一些特殊的需求。详细的文档可以在这里参考

从release获取

  • 你可以通过命令 curl https://dev.ont.io/ontology_install | sh 获取最新的ontology版本
  • 你也可以从下载页面获取.

服务器部署

选择网络

ontology的运行支持以下4种方式

  • 主网同步节点部署
  • 公开测试网Polaris同步节点部署
  • 单机部署
  • 多机部署

主网同步节点部署

直接启动Ontology

 ./ontology --networkid 1

公开测试网Polaris同步节点部署

直接启动Ontology

 ./ontology --networkid 2

单机部署配置

在单机上创建一个目录，在目录下存放以下文件：

  • 节点程序 + 节点控制程序 ontology
  • 钱包文件wallet.dat

使用命令 $ ./ontology --testmode --networkid 3 即可启动单机版的测试网络。

单机配置的例子如下：

  • 目录结构

    $ tree
└── node
    ├── ontology
    └── wallet.dat

多机部署配置

注意：当你想搭建一个私网去运行DBFT或者VBFT模式的ontology时，你必须要使用 --config参数去指定一个具体的配置文件，并且要使用 --networkid去定义一个 网络标识（不能等于1/2/3），否则，ontology节点将会自动连接到主网上。

VBFT部署方法

多机环境下，根据VBFT共识算法的要求，最少需要7个节点（共识节点）完成部署。

我们可以通过修改配置文件config-vbft.json进行快速部署，配置文件的说明请点击这里。

  1. 生成七个钱包文件，每个钱包文件包含一个账户，共七个账户，分别作为每个节点的记账人。生成账户和钱包的命令为：

    ./ontology account add -d -w wallet.dat
Use default setting '-t ecdsa -b 256 -s SHA256withECDSA' 
	signature algorithm: ecdsa 
	curve: P-256 
	signature scheme: SHA256withECDSA 
Password:
Re-enter Password:

Index: 1
Label: 
Address: AXkDGfr9thEqWmCKpTtQYaazJRwQzH48eC
Public key: 03d7d8c0c4ca2d2bc88209db018dc0c6db28380d8674aff86011b2a6ca32b512f9
Signature scheme: SHA256withECDSA

Create account successfully.

    使用-w参数指定生成的钱包文件名

  2. 修改config-vbft.json，将上一步生成的七个账户的公钥、address分别填入config-vbft.json中的peers配置的1-7项

  3. 将相关文件复制到目标主机，包括：

    • 配置文件config-vbft.json
    • 节点程序ontology
    • 钱包文件

  4. 设置每个节点网络连接的端口号（推荐不做修改，使用默认端口配置）

    • NodePort为的P2P连接端口号（默认20338）
    • HttpJsonPort和HttpLocalPort为RPC端口号（默认为20336，20337）

  5. 种子节点配置

    • 在7个主机中选出至少一个做种子节点，并将种子节点地址分别填写到每个配置文件的SeelList中，格式为种子节点IP地址 + 种子节点NodePort
DBFT部署方法

多机环境下，最少需要4个节点（共识节点）完成部署。 我们可以通过修改默认的配置文件config-dbft.json进行快速部署，配置文件的说明请点击这里。

  1. 将相关文件复制到目标主机，包括：

    • 配置文件config-dbft.json
    • 节点程序ontology

  2. 设置每个节点网络连接的端口号（推荐不做修改，使用默认端口配置）

    • NodePort为的P2P连接端口号（默认20338）
    • HttpJsonPort和HttpLocalPort为RPC端口号（默认为20336，20337）

  3. 种子节点配置

    • 在4个主机中选出至少一个做种子节点，并将种子节点地址分别填写到每个配置文件的SeelList中，格式为种子节点IP地址 + 种子节点NodePort

  4. 创建钱包文件

    • 通过命令行程序，在每个主机上分别创建节点运行所需的钱包文件wallet.dat 
      $ ./ontology account add -d
Use default setting '-t ecdsa -b 256 -s SHA256withECDSA' 
signature algorithm: ecdsa 
curve: P-256 
signature scheme: SHA256withECDSA 
Password:
Re-enter Password:

Index: 1
Label: 
Address: AXkDGfr9thEqWmCKpTtQYaazJRwQzH48eC
Public key: 03d7d8c0c4ca2d2bc88209db018dc0c6db28380d8674aff86011b2a6ca32b512f9
Signature scheme: SHA256withECDSA

Create account successfully.

  5. 记账人配置

    • 为每个节点创建钱包时会显示钱包的公钥信息，将所有节点的公钥信息分别填写到每个节点的配置文件的Bookkeepers项中

      注：每个节点的钱包公钥信息也可以通过命令行程序查看：

      1	AYiToLDT2yZuNs3PZieXcdTpyC5VWQmfaN (default)
	Label: 
	Signature algorithm: ECDSA
	Curve: P-256
	Key length: 384 bits
	Public key: 030e5d50bf585ff5c73464114244b93f04b231862d6bbdfd846be890093b2c1c17
	Signature scheme: SHA256withECDSA

部署完成

多机部署配置完成，每个节点目录结构如下:

 $ ls
 config.json ontology wallet.dat

运行

以任意顺序运行每个节点node程序， 并在出现Password:提示后输入节点的钱包密码。

如果你想启动一个共识节点（比如在自己的私网上），必须使用 --enableconsensus参数。如果你想自己运行一个私网，需要使用 --networkid参数指定私网节 点之间通信的网络id（不能等于1/2/3），并且要使用 --config参数指定配置文件。

例如:

 $ ./ontology --enableconsensus --networkid 4 --config ./config.json
 $ - Input your wallet password

了解更多请运行 ./ontology --help，你也可以参考Ontology CLI 用户指引获得更多信息。

使用docker运行

请确保机器上已安装有docker环境。

  1. 编译docker镜像

    • 在下载好的源码根目录下，运行make docker命令，这将编译好ontology的docker镜像

  2. 运行ontology镜像

    • 使用命令docker run ontio/ontology运行ontology；

    • 如果需要使镜像运行时接受交互式键盘输入，则使用docker -ti run ontio/ontology命令启动镜像即可；

    • 如果需要保留镜像每次运行时的数据，可以参考docker的数据持久化功能（例如 valume）；

    • 如果需要使用ontology参数，则在docker run ontio/ontology后面直接加参数即可，例如docker run ontio/ontology --networkid 2，具体的ontology命令 行参数可以参考这里。

ONT转账调用示例

  • from: 转出地址； - to: 转入地址； - amount: 资产转移数量； from参数可以不指定，如果不指定则使用默认账户。
  ./ontology asset transfer  --to=TA4Xe9j8VbU4m3T1zEa1uRiMTauiAT88op --amount=10

执行完后会输出：

Transfer ONT
From:TA6edvwgNy3c1nBHgmFj8KrgQ1JCJNhM3o
To:TA4Xe9j8VbU4m3T1zEa1uRiMTauiAT88op
Amount:10
TxHash:10dede8b57ce0b272b4d51ab282aaf0988a4005e980d25bd49685005cc76ba7f

其中TxHash是转账交易的交易HASH，可以通过这个HASH查询转账交易的直接结果。 出于区块链出块时间的限制，提交的转账请求不会马上执行，需要等待至少一个区块时间，等待记账节点打包交易。

查询转账结果示例

--hash:指定查询的转账交易hash

./ontology asset status --hash=10dede8b57ce0b272b4d51ab282aaf0988a4005e980d25bd49685005cc76ba7f

查询结果：

Transaction:transfer success
From:TA6edvwgNy3c1nBHgmFj8KrgQ1JCJNhM3o
To:TA4Xe9j8VbU4m3T1zEa1uRiMTauiAT88op
Amount:10

查询账户余额示例

--address:账户地址

./ontology asset balance --address=TA4Xe9j8VbU4m3T1zEa1uRiMTauiAT88op

查询结果：

BalanceOf:TA4Xe9j8VbU4m3T1zEa1uRiMTauiAT88op
ONT:10
ONG:0
ONGApprove:0

贡献代码

请您以签过名的commit发送pull request请求，我们期待您的加入！ 您也可以通过邮件的方式发送你的代码到开发者邮件列表，欢迎加入Ontology邮件列表和开发者论坛。

另外，在您想为本项目贡献代码时请提供详细的提交信息，格式参考如下：

Header line: explain the commit in one line (use the imperative)

Body of commit message is a few lines of text, explaining things in more detail, possibly giving some background about the issue being fixed, etc etc.

The body of the commit message can be several paragraphs, and please do proper word-wrap and keep columns shorter than about 74 characters or so. That way "git log" will show things nicely even when it's indented.

Make sure you explain your solution and why you're doing what you're doing, as opposed to describing what you're doing. Reviewers and your future self can read the patch, but might not understand why a particular solution was implemented.

Reported-by: whoever-reported-it Signed-off-by: Your Name youremail@yourhost.com

开源社区

网站

Discord开发者社区

许可证

Ontology遵守GNU Lesser General Public License, 版本3.0。 详细信息请查看项目根目录下的LICENSE文件。