meling / resilientdb

ResilientDB: Global-Scale Sustainable Blockchain Fabric

Home Page:https://resilientdb.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ResilientDB: Global-Scale Sustainable Blockchain Fabric

ResilientDB is a High Throughput Yielding Permissioned Blockchain Fabric founded by ExpoLab at UC Davis in 2018. ResilientDB advocates a system-centric design by adopting a multi-threaded architecture that encompasses deep pipelines. Further, ResilientDB separates the ordering of client transactions from their execution, which allows it to process messages out-of-order.

Quick Facts on ResilientDB

  1. ResilientDB's core consensus protocol is based on a highly optimized PBFT [Castro and Liskov, 1998] implementation to achieve agreement among replicas. The core consensus layer is further expanded with the state-of-the-art consensus protocols [release are planned] such as GeoBFT [blog, released], PoE, RCC, RingBFT, PoC, SpotLess, HotStuff, and DAG.
  2. ResilientDB expects minimum of 3f+1 replicas, where f is the maximum number of arbitrary (or malicious) replicas.
  3. ReslientDB designates one of its replicas as the primary (replicas with identifier 0), which is also responsible for initiating the consensus.
  4. ResilientDB exposes a wide range of interfaces such as a Key-Value, Smart Contracts, UTXO, and Python SDK. Examples DApp that are being built on ResilientDB are: NFT Marketplace and Debitable.
  5. To facilitate the persistence of the chain and chain state, ResilientDB provides durability through LevelDB and RocksDB.
  6. To support deployment and maintenance, ResilientDB provides access to a seamless GUI display along with access to Grafana for plotting monitoring data.
  7. [Historial Facts] The ResilientDB project was founded by Mohammad Sadoghi along with his students (Suyash Gupta as the lead Architect, Sajjad Rahnama, Jelle Hellings) at UC Davis in 2018 and was open-sourced in late 2019. On September 30, 2021, we released ResilientDB v-3.0. In 2022, ResilientDB was completely re-written and re-architected (Junchao Chen as the lead Architect along with the entire NexRes Team), paving the way for a new sustainable foundation, referred to as NexRes (Next Generation ResilientDB); thus, on September 30, 2022, NexRes-v1.0.0 was born, marking a new beginning for ResilientDB.

Online Documentation:

You may find the latest ResilientDB documentation, including a programming guide, on our blog repository. This README file provides basic setup instructions.

Table of Contents

  1. Software Stack Architecture
    • SDK, Interface/API, Platform, Execution, and Storage Layers [TBA]
    • Detailed API Documentation: Core and SDK
    • Overview of Class Diagram & Code Structure [TBA]
  2. SDK Layer: Python SDK
  3. Interface Layer: Key-Value, Solidity Smart Contract, Unspent Transaction Output (UTXO) Model, ResilientDB Database Connectivity (RDBC) API
  4. Platform Layer: Consensus Manager Architecture (ordering, recovery, network, chain management)
    • Recovery & Checkpoint Design [TBA]
  5. Execution Layer: Transaction Manager Design (Runtime) [TBA]
  6. Chain Layer: Chain State & Storage Manager Design (durability) [TBA]
  7. Installing & Deploying ResilientDB

Nexres

OS Requirements

Ubuntu 20.*


Build and Deploy ResilientDB

Install dependencies:

./INSTALL.sh

Run ResilientDB (Providing a Key-Value Service):

./service/tools/kv/server_tools/start_kv_service.sh
  • This script will start 4 replica and 1 client. Each replica instantiates a key-value store.

Build Interactive Tools:

bazel build service/tools/kv/api_tools/kv_service_tools

Run tools to set a value by a key (for example, set the value with key "test" and value "test_value"):

bazel-bin/service/tools/kv/api_tools/kv_service_tools service/tools/config/interface/service.config set test test_value

You will see the following result if successful:

client set ret = 0

Run tools to get value by a key (for example, get the value with key "test"):

bazel-bin/service/tools/kv/api_tools/kv_service_tools service/tools/config/interface/service.config get test 

You will see the following result if successful:

client get value = test_value

Run tools to get all values that have been set:

bazel-bin/service/tools/kv/api_tools/kv_service_tools service/tools/config/interface/service.config getvalues

You will see the following result if successful:

client getvalues value = [test_value]

About

ResilientDB: Global-Scale Sustainable Blockchain Fabric

https://resilientdb.com/

License:Apache License 2.0


Languages

Language:C++ 90.7%Language:Starlark 6.7%Language:Shell 1.4%Language:Python 0.9%Language:QMake 0.1%Language:Solidity 0.1%