orbit core

ядро орбиты

Протокол связи на IPFS

Orbit — это бессерверная распределенная библиотека и протокол связи p2p, который обеспечивает обмен информацией на основе каналов, например чат в реальном времени, в одноранговой сети IPFS.

Этот репозиторий является основной библиотекой Orbit. Эта библиотека предназначена для использования в ваших приложениях Node.js или браузере.

Используется в различных проектах Orbit:

• orbit-web — браузерное приложение Orbit
• орбита-электрон - настольное приложение Orbit
• orbit-textui — клиент терминала Orbit

Оглавление

• Установить
• Использование
• API
• Разработка
  • Установить зависимости
  • Запуск тестов
  • Сборка библиотеки и дистрибутивов
• Лицензия

Установить

Этот модуль использует npm и node.

npm install orbit_

Использование

Более подробный пример см. в разделе example/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.

• Начиная
• Конструктор
• Характеристики
  • пользователь
  • сеть
  • каналы
  • сверстники
• Методы
  • подключиться (имя пользователя)
  • отключить()
  • присоединиться (канал)
  • покинуть (канал)
  • отправить(канал, сообщение)
  • addFile(канал, источник)
  • получить файл (хеш)
  • 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