corestore 6.8.3 → 6.9.0

package/README.md

@@ -1,6 +1,6 @@
 # Corestore
 
-### [See the full API docs at docs.holepunch.to](https://docs.holepunch.to/building-blocks/corestore)
+### [See the full API docs at docs.holepunch.to](https://docs.holepunch.to/helpers/corestore)
 
 Corestore is a Hypercore factory that makes it easier to manage large collections of named Hypercores.
 
@@ -30,7 +30,7 @@ Create a new Corestore instance.
 `storage` can be either a random-access-storage module, a string, or a function that takes a path and returns an random-access-storage instance.
 
 #### `const core = store.get(key | { name: 'a-name', exclusive, ...hypercoreOpts})`
-Loads a Hypercore, either by name (if the `name` option is provided), or from the provided key (if the first argument is a Buffer, or if the `key` options is set).
+Loads a Hypercore, either by name (if the `name` option is provided), or from the provided key (if the first argument is a Buffer or String with hex/z32 key, or if the `key` options is set).
 
 If that Hypercore has previously been loaded, subsequent calls to `get` will return a new Hypercore session on the existing core.
 

package/index.js

@@ -2,6 +2,7 @@ const safetyCatch = require('safety-catch')
 const crypto = require('hypercore-crypto')
 const sodium = require('sodium-universal')
 const Hypercore = require('hypercore')
+const hypercoreId = require('hypercore-id-encoding')
 const Xache = require('xache')
 const b4a = require('b4a')
 const ReadyResource = require('ready-resource')
@@ -47,6 +48,37 @@ module.exports = class Corestore extends ReadyResource {
     this.ready().catch(safetyCatch)
   }
 
+  // for now just release the lock...
+  async suspend () {
+    if (this._root !== this) return this._root.suspend()
+
+    await this.ready()
+
+    if (this._keyStorage !== null) {
+      await new Promise((resolve, reject) => {
+        this._keyStorage.suspend((err) => {
+          if (err) return reject(err)
+          resolve()
+        })
+      })
+    }
+  }
+
+  async resume () {
+    if (this._root !== this) return this._root.resume()
+
+    await this.ready()
+
+    if (this._keyStorage !== null) {
+      await new Promise((resolve, reject) => {
+        this._keyStorage.open((err) => {
+          if (err) return reject(err)
+          resolve()
+        })
+      })
+    }
+  }
+
   findingPeers () {
     let done = false
     this._incFindingPeers()
@@ -403,9 +435,11 @@ function sign (keyPair, message) {
 }
 
 function validateGetOptions (opts) {
-  if (b4a.isBuffer(opts)) return { key: opts, publicKey: opts }
+  const key = (b4a.isBuffer(opts) || typeof opts === 'string') ? hypercoreId.decode(opts) : null
+  if (key) return { key, publicKey: key }
+
   if (opts.key) {
-    opts.publicKey = opts.key
+    opts.key = opts.publicKey = hypercoreId.decode(opts.key)
   }
   if (opts.keyPair) {
     opts.publicKey = opts.keyPair.publicKey

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "corestore",
-  "version": "6.8.3",
+  "version": "6.9.0",
   "description": "A Hypercore factory that simplifies managing collections of cores.",
   "main": "index.js",
   "scripts": {
@@ -32,6 +32,7 @@
     "b4a": "^1.3.1",
     "hypercore": "^10.12.0",
     "hypercore-crypto": "^3.2.1",
+    "hypercore-id-encoding": "^1.1.0",
     "read-write-mutexify": "^2.1.0",
     "ready-resource": "^1.0.0",
     "safety-catch": "^1.0.1",