corestore 7.4.5 → 7.4.7

package/README.md

@@ -7,7 +7,7 @@ Corestore is a Hypercore factory that makes it easier to manage large collection
 Corestore provides:
 1. __Key Derivation__ - All writable Hypercore keys are derived from a single master key and a user-provided name.
 2. __Session Handling__ - If a single Hypercore is loaded multiple times through the `get` method, the underlying resources will only be opened once (using Hypercore 10's new session feature). Once all sessions are closed, the resources will be released.
-3. __Storage Management__ - Hypercores can be stored in any random-access-storage instance, where they will be keyed by their discovery keys.
+3. __Storage Management__ - Hypercores can be stored in any `hypercore-storage` instance, where they will be keyed by their discovery keys.
 4. __Namespacing__ - You can share a single Corestore instance between multiple applications or components without worrying about naming collisions by creating "namespaces" (e.g. `corestore.namespace('my-app').get({ name: 'main' })`)
 
 ### Installation
@@ -19,7 +19,7 @@ Corestore provides:
 > It will be updated to 11 in a few weeks.
 
 ### Usage
-A corestore instance can be constructed with a random-access-storage module, a function that returns a random-access-storage module given a path, or a string. If a string is specified, it will be assumed to be a path to a local storage directory:
+A corestore instance can be constructed with a `hypercore-storage` instance, or a string. If a string is specified, it will be assumed to be a path to a local storage directory:
 ```js
 const Corestore = require('corestore')
 
@@ -29,10 +29,21 @@ const core2 = store.get({ name: 'core-2' })
 ```
 
 ### API
-#### `const store = new Corestore(storage)`
+
+#### `const store = new Corestore(storage, options = {})`
+
 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.
+`storage` can be either a `hypercore-storage` instance or a string.
+
+Options:
+
+```
+{
+  primaryKey: null, // The primary key to use as the master key for key derivation.
+  writable: true,
+}
+```
 
 #### `const core = store.get(key | { name: 'a-name', ...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 String with hex/z32 key, or if the `key` options is set).
@@ -79,6 +90,29 @@ const core2 = ns2.get({ name: 'main' })
 #### `const stream = store.list(namespace)`
 Creates a discovery key stream of all cores within a namespace or all cores in general if no namespace is provided.
 
+#### `store.watch((core) => {})`
+Register a callback called when new Hypercores are opened. `core` is the internal core for the opened Hypercore. It can be used to create weak references to a Hypercore like so:
+
+```
+store.watch(function (core) {
+  const weakCore = new Hypercore({ core, weak: true })
+})
+```
+
+#### `store.unwatch(callback)`
+Unregister a callback used with `store.watch(callback)` so it no longer fires.
+
+#### `await store.suspend()`
+Suspend the underlying storage for the Corestore.
+
+#### `await store.resume()`
+Resume a suspended Corestore.
+
+#### `const keypair = await store.createKeyPair(name, ns = this.ns)`
+Generate a key pair seeded with the Corestore's primary key using a `name` and a `ns` aka namespace. `ns` defaults to the current namespace.
+
+This is useful for creating deterministic key pairs that are unique to a peer.
+
 #### `await store.close()`
 Fully close this Corestore instance.
 

package/index.js

@@ -230,7 +230,7 @@ class Corestore extends ReadyResource {
     super()
 
     this.root = opts.root || null
-    this.storage = this.root ? this.root.storage : Hypercore.defaultStorage(storage, { id: opts.id, allowBackup: opts.allowBackup })
+    this.storage = this.root ? this.root.storage : Hypercore.defaultStorage(storage, { id: opts.id, allowBackup: opts.allowBackup, readOnly: opts.readOnly })
     this.streamTracker = this.root ? this.root.streamTracker : new StreamTracker()
     this.cores = this.root ? this.root.cores : new CoreTracker()
     this.sessions = new SessionTracker()

package/lib/audit.js

@@ -1,12 +1,14 @@
 module.exports = async function * audit (store, { dryRun = false } = {}) {
-  for await (const { discoveryKey } of store.storage.createCoreStream()) {
-    const core = store.get({ discoveryKey, active: false })
-    await core.ready()
+  for await (const { discoveryKey, core } of store.storage.createCoreStream()) {
+    if (core.version < 1) continue // not migrated, ignore
 
-    yield { discoveryKey, key: core.key, audit: await core.core.audit({ dryRun }) }
+    const c = store.get({ discoveryKey, active: false })
+    await c.ready()
+
+    yield { discoveryKey, key: c.key, audit: await c.core.audit({ dryRun }) }
 
     try {
-      await core.close()
+      await c.close()
     } catch {
       // ignore if failed, we are auditing...
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "corestore",
-  "version": "7.4.5",
+  "version": "7.4.7",
   "description": "A Hypercore factory that simplifies managing collections of cores.",
   "main": "index.js",
   "files": [