orbit core

núcleo de órbita

Protocolo de comunicação em IPFS

Orbit é uma biblioteca e protocolo de comunicação p2p distribuída e sem servidor que permite o compartilhamento de informações baseado em feed, como bate-papo em tempo real, na rede ponto a ponto IPFS.

Este repositório é a biblioteca principal do Orbit. Esta biblioteca deve ser usada em seus aplicativos Node.js ou navegador.

Usado nos vários projetos Orbit:

• orbit-web - aplicativo de navegador Orbit
• orbit-electron - aplicativo de desktop Orbit
• orbit-textui - Cliente terminal orbital

Índice

• Instalar
• Uso
• API
• Desenvolvimento
  • Instalar dependências
  • Executar testes
  • Construir biblioteca e distribuíveis
• Licença

Instalar

Este módulo usa npm e node.

npm install orbit_

Uso

Veja exemplos/browser/index.html para um exemplo mais detalhado.

 '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

Consulte a documentação da API para obter detalhes completos.

• Começando
• Construtor
• Propriedades
  • usuário
  • rede
  • canais
  • pares
• Métodos
  • conectar(nome de usuário)
  • desconectar()
  • entrar (canal)
  • sair (canal)
  • enviar(canal, mensagem)
  • addFile(canal, fonte)
  • getArquivo(hash)
  • getDiretório(hash)

Desenvolvimento

Instalar dependências

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

Execute um ambiente de desenvolvimento de exemplo

npm run dev

Executar testes

npm test

Construir biblioteca e distribuíveis

npm run build

Distribuível (ES5 minificado para navegadores) estará localizado em dist/ .

Contribuir

Ficaríamos felizes em aceitar PRs! Se você quiser trabalhar em algo, seria bom conversar com antecedência para ter certeza de que ninguém mais está trabalhando nisso. Você pode entrar em contato conosco no Gitter ou na seção de problemas.

Também temos chamadas comunitárias regulares , que anunciamos nas edições do repositório de boas-vindas @orbitdb. Junte-se a nós!

Se você deseja codificar, mas não sabe por onde começar, verifique os problemas rotulados como "procura-se ajuda".

Para diretrizes específicas sobre como contribuir para este repositório, confira o guia de contribuição. Para saber mais sobre como contribuir para o OrbitDB em geral, dê uma olhada no repositório de boas-vindas @OrbitDB. Observe que todas as interações no @OrbitDB se enquadram em nosso Código de Conduta.

Licença

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