hypercore-signing-request

hypercore-signing-request

Generate shareable signing requests for Hypercore

npm install hypercore-signing-request

Useful for manual multisig

Usage

const { generate, decode, signable } = require('hypercore-signing-request')

API

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

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)

Decode the signing request. Looks like this:

{
  version, // request version
  id, // hypercore id
  key, // the key as well
  manifest, // core manifest
  treeHash, // the tree hash
  length, // the core length
  fork // the core fork id
}

responseBuffer = encodeResponse(response)

Encode the signing response. Looks like this:

{
  version, // request version
  publicKey, // signer public key
  requestHash, // request hash
  signatures // array of signatures
}

res = encodeResponse(responseBuffer)

Decode the signing response.

buffer = signable(publicKey, req)

Get the buffer to sign. Pass your public key and it validates that you can sign it.

License

Apache-2.0