Hyper Multisig

• Create multisig hypercores and hyperdrives
• Create signing requests for multisig cores and drives
• Sign and release multisig cores and drives

Includes sanity checks to avoid common mistakes and risky releases (detecting conflicts before committing, ensuring all cores are seeded by multiple other peers etc.)

Install

npm i hyper-multisig

Usage

End users most likely want to use hyper-multisig-cli instead of interacting directly with this module.

Multisig Flow

• Step 1: Each signer uses hypercore-sign to generate a key pair (secret key and public key). Later, public keys from all signers will be collected to create a multisig core.

  hypercore-sign generate-keys
  
  # to create an additional key pair
  HYPERCORE_SIGN_KEYS_DIRECTORY=<path-to-another-dir> hypercore-sign generate-keys

• Step 2: Create a multisig core given the public keys from the previous step, and a namespace to avoid collisions (the combination signers-namespace has to be globally unique, as it determinstically defines the key of the resulting multisig hypercore).

  // collect public keys of all signers generated by hypercore-sign
  const publicKeys = ['o37a1...', 'qgbd9...', '6r66j...']
  
  // to avoid collision, we structure namespace based on repo path
  const namespace = 'holepunchto/my-repo'
  
  const store = new Corestore('storage')
  await store.ready()
  
  const multisig = new HyperMultisig(store, swarm)
  const { manifest, core } = await multisig.createCore(publicKeys, namespace).done()

• Step 3: Generate a signing request based on a normal core (non-multisig) with the manifest from the previous step.

  const srcCore = store.get({ name: 'my-core' })
  await srcCore.ready()
  
  srcCore.append('hello world 1')
  srcCore.append('hello world 2')
  srcCore.append('hello world 3')
  
  const multisig = new HyperMultisig(store)
  const { request } = await multisig.requestCore(publicKeys, namespace, srcCore, 3).done()

• Step 4: Use hypercore-sign to sign the signing request to generate a signature. Later, signatures from all signers will be collected to sign the multisig core.

  hypercore-sign <signingRequest>

• Step 5: Commit the multisig core with the signatures from the previous step.

  // collect signatures from all signers generated by hypercore-sign
  const signatures = [signature1, signature2, ...]
  
  const multisig = new HyperMultisig(store, swarm)
  await multisig.commitCore(publicKeys, namespace, srcCore, request, signatures).done()