hypercore-signing-request 3.1.1 → 4.0.0

package/README.md

@@ -16,10 +16,14 @@ const { generate, decode, signable } = require('hypercore-signing-request')
 
 ## API
 
-#### `requestBuffer = await generate(core, { length = core.length })`
+#### `requestBuffer = await generate(coreOrDrive, { length = core.length })`
 
 Generate a signing request, returned as a buffer so it can be shared.
-Only works for non-compat cores (ie manifest backed)
+Only works for non-compat cores (ie manifest backed).
+
+Alternatvely a Hyperdrive can be passed and a joint request for signing both metadata and blob cores will be generated.
+Only works for v1 manifest backed Hyperdrives.
+
 
 #### `req = decode(requestBuffer)`
 

package/index.js

@@ -1,10 +1,12 @@
 const HypercoreID = require('hypercore-id-encoding')
+const Hyperdrive = require('hyperdrive')
 const Verifier = require('hypercore/lib/verifier')
 const caps = require('hypercore/lib/caps')
 const m = require('hypercore/lib/messages')
 const c = require('compact-encoding')
 
-const VERSION = 1
+const VERSION = 2
+const FLAG_DRIVE = 1
 
 const Request = {
   preencode (state, req) {
@@ -13,6 +15,13 @@ const Request = {
     c.uint.preencode(state, req.fork)
     c.fixed32.preencode(state, req.treeHash)
     m.manifest.preencode(state, req.manifest)
+
+    c.uint.preencode(state, 0) // flags
+
+    if (req.content) {
+      c.uint.preencode(state, req.content.length)
+      c.fixed32.preencode(state, req.content.treeHash)
+    }
   },
   encode (state, req) {
     c.uint.encode(state, req.version)
@@ -20,10 +29,19 @@ const Request = {
     c.uint.encode(state, req.fork)
     c.fixed32.encode(state, req.treeHash)
     m.manifest.encode(state, req.manifest)
+
+    let flags = 0
+    if (req.content) flags |= FLAG_DRIVE
+    c.uint.encode(state, flags)
+
+    if (req.content) {
+      c.uint.encode(state, req.content.length)
+      c.fixed32.encode(state, req.content.treeHash)
+    }
   },
   decode (state) {
     const version = c.uint.decode(state)
-    if (version !== VERSION) throw new Error('Unknown signing request version: ' + version)
+    if (version > VERSION) throw new Error('Unknown signing request version: ' + version)
 
     const length = c.uint.decode(state)
     const fork = c.uint.decode(state)
@@ -33,6 +51,18 @@ const Request = {
     const key = Verifier.manifestHash(manifest)
     const id = HypercoreID.normalize(key)
 
+    const flags = state.start !== state.end ? c.uint.decode(state) : 0
+
+    let content = null
+
+    const isHyperdrive = flags & FLAG_DRIVE
+    if (isHyperdrive) {
+      content = {
+        length: c.uint.decode(state),
+        treeHash: c.fixed32.decode(state)
+      }
+    }
+
     return {
       version,
       id,
@@ -40,44 +70,100 @@ const Request = {
       length,
       fork,
       treeHash,
-      manifest
+      manifest,
+      isHyperdrive,
+      content
     }
   }
 }
 
 module.exports = {
-  async generate (core, { length = core.length, fork = core.fork, manifest = null } = {}) {
-    if (!core.opened) await core.ready()
+  generate,
+  generateDrive,
+  decode,
+  signable
+}
 
-    if (core.core.compat && !manifest) throw new Error('Cannot generate signing requests for compat cores')
-    if (core.fork !== fork) throw new Error('Core should have the same fork')
-    if (!manifest) manifest = core.manifest
+async function generate (core, { length = core.length, fork = core.fork, manifest = null } = {}) {
+  if (!core.opened) await core.ready()
 
-    return c.encode(Request, {
-      version: VERSION,
-      length,
-      fork,
-      treeHash: await core.treeHash(length),
-      manifest
-    })
-  },
-  decode (buffer) {
-    const state = { start: 0, end: buffer.byteLength, buffer }
-    const req = Request.decode(state)
+  if (core.blobs) return generateDrive(core, { length, fork, manifest })
 
-    if (req.length === 0) throw new Error('Refusing to sign length = 0')
-    if (state.start < state.end) throw new Error('Unparsed padding left in request, bailing')
+  if (core.core.compat && !manifest) throw new Error('Cannot generate signing requests for compat cores')
+  if (core.fork !== fork) throw new Error('Core should have the same fork')
+  if (!manifest) manifest = core.manifest
 
-    return req
-  },
-  signable (pub, req) {
-    const v = req.manifest.version
-    for (const s of req.manifest.signers) {
-      if (s.publicKey.equals(pub)) {
-        return caps.treeSignable(v === 0 ? s.namespace : req.key, req.treeHash, req.length, req.fork)
-      }
-    }
+  return c.encode(Request, {
+    version: VERSION,
+    length,
+    fork,
+    treeHash: await core.treeHash(length),
+    manifest,
+    content: null
+  })
+}
+
+async function generateDrive (drive, { length = drive.core.length, fork = drive.core.fork, manifest = null }) {
+  if (drive.core.core.compat && !manifest) throw new Error('Cannot generate signing requests for compat cores')
 
-    throw new Error('Public key is not a declared signer for this request')
+  if (!manifest) manifest = drive.core.manifest
+  if (manifest < 1) throw new Error('Only v1 manifests are supported')
+
+  const last = await drive.db.getBySeq(length - 1)
+  const { blockOffset, blockLength } = last.value.blob
+
+  const contentLength = blockOffset + blockLength
+  const content = {
+    length: contentLength,
+    treeHash: await drive.blobs.core.treeHash(contentLength)
   }
+
+  return c.encode(Request, {
+    version: VERSION,
+    length,
+    fork,
+    treeHash: await drive.core.treeHash(length),
+    manifest,
+    content
+  })
+}
+
+function decode (buffer) {
+  const state = { start: 0, end: buffer.byteLength, buffer }
+  const req = Request.decode(state)
+
+  if (req.length === 0) throw new Error('Refusing to sign length = 0')
+  if (state.start < state.end) throw new Error('Unparsed padding left in request, bailing')
+
+  return req
+}
+
+function signable (pub, req) {
+  const v = req.manifest.version
+
+  for (const s of req.manifest.signers) {
+    if (!s.publicKey.equals(pub)) continue
+
+    if (req.isHyperdrive) return driveSignable(pub, req)
+
+    const signable = caps.treeSignable(v === 0 ? s.namespace : req.key, req.treeHash, req.length, req.fork)
+    return [signable]
+  }
+
+  throw new Error('Public key is not a declared signer for this request')
+}
+
+function driveSignable (pub, req) {
+  const contentKey = Hyperdrive.getContentKey(req.manifest)
+  if (!contentKey) {
+    throw new Error('Drive is not compatible, needs v1 manifest')
+  }
+
+  const signable = caps.treeSignable(req.key, req.treeHash, req.length, req.fork)
+  const content = caps.treeSignable(contentKey, req.content.treeHash, req.content.length, req.fork)
+
+  return [
+    signable,
+    content
+  ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypercore-signing-request",
-  "version": "3.1.1",
+  "version": "4.0.0",
   "description": "Generate shareable signing requests for Hypercore",
   "main": "index.js",
   "scripts": {
@@ -12,6 +12,7 @@
   "dependencies": {
     "compact-encoding": "^2.13.0",
     "hypercore": "^10.32.8",
+    "hyperdrive": "^11.7.0",
     "hypercore-id-encoding": "^1.2.0"
   },
   "repository": {
@@ -26,6 +27,7 @@
   "homepage": "https://github.com/holepunchto/hypercore-signing-request",
   "devDependencies": {
     "brittle": "^3.4.0",
+    "corestore": "^6.17.0",
     "random-access-memory": "^6.2.0",
     "standard": "^17.1.0"
   }