orbit core

Orbitkern

Kommunikationsprotokoll auf IPFS

Orbit ist eine serverlose, verteilte P2P-Kommunikationsbibliothek und ein Protokoll, das den Feed-basierten Informationsaustausch, wie z. B. Echtzeit-Chat, im IPFS-Peer-to-Peer-Netzwerk ermöglicht.

Dieses Repository ist die Kernbibliothek von Orbit. Diese Bibliothek ist für die Verwendung in Ihren Node.js- oder Browseranwendungen vorgesehen.

Wird in den verschiedenen Orbit-Projekten verwendet:

• orbit-web – Orbit-Browser-App
• orbit-electron – Orbit-Desktop-App
• orbit-textui – Orbit-Terminal-Client

Inhaltsverzeichnis

• Installieren
• Verwendung
• API
• Entwicklung
  • Abhängigkeiten installieren
  • Führen Sie Tests durch
  • Erstellen Sie eine Bibliothek und verteilbare Dateien
• Lizenz

Installieren

Dieses Modul verwendet npm und node.

npm install orbit_

Verwendung

Ein detaillierteres Beispiel finden Sie unter „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

Ausführliche Informationen finden Sie in der API-Dokumentation.

• Erste Schritte
• Konstrukteur
• Eigenschaften
  • Benutzer
  • Netzwerk
  • Kanäle
  • Gleichaltrige
• Methoden
  • verbinden(Benutzername)
  • trennen()
  • beitreten (Kanal)
  • verlassen (Kanal)
  • senden (Kanal, Nachricht)
  • addFile(Kanal, Quelle)
  • getFile(Hash)
  • getDirectory(Hash)

Entwicklung

Abhängigkeiten installieren

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

Führen Sie eine Beispielentwicklungsumgebung aus

npm run dev

Führen Sie Tests durch

npm test

Erstellen Sie eine Bibliothek und verteilbare Dateien

npm run build

Distributable (ES5 minimiert für Browser) befindet sich in dist/ .

Beitragen

Gerne nehmen wir PRs entgegen! Wenn Sie an etwas arbeiten möchten, ist es gut, vorher zu sprechen, um sicherzustellen, dass niemand anderes daran arbeitet. Sie können uns auf Gitter oder im Bereich „Probleme“ erreichen.

Wir veranstalten auch regelmäßige Community-Calls , die wir in den Ausgaben im @orbitdb-Willkommens-Repository bekannt geben. Begleiten Sie uns!

Wenn Sie programmieren möchten, aber nicht wissen, wo Sie anfangen sollen, sehen Sie sich die Probleme mit der Bezeichnung „Hilfe gesucht“ an.

Spezifische Richtlinien für Beiträge zu diesem Repository finden Sie im Beitragsleitfaden. Weitere Informationen zum Mitwirken an OrbitDB im Allgemeinen finden Sie im @OrbitDB-Willkommens-Repository. Bitte beachten Sie, dass alle Interaktionen in @OrbitDB unter unseren Verhaltenskodex fallen.

Lizenz

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