hypercore 10.0.0-alpha.9 → 10.0.0

package/lib/protocol.js

@@ -1,524 +0,0 @@
-const { uint, from: fromEncoding } = require('compact-encoding')
-const safetyCatch = require('safety-catch')
-const codecs = require('codecs')
-
-const messages = require('./messages')
-
-class Extension {
-  constructor (protocol, type, name, handlers) {
-    this.protocol = protocol
-    this.name = name
-    this.type = type
-    this.peers = new Set()
-    this.aliased = !!handlers.aliased
-    this.remoteSupports = false
-    this.destroyed = false
-
-    this.onerror = handlers.onerror || noop
-    this.onclose = handlers.onclose || noop
-    this.onmessage = handlers.onmessage || noop
-    this.onremotesupports = handlers.onremotesupports || noop
-
-    this.encoding = fromEncoding(codecs(handlers.encoding || 'binary'))
-    this.announce()
-  }
-
-  announce () {
-    if (this.destroyed) return
-
-    this.protocol.send(1, messages.extension, -1, { alias: this.type, name: this.name })
-  }
-
-  send (message) {
-    if (this.destroyed) return
-
-    return this._sendAlias(message, -1)
-  }
-
-  _sendAlias (message, alias) {
-    if (this.destroyed) return
-
-    if (this._remoteAliases) {
-      return this.protocol.send(this.type, this.encoding, alias, message)
-    }
-
-    this.protocol.cork()
-    this.announce()
-    this.protocol.send(this.type, this.encoding, alias, message)
-    this.protocol.uncork()
-
-    return false
-  }
-
-  _onremotesupports () {
-    if (this.destroyed) return
-
-    this.remoteSupports = true
-    this.onremotesupports(this)
-    for (const peer of this.peers) {
-      peer.onremotesupports(peer)
-    }
-  }
-
-  _onmessage (state) {
-    if (this.destroyed) return
-
-    if (!this.aliased) {
-      this.onmessage(this.encoding.decode(state))
-      return
-    }
-
-    const alias = uint.decode(state)
-    const m = this.encoding.decode(state)
-
-    for (const peer of this.peers) {
-      if (peer.alias === alias) {
-        peer.onmessage(m, peer.peer)
-      }
-    }
-  }
-
-  destroy () {
-    if (this.destroyed) return
-    this.destroyed = true
-    this.protocol.unregisterExtension(this.name)
-    this.onclose()
-  }
-}
-
-class CoreExtension {
-  constructor (ext, peer, name, handlers) {
-    this.extension = ext
-    this.peer = peer
-    this.name = name
-    this.alias = peer.alias
-    this.onmessage = handlers.onmessage || noop
-    this.onremotesupports = handlers.onremotesupports || noop
-  }
-
-  get remoteSupports () {
-    return this.extension.remoteSupports
-  }
-
-  announce () {
-    this.extension.announce()
-  }
-
-  send (message) {
-    return this.extension._sendAlias(message, this.peer.alias)
-  }
-
-  destroy () {
-    this.peer.extensions.delete(this.name)
-    this.extension.peers.delete(this)
-  }
-}
-
-class Peer {
-  constructor (protocol, alias, key, discoveryKey, handlers, state) {
-    this.protocol = protocol
-    this.handlers = handlers
-    this.key = key
-    this.discoveryKey = discoveryKey
-    this.alias = alias
-    this.remoteAlias = -1
-    this.resend = false
-    this.state = state
-    this.extensions = new Map()
-    this.destroyed = false
-
-    this._destroyer = this._safeDestroy.bind(this)
-  }
-
-  onmessage (type, state) {
-    const handlers = this.handlers
-
-    switch (type) {
-      case 4: {
-        this._catch(handlers.oninfo(messages.info.decode(state), this))
-        break
-      }
-
-      case 5: {
-        // options
-        break
-      }
-
-      case 6: {
-        // want
-        break
-      }
-
-      case 7: {
-        this._catch(handlers.onhave(messages.have.decode(state), this))
-        break
-      }
-
-      case 8: {
-        this._catch(handlers.onbitfield(messages.bitfield.decode(state), this))
-        break
-      }
-
-      case 9: {
-        this._catch(handlers.onrequest(messages.request.decode(state), this))
-        break
-      }
-
-      case 10: {
-        this._catch(handlers.ondata(messages.data.decode(state), this))
-        break
-      }
-    }
-
-    state.start = state.end
-  }
-
-  _catch (p) {
-    if (isPromise(p)) p.then(noop, this._destroyer)
-  }
-
-  registerExtension (name, handlers) {
-    if (this.extensions.has(name)) return this.extensions.get(name)
-    const ext = this.protocol.registerExtension(name, { aliased: true, encoding: handlers.encoding })
-    const coreExt = new CoreExtension(ext, this, name, handlers)
-    ext.peers.add(coreExt)
-    this.extensions.set(name, coreExt)
-    return coreExt
-  }
-
-  cork () {
-    this.protocol.cork()
-  }
-
-  uncork () {
-    this.protocol.uncork()
-  }
-
-  info (message) {
-    return this.protocol.send(4, messages.info, this.alias, message)
-  }
-
-  options (message) {
-    // TODO
-    // this._send(5, messages.info, this.alias, message)
-  }
-
-  want (message) {
-    // TODO
-    // this._send(6, messages.info, this.alias, message)
-  }
-
-  have (message) {
-    return this.protocol.send(7, messages.have, this.alias, message)
-  }
-
-  bitfield (message) {
-    return this.protocol.send(8, messages.bitfield, this.alias, message)
-  }
-
-  request (message) {
-    return this.protocol.send(9, messages.request, this.alias, message)
-  }
-
-  data (message) {
-    return this.protocol.send(10, messages.data, this.alias, message)
-  }
-
-  _safeDestroy (err) {
-    safetyCatch(err)
-    return this.destroy(err)
-  }
-
-  destroy (err) {
-    this.destroyed = true
-    return this.protocol.unregisterPeer(this, err)
-  }
-}
-
-module.exports = class Protocol {
-  constructor (noiseStream, handlers = {}) {
-    this.noiseStream = noiseStream
-
-    this.protocolVersion = handlers.protocolVersion || 0
-    this.userAgent = handlers.userAgent || ''
-    this.remoteUserAgent = ''
-    this.handlers = handlers
-
-    this._firstMessage = true
-    this._corks = 1
-    this._batch = []
-
-    this._localAliases = 0
-    this._remoteAliases = []
-    this._peers = new Map()
-
-    this._localExtensions = 128
-    this._remoteExtensions = []
-    this._extensions = new Map()
-
-    this._destroyer = this._safeDestroy.bind(this)
-    this.noiseStream.on('data', this.onmessage.bind(this))
-    this.noiseStream.on('end', this.noiseStream.end) // no half open
-    this.noiseStream.on('close', () => {
-      // TODO: If the stream was destroyed with an error, we probably want to forward it here
-      for (const peer of this._peers.values()) {
-        peer.destroy(null)
-      }
-    })
-
-    this._sendHandshake()
-  }
-
-  _sendHandshake () {
-    const m = { protocolVersion: this.protocolVersion, userAgent: this.userAgent }
-    const state = { start: 0, end: 0, buffer: null }
-
-    messages.handshake.preencode(state, m)
-    state.buffer = this.noiseStream.alloc(state.end)
-    messages.handshake.encode(state, m)
-    this.noiseStream.write(state.buffer)
-  }
-
-  isRegistered (discoveryKey) {
-    return this._peers.has(discoveryKey.toString('hex'))
-  }
-
-  registerPeer (key, discoveryKey, handlers = {}, state = null) {
-    const peer = new Peer(this, this._localAliases++, key, discoveryKey, handlers, state)
-    this._peers.set(discoveryKey.toString('hex'), peer)
-    this._announceCore(peer.alias, key, discoveryKey)
-    return peer
-  }
-
-  unregisterPeer (peer, err) {
-    this._peers.delete(peer.discoveryKey.toString('hex'))
-
-    if (peer.remoteAlias > -1) {
-      this._remoteAliases[peer.remoteAlias] = null
-      peer.remoteAlias = -1
-    }
-
-    peer.handlers.onunregister(peer, err)
-
-    if (err) this.noiseStream.destroy(err)
-  }
-
-  registerExtension (name, handlers) {
-    let ext = this._extensions.get(name)
-    if (ext) return ext
-    ext = new Extension(this, this._localExtensions++, name, handlers)
-    this._extensions.set(name, ext)
-    return ext
-  }
-
-  unregisterExtension (name) {
-    const ext = this._extensions.get(name)
-    if (!ext) return
-    if (!ext.destroyed) return ext.destroy()
-    this._extensions.delete(name)
-    this._remoteExtensions[ext.type - 128] = null
-  }
-
-  cork () {
-    if (++this._corks === 1) this._batch = []
-  }
-
-  uncork () {
-    if (--this._corks > 0) return
-
-    const batch = this._batch
-    this._batch = null
-
-    if (batch.length === 0) return
-
-    const state = { start: 0, end: 0, buffer: null }
-    const lens = new Array(batch.length)
-
-    uint.preencode(state, 0)
-    for (let i = 0; i < batch.length; i++) {
-      const [type, enc, dk, message] = batch[i]
-      const start = state.end
-      uint.preencode(state, type)
-      if (dk > -1) uint.preencode(state, dk)
-      enc.preencode(state, message)
-      uint.preencode(state, (lens[i] = state.end - start))
-    }
-
-    state.buffer = this.noiseStream.alloc(state.end)
-
-    uint.encode(state, 0)
-    for (let i = 0; i < batch.length; i++) {
-      const [type, enc, dk, message] = batch[i]
-      uint.encode(state, lens[i])
-      uint.encode(state, type)
-      if (dk > -1) uint.encode(state, dk)
-      enc.encode(state, message)
-    }
-
-    this.noiseStream.write(state.buffer)
-  }
-
-  onmessage (message) {
-    try {
-      this._decode(message)
-    } catch (err) {
-      this._safeDestroy(err)
-    }
-  }
-
-  _catch (p) {
-    if (isPromise(p)) p.then(noop, this._destroyer)
-  }
-
-  _announceCore (alias, key, discoveryKey) {
-    this.send(2, messages.core, -1, {
-      alias: alias,
-      discoveryKey: discoveryKey,
-      capability: Buffer.alloc(32) // TODO
-    })
-  }
-
-  _decode (buffer) {
-    const state = { start: 0, end: buffer.length, buffer }
-
-    if (this._firstMessage === true) {
-      this._firstMessage = false
-      const { userAgent } = messages.handshake.decode(state)
-      this.remoteUserAgent = userAgent
-      this.uncork()
-      return
-    }
-
-    const type = uint.decode(state)
-
-    if (type === 0) { // batch
-      while (state.start < state.end) {
-        const len = uint.decode(state)
-        state.end = state.start + len
-        const type = uint.decode(state)
-        this._decodeMessage(type, state)
-        state.end = buffer.length
-      }
-    } else {
-      this._decodeMessage(type, state)
-    }
-  }
-
-  _decodeMessage (type, state) {
-    switch (type) {
-      case 1: return this._onextension(messages.extension.decode(state))
-      case 2: return this._oncore(messages.core.decode(state))
-      case 3: return this._onunknowncore(messages.unknownCore.decode(state))
-    }
-
-    if (type < 11) {
-      const remoteAlias = uint.decode(state)
-      const peer = this._remoteAliases[remoteAlias]
-      if (peer) peer.onmessage(type, state)
-    } else if (type >= 128) {
-      const ext = this._remoteExtensions[type - 128]
-      if (ext) ext._onmessage(state)
-    }
-
-    state.start = state.end
-  }
-
-  _onextension (m) {
-    const type = m.alias - 128
-    const ext = this._extensions.get(m.name)
-
-    if (type === this._remoteExtensions.length) {
-      this._remoteExtensions.push(null)
-    }
-
-    if (!ext) return
-
-    if (type < 0 || type >= this._remoteExtensions.length) {
-      this.destroy(new Error('Remote alias out of bounds'))
-      return
-    }
-
-    this._remoteExtensions[type] = ext
-    if (!ext.remoteSupports) ext._onremotesupports()
-  }
-
-  _oncore (m) {
-    const hex = m.discoveryKey.toString('hex')
-    const peer = this._peers.get(hex)
-
-    // allow one alloc
-    // TODO: if the remote allocs too many "holes", move to slower sparse firendly
-    // data structures such as a Map
-    if (m.alias === this._remoteAliases.length) this._remoteAliases.push(null)
-
-    if (peer) {
-      // TODO: check cap
-
-      if (m.alias >= this._remoteAliases.length) {
-        this.destroy(new Error('Remote alias out of bounds'))
-        return
-      }
-
-      this._remoteAliases[m.alias] = peer
-      peer.remoteAlias = m.alias
-      if (peer.resend) this._announceCore(peer.alias, peer.key, peer.discoveryKey)
-      this._catch(peer.handlers.oncore(m, peer))
-      return
-    }
-
-    const self = this
-    const p = this.handlers.ondiscoverykey ? this.handlers.ondiscoverykey(m.discoveryKey) : undefined
-
-    if (isPromise(p)) p.then(next, next)
-    else next()
-
-    function next () {
-      if (self._peers.has(hex)) return self._oncore(m)
-      self.send(3, messages.unknownCore, -1, { discoveryKey: m.discoveryKey })
-    }
-  }
-
-  _onunknowncore (m) {
-    const peer = this._peers.get(m.discoveryKey.toString('hex'))
-    if (!peer) return
-
-    peer.resend = true
-    this._catch(peer.handlers.onunknowncore(m, peer))
-  }
-
-  send (type, enc, dk, message) {
-    if (this._corks > 0) {
-      this._batch.push([type, enc, dk, message])
-      return false
-    }
-
-    const state = { start: 0, end: 0, buffer: null }
-
-    uint.preencode(state, type)
-    if (dk > -1) uint.preencode(state, dk)
-    enc.preencode(state, message)
-
-    state.buffer = this.noiseStream.alloc(state.end)
-
-    uint.encode(state, type)
-    if (dk > -1) uint.encode(state, dk)
-    enc.encode(state, message)
-
-    return this.noiseStream.write(state.buffer)
-  }
-
-  destroy (err) {
-    return this.noiseStream.destroy(err)
-  }
-
-  _safeDestroy (err) {
-    safetyCatch(err) // check if this was an accidental catch
-    this.destroy(err)
-  }
-}
-
-function noop () {}
-
-function isPromise (p) {
-  return !!p && typeof p.then === 'function'
-}

