ontology

README

Ontology

Version 1.6.0

English | 中文

Welcome to the official Go implementation of the Ontology blockchain!

Ontology is a high-performance public blockchain project and distributed trust collaboration platform. It is highly customizable and suitable for all kinds of business requirements. The Ontology MainNet was launched on June 30th, 2018.

As a public blockchain project, Ontology is currently maintained by both the Ontology core tech team and community members who can all support you in development. There are many available tools for use for development - SDKs, the SmartX IDE, Ontology blockchain explorer and more.

New features are still being rapidly developed, therefore the master branch may be unstable. Stable versions can be found in the releases section.

• Features
• Build Development Environment
• Download Ontology
  • Download Release
  • Build from Source Code
• Run Ontology
  • MainNet Sync Node
  • TestNet Sync Node
  • Local PrivateNet
  • Run with Docker
• Examples
  • ONT transfer sample
  • Query transfer status sample
  • Query account balance sample
• Contributions
• License

Features

• Scalable lightweight universal smart contracts
• Scalable WASM contract support
• Cross-chain interactive protocol
• Multiple encryption algorithms supported
• Highly optimized transaction processing speed
• P2P link layer encryption (optional module)
• Multiple consensus algorithms supported (VBFT/DBFT/RBFT/SBFT/PoW)
• Quick block generation time (1-30 seconds)

Build Development Environment

The requirements to build Ontology are:

• Golang version 1.9 or later
• Glide (a third party package management tool for Golang)

Download Ontology

Download Release

You can download a stable compiled version of the Ontology node software by either:

• Downloading the latest Ontology binary file with curl https://dev.ont.io/ontology_install | sh.
• Downloading a specific version from the release section.

Build from Source Code

Alternatively, you can build the Ontology application directly from the source code. Note that the code in the master branch may not be stable.

1. Clone the Ontology repository into the appropriate $GOPATH/src/github.com/ontio directory:

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

or

$ go get github.com/ontio/ontology

1. Fetch the dependent third party packages with Glide:

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

1. If necessary, update the dependent third party packages with Glide:

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

1. Build the source code with make:

$ make all

After building the source code successfully, you should see two executable programs:

• ontology: The primary Ontology node application and CLI.
• tools/sigsvr: The Ontology Signature Server, sigsvr - an RPC server for signing transactions. Detailed documentation can be found here.

Run Ontology

The Ontology CLI can run nodes for the MainNet, TestNet and local PrivateNet. Check out the Ontology CLI user guide for a full list of commands.

MainNet Sync Node

You can run an Ontology MainNet node built from the source code with:

./ontology

To run it with a macOS release build:

./ontology-darwin-amd64

To run it with a Windows release build:

start ontology-windows-amd64.exe

TestNet Sync Node

You can run an Ontology TestNet node built from the source code with:

./ontology --networkid 2

To run it with a macOS release build:

./ontology-darwin-amd64 --networkid 2

To run it with a Windows release build:

start ontology-windows-amd64.exe --networkid 2

Local PrivateNet

The Ontology CLI allows you to run a local PrivateNet on your computer. Before you can run the PrivateNet you will need to create a wallet file. A wallet file named wallet.dat can be generated by running

./ontology account add -d

To start the PrivateNet built from the source code with:

./ontology --testmode

Here's an example of the directory structure

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

To run it with a macOS release build:

./ontology-darwin-amd64 --testmode

To run it with a Windows release build:

start ontology-windows-amd64.exe --testmode

Run with Docker

You can run the Ontology node software with Docker.

1. Setup Docker on your computer

• You will need the latest version of Docker Desktop.

1. Make a Docker image

• In the root directory of the source code, run make docker to make an Ontology image.

1. Run the Ontology image

• Run the command docker run ontio/ontology to start Ontology
• Run the command docker run -ti ontio/ontology to start Ontology and allow interactive keyboard input
• If you need to keep the data generated by the image, refer to Docker's data persistence function
• You can add arguments to the Ontology command, such as with docker run ontio/ontology --networkid 2.

Examples

ONT transfer sample

-- from: transfer from； -- to: transfer to； -- amount: ONT amount；

 ./ontology asset transfer  --from=ARVVxBPGySL56CvSSWfjRVVyZYpNZ7zp48 --to=AaCe8nVkMRABnp5YgEjYZ9E5KYCxks2uce --amount=10

If the asset transfer is successful, the result will display as follows:

Transfer ONT
  From:ARVVxBPGySL56CvSSWfjRVVyZYpNZ7zp48
  To:AaCe8nVkMRABnp5YgEjYZ9E5KYCxks2uce
  Amount:10
  TxHash:437bff5dee9a1894ad421d55b8c70a2b7f34c574de0225046531e32faa1f94ce

TxHash is the transfer transaction hash, and we can query a transfer result by the TxHash. Due to block time, the transfer transaction will not be executed before the block is generated and added.

If you want to transfer ONG, just add --asset=ong flag.

Note that ONT is an integer and has no decimals, whereas ONG has 9 decimals. For detailed info please read Everything you need to know about ONG.

./ontology asset transfer --from=ARVVxBPGySL56CvSSWfjRVVyZYpNZ7zp48 --to=ARVVxBPGySL56CvSSWfjRVVyZYpNZ7zp48 --amount=95.479777254 --asset=ong

If transfer of the asset succeeds, the result will display as follows:

Transfer ONG
  From:ARVVxBPGySL56CvSSWfjRVVyZYpNZ7zp48
  To:AaCe8nVkMRABnp5YgEjYZ9E5KYCxks2uce
  Amount:95.479777254
  TxHash:e4245d83607e6644c360b6007045017b5c5d89d9f0f5a9c3b37801018f789cc3

Please note, when you use the address of an account, you can use the index or label of the account instead. Index is the sequence number of a particular account in the wallet. The index starts from 1, and the label is the unique alias of an account in the wallet.

./ontology asset transfer --from=1 --to=2 --amount=10

Query transfer status sample

./ontology info status <TxHash>

For Example:

./ontology info status 10dede8b57ce0b272b4d51ab282aaf0988a4005e980d25bd49685005cc76ba7f

Result:

Transaction:transfer success
From:AXkDGfr9thEqWmCKpTtQYaazJRwQzH48eC
To:AYiToLDT2yZuNs3PZieXcdTpyC5VWQmfaN
Amount:10

Query account balance sample

./ontology asset balance <address|index|label>

For Example:

./ontology asset balance ARVVxBPGySL56CvSSWfjRVVyZYpNZ7zp48

or

./ontology asset balance 1

Result:

BalanceOf:ARVVxBPGySL56CvSSWfjRVVyZYpNZ7zp48
  ONT:989979697
  ONG:28165900

For further examples, please refer to the CLI User Guide.

Contributions

Contributors to Ontology are very welcome! Before beginning, please take a look at our contributing guidelines. You can open an issue by clicking here.

If you have any issues getting setup, open an issue or reach out in the Ontology Discord.

License

The Ontology source code is available under the LGPL-3.0 license.

Documentation

Overview

* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library. * * The ontology is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * The ontology is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with The ontology. If not, see <http://www.gnu.org/licenses/>.