Skip to content

Commit

Permalink
Update the NKN description
Browse files Browse the repository at this point in the history 
The NKN will extend the blockchain network capability and setup a
new incentive mechanism based on the network connectivity and
transmission capability. Some general parts of DNA which we developed
be reused under compliance with the Apache2 license to avoid rebuild
the wheels.

Signed-off-by: Yanbo Li <[email protected]>
  • Loading branch information
@dreamfly281
dreamfly281 committed Mar 30, 2018
1 parent 1de2556 commit 3481bd9
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 355 deletions.
20 changes: 17 additions & 3 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Apache License
Apache License
Version 2.0, January 2004
https://www.apache.org/licenses/
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

Expand Down Expand Up @@ -175,7 +175,21 @@

END OF TERMS AND CONDITIONS

Copyright 2016-2017 DNA Dev team
Copyright 2017 - Now NKN Labs
Copyright 2016 - 2017 DNA Dev team

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
354 changes: 2 additions & 352 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,352 +1,2 @@
[![Build Status](https://travis-ci.org/DNAProject/DNA.svg?branch=master)](https://travis-ci.org/DNAProject/DNA)

# DNA (Distributed Networks Architecture)

DNA is a decentralized distributed network protocol based on blockchain technology and is implemented in Golang. Through peer-to-peer network, DNA can be used to digitize assets and provide financial service, including asset registration, issuance, transfer, etc.

## Highlight Features

* Scalable Lightweight Universal Smart Contract
* Crosschain Interactive Protocol
* Quantum-Resistant Cryptography (optional module)
* China National Crypto Standard (optional module)
* High Optimization of TPS
* Distributed Storage and File Sharding Solutions Based on IPFS
* P2P Link Layer Encryption
* Node Access Control
* Multiple Consensus Algorithm Support (DBFT/RBFT/SBFT)
* Configurable Block Generation Time
* Configurable Digital Currency Incentive
* Configable Sharding Consensus (in progress)


# Building
The requirements to build DNA are:
* Go version 1.8 or later
* Glide (a third-party package management tool)
* Properly configured Go environment

Clone the DNA repository into the appropriate $GOPATH/src directory.


```shell
$ git clone https://github.com/DNAProject/DNA.git

```

Fetch the dependent third-party packages with glide.


````shell
$ cd DNA
$ glide install
````
Build the source code with make.

```shell
$ make
```

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

* `node`: the node program
* `nodectl`: command line tool for node control

Follow the procedures in Deployment section to give them a shot!


# Deployment

To run DNA successfully, at least 4 nodes are required. The four nodes can be deployed in the following two way:

* multi-hosts deployment
* single-host deployment

## Configurations for multi-hosts deployment

We can do a quick multi-host deployment by modifying the default configuration file `config.json`. Change the IP address in `SeedList` section to the seed node's IP address, and then copy the changed file to the hosts that you will run on.
On each host, put the executable program `node`, `nodectl` and the configuration file `config.json` into the same directory. Like :

```shell
$ ls
config.json node nodectl

```
Each node also needs a `wallet.dat` to run. The quickest way to generate wallets is to run `./nodectl wallet -c -p YourPassword` on each host.
Then, change the `BookKeepers` field to the 4 nodes' wallet public keys, which you can get from the last command's echo. The public key sequence does not matter.
Now all configurations are completed.

Here's an snippet for configuration, note that `10.0.1.100` and `10.0.1.101` are public seed node's addresses:


```shell
$ cat config.json
"SeedList": [
"10.0.1.100:10338",
"10.0.1.101:10338",
"10.0.1.102:10338"
],
"BookKeepers": [
"0322cfdb6a20401c2e44ede40b5282b2925fcff21cdc3814d782fd26026f1d023d",
"02b639c019537839ba30b7c8c0396095da8838993492c07fe6ca11a5cf7b8fd2ca",
"032c842494feba4e3dec3b9b7d9ad080ce63c81a41f7d79d2bbb5d499d16322907",
"03d36828a99547184452276116f1b5171861931ff439a6da2316fddf1f3f428850"
],
"HttpInfoPort": 10333,
"HttpInfoStart": true,
"HttpRestPort": 10334,
"HttpWsPort": 10335,
"HttpJsonPort": 10336,
"HttpLocalPort": 10337,
"NoticeServerUrl":"",
"OauthServerUrl":"",
"NodePort": 10338,
...
```

## Configurations for single-host deployment

Copy the executable file `node`, `nodectl` and configuration file `config.json` to 4 different directories on the single host. Then change each `config.json` file as following.
* The SeedList section should be same in all `config.json`.
* For the seed node, the `NodePort` is the same with the port in `SeedList` part.
* For each non-seed node, the `NodePort` should have different ports.
* Also make sure that the `HttpJsonPort` and `HttpLocalPort` of each node do not conflict with those of the current host.
After changing the configuration file, we also need to generate a wallet for each node and field the `BookKeepers` with the 4 nodes' wallet public keys. Please follow the steps in the multi-hosts deployment section above.
Here's an example:


```shell
# directory structure #
$ tree
├── node1
│ ├── config.json
│ ├── node
│ ├── nodectl
│ └── wallet.dat
├── node2
│ ├── config.json
│ ├── node
│ ├── nodectl
│ └── wallet.dat
├── node3
│ ├── config.json
│ ├── node
│ ├── nodectl
│ └── wallet.dat
└── node4
├── config.json
├── node
├── nodectl
└── wallet.dat
```

```shell
# configuration snippets #
$ cat node[1234]/config.json
...
"SeedList": [
"10.0.1.100:10338",
"10.0.1.100:20338",
"10.0.1.100:30338",
"10.0.1.100:40338"
],
"BookKeepers": [
"0322cfdb6a20401c2e44ede40b5282b2925fcff21cdc3814d782fd26026f1d023d",
"02b639c019537839ba30b7c8c0396095da8838993492c07fe6ca11a5cf7b8fd2ca",
"032c842494feba4e3dec3b9b7d9ad080ce63c81a41f7d79d2bbb5d499d16322907",
"03d36828a99547184452276116f1b5171861931ff439a6da2316fddf1f3f428850"
],
"HttpInfoPort": 10333,
"HttpInfoStart": true,
"HttpRestPort": 10334,
"HttpWsPort": 10335,
"HttpJsonPort": 10336,
"HttpLocalPort": 10337,
"NoticeServerUrl":"",
"OauthServerUrl":"",
"NodePort": 10338,
...

"SeedList": [
"10.0.1.100:10338",
"10.0.1.100:20338",
"10.0.1.100:30338",
"10.0.1.100:40338"
],
"BookKeepers": [
"0322cfdb6a20401c2e44ede40b5282b2925fcff21cdc3814d782fd26026f1d023d",
"02b639c019537839ba30b7c8c0396095da8838993492c07fe6ca11a5cf7b8fd2ca",
"032c842494feba4e3dec3b9b7d9ad080ce63c81a41f7d79d2bbb5d499d16322907",
"03d36828a99547184452276116f1b5171861931ff439a6da2316fddf1f3f428850"
],
"HttpInfoPort": 20333,
"HttpInfoStart": true,
"HttpRestPort": 20334,
"HttpWsPort": 20335,
"HttpJsonPort": 20336,
"HttpLocalPort": 20337,
"NoticeServerUrl":"",
"OauthServerUrl":"",
"NodePort": 20338,
...

"SeedList": [
"10.0.1.100:10338",
"10.0.1.100:20338",
"10.0.1.100:30338",
"10.0.1.100:40338"
],
"BookKeepers": [
"0322cfdb6a20401c2e44ede40b5282b2925fcff21cdc3814d782fd26026f1d023d",
"02b639c019537839ba30b7c8c0396095da8838993492c07fe6ca11a5cf7b8fd2ca",
"032c842494feba4e3dec3b9b7d9ad080ce63c81a41f7d79d2bbb5d499d16322907",
"03d36828a99547184452276116f1b5171861931ff439a6da2316fddf1f3f428850"
],
"HttpInfoPort": 30333,
"HttpInfoStart": true,
"HttpRestPort": 30334,
"HttpWsPort": 30335,
"HttpJsonPort": 30336,
"HttpLocalPort": 30337,
"NoticeServerUrl":"",
"OauthServerUrl":"",
"NodePort": 30338,
...

"SeedList": [
"10.0.1.100:10338",
"10.0.1.100:20338",
"10.0.1.100:30338",
"10.0.1.100:40338"
],
"BookKeepers": [
"0322cfdb6a20401c2e44ede40b5282b2925fcff21cdc3814d782fd26026f1d023d",
"02b639c019537839ba30b7c8c0396095da8838993492c07fe6ca11a5cf7b8fd2ca",
"032c842494feba4e3dec3b9b7d9ad080ce63c81a41f7d79d2bbb5d499d16322907",
"03d36828a99547184452276116f1b5171861931ff439a6da2316fddf1f3f428850"
],
"HttpInfoPort": 40333,
"HttpInfoStart": true,
"HttpRestPort": 40334,
"HttpWsPort": 40335,
"HttpJsonPort": 40336,
"HttpLocalPort": 40337,
"NoticeServerUrl":"",
"OauthServerUrl":"",
"NodePort": 40338,
...
```
## Getting Started

Start the seed node program first and then other nodes. Just run:

```shell
$ ./node
$ - input you wallet password
```

## Testing DNA in an open environment

We also provide an open testing environment. It supports the operation below:

1. make some transactions :
```
./nodectl --ip 139.219.65.178 --port 10336 test -tx perf -num 10
```

2. register, issue, transfer assert :
```
./nodectl --ip 139.219.65.178 --port 10336 test -tx full
```

3. look up block's information :
```
./nodectl --ip 139.219.65.178 --port 10336 info -height 10
```

4. look up transaction's information :
```
./nodectl --ip 139.219.65.178 --port 10336 info -txhash d438896f07786b74281bc70259b0caaccb87460171104ea17473b5e802033a98
```

......

Run `./nodectl --h` for more details.

Some other available nodes for testing:
```
IP PORT
----------------------
139.219.65.178: 10336
139.219.99.201: 10336
139.219.96.154: 10336
```

`Notice: The nodes above are intended to be used for public testing only. The data saved on the testing chain maybe be reset at any time. Keep in mind to back up the data by yourself to avoid data loss.`

# Contributing

Can I contribute patches to DNA project?

Yes! Please open a pull request with signed-off commits. We appreciate your help!

You can also send your patches as emails to the developer mailing list.
Please join the DNA mailing list or forum and talk to us about it.

Either way, if you don't sign off your patches, we will not accept them.
This means adding a line that says "Signed-off-by: Name <email>" at the
end of each commit, indicating that you wrote the code and have the right
to pass it on as an open source patch.

Also, please write good git commit messages. A good commit message
looks like this:

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 <[email protected]>

# Community

## Mailing list

We have a mailing list for developers:

* [email protected]

We provide two ways to subscribe:

* Send any contents to the email [email protected]

* Sign in https://groups.google.com/forum/#!forum/OnchainDNA


## Site

* https://www.DNAproject.org

## Forum

* https://forum.DNAproject.org

## Wiki

* https://wiki.DNAproject.org

# License

DNA is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
# nkn-core
NKN (New Kind of Network) is a new project aiming to rebuild the Internet that will be truly open, decentralized, dynamic, safe, shared and owned by the community. NKN intend to introduce Cellular Automata to innovate on several major layers in the entire stack. First of all, the project will address the network decentralization in a broad sense, starting from application connectivity, to networking protocol. Secondly, the project intend to improve the underlying blockchain technology to achieve efficient and fair consensus without sacrificing node equality and decentralization. Finally the project will leverage blockchain to maximize network resource utilization and incentivize community driven network creation, participation and expansion.

0 comments on commit 3481bd9

Please sign in to comment.