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