hypercore 10.0.0-alpha.11 → 10.0.0-alpha.15

package/examples/announce.js

@@ -1,19 +0,0 @@
-const Hypercore = require('../')
-const Hyperswarm = require('hyperswarm')
-
-const core = new Hypercore('./source')
-
-start()
-
-async function start () {
-  await core.ready()
-  while (core.length < 1000) {
-    await core.append('block #' + core.length)
-  }
-
-  const swarm = new Hyperswarm()
-  swarm.on('connection', socket => core.replicate(socket))
-  swarm.join(core.discoveryKey, { server: true, client: false })
-
-  console.log('Core:', core.key.toString('hex'))
-}

package/examples/basic.js

@@ -1,10 +0,0 @@
-const Hypercore = require('../')
-
-start()
-
-async function start () {
-  const core = new Hypercore('/tmp/basic')
-  await core.append(['Hello', 'World'])
-  console.log(core)
-  await core.close()
-}

package/examples/http.js

@@ -1,123 +0,0 @@
-const Hypercore = require('../')
-const streamx = require('streamx')
-const replicator = require('@hyperswarm/replicator')
-
-const core = new Hypercore('/tmp/movie')
-
-if (process.argv[2] === 'bench') bench()
-else if (process.argv[2]) importData()
-else start()
-
-class ByteStream extends streamx.Readable {
-  constructor (core, byteOffset, byteLength) {
-    super()
-
-    this.core = core
-    this.byteOffset = byteOffset
-    this.byteLength = byteLength
-    this.index = 0
-    this.range = null
-  }
-
-  async _read (cb) {
-    let data = null
-
-    if (!this.byteLength) {
-      this.push(null)
-      return cb(null)
-    }
-
-    if (this.byteOffset > 0) {
-      const [block, byteOffset] = await core.seek(this.byteOffset)
-      this.byteOffset = 0
-      this.index = block + 1
-      this._select(this.index)
-      data = (await core.get(block)).slice(byteOffset)
-    } else {
-      this._select(this.index + 1)
-      data = await core.get(this.index++)
-    }
-
-    if (data.length >= this.byteLength) {
-      data = data.slice(0, this.byteLength)
-      this.push(data)
-      this.push(null)
-    } else {
-      this.push(data)
-    }
-
-    this.byteLength -= data.length
-
-    cb(null)
-  }
-
-  _select (index) {
-    if (this.range !== null) this.range.destroy(null)
-    this.range = this.core.download({ start: index, end: index + 32, linear: true })
-  }
-
-  _destroy (cb) {
-    if (this.range) this.range.destroy(null)
-    cb(null)
-  }
-}
-
-async function bench () {
-  await core.ready()
-
-  console.time()
-  for (let i = 0; i < core.length; i++) {
-    await core.get(i)
-  }
-  console.timeEnd()
-}
-
-async function start () {
-  const http = require('http')
-  const parse = require('range-parser')
-
-  await core.ready()
-
-  core.on('download', (index) => console.log('Downloaded block #' + index))
-  core.download({ start: 0, end: 1 })
-
-  // hack until we update the replicator
-  core.ready = (cb) => cb(null)
-
-  replicator(core, {
-    discoveryKey: require('crypto').createHash('sha256').update('http').digest(),
-    announce: true,
-    lookup: true
-  })
-
-  http.createServer(function (req, res) {
-    res.setHeader('Content-Type', 'video/x-matroska')
-    res.setHeader('Accept-Ranges', 'bytes')
-
-    let s
-
-    if (req.headers.range) {
-      const range = parse(core.byteLength, req.headers.range)[0]
-      const byteLength = range.end - range.start + 1
-      res.statusCode = 206
-      res.setHeader('Content-Range', 'bytes ' + range.start + '-' + range.end + '/' + core.byteLength)
-      s = new ByteStream(core, range.start, byteLength)
-    } else {
-      s = new ByteStream(core, 0, core.byteLength)
-    }
-
-    res.setHeader('Content-Length', s.byteLength)
-    s.pipe(res, () => {})
-  }).listen(10101)
-}
-
-async function importData () {
-  const fs = require('fs')
-  const rs = fs.createReadStream(process.argv[2])
-
-  for await (const data of rs) {
-    await core.append(data)
-  }
-
-  console.log('done!', core)
-}

