ontology

command module
v0.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 21, 2020 License: LGPL-3.0 Imports: 42 Imported by: 0

README

Ontology

Version 1.6.0

GoDoc Go Report Card Travis Discord

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

  • 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
  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/>.

Directories

Path Synopsis
cmd
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
abi
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
sigsvr
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
sigsvr/handlers
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
sigsvr/store
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
utils
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
log
core
store/ledgerstore
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
store/overlaydb
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
http
base/actor
Package actor privides communication with other actor
Package actor privides communication with other actor
base/common
Package common privides functions for http handler call
Package common privides functions for http handler call
base/error
Package error privides error code for http
Package error privides error code for http
base/rest
Package rest privides functions to for restful server call
Package rest privides functions to for restful server call
base/rpc
Package rpc provides functions to for rpc server call
Package rpc provides functions to for rpc server call
jsonrpc
Package jsonrpc privides a function to start json rpc server
Package jsonrpc privides a function to start json rpc server
localrpc
Package localrpc privides a function to start local rpc server
Package localrpc privides a function to start local rpc server
nodeinfo
Package nodeinfo privides functions for nodeinfo server
Package nodeinfo privides functions for nodeinfo server
restful
Package restful privides a function to start restful server
Package restful privides a function to start restful server
restful/restful
Package restful privides restful server router and handler
Package restful privides restful server router and handler
websocket
Package websocket privides a function to start websocket server
Package websocket privides a function to start websocket server
websocket/session
Package session privides websocket server manager sessionlist
Package session privides websocket server manager sessionlist
websocket/websocket
Package websocket privides websocket server handler
Package websocket privides websocket server handler
common
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
net/protocol
Package p2p provides an network interface
Package p2p provides an network interface
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
service/native/governance
Governance contract: Users can apply for a candidate node to join consensus selection, deposit ONT to authorize for candidate nodes, quit selection and unAuthorize for candidate nodes through this contract.
Governance contract: Users can apply for a candidate node to join consensus selection, deposit ONT to authorize for candidate nodes, quit selection and unAuthorize for candidate nodes through this contract.
service/native/ontid
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
service/native/utils
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
service/neovm
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
service/wasmvm
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
Package txnpool provides a function to start micro service txPool for external process
Package txnpool provides a function to start micro service txPool for external process
common
Package common provides constants, common types for other packages
Package common provides constants, common types for other packages
proc
Package proc provides functions for handle messages from consensus/ledger/net/http/validators
Package proc provides functions for handle messages from consensus/ledger/net/http/validators
validator
db
vm
neovm
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
wasmvm/disasm
Package disasm provides functions for disassembling WebAssembly bytecode.
Package disasm provides functions for disassembling WebAssembly bytecode.
wasmvm/exec
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
* Copyright (C) 2018 The ontology Authors * This file is part of The ontology library.
wasmvm/exec/internal/compile
Package compile is used internally by wagon to convert standard structured WebAssembly bytecode into an unstructured form suitable for execution by it's VM.
Package compile is used internally by wagon to convert standard structured WebAssembly bytecode into an unstructured form suitable for execution by it's VM.
wasmvm/internal/stack
Package stack implements a growable uint64 stack
Package stack implements a growable uint64 stack
wasmvm/validate
package validate provides functions for validating WebAssembly modules.
package validate provides functions for validating WebAssembly modules.
wasmvm/wasm
Package wasm provides functions for reading and parsing WebAssembly modules.
Package wasm provides functions for reading and parsing WebAssembly modules.
wasmvm/wasm/leb128
Package leb128 provides functions for reading integer values encoded in the Little Endian Base 128 (LEB128) format: https://en.wikipedia.org/wiki/LEB128
Package leb128 provides functions for reading integer values encoded in the Little Endian Base 128 (LEB128) format: https://en.wikipedia.org/wiki/LEB128
wasmvm/wasm/operators
Package operators provides all operators used by WebAssembly bytecode, together with their parameter and return type(s).
Package operators provides all operators used by WebAssembly bytecode, together with their parameter and return type(s).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL