blind-peer-muxer 1.3.0 → 1.5.0

package/index.js

@@ -3,15 +3,29 @@ const { BlindPeerRequest: NotificationRequest } = require('blind-push/encodings'
 const Protomux = require('protomux')
 
 const Cores = getEncoding('@blind-peer/cores')
+const Handshake = getEncoding('@blind-peer/handshake')
+// The wrapper makes it work seamlessly if the other side does not have a handshake
+// We default the value to a real decode, which will create a default object based on hyperschema config.
+// This way there is no need to handle special null states by blind-peer-muxer users.
+const HandshakeWrapped = {
+  preencode: Handshake.preencode,
+  encode: Handshake.encode,
+  decode(state) {
+    return state.start >= state.end
+      ? Handshake.decode({ buffer: Buffer.alloc(1), start: 0, end: 1 })
+      : Handshake.decode(state)
+  }
+}
 
 module.exports = class BlindPeerChannel {
   constructor(
     stream,
-    { oncores = noop, onnotification = noop, onopen = noop, onclose = noop } = {}
+    { handshake = {}, oncores = noop, onnotification = noop, onopen = noop, onclose = noop } = {}
   ) {
     this.muxer = Protomux.from(stream)
     this.channel = this.muxer.createChannel({
       protocol: 'blind-peer',
+      handshake: HandshakeWrapped,
       messages: [
         { encoding: Cores, onmessage: oncores },
         { encoding: NotificationRequest, onmessage: onnotification }
@@ -21,7 +35,7 @@ module.exports = class BlindPeerChannel {
     })
     this.wireCores = this.channel.messages[0]
     this.wireNotification = this.channel.messages[1]
-    this.channel.open()
+    this.channel.open(handshake)
   }
 
   get stream() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blind-peer-muxer",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Protomux channel muxer for blind peers",
   "main": "index.js",
   "repository": {
@@ -32,7 +32,7 @@
     "prettier-config-holepunch": "^2.0.0"
   },
   "dependencies": {
-    "blind-push": "^0.2.3",
+    "blind-push": "^1.0.1",
     "compact-encoding": "^3.0.0",
     "hyperschema": "^1.19.0",
     "protomux": "^3.10.1"

package/spec/hyperschema/index.js

@@ -65,6 +65,29 @@ const encoding1 = {
   }
 }
 
+// @blind-peer/handshake
+const encoding2 = {
+  preencode(state, m) {
+    state.end++ // max flag is 1 so always one byte
+
+    if (m.blindPeeringVersion) c.string.preencode(state, m.blindPeeringVersion)
+  },
+  encode(state, m) {
+    const flags = m.blindPeeringVersion ? 1 : 0
+
+    c.uint.encode(state, flags)
+
+    if (m.blindPeeringVersion) c.string.encode(state, m.blindPeeringVersion)
+  },
+  decode(state) {
+    const flags = c.uint.decode(state)
+
+    return {
+      blindPeeringVersion: (flags & 1) !== 0 ? c.string.decode(state) : null
+    }
+  }
+}
+
 function setVersion(v) {
   version = v
 }
@@ -92,6 +115,8 @@ function getEncoding(name) {
       return encoding0
     case '@blind-peer/cores':
       return encoding1
+    case '@blind-peer/handshake':
+      return encoding2
     default:
       throw new Error('Encoder not found ' + name)
   }

package/spec/hyperschema/schema.json

@@ -50,6 +50,19 @@
           "version": 1
         }
       ]
+    },
+    {
+      "name": "handshake",
+      "namespace": "blind-peer",
+      "compact": false,
+      "flagsPosition": 0,
+      "fields": [
+        {
+          "name": "blindPeeringVersion",
+          "type": "string",
+          "version": 1
+        }
+      ]
     }
   ]
 }