orbit core

轨道核心

IPFS上的通信协议

Orbit 是一个无服务器、分布式、p2p 通信库和协议，可在 IPFS 对等网络中实现基于源的信息共享，例如实时聊天。

该存储库是 Orbit 的核心库。该库旨在用于 Node.js 或浏览器应用程序。

用于各种 Orbit 项目：

• Orbit-web - Orbit 浏览器应用程序
• 轨道电子 - 轨道桌面应用程序
• Orbit-textui - Orbit 终端客户端

目录

• 安装
• 用法
• 应用程序编程接口
• 发展
  • 安装依赖项
  • 运行测试
  • 构建库和可分发文件
• 执照

安装

该模块使用 npm 和 node。

npm install orbit_

用法

有关更详细的示例，请参阅 Examples/browser/index.html。

 'use strict'

const Orbit = require ( 'orbit_' )

const ipfs = new Ipfs ( )

ipfs . on ( 'ready' , ( ) => {
  const orbit = new Orbit ( ipfs )

  const username = 'Example Bot'
  const channel = 'HelloWorld'

  orbit . events . on ( 'connected' , ( ) => {
    console . log ( `-!- Orbit connected` )
    orbit . join ( channel )
  } )

  orbit . events . on ( 'joined' , channelName => {
    orbit . send ( channelName , '/me is now caching this channel' )
    console . log ( `-!- Joined # ${ channelName } ` )
  } )

  // Listen for new messages
  orbit . events . on ( 'entry' , ( entry , channelName ) => {
    const post = entry . payload . value
    console . log ( `[ ${ post . meta . ts } ] < ${ post . meta . from . name } > ${ post . content } ` )
  } )

  // Connect to Orbit network
  orbit . connect ( username ) . catch ( e => console . error ( e ) )
} ) 

应用程序编程接口

有关完整详细信息，请参阅 API 文档。

• 入门
• 构造函数
• 特性
  • 用户
  • 网络
  • 渠道
  • 同行
• 方法
  • 连接（用户名）
  • 断开（）
  • 加入（频道）
  • 离开（频道）
  • 发送（频道，消息）
  • 添加文件（通道，源）
  • 获取文件（哈希）
  • 获取目录（哈希）

发展

安装依赖项

git clone https://github.com/orbitdb/orbit-core.git
cd orbit-core/
npm install

运行示例开发环境

npm run dev

运行测试

npm test

构建库和可分发文件

npm run build

可分发（针对浏览器的 ES5 缩小版）将位于dist/中。

贡献

我们很乐意接受 PR！如果你想做某件事，最好提前谈谈，以确保没有其他人在做这件事。您可以通过 Gitter 或问题部分联系我们。

我们还定期举行社区电话会议，我们在@orbitdb 欢迎存储库的问题中宣布了这一点。加入我们！

如果您想编码但不知道从哪里开始，请查看标记为“需要帮助”的问题。

有关为此存储库做出贡献的具体指南，请查看贡献指南。有关为 OrbitDB 做出贡献的更多信息，请查看 @OrbitDB 欢迎存储库。请注意，@OrbitDB 中的所有互动均符合我们的行为准则。

执照

麻省理工学院 © 2016-2019 Protocol Labs Inc.、Haja Networks Oy