hypercore-multi-key's Introduction

hypercore-multi-key

Function that takes a hypercore and returns a new one that is signed by a new key pair but backed by the same data.

npm install hypercore-multi-key

Useful if you want to do one-off sharing of a hypercore

Usage

const multiKey = require('hypercore-multi-key')

// returns a new feed that is identical as the one passed
// but signed by a new key pair
const newFeed = multiKey(feed)

feed.append('hello')
newFeed.get(0, console.log) // returns 'hello'

API

`newFeed = multiKey(feed, [keyPair], [options])`

Create a new hypercore that is backed by the same data as another one but signed by a new key pair.

You can replicate this new one to other people just like you would any other hypercore.

If you want to use a specific new key pair pass it in as the 2nd arguments. Otherwise a random one is generated.

All options are passed to the hypercore constructor.

License

MIT

hypercore-multi-key's People

Contributors

Stargazers

Watchers

hypercore-multi-key's Issues

"tail" option doesn't work with multi-key

Example:

Without the multiKey, this doesn't log anything as expected.

const keys = keyPair()

const x = hypercore(ram, keys.publicKey, { secretKey: keys.secretKey })

const y = hypercore(ram, x.key)

const replicate = (x, y) => {
  const a = x.replicate({ live: true })
  const b = y.replicate({ live: true })
  a.pipe(b).pipe(a)
}

replicate(x, y)

x.append(['hello', 'world'], er => {
  if (er) {
    throw er
  }
  y.createReadStream({ live: true, tail: true }).on('data', console.log)
})

tail option doesn't seem to have any effect when multiKey is used:

const x = hypercore(ram)
const xm = multiKey(x)

const y = hypercore(ram, xm.key)

const replicate = (x, y) => {
  const a = x.replicate({ live: true })
  const b = y.replicate({ live: true })
  a.pipe(b).pipe(a)
}

replicate(xm, y)

x.append(['hello', 'world'], er => {
  if (er) {
    throw er
  }
  y.createReadStream({ live: true, tail: true }).on('data', console.log)
})

Recommend Projects