orbit core

オービットコア

IPFS上の通信プロトコル

Orbit は、サーバーレスの分散型 p2p 通信ライブラリおよびプロトコルであり、IPFS ピアツーピア ネットワークでのリアルタイム チャットなどのフィードベースの情報共有を可能にします。

このリポジトリは Orbit のコア ライブラリです。このライブラリは、Node.js またはブラウザ アプリケーションで使用することを目的としています。

さまざまな Orbit プロジェクトで使用されます。

• orbit-web - Orbit ブラウザ アプリ
• orbit-electron - Orbit デスクトップ アプリ
• orbit-textui - Orbit ターミナルクライアント

目次

• インストール
• 使用法
• API
• 発達
  • 依存関係のインストール
  • テストの実行
  • ライブラリと配布物をビルドする
• ライセンス

インストール

このモジュールは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

詳細については、API ドキュメントを参照してください。

• はじめる
• コンストラクタ
• プロパティ
  • ユーザー
  • ネットワーク
  • チャンネル
  • 仲間
• メソッド
  • 接続(ユーザー名)
  • 切断()
  • 参加(チャンネル)
  • 退出(チャンネル)
  • send(チャンネル、メッセージ)
  • addFile(チャンネル、ソース)
  • getFile(ハッシュ)
  • getDirectory(ハッシュ)

発達

依存関係のインストール

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 でのすべてのやり取りは当社の行動規範に該当することに注意してください。

ライセンス

MIT © 2016-2019 Protocol Labs Inc.、Haja Networks Oy