hypercore 10.0.0-alpha.7 → 10.0.0

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

package/test/encryption.js

@@ -1,85 +0,0 @@
-const test = require('brittle')
-const { create, replicate } = require('./helpers')
-
-const encryptionKey = Buffer.alloc(32, 'hello world')
-
-test('encrypted append and get', async function (t) {
-  const a = await create({ encryptionKey })
-
-  t.alike(a.encryptionKey, encryptionKey)
-
-  await a.append(['hello'])
-
-  t.is(a.byteLength, 5)
-  t.is(a.core.tree.byteLength, 5 + a.padding)
-
-  const unencrypted = await a.get(0)
-  const encrypted = await a.core.blocks.get(0)
-
-  t.alike(unencrypted, Buffer.from('hello'))
-  t.unlike(unencrypted, encrypted)
-})
-
-test('encrypted seek', async function (t) {
-  const a = await create({ encryptionKey })
-
-  await a.append(['hello', 'world', '!'])
-
-  t.alike(await a.seek(0), [0, 0])
-  t.alike(await a.seek(4), [0, 4])
-  t.alike(await a.seek(5), [1, 0])
-  t.alike(await a.seek(6), [1, 1])
-  t.alike(await a.seek(6), [1, 1])
-  t.alike(await a.seek(9), [1, 4])
-  t.alike(await a.seek(10), [2, 0])
-  t.alike(await a.seek(11), [3, 0])
-})
-
-test('encrypted replication', async function (t) {
-  const a = await create({ encryptionKey })
-
-  await a.append(['a', 'b', 'c', 'd', 'e'])
-
-  t.test('with encryption key', async function (t) {
-    t.plan(10)
-
-    const b = await create(a.key, { encryptionKey })
-
-    b.on('download', (i, block) => {
-      t.alike(block, Buffer.from([i + /* a */ 0x61]))
-    })
-
-    replicate(a, b, t)
-
-    const r = b.download({ start: 0, end: a.length })
-    await r.downloaded()
-
-    for (let i = 0; i < 5; i++) {
-      t.alike(await b.get(i), await a.get(i))
-    }
-  })
-
-  t.test('without encryption key', async function (t) {
-    const b = await create(a.key)
-
-    replicate(a, b, t)
-
-    const r = b.download({ start: 0, end: a.length })
-    await r.downloaded()
-
-    for (let i = 0; i < 5; i++) {
-      t.unlike(await b.get(i), await a.get(i))
-      t.alike(await b.get(i), await a.core.blocks.get(i))
-    }
-  })
-})
-
-test('encrypted sessions', async function (t) {
-  const a = await create({ encryptionKey })
-
-  await a.append(['hello'])
-
-  const session = a.session()
-
-  t.alike(await session.get(0), Buffer.from('hello'))
-})

package/test/extension.js

@@ -1,71 +0,0 @@
-const test = require('brittle')
-const { create, replicate, eventFlush } = require('./helpers')
-
-test('basic extension', async function (t) {
-  const messages = ['world', 'hello']
-
-  const a = await create()
-  a.registerExtension('test-extension', {
-    encoding: 'utf-8',
-    onmessage: (message, peer) => {
-      t.ok(peer === a.peers[0])
-      t.is(message, messages.pop())
-    }
-  })
-
-  const b = await create(a.key)
-  const bExt = b.registerExtension('test-extension', {
-    encoding: 'utf-8'
-  })
-
-  replicate(a, b, t)
-
-  await eventFlush()
-  t.is(b.peers.length, 1)
-
-  bExt.send('hello', b.peers[0])
-  bExt.send('world', b.peers[0])
-
-  await eventFlush()
-  t.absent(messages.length)
-
-  t.end()
-})
-
-test('two extensions', async function (t) {
-  const messages = ['world', 'hello']
-
-  const a = await create()
-  const b = await create(a.key)
-
-  replicate(a, b, t)
-
-  b.registerExtension('test-extension-1', {
-    encoding: 'utf-8'
-  })
-  const bExt2 = b.registerExtension('test-extension-2', {
-    encoding: 'utf-8'
-  })
-
-  await eventFlush()
-  t.is(b.peers.length, 1)
-
-  bExt2.send('world', b.peers[0])
-
-  await eventFlush()
-
-  a.registerExtension('test-extension-2', {
-    encoding: 'utf-8',
-    onmessage: (message, peer) => {
-      t.ok(peer === a.peers[0])
-      t.is(message, messages.pop())
-    }
-  })
-
-  bExt2.send('hello', b.peers[0])
-
-  await eventFlush()
-  t.is(messages.length, 1) // First message gets ignored
-
-  t.end()
-})

package/test/helpers/index.js

@@ -1,23 +0,0 @@
-const Hypercore = require('../../')
-const ram = require('random-access-memory')
-
-module.exports = {
-  async create (...args) {
-    const core = new Hypercore(ram, ...args)
-    await core.ready()
-    return core
-  },
-
-  replicate (a, b, t) {
-    const s1 = a.replicate(true)
-    const s2 = b.replicate(false)
-    s1.on('error', err => t.comment(`STREAM ERROR: ${err}`))
-    s2.on('error', err => t.comment(`STREAM ERROR: ${err}`))
-    s1.pipe(s2).pipe(s1)
-    return [s1, s2]
-  },
-
-  async eventFlush () {
-    await new Promise(resolve => setImmediate(resolve))
-  }
-}