autopass 2.2.0 → 3.0.0

package/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

package/.github/workflows/test-node.yml

@@ -14,10 +14,10 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm install
-    - run: npm test
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test

package/.prettierrc

@@ -0,0 +1 @@
+"prettier-config-holepunch"

package/README.md

@@ -2,7 +2,7 @@
 
 Distributed notes/password manager
 
-``` sh
+```sh
 npm install autopass
 ```
 
@@ -13,7 +13,7 @@ npm install autopass
 
 First choose if you wanna pair or make a new instance.
 
-``` js
+```js
 import Autopass from 'autopass'
 import Corestore from 'corestore'
 
@@ -25,7 +25,7 @@ console.log('share to add', inv)
 
 Then invite another instance
 
-``` js
+```js
 const pair = Autopass.pair(new Corestore('./another-pass'), inv)
 
 const anotherPass = await pair.finished()
@@ -34,13 +34,13 @@ await anotherPass.ready()
 
 When paired you can simply start the instance again with the normal constructor.
 
-``` js
+```js
 await pass.add('a-note', 'hello this is a note')
 ```
 
 Then on the other node you get it out with
 
-``` js
+```js
 const note = await pass.get('a-note')
 console.log({ note })
 ```
@@ -59,23 +59,14 @@ Triggered when it updates, ie something added/removed an entry
 
 Get an entry.
 
-#### `value = await pass.getFile(name)`
-
-Get a file.
-
 #### `stream = pass.list()`
 
 Get all entries.
 
-#### `await pass.add(key, value)`
+#### `await pass.add(key, value, file)`
 
 Add new entry
 
-#### `await pass.addFIle(name, buffer)`
-
-Add new file
-
-
 #### `await pass.remove(key)`
 
 Remove an entry.
@@ -112,6 +103,18 @@ Pair with another instance.
 
 Wait for the pair to finish.
 
+#### `await pass.addMirror(key)`
+
+Add a blind mirror.
+
+#### `await getMirror()`
+
+Returns an array of blind mirrors
+
+#### `await removeMirror(key)`
+
+Remove a blind mirror
+
 #### `await pair.close()`
 
 Force close the pair instance. Only need to call this if you dont wait for it to finish.get
@@ -120,6 +123,14 @@ Force close the pair instance. Only need to call this if you dont wait for it to
 
 Fully close the pass instance.
 
+#### `await pass.suspend()`
+
+Suspend the swarm and discovery
+
+#### `await pass.resume`
+
+Resume the swarm is suspended
+
 ## Contributors
 
 Written with big contributions from [@supersu](https://github.com/supersuryaansh)

package/example.mjs

@@ -20,7 +20,7 @@ if (pass.base.writable) {
 onupdate()
 pass.on('update', onupdate)
 
-function onupdate () {
+function onupdate() {
   console.log('db changed, all entries:')
   pass.list().on('data', console.log)
 }

package/index.js

@@ -7,16 +7,19 @@ const Hyperswarm = require('hyperswarm')
 const ReadyResource = require('ready-resource')
 const z32 = require('z32')
 const b4a = require('b4a')
-const { Router, dispatch } = require('./spec/hyperdispatch')
+const { Router, encode, decode } = require('./spec/hyperdispatch')
+const BlindPeering = require('blind-peering')
 const db = require('./spec/db/index.js')
+const enc = require('hypercore-id-encoding')
 
 class AutopassPairer extends ReadyResource {
-  constructor (store, invite, opts = {}) {
+  constructor(store, invite, opts = {}) {
     super()
     this.store = store
     this.invite = invite
     this.swarm = null
     this.pairing = null
+    this.peering = null
     this.candidate = null
     this.bootstrap = opts.bootstrap || null
     this.onresolve = null
@@ -26,7 +29,7 @@ class AutopassPairer extends ReadyResource {
     this.ready().catch(noop)
   }
 
-  async _open () {
+  async _open() {
     await this.store.ready()
     this.swarm = new Hyperswarm({
       keyPair: await this.store.createKeyPair('hyperswarm'),
@@ -54,6 +57,8 @@ class AutopassPairer extends ReadyResource {
             encryptionKey: result.encryptionKey,
             bootstrap: this.bootstrap
           })
+
+          await this.pass.deleteInvite()
         }
         this.swarm = null
         this.store = null
@@ -63,7 +68,7 @@ class AutopassPairer extends ReadyResource {
     })
   }
 
-  _whenWritable () {
+  _whenWritable() {
     if (this.pass.base.writable) return
     const check = () => {
       if (this.pass.base.writable) {
@@ -74,7 +79,7 @@ class AutopassPairer extends ReadyResource {
     this.pass.base.on('update', check)
   }
 
-  async _close () {
+  async _close() {
     if (this.candidate !== null) {
       await this.candidate.close()
     }
@@ -94,7 +99,7 @@ class AutopassPairer extends ReadyResource {
     }
   }
 
-  finished () {
+  finished() {
     return new Promise((resolve, reject) => {
       this.onresolve = resolve
       this.onreject = reject
@@ -103,7 +108,7 @@ class AutopassPairer extends ReadyResource {
 }
 
 class Autopass extends ReadyResource {
-  constructor (corestore, opts = {}) {
+  constructor(corestore, opts = {}) {
     super()
     this.router = new Router()
     this.store = corestore
@@ -127,10 +132,18 @@ class Autopass extends ReadyResource {
       await context.view.insert('@autopass/records', data)
     })
 
+    this.router.add('@autopass/add-mirror', async (data, context) => {
+      await context.view.insert('@autopass/mirrors', data)
+    })
+
     this.router.add('@autopass/del', async (data, context) => {
       await context.view.delete('@autopass/records', { key: data.key })
     })
 
+    this.router.add('@autopass/del-mirror', async (data, context) => {
+      await context.view.delete('@autopass/mirrors', { key: data.key })
+    })
+
     this.router.add('@autopass/add-invite', async (data, context) => {
       await context.view.insert('@autopass/invite', data)
     })
@@ -144,13 +157,13 @@ class Autopass extends ReadyResource {
   }
 
   // Initialize autobase
-  _boot (opts = {}) {
+  _boot(opts = {}) {
     const { encryptionKey, key } = opts
 
     this.base = new Autobase(this.store, key, {
       encrypt: true,
       encryptionKey,
-      open (store) {
+      open(store) {
         return HyperDB.bee(store.get('view'), db, {
           extension: false,
           autoUpdate: true
@@ -165,19 +178,19 @@ class Autopass extends ReadyResource {
     })
   }
 
-  async _apply (nodes, view, base) {
+  async _apply(nodes, view, base) {
     for (const node of nodes) {
       await this.router.dispatch(node.value, { view, base })
     }
     await view.flush()
   }
 
-  async _open () {
+  async _open() {
     await this.base.ready()
     if (this.replicate) await this._replicate()
   }
 
-  async _close () {
+  async _close() {
     if (this.swarm) {
       await this.member.close()
       await this.pairing.close()
@@ -186,73 +199,83 @@ class Autopass extends ReadyResource {
     await this.base.close()
   }
 
-  get writerKey () {
+  get writerKey() {
     return this.base.local.key
   }
 
-  get key () {
+  get key() {
     return this.base.key
   }
 
-  get discoveryKey () {
+  get discoveryKey() {
     return this.base.discoveryKey
   }
 
-  get encryptionKey () {
+  get encryptionKey() {
     return this.base.encryptionKey
   }
 
-  static pair (store, invite, opts) {
+  static pair(store, invite, opts) {
     return new AutopassPairer(store, invite, opts)
   }
 
-  async createInvite (opts) {
+  async createInvite(opts) {
     if (this.opened === false) await this.ready()
     const existing = await this.base.view.findOne('@autopass/invite', {})
     if (existing) {
       return z32.encode(existing.invite)
     }
-    const { id, invite, publicKey, expires } = BlindPairing.createInvite(this.base.key)
+    const { id, invite, publicKey, expires } = BlindPairing.createInvite(
+      this.base.key
+    )
 
     const record = { id, invite, publicKey, expires }
-    await this.base.append(dispatch('@autopass/add-invite', record))
+    await this.base.append(encode('@autopass/add-invite', record))
     return z32.encode(record.invite)
   }
 
-  async deleteInvite () {
+  async deleteInvite() {
     if (this.opened === false) await this.ready()
     const existing = await this.base.view.findOne('@autopass/invite', {})
     if (existing) {
-      await this.base.append(dispatch('@autopass/del-invite', existing))
+      await this.base.append(encode('@autopass/del-invite', existing))
     }
   }
 
-  list (opts) {
+  list(opts) {
     return this.base.view.find('@autopass/records', {})
   }
 
-  async get (key) {
+  async get(key) {
     const data = await this.base.view.get('@autopass/records', { key })
     if (data === null) {
       return null
     }
-    return data.value
+    return { value: data.value, file: data.file }
   }
 
-  async addWriter (key) {
-    await this.base.append(dispatch('@autopass/add-writer', { key: b4a.isBuffer(key) ? key : b4a.from(key) }))
+  async addWriter(key) {
+    await this.base.append(
+      encode('@autopass/add-writer', {
+        key: b4a.isBuffer(key) ? key : b4a.from(key)
+      })
+    )
     return true
   }
 
-  async removeWriter (key) {
-    await this.base.append(dispatch('@autopass/remove-writer', { key: b4a.isBuffer(key) ? key : b4a.from(key) }))
+  async removeWriter(key) {
+    await this.base.append(
+      encode('@autopass/remove-writer', {
+        key: b4a.isBuffer(key) ? key : b4a.from(key)
+      })
+    )
   }
 
-  get writable () {
+  get writable() {
     return this.base.writable
   }
 
-  async _replicate () {
+  async _replicate() {
     await this.base.ready()
     if (this.swarm === null) {
       this.swarm = new Hyperswarm({
@@ -269,7 +292,7 @@ class Autopass extends ReadyResource {
       onadd: async (candidate) => {
         const id = candidate.inviteId
         const inv = await this.base.view.findOne('@autopass/invite', {})
-        if (!b4a.equals(inv.id, id)) {
+        if (inv === null || !b4a.equals(inv.id, id)) {
           return
         }
         candidate.open(inv.publicKey)
@@ -278,32 +301,63 @@ class Autopass extends ReadyResource {
           key: this.base.key,
           encryptionKey: this.base.encryptionKey
         })
+        await this.deleteInvite()
       }
     })
     this.swarm.join(this.base.discoveryKey)
+
+    const mirrorList = await this.getMirror()
+    const mirrors = mirrorList.map((item) => item.key)
+    this.peering = new BlindPeering(this.swarm, this.store, {
+      autobaseMirrors: mirrors
+    })
+    this.peering.addAutobaseBackground(this.base)
   }
 
-  async add (key, value) {
-    await this.base.append(dispatch('@autopass/put', { key, value }))
+  async add(key, value, file) {
+    await this.base.append(encode('@autopass/put', { key, value, file }))
   }
 
-  async addFile (key, file) {
-    await this.base.append(dispatch('@autopass/put', { key, file }))
+  async remove(key) {
+    await this.base.append(encode('@autopass/del', { key }))
   }
 
-  async getFile (key) {
-    const data = await this.base.view.get('@autopass/records', { key })
-    if (data === null) {
-      return null
+  async addMirror(key) {
+    const keyBuffer = enc.decode(enc.normalize(key))
+    await this.base.append(encode('@autopass/add-mirror', { key: keyBuffer }))
+  }
+
+  async getMirror() {
+    const queryStream = this.base.view.find('@autopass/mirrors', {})
+    const results = await queryStream.toArray()
+    return results.map((r) => ({
+      ...r,
+      key: enc.encode(r.key)
+    }))
+  }
+
+  async removeMirror(key) {
+    const keyBuffer = enc.decode(enc.normalize(key))
+    await this.base.append(encode('@autopass/del-mirror', { key: keyBuffer }))
+  }
+
+  async suspend() {
+    if (this.swarm) {
+      await this.pairing.suspend()
+      await this.swarm.suspend()
+      await this.store.suspend()
     }
-    return data.file
   }
 
-  async remove (key) {
-    await this.base.append(dispatch('@autopass/del', { key }))
+  async resume() {
+    if (this.swarm) {
+      await this.store.resume()
+      await this.swarm.resume()
+      await this.pairing.resume()
+    }
   }
 } // end class
 
-function noop () {}
+function noop() {}
 
 module.exports = Autopass

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "autopass",
-  "version": "2.2.0",
+  "version": "3.0.0",
   "main": "index.js",
   "scripts": {
-    "test": "standard && brittle test.js"
+    "brittle": "npx brittle test.js",
+    "lint": "npx prettier . --check",
+    "test": "npm run lint && npm run brittle"
   },
   "author": "Holepunch Inc",
   "license": "Apache-2.0",
@@ -19,25 +21,27 @@
     }
   },
   "devDependencies": {
-    "brittle": "^3.7.0",
-    "hyperdht": "^6.20.1",
-    "standard": "^17.1.2",
-    "test-tmp": "^1.3.0"
+    "bare-fs": "^4.4.4",
+    "bare-process": "^4.2.1",
+    "brittle": "^3.19.0",
+    "hyperdht": "^6.23.0",
+    "prettier": "^3.6.2",
+    "prettier-config-holepunch": "^1.0.0",
+    "test-tmp": "^1.4.0"
   },
   "dependencies": {
-    "autobase": "^7.0.34",
-    "b4a": "^1.6.7",
-    "bare-fs": "^4.1.2",
-    "bare-process": "^4.2.1",
+    "autobase": "^7.19.4",
+    "b4a": "^1.7.1",
     "blind-pairing": "^2.3.1",
-    "compact-encoding": "^2.16.0",
-    "corestore": "^7.0.7",
-    "hyperbee": "^2.22.2",
-    "hypercore": "^11.0.9",
-    "hyperdb": "^4.9.4",
-    "hyperdispatch": "^1.0.2",
-    "hyperschema": "^1.10.4",
-    "hyperswarm": "^4.8.4",
-    "ready-resource": "^1.1.1"
+    "blind-peering": "^1.13.0",
+    "corestore": "^7.4.7",
+    "hyperbee": "^2.26.5",
+    "hypercore": "^11.16.2",
+    "hypercore-id-encoding": "^1.3.0",
+    "hyperdb": "^4.16.1",
+    "hyperdispatch": "^1.4.2",
+    "hyperschema": "^1.15.0",
+    "hyperswarm": "^4.14.0",
+    "ready-resource": "^1.2.0"
   }
 }