hypercore 10.10.0 → 10.12.0

package/README.md

@@ -72,7 +72,8 @@ Note that `tree`, `data`, and `bitfield` are normally heavily sparse files.
   encodeBatch: batch => { ... }, // optionally apply an encoding to complete batches
   keyPair: kp, // optionally pass the public key and secret key as a key pair
   encryptionKey: k, // optionally pass an encryption key to enable block encryption
-  onwait: () => {} // hook that is called if gets are waiting for download
+  onwait: () => {}, // hook that is called if gets are waiting for download
+  writable: true // disable appends and truncates
 }
 ```
 
@@ -227,7 +228,7 @@ partialStream.pipe(process.stdout)
 }
 ```
 
-#### `await core.clear(start, [end])`
+#### `const cleared = await core.clear(start, [end], [options])`
 
 Clear stored blocks between `start` and `end`, reclaiming storage when possible.
 
@@ -238,6 +239,13 @@ await core.clear(0, 10) // clear block 0-10 from your local cache
 
 The core will also gossip to peers it is connected to, that is no longer has these blocks.
 
+`options` include:
+```js
+{
+  diff: false // Returned `cleared` bytes object is null unless you enable this
+}
+```
+
 #### `await core.truncate(newLength, [forkId])`
 
 Truncate the core to a smaller length.

package/index.js

@@ -74,6 +74,7 @@ module.exports = class Hypercore extends EventEmitter {
     this.onwait = opts.onwait || null
     this.wait = opts.wait !== false
     this.timeout = opts.timeout || 0
+    this._readonly = opts.writable === false
 
     this.closing = null
     this.opening = this._openSession(key, storage, opts)
@@ -201,6 +202,7 @@ module.exports = class Hypercore extends EventEmitter {
 
     const sparse = opts.sparse === false ? false : this.sparse
     const wait = opts.wait === false ? false : this.wait
+    const writable = opts.writable === false ? false : !this._readonly
     const onwait = opts.onwait === undefined ? this.onwait : opts.onwait
     const timeout = opts.timeout === undefined ? this.timeout : opts.timeout
     const Clz = opts.class || Hypercore
@@ -210,6 +212,7 @@ module.exports = class Hypercore extends EventEmitter {
       wait,
       onwait,
       timeout,
+      writable,
       _opening: this.opening,
       _sessions: this.sessions
     })
@@ -237,7 +240,7 @@ module.exports = class Hypercore extends EventEmitter {
     this.core = o.core
     this.replicator = o.replicator
     this.encryption = o.encryption
-    this.writable = !!(this.auth && this.auth.sign)
+    this.writable = !this._readonly && !!(this.auth && this.auth.sign)
     this.autoClose = o.autoClose
 
     if (this.snapshotted && this.core && !this._snapshot) this._updateSnapshot()
@@ -295,7 +298,7 @@ module.exports = class Hypercore extends EventEmitter {
     }
 
     if (!this.auth) this.auth = this.core.defaultAuth
-    this.writable = !!this.auth.sign
+    this.writable = !this._readonly && !!this.auth.sign
 
     if (opts.valueEncoding) {
       this.valueEncoding = c.from(opts.valueEncoding)
@@ -745,9 +748,13 @@ module.exports = class Hypercore extends EventEmitter {
       end = start + 1
     }
 
-    if (start >= end) return
+    const cleared = (opts && opts.diff) ? { blocks: 0 } : null
 
-    await this.core.clear(start, end)
+    if (start >= end) return cleared
+
+    await this.core.clear(start, end, cleared)
+
+    return cleared
   }
 
   async purge () {

package/lib/core.js

@@ -5,6 +5,7 @@ const Mutex = require('./mutex')
 const MerkleTree = require('./merkle-tree')
 const BlockStore = require('./block-store')
 const Bitfield = require('./bitfield')
+const Info = require('./info')
 const { BAD_ARGUMENT, STORAGE_EMPTY, STORAGE_CONFLICT, INVALID_SIGNATURE } = require('./errors')
 const m = require('./messages')
 
@@ -238,7 +239,7 @@ module.exports = class Core {
     }
   }
 
-  async clear (start, end) {
+  async clear (start, end, cleared) {
     await this._mutex.lock()
 
     try {
@@ -265,13 +266,20 @@ module.exports = class Core {
       end = this.bitfield.firstSet(end)
 
       if (end === -1) end = this.tree.length
+      if (start >= end || start >= this.tree.length) return
 
       const offset = await this.tree.byteOffset(start * 2)
       const [byteEnd, byteEndLength] = await this.tree.byteRange((end - 1) * 2)
       const length = (byteEnd + byteEndLength) - offset
 
+      const before = cleared ? await Info.bytesUsed(this.blocks.storage) : null
+
       await this.blocks.clear(offset, length)
 
+      const after = cleared ? await Info.bytesUsed(this.blocks.storage) : null
+
+      if (cleared) cleared.blocks = Math.max(before - after, 0)
+
       this.onupdate(0, entry.bitfield, null, null)
 
       if (this._shouldFlush()) await this._flushOplog()

package/lib/info.js

@@ -27,27 +27,27 @@ module.exports = class Info {
     const { oplog, tree, blocks, bitfield } = session.core
     try {
       return {
-        oplog: await bytesUsed(oplog.storage),
-        tree: await bytesUsed(tree.storage),
-        blocks: await bytesUsed(blocks.storage),
-        bitfield: await bytesUsed(bitfield.storage)
+        oplog: await Info.bytesUsed(oplog.storage),
+        tree: await Info.bytesUsed(tree.storage),
+        blocks: await Info.bytesUsed(blocks.storage),
+        bitfield: await Info.bytesUsed(bitfield.storage)
       }
     } catch {
       return null
     }
+  }
 
-    function bytesUsed (file) {
-      return new Promise((resolve, reject) => {
-        file.stat((err, st) => {
-          if (err) {
-            resolve(0) // prob just file not found (TODO, improve)
-          } else if (typeof st.blocks !== 'number') {
-            reject(new Error('cannot determine bytes used'))
-          } else {
-            resolve(st.blocks * 512)
-          }
-        })
+  static bytesUsed (file) {
+    return new Promise((resolve, reject) => {
+      file.stat((err, st) => {
+        if (err) {
+          resolve(0) // prob just file not found (TODO, improve)
+        } else if (typeof st.blocks !== 'number') {
+          reject(new Error('cannot determine bytes used'))
+        } else {
+          resolve(st.blocks * 512)
+        }
       })
-    }
+    })
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypercore",
-  "version": "10.10.0",
+  "version": "10.12.0",
   "description": "Hypercore is a secure, distributed append-only log",
   "main": "index.js",
   "scripts": {