github.com/aergoio/aergo@v1.3.1/README.md (about)

     1  [![Go Report Card](https://goreportcard.com/badge/github.com/aergoio/aergo)](https://goreportcard.com/report/github.com/aergoio/aergo)
     2  [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
     3  [![Travis_ci](https://travis-ci.org/aergoio/aergo.svg?branch=master)](https://travis-ci.org/aergoio/aergo)
     4  [![Maintainability](https://api.codeclimate.com/v1/badges/8ae0a363155bd9e8bccb/maintainability)](https://codeclimate.com/github/aergoio/aergo/maintainability)
     5  [![Test Coverage](https://api.codeclimate.com/v1/badges/8ae0a363155bd9e8bccb/test_coverage)](https://codeclimate.com/github/aergoio/aergo/test_coverage)
     6  [![LoC](https://tokei.rs/b1/github/aergoio/aergo)](https://github.com/aergoio/aergo)
     7  [![API Reference](https://godoc.org/github.com/aergoio/aergo?status.svg)](https://godoc.org/github.com/aergoio/aergo)
     8  
     9  # Aergo - Distributed Trust at Scale
    10  
    11  Official Chain Software of Aergo Protocol
    12  
    13  We are developing the most practical and powerful platform for blockchain businesses. This will be a huge challenge. There are 4 main ideologies regarding this project.
    14  
    15  1. Developer-friendly
    16  2. Guaranteed performance
    17  3. Scalable architecture
    18  4. Connect with the world
    19  
    20  You can see the current public network status via aergoscan service: [aergoscan](https://aergoscan.io)
    21  
    22  Official Documentation Link: [aergodocs](http://docs.aergo.io)
    23  
    24  ## Roadmaps
    25  
    26  ### beginning: Skeleton (31, July, 2018)
    27  * Platform framework
    28  * Stub consensus(dpos without voting)
    29  * Account model
    30  * Mempool
    31  * Networking - p2p/protocol
    32  * Cmd aergocli/aergosvr
    33  * Simple client API
    34  * Smart contract will not be released - you can see the prototype in [coinstack3sp2](https://github.com/coinstack/coinstackd)
    35  
    36  ### 1st: Aergo Alpha (31, Oct, 2018)
    37  * Consensus - BFT-dPOS (election not integrated)
    38    * We provide BFT by solving various problems that may occur in dpos.
    39  * Aergo SQL smart contract (Lua-jit)
    40    * It is a powerful smart contract language providing DB function.
    41  * Client - Ship
    42    * Client framework and development environment
    43    * Provides a package management and testing environment similar to NPM.
    44  * Client SDK
    45    * heraj (java)
    46    * herajs (javascript)
    47    * herapy (python)
    48  * Browser Wallet (1~2 weeks later)
    49    * Chrome Extension provides a coin transfer wallet.
    50  * Sub Project
    51    * Litetree
    52      * Improved SQLite is used to provide DB functionality in a block chain.
    53      * Provides higher performance through LMDB.
    54    * Sparse Merkle Tree
    55      * Provides fast, space-saving sparse merkle tree.
    56    * Pre-Testnet
    57      * Launch the pre-testnet to monitor operation environment.
    58      * We provide https://aergoscan.io.
    59  
    60  ### 2nd: Aergo Testnet (28, Dec, 2018)
    61  * BFT-dPOS with Voting
    62    * The pre-test net has the function of agreeing blocks among the set BPs. TestNet has a function to select BP through voting.
    63  * Named Account
    64    * For user's convenience, Named Account function that can be accessed based on Name rather than Address is provided.
    65  * Expanded Aergo Lua
    66    * The Aergo Lua feature has been extended for more convenient development.
    67  * Advanced Client Framework
    68    * Provides a wallet interface that interacts with keystore and manages nonce.
    69    * Provides the ability to make smart contracts through interface calls.
    70    * Provides a contract library to issue tokens based on Aergo.
    71  * Hub Enterprise
    72    * Enterprise customers view management and monitoring of their networks as a prerequisite.
    73    * We provide Hub Enterprise control solution to solve this problem.
    74  * Merkle Bridge Verification
    75    * StateTrie Merkle proof verifications and delegated token transfers are now implemented in the merkle-bridge.
    76  * Various Smart Contract Examples
    77    * Provide some standard smart contracts
    78  * TestNet
    79    * Launch the Test Network to provide network for community and experment
    80    * We provide https://aergoscan.io.
    81  
    82  ### 3rd: Aergo Mainnet (planned in March, 2019)
    83  * Parallelism (inter-contract)
    84  * Simple branching (2WP or simple Plasma)
    85  
    86  ### 4th: Aergo World Launch (planned in 4Q, 2019)
    87  * Orchestration with Aergo Horde
    88  * Service with Aergo Hub
    89  * Advanced performance features
    90  
    91  ### 5th: Aergo Future
    92  * Will be updated
    93  
    94  ## Key thoughts of the architecture
    95  
    96  MVP based, Forward compatibility, Iteration
    97  
    98  ## Information
    99  
   100  ### Server port usages
   101  
   102  | Usage | Port |
   103  |-------|------|
   104  |  gRPC | 7845 |
   105  |  P2P  | 7846 |
   106  
   107  ## Installation
   108  
   109  ### Prerequisites
   110  
   111  * Go1.11.4+ - https://golang.org/dl
   112  * Proto Buffers - https://github.com/google/protobuf
   113  * CMake 3.0.0 or higher - https://cmake.org
   114  
   115  ### Build
   116  
   117  [Building from Source](https://docs.aergo.io/en/latest/contribution/building-from-source.html)
   118  
   119  ## Contribution
   120  
   121  Following Golang conventions
   122  TBD
   123  
   124  ## License
   125  
   126  All code is licensed under the MIT License (https://opensource.org/licenses/MIT).