orbit core

noyau d'orbite

Protocole de communication sur IPFS

Orbit est une bibliothèque et un protocole de communication p2p distribués sans serveur qui permettent le partage d'informations basé sur des flux, comme le chat en temps réel, dans le réseau peer-to-peer IPFS.

Ce référentiel est la bibliothèque principale d'Orbit. Cette bibliothèque est destinée à être utilisée dans vos applications Node.js ou Browser.

Utilisé dans les différents projets Orbit :

• orbit-web - Application de navigateur Orbit
• orbit-electron - Application de bureau Orbit
• orbit-textui - Client de terminal Orbit

Table des matières

• Installer
• Usage
• API
• Développement
  • Installer les dépendances
  • Exécuter des tests
  • Construire une bibliothèque et des distribuables
• Licence

Installer

Ce module utilise npm et node.

npm install orbit_

Usage

Voir examples/browser/index.html pour un exemple plus détaillé.

 '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

Consultez la documentation de l'API pour plus de détails.

• Commencer
• Constructeur
• Propriétés
  • utilisateur
  • réseau
  • chaînes
  • pairs
• Méthodes
  • se connecter (nom d'utilisateur)
  • déconnecter()
  • rejoindre (canal)
  • quitter (canal)
  • envoyer (canal, message)
  • addFile (canal, source)
  • getFile (hachage)
  • getDirectory (hachage)

Développement

Installer les dépendances

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

Exécuter un exemple d'environnement de développement

npm run dev

Exécuter des tests

npm test

Construire une bibliothèque et des distribuables

npm run build

Distribuable (ES5 minifié pour les navigateurs) sera situé dans dist/ .

Contribuer

Nous serions heureux d'accepter les PR ! Si vous souhaitez travailler sur quelque chose, ce serait bien d'en parler au préalable pour vous assurer que personne d'autre n'y travaille. Vous pouvez nous joindre sur Gitter ou dans la section des problèmes.

Nous organisons également des appels communautaires réguliers , que nous annonçons dans les numéros du référentiel de bienvenue @orbitdb. Rejoignez-nous !

Si vous souhaitez coder mais ne savez pas par où commencer, consultez les problèmes intitulés « aide recherchée ».

Pour obtenir des directives spécifiques pour contribuer à ce référentiel, consultez le guide de contribution. Pour en savoir plus sur la contribution à OrbitDB en général, jetez un œil au référentiel de bienvenue @OrbitDB. Veuillez noter que toutes les interactions dans @OrbitDB relèvent de notre code de conduite.

Licence

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