Skip to content

Update CovenantSQL README-zh.md #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
auxten merged 2 commits into from
Apr 19, 2019
Merged

Update CovenantSQL README-zh.md #314

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc701bb
Update README-zh.md
ConnorLi96 Apr 19, 2019
53850cf
Update README-zh.md
auxten Apr 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 119 additions & 26 deletions README-zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,40 +26,36 @@
alt="Join the chat at https://gitter.im/CovenantSQL/CovenantSQL"></a>
</p>

CovenantSQL 是应用区块链技术构建的去中心化 SQL 云数据库。
CovenantSQL(CQL) 是一个运行在公网上的 SQL 数据库，并具有 GDPR 合规与去中心化等特点。

结合了区块链、共享经济、分布式数据库的优势，保障了用户隐私及对数据的所有权。

CovenantSQL 具备以下特点：
- **GDPR 合规**: 无痛 GDPR 合规
- **SQL 接口**: 支持 SQL-92 标准
- **去中心化**: 基于共识算法 DH-RPC & Kayak 实现的去中心化
- **不可篡改**: CQL 中的 Query 历史是不可篡改且可追溯的
- **隐私**: 使用列级 ACL 和 SQL 白名单模式授予权限

- **SQL接口**: 支持 SQL-92 标准，传统 App 几乎 0 修改即可数据上链
- **去中心化**: 基于独有的高效拜占庭容错共识算法 Kayak 实现的去中心化结构
- **不可篡改**: CovenantSQL 中的 Query 历史记录是可追溯的
- **隐私**: 如果 Bitcoin 是用户的钱包，那么 CovenantSQL 就是是用户的去中心化数据库
我们坚信 [在下一个互联网时代，每个人都应该有完整的**数据权利**](https://medium.com/@covenant_labs/covenantsql-the-sql-database-on-blockchain-db027aaf1e0e)

我们相信 [在下一个互联网时代，每个人都应该有完整的**数据权利**](https://medium.com/@covenant_labs/covenantsql-the-sql-database-on-blockchain-db027aaf1e0e)
## 使用文档

## 原理
https://developers.covenantsql.io/docs/zh-CN/quickstart

CovenantSQL 是一个运行在 Internet 上的开放网络，主要有以下三种角色组成：
**一行代码让数据上链**

- 主链节点：
- 通过去中心化的架构，DPoS 模式的共识机制对矿工和用户进行撮合、协调、仲裁
- 侧链矿工：
- 所有人都可以通过运行 Covenant Miner 来提供数据库服务来赚取奖励
- 通过 ETLS 传输层加密、应用层签名、落盘加密、端到端加密 保证用户数据隐私
- 数据库用户：
- 用户通过一个私钥就可以创建指定数量节点的分布式数据库，存储自己的结构化数据
- 数据矿工的分布和地址仅对数据库用户可见，防止用户数据被嗅探
- 通过 **去中心化的高可用的架构** 和 **Miner 押金机制**，用户的数据可以在成本和可靠性、可用性上达到平衡可控


#### 一行代码接入区块链数据
```go
sql.Open("CovenantSQL", dbURI)
sql.Open("cql", dbURI)
```

##
## CQL 是什么?

- [Amazon QLDB](https://aws.amazon.com/qldb/)的开源版
- 如果 [filecoin](https://filecoin.io/) + [IPFS](https://ipfs.io/) 是去中心化的文件系统, 那么 CQL 就是去中心化的数据库

## CQL 如何工作

### 3 层架构


![CovenantSQL 3 Layer design](logo/arch.png)

Expand All @@ -73,21 +69,111 @@ sql.Open("CovenantSQL", dbURI)
- 每个数据库都有自己独立的分布式引擎。
- 主要负责：数据库存储和加密；查询处理和签名；高效索引。

## 文章

### 共识算法

CQL 支持两种共识算法：

1. DPoS (委任权益证明) 应用在数据库的 `最终一致性` 和 Block Producer 所在的 `第一层 (全局共识层)` ，CQL 的矿工在客户端将所有SQL查询及其签名打包成块，从而形成整个区块链，我们把这个算法命名为 [`Xenomint`](https://github.com/CovenantSQL/CovenantSQL/tree/develop/xenomint)
2. BFT-Raft (拜占庭容错算法)<sup>[bft-raft](#bft-raft)</sup> 应用于数据库的 `强一致性`。我们把这个实现命名为 [`Kayak`](https://github.com/CovenantSQL/CovenantSQL/tree/develop/kayak). 矿工 leader 会基于 `Kayak` 做 `两阶段提交` 来支持 `Transaction`.<sup>[transaction](#transaction)</sup>

可以用命令行 `cql create '{"UseEventualConsistency": true, "Node": 3}'` 来创建 `最终一致性` CQL 数据库


## 项目对比

| | 以太坊 | Hyperledger Fabric | AWS QLDB | CovenantSQL |
| ---------------------------- | ----------------- | ---------------------- | ----------- | ------------------------------------------------------------ |
| **开发语言** | Solidity, ewasm | Chaincode (Go, NodeJS) | ? | Python, Golang, Java, PHP, NodeJS, MatLab |
| **开发模式** | Smart Contract | Chaincode | SQL | SQL |
| **是否开源** | Y | Y | N | Y |
| **高可用节点** | 3 | 15 | ? | 3 |
| **列级别 ACL** | N | Y | ? | Y |
| **数据格式** | File | Key-value | Document | File<sup>[fuse](#fuse)</sup>, Key-value, Structured |
| **存储加密** | N | API | Y | Y |
| **数据脱敏** | N | N | N | Y |
| **多租户** | DIY | DIY | N | Y |
| **吞吐量（1秒延迟）** | 15~10 tx/s | 3500 tx/s | ? | 11065 tx/s (Eventually Consistency)<br/>1866 tx/s (Strong Consistency) |
| **一致性延迟** | 2~6 min | < 1 s | ? | < 10 ms |
| **开放网络上的安全性** | Y | N | Only in AWS | Y |
| **共识机制** | PoW + PoS(Casper) | CFT | ? | DPoS (Eventually Consistency)<br/>BFT-Raft (Strong Consistency) |

#### 注释：
- <a name="bft-raft">BFT-Raft</a>: 在一个 CQL leader 离线的情况下，有两种可能的选择：等待 leader 上线，以保证数据的完整性，或者提拔 follwers 以保证服务可用性；目前是需要一定的人工介入来进行策略选择，这部分仍在迭代中，欢迎任何建议。

- <a name="transaction">事务 (Transaction)</a>: 说到 `ACID`，CQL 具有完整的 "一致性，隔离性，持久化" 和特定的 `Atomicity` 支持。即使在强一致性的模式下，CQL 事务只支持在 leader 节点上执行。如果你想要并发执行事务："读取 `v`, `v++`, 写回 `v` ", 仅有的办法是："从 leader 读取 `v` , `v++`, 从 leader 写回 `v`"

- <a name="fuse">FUSE</a>: CQL 有一个从 CockroachDB 移植过来的 [FUSE 客户端](https://github.com/CovenantSQL/CovenantSQL/tree/develop/cmd/cql-fuse)，目前性能不是很理想，仍然存在一些小问题。但它可以通过如下的 fio 测试：

```bash
fio --debug=io --loops=1 --size=8m --filename=../mnt/fiotest.tmp --stonewall --direct=1 --name=Seqread --bs=128k --rw=read --name=Seqwrite --bs=128k --rw=write --name=4krandread --bs=4k --rw=randread --name=4krandwrite --bs=4k --rw=randwrite
```


## Demos

- 去中心化论坛：[CovenantForum](https://demo.covenantsql.io/forum/)
- 推特上链：[Twitter Bot @iBlockPin](https://twitter.com/iblockpin)
- 微博上链：[Weibo Bot @BlockPin](https://weibo.com/BlockPin)
- Markdown 同步上链：[Markdown Editor with CovenantSQL sync](https://github.com/CovenantSQL/stackedit)
- 网页端管理：[Web Admin for CovenantSQL](https://github.com/CovenantSQL/adminer)
- CovenantSQL 介绍视频：[How CovenantSQL works(video)](https://youtu.be/2Mz5POxxaQM?t=106)

## 使用案例

### 传统 App

#### 数据隐私

如果你是一个使用密码管理工具的开发者，比如 [1Password](https://1password.com/) or [LastPass](https://www.lastpass.com/). 你可以使用 CQL 作为数据库并有以下优点：

1. 无服务器: 不需要部署服务器来存储用户密码，以进行同步，这是一个烫手山芋。
2. 安全: CQL 可以保证所有的加密工作，去中心化的数据存储给予用户更多信心。
3. 合规: CQL 天然符合 [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation) 标准。

#### 物联网存储

CQL 矿工全球化部署，IoT 节点可以写入最近的矿工。

1. 实惠: 不需要通过网关传输流量，你可以节省大量的带宽费用。同时，SQL 具有共享经济的特性，以此让存储更实惠。
2. 更快: CQL 共识协议是基于互联网而设计，网络延迟不可避免。


#### 开放数据服务

例如，你是一个非常在意细节的比特币 OHLC 数据维护者，你可以直接放一个 SQL 接口给你的用户以满足各种查询需求。

1. CQL 在平衡数据安全性的同时，可以限制特定的 SQL 查询语句以满足需求。
2. CQL 将 SQL 操作，增删查改等记录在区块链上，方便用户检查账单比如 [这个](https://explorer.dbhub.org/dbs/7a51191ae06afa22595b3904dc558d41057a279393b22650a95a3fc610e1e2df/requests/f466f7bf89d4dd1ece7849ef3cbe5c619c2e6e793c65b31966dbe4c7db0bb072)
3. 对于那些对高性能有要求的客户，可以在用户那里部署 `Slave` 节点，以满足低延迟查询的需求，同时实现几乎实时的数据更新。

#### 安全存储

由于 CQL 数据历史是不可篡改的，CQL 可以用来存储敏感的操作日志，以防止黑客攻击和删除访问日志。


### 去中心化应用（ĐApp）

在比特币或以太坊这种传统公链上存储数据非常昂贵（2018-05-15 以太坊上为 $4305 / MB），而且由于缺乏结构化数据的支持，代码实现非常复杂。但 CQL 可以给你一个结构化且低成本的 SQL 数据库，并为 ĐApp 提供了与真实世界交换数据的空间。


## 相关论文
团队成员发表过的论文

- [迅雷水晶：一种新颖的基于众筹的内容分发平台](https://dl.acm.org/citation.cfm?id=2736085)
- [基于众筹的视频服务系统性能分析](https://ieeexplore.ieee.org/abstract/document/7114727/)
- [迅雷水晶性能分析：基于众筹的视频分发平台](https://ieeexplore.ieee.org/abstract/document/7762143/)


这些启发了我们：

- [比特币：P2P电子现金系统](https://bitcoin.org/bitcoin.pdf)
- [S/Kademlia](https://github.com/thunderdb/research/wiki/Secure-Kademlia)
- [S/Kademlia: 一种针对密钥的实用方法](https://ieeexplore.ieee.org/document/4447808/)
- [vSQL: 验证动态外包数据库上的任意SQL查询](https://ieeexplore.ieee.org/abstract/document/7958614/)

## Libs

## 相关库

### 网络栈

Expand Down Expand Up @@ -117,17 +203,24 @@ CovenantSQL仍在建设中，测试网已经发布，[尝试一下](https://deve
- [Java](https://github.com/CovenantSQL/covenant-connector)
- [NodeJS](https://github.com/CovenantSQL/node-covenantsql)
- [Python](https://github.com/CovenantSQL/python-driver)
- [Microsoft Excel (来自社区)](https://github.com/melancholiaforever/CQL_Excel)
- Coding for more……

关注我们或[![follow on Twitter](https://img.shields.io/twitter/url/https/twitter.com/fold_left.svg?style=social&label=Follow%20%40CovenantLabs)](https://twitter.com/intent/follow?screen_name=CovenantLabs) 保持更新

## 测试网

- [快捷入口](https://developers.covenantsql.io)
- [主链浏览器](http://scan.covenantsql.io)
- [SQL 链浏览器](https://explorer.dbhub.org)
- [Demo & 论坛](https://demo.covenantsql.io/forum/)

## 联系我们

- [博客](https://medium.com/@covenant_labs)
- [YouTube](https://www.youtube.com/channel/UCe9P_TMiexSHW2GGV5qBmZw)
- [邮箱地址](mailto:[email protected])
- [论坛](https://demo.covenantsql.io/forum/)
- <a href="https://twitter.com/intent/follow?screen_name=CovenantLabs">
<img src="https://img.shields.io/twitter/url/https/twitter.com/fold_left.svg?style=social&label=Follow%20%40CovenantLabs"
alt="follow on Twitter"></a>
Expand Down