README
¶
UniChain
Welcome to the UniChain source code repository!
What is UniChain?
UniChain is a high-level blockchain framework that can implement the issuance, circulation, and dividends of tokens efficiently and reliably. UniChain can also steadily implement various community governance functions with voting as the core and foundation. These functions are the foundation for building the token economy of future.
home page: https://unichainproject.com/
Executables
The unichain project comes with several wrappers/executables found in the cmd directory.
| Command | Description |
|---|---|
uni |
Our main unichain CLI client. It is the entry point into the unichain network (main-, test- or private net), It can be used by other processes as a gateway into the unichain network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. uni -h and the Command Line Options for command line options. |
unifinder |
unifinder is a unichain node discoverer.unifinder -h and the Command Line Options for command line options. |
Getting Started
The following instructions overview the process of getting the code, building it, and start node.
Getting the code
To download all of the code:
git clone https://github.com/unichainplatform/unichain
Setting up a build/development environment
Install latest distribution of Go if you don't have it already. (go version >= go1.10 )
Currently supports the following operating systems:
- Ubuntu 16.04
- Ubuntu 18.04
- MacOS Darwin 10.12 and higher
Build UniChain
make all
more information see: Installing UniChain
Running a node
To run ./uni , you can run your own UNI instance.
$ uni
Join the unichain main network see: Main Network
Join the unichain test network see: Test Network
Operating a private network see:Private Network
Resources
More Documentation see the UniChain wiki
License
UniChain is distributed under the terms of the GPLv3 License.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
Package common contains various helper functions.
|
Package common contains various helper functions. |
|
Package debug interfaces Go runtime debugging facilities.
|
Package debug interfaces Go runtime debugging facilities. |
|
Go port of Coda Hale's Metrics library
|
Go port of Coda Hale's Metrics library |
|
Package p2p implements the Ethereum p2p network protocols.
|
Package p2p implements the Ethereum p2p network protocols. |
|
discover
Package discover implements the Node Discovery Protocol.
|
Package discover implements the Node Discovery Protocol. |
|
enr
Package enr implements Ethereum Node Records as defined in EIP-778.
|
Package enr implements Ethereum Node Records as defined in EIP-778. |
|
netutil
Package netutil contains extensions to the net package.
|
Package netutil contains extensions to the net package. |
|
vm
VM is a Virtual Machine based on Ethereum Virtual Machine
|
VM is a Virtual Machine based on Ethereum Virtual Machine |
|
Package rawdb contains a collection of low level database accessors.
|
Package rawdb contains a collection of low level database accessors. |
|
mtp
package mtp implements Merkle Patricia Tries.
|
package mtp implements Merkle Patricia Tries. |
|
test
|
|
|
Package types contains data types related to UniChain.
|
Package types contains data types related to UniChain. |
|
utils
|
|
|
abi
Package abi implements the Ethereum ABI (Application Binary Interface).
|
Package abi implements the Ethereum ABI (Application Binary Interface). |
|
filelock
Package filelock provides portable file locking.
|
Package filelock provides portable file locking. |
|
rlp
Package rlp implements the RLP serialization format.
|
Package rlp implements the RLP serialization format. |