Google Git
Sign in
apache / incubator-resilientdb / f9d2ee222abdea58e40ee8747a1cafa07950eead
commitf9d2ee222abdea58e40ee8747a1cafa07950eead[log] [tgz]
authorUbuntu <ubuntu@ip-172-31-66-55.ec2.internal>Tue Mar 07 19:20:57 2023 +0000
committerUbuntu <ubuntu@ip-172-31-66-55.ec2.internal>Tue Mar 07 19:20:57 2023 +0000
treef249136cf55ef50751a9c770800e85a3384baef1
parent18163e375846373bcb8df6d74d875bba07d2a513 [diff]
rm addr2'
1 file changed
tree: f249136cf55ef50751a9c770800e85a3384baef1
  1. .github/
  2. application/
  3. cert/
  4. client/
  5. common/
  6. config/
  7. crypto/
  8. database/
  9. docker/
  10. documents/
  11. durable_layer/
  12. example/
  13. execution/
  14. kv_client/
  15. kv_server/
  16. node_modules/
  17. ordering/
  18. proto/
  19. sdk_client/
  20. sdk_validator/
  21. server/
  22. statistic/
  23. test/
  24. third_party/
  25. tools/
  26. .bazelrc
  27. .clang-format
  28. .gitignore
  29. BUILD.bazel
  30. CHANGELOG.md
  31. CNAME
  32. CODE_OF_CONDUCT.md
  33. format.sh
  34. INSTALL.sh
  35. INSTALL_MAC.sh
  36. LICENSE
  37. README.md
  38. WORKSPACE
README.md

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 [the release is pending] such as GeoBFT, PoE, RCC, RingBFT, PVP, PoC, 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 API services 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
  2. Platform Layer: Consensus Manager Architecture (ordering, recovery, network, chain management, storage)
  3. Service Layer: Transaction Manager Design (runtime and chain state) [TBA]
  4. Tooling & API Layer: Key-Value, Solidity Smart Contract, Unspent Transaction Output (UTXO) Model, Python SDK
  5. Installing & Deploying ResilientDB

OS Requirements

Ubuntu 20.*

Build and Deploy ResilientDB

Install dependencies:

./INSTALL.sh

Run ResilientDB (Providing a Key-Value Service):

./example/start_kv_server.sh
  • This script will start 4 replica and 1 client. Each replica instantiates a key-value store.

Build Interactive Tools:

bazel build example/kv_server_tools

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

bazel-bin/example/kv_server_tools example/kv_client_config.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/example/kv_server_tools example/kv_client_config.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/example/kv_server_tools example/kv_client_config.config getvalues

You will see the following result if successful:

client getvalues value = [test_value]

Enable SDK

If you want to enable sdk verification, add a flag to the command

./example/start_kv_server.sh --define enable_sdk=True

And in example/kv_config.config

require_txn_validation:true,

FAQ

If installing bazel fails on a ubuntu server, follow these steps:

mkdir bazel-src

cd bazel-src

wget https://github.com/bazelbuild/bazel/releases/download/5.4.0/bazel-5.4.0-dist.zip

sudo apt-get install build-essential openjdk-11-jdk python zip unzip

unzip bazel-5.4.0-dist.zip

env EXTRA_BAZEL_ARGS=“--tool_java_runtime_version=local_jdk” bash ./compile.sh

sudo mv output/bazel /usr/local/bin