hyper-multisig 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,76 @@
+![CI](https://github.com/holepunchto/hyper-multisig/actions/workflows/ci.yml/badge.svg)
+
+# 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](https://github.com/holepunchto/hyper-multisig-cli) instead of interacting directly with this module.
+
+## Multisig Flow
+
+- Step 1: Each signer uses [hypercore-sign](https://github.com/holepunchto/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.
+
+  ```shell
+  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).
+
+  ```js
+  // 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)
+  ```
+
+- Step 3: Generate a signing request based on a normal core (non-multisig) with the manifest from the previous step.
+
+  ```js
+  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)
+  ```
+
+- Step 4: Use [hypercore-sign](https://github.com/holepunchto/hypercore-sign) to sign the signing request to generate a signature. Later, signatures from all signers will be collected to sign the multisig core.
+
+  ```shell
+  hypercore-sign <signingRequest>
+  ```
+
+- Step 5: Commit the multisig core with the signatures from the previous step.
+
+  ```js
+  // 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)
+  ```

package/index.js

@@ -0,0 +1,245 @@
+/**
+ * @typedef {import('corestore')} Corestore
+ * @typedef {import('hypercore')} Hypercore
+ * @typedef {import('hyperswarm')} Hyperswarm
+ * @typedef {import('hypercore/lib/download')} Download
+ * @typedef {{
+ *   version: number
+ *   hash: string
+ *   quorum: number
+ *   signers: Array<{
+ *     signature: string
+ *     publicKey: Buffer
+ *     namespace: Buffer
+ *   }>
+ * }} Manifest
+ * @typedef {{
+ *   key: string
+ *   length: number
+ *   treeHash: string
+ * }} CoreInfo
+ */
+
+const cenc = require('compact-encoding')
+const CoreSign = require('hypercore-sign')
+const SignRequest = require('hypercore-signing-request')
+const Hyperdrive = require('hyperdrive')
+const z32 = require('z32')
+
+const MultisigUtil = require('./lib/util')
+
+class HyperMultisig {
+  constructor(store, swarm) {
+    /** @type {Corestore} */
+    this.store = store
+    /** @type {Hyperswarm} */
+    this.swarm = swarm
+  }
+
+  /**
+   * @param {string[]} publicKeys
+   * @param {string} namespace
+   * @return {Promise<{ manifest: Manifest, key: Buffer, core: Hypercore }>}
+   */
+  async createCore(publicKeys, namespace, { quorum } = {}) {
+    const manifest = MultisigUtil.getManifest(publicKeys, namespace, { quorum })
+    const core = this.store.get({ manifest })
+    await core.ready()
+    return { manifest, key: core.key, core }
+  }
+
+  /**
+   * @param {string[]} publicKeys
+   * @param {string} namespace
+   * @return {Promise<{
+   *   manifest: Manifest, key: Buffer, core: Hypercore,
+   *   blobsManifest: Manifest, blobsKey: Buffer, blobsCore: Hypercore
+   * }>}
+   */
+  async createDrive(publicKeys, namespace, { quorum } = {}) {
+    const { manifest, key, core } = await this.createCore(publicKeys, namespace, { quorum })
+
+    const blobsManifest = Hyperdrive.getContentManifest(manifest, key)
+    const blobsKey = Hyperdrive.getContentKey(manifest, key)
+    const blobsCore = this.store.get({ manifest: blobsManifest })
+
+    return { manifest, key, core, blobsManifest, blobsKey, blobsCore }
+  }
+
+  async requestCore(
+    publicKeys,
+    namespace,
+    srcCore,
+    length,
+    { force = false, quorum, peerUpdateTimeout } = {}
+  ) {
+    await srcCore.ready()
+    this.swarm.join(srcCore.discoveryKey, { client: true, server: false })
+    await srcCore.download({ start: 0, end: length }).done()
+
+    if (!force) await MultisigUtil.verifyCoreRequestable(srcCore, length, { peerUpdateTimeout })
+
+    const manifest = MultisigUtil.getManifest(publicKeys, namespace, { quorum })
+    const request = await SignRequest.generate(srcCore, { manifest, length })
+    return { manifest, request }
+  }
+
+  async requestDrive(
+    publicKeys,
+    namespace,
+    srcDrive,
+    length,
+    { force = false, quorum, peerUpdateTimeout } = {}
+  ) {
+    await srcDrive.ready()
+    this.swarm.join(srcDrive.discoveryKey, { client: true, server: false })
+    await srcDrive.getBlobs()
+    length = length || srcDrive.core.length
+
+    if (!force) {
+      await MultisigUtil.verifyCoreRequestable(srcDrive.core, length, {
+        peerUpdateTimeout,
+        coreId: 'db'
+      })
+      const contentLength = await srcDrive.getBlobsLength(length)
+      await MultisigUtil.verifyCoreRequestable(srcDrive.blobs.core, contentLength, {
+        peerUpdateTimeout,
+        coreId: 'blobs'
+      })
+    }
+
+    const manifest = MultisigUtil.getManifest(publicKeys, namespace, { quorum })
+    const request = await SignRequest.generateDrive(srcDrive, { manifest, length })
+    return { manifest, request }
+  }
+
+  async commitCore(
+    publicKeys,
+    namespace,
+    srcCore,
+    request,
+    responses,
+    { force = false, dryRun, quorum, skipTargetChecks = false, peerUpdateTimeout } = {}
+  ) {
+    await srcCore.ready()
+    this.swarm.join(srcCore.discoveryKey, { client: true, server: false })
+
+    const { manifest, core } = await this.createCore(publicKeys, namespace, { quorum })
+    this.swarm.join(core.discoveryKey)
+
+    const { length } = SignRequest.decode(z32.decode(request))
+
+    if (!force) {
+      await MultisigUtil.verifyCoreCommittable(srcCore, core, length, {
+        skipTargetChecks,
+        peerUpdateTimeout
+      })
+    }
+
+    const signResponses = []
+    for (const response of responses) {
+      const res = cenc.decode(CoreSign.messages.Response, z32.decode(response))
+      await CoreSign.verify(response, request, z32.encode(res.publicKey))
+      const publicKeyHex = res.publicKey.toString('hex')
+      signResponses[publicKeyHex] = res
+    }
+    const obtainedQuorum = Object.keys(signResponses).length
+    if (!dryRun && obtainedQuorum < manifest.quorum) {
+      throw new Error(`Insufficient quorum: ${obtainedQuorum} / ${manifest.quorum}`)
+    }
+
+    // NOTE: the ordering is important here, must map to signers ordering
+    const signatures = manifest.signers.map((signer) => {
+      const publicKeyHex = signer.publicKey.toString('hex')
+      return signResponses[publicKeyHex]?.signatures[0]
+    })
+
+    const batch = await MultisigUtil.signCore(core, srcCore, signatures, {
+      end: length,
+      commit: !dryRun
+    })
+    const result = {
+      destCore: await MultisigUtil.getCoreInfo(core),
+      srcCore: await MultisigUtil.getCoreInfo(srcCore),
+      batch
+    }
+    return { manifest, quorum: obtainedQuorum, result }
+  }
+
+  async commitDrive(
+    publicKeys,
+    namespace,
+    srcDrive,
+    request,
+    responses,
+    { dryRun, quorum, force = false, skipTargetChecks = false, peerUpdateTimeout } = {}
+  ) {
+    await srcDrive.ready()
+    this.swarm.join(srcDrive.discoveryKey, { client: true, server: false })
+    await srcDrive.getBlobs()
+
+    const { manifest, core, blobsCore } = await this.createDrive(publicKeys, namespace, { quorum })
+    this.swarm.join(core.discoveryKey)
+
+    const { length, content } = SignRequest.decode(z32.decode(request))
+    const blobsLength = content.length
+
+    if (!force) {
+      await MultisigUtil.verifyCoreCommittable(srcDrive.db.core, core, length, {
+        skipTargetChecks,
+        peerUpdateTimeout,
+        coreId: 'db'
+      })
+      await MultisigUtil.verifyCoreCommittable(srcDrive.blobs.core, blobsCore, blobsLength, {
+        skipTargetChecks,
+        peerUpdateTimeout,
+        coreId: 'blobs'
+      })
+    }
+
+    const signResponses = []
+    for (const response of responses) {
+      const res = cenc.decode(CoreSign.messages.Response, z32.decode(response))
+      await CoreSign.verify(response, request, z32.encode(res.publicKey))
+      const publicKeyHex = res.publicKey.toString('hex')
+      signResponses[publicKeyHex] = res
+    }
+    const obtainedQuorum = Object.keys(signResponses).length
+    if (!dryRun && obtainedQuorum < manifest.quorum) {
+      throw new Error(`Insufficient quorum: ${obtainedQuorum} / ${manifest.quorum}`)
+    }
+
+    const allSignatures = manifest.signers.map((signer) => {
+      const publicKeyHex = signer.publicKey.toString('hex')
+      return signResponses[publicKeyHex]?.signatures
+    })
+    // NOTE: the ordering is important here, must map to signers ordering
+    const signatures = allSignatures.map((item) => item?.[0])
+    const blobsSignatures = allSignatures.map((item) => item?.[1])
+
+    const { batch, blobsBatch } = await MultisigUtil.signDrive(
+      core,
+      srcDrive.core,
+      signatures,
+      blobsCore,
+      srcDrive.blobs.core,
+      blobsSignatures,
+      { end: length, blobsEnd: blobsLength, commit: !dryRun }
+    )
+    const result = {
+      db: {
+        destCore: await MultisigUtil.getCoreInfo(core),
+        srcCore: await MultisigUtil.getCoreInfo(srcDrive.core),
+        batch
+      },
+      blobs: {
+        destCore: await MultisigUtil.getCoreInfo(blobsCore),
+        srcCore: await MultisigUtil.getCoreInfo(srcDrive.blobs.core),
+        batch: blobsBatch
+      }
+    }
+    return { manifest, quorum: obtainedQuorum, result }
+  }
+}
+
+module.exports = HyperMultisig

package/lib/error.js

@@ -0,0 +1,80 @@
+class MultisigError extends Error {
+  constructor(msg, code, fn = MultisigError) {
+    super(`${code}: ${msg}`)
+    this.code = code
+
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, fn)
+    }
+  }
+
+  get name() {
+    return 'MultisigError'
+  }
+
+  static SOURCE_CORE_TOO_SMALL(length, { coreId = '' } = {}) {
+    return new MultisigError(
+      `${coreId} Source core is smaller than the requested length of ${length}`,
+      'SOURCE_CORE_TOO_SMALL',
+      MultisigError.SOURCE_CORE_TOO_SMALL
+    )
+  }
+
+  static TARGET_CORE_TOO_BIG() {
+    return new MultisigError(
+      'The target core already has higher length than the source core. Committing this signing request will most likely corrupt your core',
+      'TARGET_CORE_TOO_BIG',
+      MultisigError.TARGET_CORE_TOO_BIG
+    )
+  }
+
+  static SOURCE_CORE_INSUFFICIENT_PEERS(nrPeers, minPeers) {
+    return new MultisigError(
+      `Source core is not well seeded (${nrPeers}/${minPeers} peers)`,
+      'SOURCE_CORE_INSUFFICIENT_PEERS',
+      MultisigError.SOURCE_CORE_INSUFFICIENT_PEERS
+    )
+  }
+
+  static SOURCE_CORE_NOT_FULLY_SEEDED(fullCopies, minPeers, { coreId = '' } = {}) {
+    return new MultisigError(
+      `${coreId} Source core is not yet fully downloaded by sufficient seeders (${fullCopies}/${minPeers})`,
+      'SOURCE_CORE_NOT_FULLY_SEEDED',
+      MultisigError.SOURCE_CORE_NOT_FULLY_SEEDED
+    )
+  }
+
+  static TARGET_NOT_EMPTY() {
+    return new MultisigError(
+      'Target core is not empty, so you should not skip those checks',
+      'TARGET_NOT_EMPTY',
+      MultisigError.TARGET_NOT_EMPTY
+    )
+  }
+
+  static TARGET_CORE_INSUFFICIENT_PEERS(nrPeers, minPeers, { coreId = '' } = {}) {
+    return new MultisigError(
+      `${coreId} Target core is not well seeded (${nrPeers}/${minPeers} peers)`,
+      'TARGET_CORE_INSUFFICIENT_PEERS',
+      MultisigError.TARGET_CORE_INSUFFICIENT_PEERS
+    )
+  }
+
+  static TARGET_CORE_NOT_FULLY_SEEDED(fullCopies, minPeers, { coreId = '' } = {}) {
+    return new MultisigError(
+      `${coreId} Target core is not yet fully downloaded by sufficient seeders (${fullCopies}/${minPeers})`,
+      'TARGET_CORE_NOT_FULLY_SEEDED',
+      MultisigError.TARGET_CORE_NOT_FULLY_SEEDED
+    )
+  }
+
+  static INCOMPATIBLE_SOURCE_AND_TARGET({ coreId = '' } = {}) {
+    return new MultisigError(
+      `${coreId} Target core contains different data from the source core. Committing this signing request will corrupt your core.`,
+      'INCOMPATIBLE_SOURCE_AND_TARGET',
+      MultisigError.INCOMPATIBLE_SOURCE_AND_TARGET
+    )
+  }
+}
+
+module.exports = MultisigError

package/lib/util.js

@@ -0,0 +1,330 @@
+/**
+ * @typedef {import('corestore')} Corestore
+ * @typedef {import('hypercore/lib/download')} Download
+ * @typedef {{
+ *   version: number
+ *   hash: string
+ *   quorum: number
+ *   signers: Array<{
+ *     signature: string
+ *     publicKey: Buffer
+ *     namespace: Buffer
+ *   }>
+ * }} Manifest
+ * @typedef {{
+ *   key: string
+ *   length: number
+ *   treeHash: string
+ * }} CoreInfo
+ */
+
+const b4a = require('b4a')
+const Hypercore = require('hypercore')
+const { assemble, partialSignature } = require('hypercore/lib/multisig')
+const crypto = require('hypercore-crypto')
+const idEnc = require('hypercore-id-encoding')
+
+const MultisigError = require('./error')
+
+/**
+ * @param {Hypercore} core
+ * @param {Hypercore} batch
+ * @param {Buffer[]} signatures
+ * @param {{
+ *   length?: number
+ *   start?: number
+ *   end?: number
+ *   commit?: boolean
+ * }} opts
+ * @return {Promise<CoreInfo>}
+ */
+async function signCore(core, fromCore, signatures, { length, start, end, commit } = {}) {
+  /** @type {Hypercore | null} */
+  let batch = null
+  try {
+    batch = await createUpdateBatch(core, fromCore, { start, end })
+    if (commit) {
+      await commitUpdateBatch(core, batch, signatures, { length })
+    }
+    const batchInfo = await getCoreInfo(batch)
+    return batchInfo
+  } finally {
+    if (batch) await batch.close()
+  }
+}
+
+/**
+ * @param {Hypercore} core
+ * @param {Hypercore} fromCore
+ * @param {Buffer[]} signatures
+ * @param {Hypercore} blobsCore
+ * @param {Hypercore} fromBlobsCore
+ * @param {Buffer[]} blobsSignatures
+ * @param {{
+ *   start?: number
+ *   end?: number
+ *   length?: number
+ *   blobsStart?: number
+ *   blobsEnd?: number
+ *   blobsLength?: number
+ *   commit?: boolean
+ * }} opts
+ * @return {Promise<{ batch: CoreInfo, blobsBatch: CoreInfo }>}
+ */
+async function signDrive(
+  core,
+  fromCore,
+  signatures,
+  blobsCore,
+  fromBlobsCore,
+  blobsSignatures,
+  { start, end, length, blobsStart, blobsEnd, blobsLength, commit } = {}
+) {
+  const blobsBatch = await signCore(blobsCore, fromBlobsCore, blobsSignatures, {
+    start: blobsStart,
+    end: blobsEnd,
+    length: blobsLength,
+    commit
+  })
+  const batch = await signCore(core, fromCore, signatures, {
+    start,
+    end,
+    length,
+    commit
+  })
+  return { batch, blobsBatch }
+}
+
+/**
+ * @param {Hypercore} core
+ * @param {Hypercore} fromCore
+ * @param {{ start?: number, end?: number }} opts
+ * @return {Promise<Hypercore>}
+ */
+async function createUpdateBatch(core, fromCore, { start, end } = {}) {
+  start = start ?? core.length
+  end = end ?? fromCore.length
+
+  const download = fromCore.download({ start, end })
+  await download.done()
+
+  /** @type {Hypercore} */
+  const batch = core.session({ name: 'batch', overwrite: true })
+  for (let idx = start; idx < end; idx += 1) {
+    await batch.append(await fromCore.get(idx))
+  }
+  return batch
+}
+
+/**
+ * @param {Hypercore} core
+ * @param {Hypercore} batch
+ * @param {Buffer[]} signatures
+ * @param {{ length?: number }} opts
+ */
+async function commitUpdateBatch(core, batch, signatures, { length } = {}) {
+  length = length || batch.length
+
+  const proofs = await Promise.all(
+    signatures.map(async (sig, idx) => {
+      if (!sig) return null
+      const proof = await partialSignature(batch, idx, length, length, sig) // idx is important here, must match with the signers index
+      return proof
+    })
+  )
+  const validProofs = proofs.filter(Boolean)
+  const multisig = assemble(validProofs)
+
+  await core.commit(batch, { signature: multisig, length })
+}
+
+/**
+ * @param {string[]} publicKeys
+ * @param {string} namespace
+ * @return {string}
+ */
+function getCoreKey(publicKeys, namespace) {
+  const manifest = getManifest(publicKeys, namespace)
+  return Hypercore.key(manifest)
+}
+
+/**
+ * @param {string[]} publicKeys
+ * @param {string} namespace
+ * @return {Manifest}
+ */
+function getManifest(publicKeys, namespace, { quorum } = {}) {
+  if (!quorum) quorum = Math.floor(publicKeys.length / 2) + 1
+
+  return {
+    version: 1,
+    hash: 'blake2b',
+    quorum,
+    signers: publicKeys.map((publicKey) => ({
+      signature: 'ed25519',
+      publicKey: idEnc.decode(publicKey),
+      namespace: idEnc.decode(getNamespace(namespace))
+    }))
+  }
+}
+
+/**
+ * @param {string} namespace
+ * @return {string}
+ */
+function getNamespace(namespace) {
+  return idEnc.normalize(crypto.hash(Buffer.from(namespace)))
+}
+
+/**
+ * @param {Manifest} manifest
+ */
+function normalizeManifest(manifest) {
+  return {
+    ...manifest,
+    signers: manifest.signers.map((signer) => ({
+      ...signer,
+      publicKey: idEnc.normalize(signer.publicKey),
+      namespace: idEnc.normalize(signer.namespace)
+    }))
+  }
+}
+
+/**
+ * @param {Hypercore} core
+ * @return {Promise<{ key: string, length: number, treeHash: string }>}
+ */
+async function getCoreInfo(core) {
+  await core.ready()
+  return {
+    key: idEnc.normalize(core.key),
+    length: core.length,
+    treeHash: idEnc.normalize(await core.treeHash())
+  }
+}
+
+async function verifyCoreRequestable(
+  srcCore,
+  length,
+  { minPeers = 2, peerUpdateTimeout = 5000, coreId } = {}
+) {
+  await waitUntilCoreLength(srcCore, length, { timeout: peerUpdateTimeout })
+
+  if (length > srcCore.length) {
+    throw MultisigError.SOURCE_CORE_TOO_SMALL(length, { coreId })
+  }
+
+  await waitUntilSufficientPeers(srcCore, { minPeers, timeout: peerUpdateTimeout })
+
+  const nrSrcPeers = srcCore.peers.length
+  if (nrSrcPeers < minPeers) {
+    throw MultisigError.SOURCE_CORE_INSUFFICIENT_PEERS(nrSrcPeers, minPeers)
+  }
+
+  await waitUntilFullySeeded(srcCore, { minPeers, timeout: peerUpdateTimeout })
+
+  let srcFullCopies = 0
+  for (const p of srcCore.peers) {
+    if (p.remoteContiguousLength === srcCore.length) srcFullCopies++
+  }
+  if (srcFullCopies < minPeers) {
+    throw MultisigError.SOURCE_CORE_NOT_FULLY_SEEDED(srcFullCopies, minPeers, { coreId })
+  }
+}
+
+async function verifyCoreCommittable(
+  srcCore,
+  tgtCore,
+  length,
+  { minPeers = 2, skipTargetChecks = false, peerUpdateTimeout = 5000, coreId } = {}
+) {
+  await waitUntilCoreLength(srcCore, length, { timeout: peerUpdateTimeout })
+
+  if (length > srcCore.length) {
+    throw MultisigError.SOURCE_CORE_TOO_SMALL(length, { coreId })
+  }
+
+  // Either it corrupts the core, or it's a no-op (re-signing already signed data). There's no possible upside.
+  if (tgtCore.length > srcCore.length) {
+    throw MultisigError.TARGET_CORE_TOO_BIG()
+  }
+
+  await waitUntilSufficientPeers(srcCore, { minPeers, timeout: peerUpdateTimeout })
+
+  const nrSrcPeers = srcCore.peers.length
+  if (nrSrcPeers < minPeers) {
+    throw MultisigError.SOURCE_CORE_INSUFFICIENT_PEERS(nrSrcPeers, minPeers)
+  }
+
+  await waitUntilFullySeeded(srcCore, { minPeers, timeout: peerUpdateTimeout })
+
+  let srcFullCopies = 0
+  for (const p of srcCore.peers) {
+    if (p.remoteContiguousLength === srcCore.length) srcFullCopies++
+  }
+  if (srcFullCopies < minPeers) {
+    throw MultisigError.SOURCE_CORE_NOT_FULLY_SEEDED(srcFullCopies, minPeers, { coreId })
+  }
+
+  if (skipTargetChecks) {
+    // no checks on the target if it's the first commit
+    if (tgtCore.length > 0) throw MultisigError.TARGET_NOT_EMPTY()
+    return
+  }
+
+  const tgtPeers = tgtCore.peers.length
+  if (tgtPeers < minPeers) {
+    throw MultisigError.TARGET_CORE_INSUFFICIENT_PEERS(tgtPeers, minPeers, { coreId })
+  }
+
+  let tgtFullCopies = 0
+  for (const p of tgtCore.peers) {
+    if (p.remoteContiguousLength === tgtCore.length) tgtFullCopies++
+  }
+  if (tgtFullCopies < minPeers) {
+    throw MultisigError.TARGET_CORE_NOT_FULLY_SEEDED(tgtFullCopies, minPeers, { coreId })
+  }
+
+  if (!b4a.equals(await tgtCore.treeHash(tgtCore.length), await srcCore.treeHash(tgtCore.length))) {
+    throw MultisigError.INCOMPATIBLE_SOURCE_AND_TARGET({ coreId })
+  }
+}
+
+async function waitUntilCoreLength(core, length, { timeout = 5000 } = {}) {
+  return await waitUntil(() => core.length >= length, { timeout })
+}
+
+async function waitUntilSufficientPeers(core, { minPeers = 2, timeout = 5000 } = {}) {
+  return await waitUntil(() => core.peers?.length >= minPeers, { timeout })
+}
+
+async function waitUntilFullySeeded(core, { minPeers = 2, timeout = 5000 } = {}) {
+  return await waitUntil(
+    () => core.peers?.filter((p) => p.remoteContiguousLength === core.length).length >= minPeers,
+    { timeout }
+  )
+}
+
+async function waitUntil(conditionFn, { timeout = 5000, interval = 100 } = {}) {
+  if (await conditionFn()) return true
+  if (timeout < 0) return false
+  await new Promise((resolve) => setTimeout(resolve, interval))
+  return waitUntil(conditionFn, { timeout: timeout - interval, interval })
+}
+
+module.exports = {
+  signCore,
+  signDrive,
+  createUpdateBatch,
+  commitUpdateBatch,
+  getCoreKey,
+  getManifest,
+  getNamespace,
+  normalizeManifest,
+  getCoreInfo,
+  verifyCoreRequestable,
+  verifyCoreCommittable,
+  waitUntilCoreLength,
+  waitUntilSufficientPeers,
+  waitUntilFullySeeded
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "hyper-multisig",
+  "version": "0.0.1",
+  "description": "Multisig hypercore and hyperdrive",
+  "main": "index.js",
+  "files": [
+    "lib/",
+    "index.js"
+  ],
+  "scripts": {
+    "format": "prettier --write . && lunte --fix",
+    "lint": "prettier --check . && lunte",
+    "test": "brittle -c test.js",
+    "test-bare": "brittle-bare -c test.js"
+  },
+  "dependencies": {
+    "b4a": "^1.7.4",
+    "compact-encoding": "^2.18.0",
+    "hypercore": "^11.24.0",
+    "hypercore-crypto": "^3.6.1",
+    "hypercore-id-encoding": "^1.3.0",
+    "hypercore-sign": "^3.0.0",
+    "hypercore-signing-request": "^4.0.2",
+    "hyperdrive": "^13.2.1",
+    "z32": "^1.1.0"
+  },
+  "devDependencies": {
+    "brittle": "^3.19.1",
+    "corestore": "^7.8.0",
+    "hyperdht": "^6.29.0",
+    "hyperswarm": "^4.16.0",
+    "lunte": "^1.6.0",
+    "prettier": "^3.8.1",
+    "prettier-config-holepunch": "^2.0.0",
+    "sodium-native": "^5.0.10"
+  },
+  "author": "Holepunch",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/holepunchto/hyper-multisig.git"
+  },
+  "bugs": {
+    "url": "https://github.com/holepunchto/hyper-multisig/issues"
+  },
+  "homepage": "https://github.com/holepunchto/hyper-multisig#readme"
+}