English | 中文
Welcome to the official source code repository for Ontology!
Ontology is dedicated to developing a high-performance blockchain infrastructure, which is customizable to different business requirements.
Prerequisites for getting started with development on the Ontology networks are:
- Mainstream coding and development experience
- Understanding of your business scenario/requirements
- No need for previous blockchain engineering experience
The Ontology core tech team, the community, and the ecosystem can all support you in development. MainNet, TestNet, SmartX and a Docker image for Ontology, SmartX, and Ontology Explorer combined make it easy to start.
Ontology makes getting started easier!
The code is currently in Alpha phase of the release life cycle, but is rapidly under development towards Beta. The master code may be unstable, but stable versions can be found under the release page.
We openly welcome developers to Ontology.
- Scalable lightweight universal smart contract
- Scalable WASM contract support
- Crosschain interactive protocol (processing)
- Multiple encryption algorithm support
- Highly optimized transaction processing speed
- P2P link layer encryption (optional module)
- Multiple consensus algorithm support (VBFT/DBFT/RBFT/SBFT/PoW)
- Quick block generation time
- Build development environment
- Get Ontology
- Run Ontology
- Some examples
- Open source community
Build development environment
The requirements to build Ontology are:
- Golang version 1.9 or later
- Glide (a third party package management tool)
- Properly configured Go language environment
- Golang supported operating system
Get from release
You can download the latest Ontology binary file with
curl https://dev.ont.io/ontology_install | sh.
You can download other versions at release page.
Get from source code
Clone the Ontology repository into the appropriate $GOPATH/src/github.com/ontio directory.
$ git clone https://github.com/ontio/ontology.git
$ go get github.com/ontio/ontology
Fetch the dependent third party packages with glide.
$ cd $GOPATH/src/github.com/ontio/ontology $ glide install
Build the source code with make.
$ make all
After building the source code sucessfully, you should see two executable programs:
ontology: the node program/command line program for node control.
tools/sigsvr: (optional) Ontology Signature Server - sigsvr is a RPC server for signing transactions for some special requirements. Detailed docs can be found here.
You can run Ontology in four different modes:
- MainNet (./ontology)
- TestNet (./ontology --networkid 2)
- Testmode (./ontology --testmode)
E.g. for Windows (64-bit), use command prompt and cd to the dirctory where you installed the Ontology release, then type
start ontology-windows-amd64.exe --networkid 2. This will sync to TestNet and you can explore further by the help command
ontology-windows-amd64.exe --networkid 2 help.
MainNet sync node
Run ontology directly
then you can connect to Ontology MainNet.
Public test network Polaris sync node (TestNet)
Run ontology directly
./ontology --networkid 2
Then you can connect to the Ontology TestNet.
Create a directory on the host and store the following files in the directory:
- Node program
- Wallet file
wallet.datcan be generated by
./ontology account add -d)
$ ./ontology --testmode can start single-host testnet.
Here's a example of a single-host configuration:
$ tree └── ontology ├── ontology └── wallet.dat
Run in docker
Please ensure there is a docker environment in your machine.
Make docker image
- In the root directory of source code, run
make docker, it will make an Ontology image in docker.
- In the root directory of source code, run
Run Ontology image
docker run ontio/ontologyto run Ontology；
If you need to allow interactive keyboard input while the image is running, you can use the
docker run -ti ontio/ontologycommand to start the image;
If you need to keep the data generated by image at runtime, you can refer to the data persistence function of docker (e.g. volume);
If you need to add Ontology parameters, you can add them directly after
docker run ontio/ontologysuch as
docker run ontio/ontology --networkid 2. The parameters of ontology command line refer to here.
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>
./ontology info status 10dede8b57ce0b272b4d51ab282aaf0988a4005e980d25bd49685005cc76ba7f
Transaction:transfer success From:AXkDGfr9thEqWmCKpTtQYaazJRwQzH48eC To:AYiToLDT2yZuNs3PZieXcdTpyC5VWQmfaN Amount:10
Query account balance sample
./ontology asset balance <address|index|label>
./ontology asset balance ARVVxBPGySL56CvSSWfjRVVyZYpNZ7zp48
./ontology asset balance 1
BalanceOf:ARVVxBPGySL56CvSSWfjRVVyZYpNZ7zp48 ONT:989979697 ONG:28165900
For further examples, please refer to the CLI User Guide.
Please open a pull request with a signed commit. We appreciate your help! You can also send your code as email to the developer mailing list. You're welcome to join the Ontology mailing list or developer forum.
Please provide a detailed submission information when you want to contribute code for this project. The format is as follows:
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.
The body of the commit message can be several paragraphs. Please do proper word-wrap and keep columns shorter than 74 characters or so. That way "git log" will show things nicely even when it is indented.
Make sure you explain your solution and why you are doing what you are doing, as opposed to describing what you are 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 email@example.com
Open source community
Developer Discord Group
The Ontology library is licensed under the GNU Lesser General Public License v3.0, read the LICENSE file in the root directory of the project for details.