package/examples/lookup.js

@@ -1,20 +0,0 @@
-const Hypercore = require('../')
-const Hyperswarm = require('hyperswarm')
-
-const core = new Hypercore('./clone', process.argv[2])
-
-start()
-
-async function start () {
-  await core.ready()
-
-  const swarm = new Hyperswarm()
-  swarm.on('connection', socket => core.replicate(socket))
-  swarm.join(core.discoveryKey, { server: false, client: true })
-
-  console.log((await core.get(42)).toString())
-  console.log((await core.get(142)).toString())
-  console.log((await core.get(511)).toString())
-  console.log((await core.get(512)).toString())
-  console.log((await core.get(513)).toString())
-}

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))
-  }
-})

package/test/core.js

@@ -1,290 +0,0 @@
-const test = require('brittle')
-const RAM = require('random-access-memory')
-const Core = require('../lib/core')
-
-test('core - append', async function (t) {
-  const { core } = await create()
-
-  {
-    const seq = await core.append([
-      Buffer.from('hello'),
-      Buffer.from('world')
-    ])
-
-    t.is(seq, 0)
-    t.is(core.tree.length, 2)
-    t.is(core.tree.byteLength, 10)
-    t.alike([
-      await core.blocks.get(0),
-      await core.blocks.get(1)
-    ], [
-      Buffer.from('hello'),
-      Buffer.from('world')
-    ])
-  }
-
-  {
-    const seq = await core.append([
-      Buffer.from('hej')
-    ])
-
-    t.is(seq, 2)
-    t.is(core.tree.length, 3)
-    t.is(core.tree.byteLength, 13)
-    t.alike([
-      await core.blocks.get(0),
-      await core.blocks.get(1),
-      await core.blocks.get(2)
-    ], [
-      Buffer.from('hello'),
-      Buffer.from('world'),
-      Buffer.from('hej')
-    ])
-  }
-})
-
-test('core - append and truncate', async function (t) {
-  const { core, reopen } = await create()
-
-  await core.append([
-    Buffer.from('hello'),
-    Buffer.from('world'),
-    Buffer.from('fo'),
-    Buffer.from('ooo')
-  ])
-
-  await core.truncate(3, 1)
-
-  t.is(core.tree.length, 3)
-  t.is(core.tree.byteLength, 12)
-  t.is(core.tree.fork, 1)
-  t.alike(core.header.hints.reorgs, [{ from: 0, to: 1, ancestors: 3 }])
-
-  await core.append([
-    Buffer.from('a'),
-    Buffer.from('b'),
-    Buffer.from('c'),
-    Buffer.from('d')
-  ])
-
-  await core.truncate(3, 2)
-
-  t.is(core.tree.length, 3)
-  t.is(core.tree.byteLength, 12)
-  t.is(core.tree.fork, 2)
-  t.alike(core.header.hints.reorgs, [{ from: 0, to: 1, ancestors: 3 }, { from: 1, to: 2, ancestors: 3 }])
-
-  await core.truncate(2, 3)
-
-  t.alike(core.header.hints.reorgs, [{ from: 2, to: 3, ancestors: 2 }])
-
-  await core.append([Buffer.from('a')])
-  await core.truncate(2, 4)
-
-  await core.append([Buffer.from('a')])
-  await core.truncate(2, 5)
-
-  await core.append([Buffer.from('a')])
-  await core.truncate(2, 6)
-
-  await core.append([Buffer.from('a')])
-  await core.truncate(2, 7)
-
-  t.is(core.header.hints.reorgs.length, 4)
-
-  // check that it was persisted
-  const coreReopen = await reopen()
-
-  t.is(coreReopen.tree.length, 2)
-  t.is(coreReopen.tree.byteLength, 10)
-  t.is(coreReopen.tree.fork, 7)
-  t.is(coreReopen.header.hints.reorgs.length, 4)
-})
-
-test('core - user data', async function (t) {
-  const { core, reopen } = await create()
-
-  await core.userData('hello', Buffer.from('world'))
-  t.alike(core.header.userData, [{ key: 'hello', value: Buffer.from('world') }])
-
-  await core.userData('hej', Buffer.from('verden'))
-  t.alike(core.header.userData, [
-    { key: 'hello', value: Buffer.from('world') },
-    { key: 'hej', value: Buffer.from('verden') }
-  ])
-
-  await core.userData('hello', null)
-  t.alike(core.header.userData, [{ key: 'hej', value: Buffer.from('verden') }])
-
-  await core.userData('hej', Buffer.from('world'))
-  t.alike(core.header.userData, [{ key: 'hej', value: Buffer.from('world') }])
-
-  // check that it was persisted
-  const coreReopen = await reopen()
-
-  t.alike(coreReopen.header.userData, [{ key: 'hej', value: Buffer.from('world') }])
-})
-
-test('core - verify', async function (t) {
-  const { core } = await create()
-  const { core: clone } = await create({ keyPair: { publicKey: core.header.signer.publicKey } })
-
-  t.is(clone.header.signer.publicKey, core.header.signer.publicKey)
-
-  await core.append([Buffer.from('a'), Buffer.from('b')])
-
-  {
-    const p = await core.tree.proof({ upgrade: { start: 0, length: 2 } })
-    await clone.verify(p)
-  }
-
-  t.is(clone.header.tree.length, 2)
-  t.is(clone.header.tree.signature, core.header.tree.signature)
-
-  {
-    const p = await core.tree.proof({ block: { index: 1, nodes: await clone.tree.nodes(2), value: true } })
-    p.block.value = await core.blocks.get(1)
-    await clone.verify(p)
-  }
-})
-
-test('core - verify parallel upgrades', async function (t) {
-  const { core } = await create()
-  const { core: clone } = await create({ keyPair: { publicKey: core.header.signer.publicKey } })
-
-  t.is(clone.header.signer.publicKey, core.header.signer.publicKey)
-
-  await core.append([Buffer.from('a'), Buffer.from('b'), Buffer.from('c'), Buffer.from('d')])
-
-  {
-    const p1 = await core.tree.proof({ upgrade: { start: 0, length: 2 } })
-    const p2 = await core.tree.proof({ upgrade: { start: 0, length: 3 } })
-
-    const v1 = clone.verify(p1)
-    const v2 = clone.verify(p2)
-
-    await v1
-    await v2
-  }
-
-  t.is(clone.header.tree.length, core.header.tree.length)
-  t.is(clone.header.tree.signature, core.header.tree.signature)
-})
-
-test('core - update hook is triggered', async function (t) {
-  const { core } = await create()
-  const { core: clone } = await create({ keyPair: { publicKey: core.header.signer.publicKey } })
-
-  let ran = 0
-
-  core.onupdate = (status, bitfield, value, from) => {
-    t.is(status, 0b01, 'was appended')
-    t.is(from, null, 'was local')
-    t.alike(bitfield, { drop: false, start: 0, length: 4 })
-    ran |= 1
-  }
-
-  await core.append([Buffer.from('a'), Buffer.from('b'), Buffer.from('c'), Buffer.from('d')])
-
-  const peer = {}
-
-  clone.onupdate = (status, bitfield, value, from) => {
-    t.is(status, 0b01, 'was appended')
-    t.is(from, peer, 'was remote')
-    t.alike(bitfield, { drop: false, start: 1, length: 1 })
-    t.alike(value, Buffer.from('b'))
-    ran |= 2
-  }
-
-  {
-    const p = await core.tree.proof({ block: { index: 1, nodes: 0, value: true }, upgrade: { start: 0, length: 2 } })
-    p.block.value = await core.blocks.get(1)
-    await clone.verify(p, peer)
-  }
-
-  clone.onupdate = (status, bitfield, value, from) => {
-    t.is(status, 0b00, 'no append or truncate')
-    t.is(from, peer, 'was remote')
-    t.alike(bitfield, { drop: false, start: 3, length: 1 })
-    t.alike(value, Buffer.from('d'))
-    ran |= 4
-  }
-
-  {
-    const p = await core.tree.proof({ block: { index: 3, nodes: await clone.tree.nodes(6), value: true } })
-    p.block.value = await core.blocks.get(3)
-    await clone.verify(p, peer)
-  }
-
-  core.onupdate = (status, bitfield, value, from) => {
-    t.is(status, 0b10, 'was truncated')
-    t.is(from, null, 'was local')
-    t.alike(bitfield, { drop: true, start: 1, length: 3 })
-    ran |= 8
-  }
-
-  await core.truncate(1, 1)
-
-  core.onupdate = (status, bitfield, value, from) => {
-    t.is(status, 0b01, 'was appended')
-    t.is(from, null, 'was local')
-    t.alike(bitfield, { drop: false, start: 1, length: 1 })
-    ran |= 16
-  }
-
-  await core.append([Buffer.from('e')])
-
-  clone.onupdate = (status, bitfield, value, from) => {
-    t.is(status, 0b11, 'was appended and truncated')
-    t.is(from, peer, 'was remote')
-    t.alike(bitfield, { drop: true, start: 1, length: 3 })
-    ran |= 32
-  }
-
-  {
-    const p = await core.tree.proof({ block: { index: 0, nodes: 0, value: false }, upgrade: { start: 0, length: 2 } })
-    const r = await clone.tree.reorg(p)
-
-    await clone.reorg(r, peer)
-  }
-
-  core.onupdate = (status, bitfield, value, from) => {
-    t.is(status, 0b10, 'was truncated')
-    t.is(from, null, 'was local')
-    t.alike(bitfield, { drop: true, start: 1, length: 1 })
-    ran |= 64
-  }
-
-  await core.truncate(1, 2)
-
-  clone.onupdate = (status, bitfield, value, from) => {
-    t.is(status, 0b10, 'was truncated')
-    t.is(from, peer, 'was remote')
-    t.alike(bitfield, { drop: true, start: 1, length: 1 })
-    ran |= 128
-  }
-
-  {
-    const p = await core.tree.proof({ block: { index: 0, nodes: 0, value: false }, upgrade: { start: 0, length: 1 } })
-    const r = await clone.tree.reorg(p)
-
-    await clone.reorg(r, peer)
-  }
-
-  t.is(ran, 255, 'ran all')
-})
-
-async function create (opts) {
-  const storage = new Map()
-
-  const createFile = (name) => {
-    if (storage.has(name)) return storage.get(name)
-    const s = new RAM()
-    storage.set(name, s)
-    return s
-  }
-
-  const reopen = () => Core.open(createFile, opts)
-  const core = await reopen()
-  return { core, reopen }
-}

package/test/encodings.js

@@ -1,18 +0,0 @@
-const test = require('brittle')
-const { create } = require('./helpers')
-
-test('encodings - supports built ins', async function (t) {
-  const a = await create(null, { valueEncoding: 'json' })
-
-  await a.append({ hello: 'world' })
-  t.alike(await a.get(0), { hello: 'world' })
-  t.alike(await a.get(0, { valueEncoding: 'utf-8' }), '{"hello":"world"}')
-})
-
-test('encodings - supports custom encoding', async function (t) {
-  const a = await create(null, { valueEncoding: { encode () { return Buffer.from('foo') }, decode () { return 'bar' } } })
-
-  await a.append({ hello: 'world' })
-  t.is(await a.get(0), 'bar')
-  t.alike(await a.get(0, { valueEncoding: 'utf-8' }), 'foo')
-})