package/lib/random-iterator.js

@@ -1,46 +0,0 @@
-module.exports = class RandomIterator {
-  constructor (values) {
-    this._values = values
-    this._next = { value: null, done: false }
-    this._start = 0
-    this._end = values.length
-  }
-
-  next () {
-    if (this._start < this._values.length) {
-      if (this._start === this._end) this._end = this._values.length
-
-      const r = this._start + (Math.random() * (this._end - this._start)) | 0
-      const tmp = this._values[r]
-
-      this._values[r] = this._values[this._start]
-      this._next.value = this._values[this._start++] = tmp
-    } else {
-      this._next.done = true
-    }
-
-    return this._next
-  }
-
-  reset () {
-    this._start = 0
-    this._end = this._values.length
-    this._next.done = false
-    return this
-  }
-
-  requeue () {
-    if (this._start === this._end) {
-      this._start--
-    } else {
-      const top = this._values[--this._end]
-
-      this._values[this._end] = this._values[--this._start]
-      this._values[this._start] = top
-    }
-  }
-
-  [Symbol.iterator] () {
-    return this
-  }
-}

package/test/basic.js

@@ -1,90 +0,0 @@
-const test = require('brittle')
-const ram = require('random-access-memory')
-
-const Hypercore = require('../')
-const { create } = require('./helpers')
-
-test('basic', async function (t) {
-  const core = await create()
-  let appends = 0
-
-  t.is(core.length, 0)
-  t.is(core.byteLength, 0)
-  t.is(core.writable, true)
-  t.is(core.readable, true)
-
-  core.on('append', function () {
-    appends++
-  })
-
-  await core.append('hello')
-  await core.append('world')
-
-  t.is(core.length, 2)
-  t.is(core.byteLength, 10)
-  t.is(appends, 2)
-
-  t.end()
-})
-
-test('session', async function (t) {
-  const core = await create()
-
-  const session = core.session()
-
-  await session.append('test')
-  t.alike(await core.get(0), Buffer.from('test'))
-  t.alike(await session.get(0), Buffer.from('test'))
-  t.end()
-})
-
-test('close', async function (t) {
-  const core = await create()
-  await core.append('hello world')
-
-  await core.close()
-
-  try {
-    await core.get(0)
-    t.fail('core should be closed')
-  } catch {
-    t.pass('get threw correctly when core was closed')
-  }
-})
-
-test('close multiple', async function (t) {
-  const core = await create()
-  await core.append('hello world')
-
-  const ev = t.test('events')
-
-  ev.plan(4)
-
-  let i = 0
-
-  core.on('close', () => ev.is(i++, 0, 'on close'))
-  core.close().then(() => ev.is(i++, 1, 'first close'))
-  core.close().then(() => ev.is(i++, 2, 'second close'))
-  core.close().then(() => ev.is(i++, 3, 'third close'))
-
-  await ev
-})
-
-test('storage options', async function (t) {
-  const core = new Hypercore({ storage: ram })
-  await core.append('hello')
-  t.alike(await core.get(0), Buffer.from('hello'))
-  t.end()
-})
-
-test(
-  'allow publicKeys with different byteLength that 32, if opts.crypto were passed',
-  function (t) {
-    const key = Buffer.alloc(33).fill('a')
-
-    const core = new Hypercore(ram, key, { crypto: {} })
-
-    t.is(core.key, key)
-    t.pass('creating a core with more than 32 byteLength key did not throw')
-  }
-)

