Skip to content

Latest commit

 

History

History
154 lines (94 loc) · 10.9 KB

README-CN.md

File metadata and controls

154 lines (94 loc) · 10.9 KB

License License GoDoc platform

P2PDB

中文 | English

简介

P2PDB,一个为了web3而生的去中心化、分布式、点对点、关系型数据库、它是传统数据库技术与区块链技术的结合,最终数据一致性算法基于merker-CRDT论文实现,它使用IPFS-libp2p构建去中心化网络和IPFS-pubsub与对等节点同步数据。它是一个使用CRDT、POW、POS解决数据一致性冲突的关系型数据库,P2PDB愿景是打造一个工业级别的去中心化数据库,使P2PDB 成为离线应用程序,去中心化应用程序(dApps)、和区块链应用程序数据存储的绝佳选择, P2PDB基于白皮书实现

使用教程

使用教程

核心模块

  • p2pdb-server: p2pdb-server一个mysql 语法的服务器端, 兼容90%mysql 语法,可使用任一一种mysql 客户端连接,包括PHP、JAVA、GO、RUBY、PYTHON等主流语言的兼容

  • p2pdb-log: 基于merker-crdt协议实现的不可篡改日志组件,p2pdb-log是一种只允许追加写入日志,并且不可窜改。基于操作的无冲突复制数据结构 (CRDT)与Merkle DAG(有向无环图)实现。如果所有 P2PDB 数据库类型都不符合您的需求和/或您需要特定于案例的功能,您可以轻松使用日志模块实现您想要的数据库

  • p2pdb-pubsub: 基于libp2p-pubsub实现的消息广播组件,用于对等节点中数据的主动传播,采用了Gossip流言广播算法,内置了一个消息队列,可通过webhook的方式监听数据的变动,支持Websocket协议链接,将来计划对接到Kafka、RabbitMq、Nsq、Nats等主流的消息队列,实现更广泛的数据消费应用,同时它也是一个具备扩展性的模块,可以根据该模块提供的接口,进行二次开发,以满足更多的业务场景

  • 🔲 p2pdb-consistency: 基于crdt,ot等协议用于消息顺序一致性判断的组件,主要用于当事件没有因果关系时(并发),作为全序判断的模块,集成了常用的顺序判断规则,如内置规则无法满足,你也可以根据该模块规范增加新的协议。

  • p2pdb-discovery: p2pdb-discovery 是对等节点的服务发现注册,用于检索对等节点,基于libp2p的mdns模块实现。

  • p2pdb-store: p2pdb-store 用于数据实际存储的模块,类似mysql的数据存储一样,提供索引检索,数据的增删改查等,这是一个抽象的模块,目的是将来如果当前的存储引擎无法满足你的存储需求,可以提供更多的DB驱动如clickhouse、postgresql、TDngine等数据库,当前提供内存存储(开发模式使用)以及文件存储(生产使用)。

生态

  • 🔲 p2pdb-desktop: p2pdb-desktop 一个便捷使用p2pdb的可视化桌面应用程序,包含经典的去中心化聊天、社交、邮件等应用例子,同时提供简易的监控及SQL查询控制面板

  • 🔲 p2pdb-ethereum : p2pdb-ethereum 一个实验性的项目,p2pdb负责实时索引以太坊数据,通过SQL查询以太坊的数据

目标

这个数据库的目标是:

  1. 一个Dapp应用数据存储解决方案
  2. 一个去中心化分布式数据库解决方案
  3. 一个边缘数据存储解决方案
  4. 一个离线应用数据存储解决方案

特性

  1. 兼容mysql 通用SQL语法,可以使用任何mysql 客户端连接
  2. 去中心化,无中心服务器
  3. 历史数据一旦生成,无法窜改
  4. 数据加密传输,公私钥加解密,授权支持到字段级别
  5. 最终一致性,支持强最终一致
  6. 故障恢复,定时快照本份,自动同步数据
  7. 版本证明,类似区块链算法,保证数据一旦生成永不丢失。

使用场景

  • 1、离线web应用存储
  • 2、多人互动游戏
  • 3、多人协作文档
  • 4、多人聊天应用
  • 5、边缘缓存存储
  • 6、Dapp应用存储
  • 7、NFT应用存储
  • 8、更多.........

本数据库使用到的部分仓库的关联引用组织

说明:由于本项目使用到的ipfs,libp2p等代码,引用的代码部分遵循代码相关协议,感谢协议实验室为web3.0做出的贡献,其余在独立模块中引用的代码,或者使用代码均在独立模块的LICENSE包含引用说明

引用说明

p2pdb是一个从0到1的项目,也是较早研究去中心化数据库领域,并且从理论到实践的项目,但是在实现的过程中,我们google了一遍全球关于去中心化数据库的文章及代码实现,可以说p2pdb 是站在巨人肩膀上,是因为有众多优秀的前辈的铺路,才有了p2pdb项目,在这里真诚的向所有研究去中心化数据库前辈,以及IPFS 团队、协议实验室的付出表示感谢,如果有任何引用代码,或者实现思路未在项目中注明来源,请联系我们,我们查证后将非常乐意注明,荣幸之至。

维护说明

维护人员:@Rock @Panda @CbYip @her-cat

当前维护P2PDB项目的是kkguan这个组织,由于某些原因考虑,仓库暂为private状态

注意:项目仍然属于快速迭代阶段,意味着大部分的API都有被重构的风险, 当前可作为学习跟研究使用,不建议运用在生产上,开发团队会尽最大的努力去推进1.0.0版本的发布,但是我们无法预估什么时候发布稳定版本。

如何贡献

非常欢迎你的加入!提一个 Issue 或者提交一个 Pull Request。

标准 Readme 遵循 Contributor Covenant 行为规范。

使用许可

Apache License Version 2.0 see http://www.apache.org/licenses/LICENSE-2.0.html

Contributors ✨

All Contributors

Thanks goes to these wonderful people :


她和她的猫

🚇 ⚠️ 💻

Rock

🚇 ⚠️ 💻

pandaLIU

🚇 ⚠️ 💻

CbYip

🚇 ⚠️ 💻

This project follows the all-contributors specification. Contributions of any kind welcome!