package/test/bitfield.js

@@ -1,71 +0,0 @@
-const test = require('brittle')
-const ram = require('random-access-memory')
-const Bitfield = require('../lib/bitfield')
-
-test('bitfield - set and get', async function (t) {
-  const b = await Bitfield.open(ram())
-
-  t.absent(b.get(42))
-  b.set(42, true)
-  t.ok(b.get(42))
-
-  // bigger offsets
-  t.absent(b.get(42000000))
-  b.set(42000000, true)
-  t.ok(b.get(42000000))
-
-  b.set(42000000, false)
-  t.absent(b.get(42000000))
-
-  await b.flush()
-})
-
-test('bitfield - random set and gets', async function (t) {
-  const b = await Bitfield.open(ram())
-  const set = new Set()
-
-  for (let i = 0; i < 200; i++) {
-    const idx = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER)
-    b.set(idx, true)
-    set.add(idx)
-  }
-
-  for (let i = 0; i < 500; i++) {
-    const idx = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER)
-    const expected = set.has(idx)
-    const val = b.get(idx)
-    if (val !== expected) {
-      t.fail('expected ' + expected + ' but got ' + val + ' at ' + idx)
-      return
-    }
-  }
-
-  for (const idx of set) {
-    const val = b.get(idx)
-    if (val !== true) {
-      t.fail('expected true but got ' + val + ' at ' + idx)
-      return
-    }
-  }
-
-  t.pass('all random set and gets pass')
-})
-
-test('bitfield - reload', async function (t) {
-  const s = ram()
-
-  {
-    const b = await Bitfield.open(s)
-    b.set(142, true)
-    b.set(40000, true)
-    b.set(1424242424, true)
-    await b.flush()
-  }
-
-  {
-    const b = await Bitfield.open(s)
-    t.ok(b.get(142))
-    t.ok(b.get(40000))
-    t.ok(b.get(1424242424))
-  }
-})