@libp2p/daemon-protocol 0.0.0 → 0.0.1

package/README.md

@@ -3,7 +3,6 @@
 <a href="http://libp2p.io/"><img src="https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square" /></a>
 <a href="http://webchat.freenode.net/?channels=%23libp2p"><img src="https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square" /></a>
 <a href="https://discuss.libp2p.io"><img src="https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg" /></a>
-<a href="https://waffle.io/libp2p/libp2p"><img src="https://img.shields.io/badge/pm-waffle-yellow.svg?style=flat-square" /></a>
 
 > Contains the protobuf definitions of the communication protocol for libp2p daemons
 
@@ -13,18 +12,6 @@
 npm i @libp2p/daemon-protocol
 ```
 
-## Usage
-
-For a full list of options, you can run help `jsp2pd --help`.
-Running the defaults, `jsp2pd`, will start the daemon and bind it to a local unix socket path.
-Daemon clients will be able to communicate with the daemon over that unix socket.
-
-As an alternative, you can use this daemon with a different version of libp2p as the one specified in `package.json`. You just need to define its path through an environment variable as follows:
-
-```sh
-export LIBP2P_JS=./../../js-libp2p/src/index.js
-```
-
 ## Contribute
 
 This module is actively under development. Please check out the issues and submit PRs!

package/dist/src/stream-handler.d.ts

@@ -0,0 +1,28 @@
+import type { Duplex, Source } from 'it-stream-types';
+export interface StreamHandlerOptions {
+    stream: Duplex<Uint8Array>;
+    maxLength?: number;
+}
+export declare class StreamHandler {
+    private readonly stream;
+    private readonly shake;
+    decoder: Source<Uint8Array>;
+    /**
+     * Create a stream handler for connection
+     */
+    constructor(opts: StreamHandlerOptions);
+    /**
+     * Read and decode message
+     */
+    read(): Promise<any>;
+    write(msg: Uint8Array): void;
+    /**
+     * Return the handshake rest stream and invalidate handler
+     */
+    rest(): Duplex<Uint8Array, Uint8Array, Promise<void>>;
+    /**
+     * Close the stream
+     */
+    close(): Promise<void>;
+}
+//# sourceMappingURL=stream-handler.d.ts.map

package/dist/src/stream-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-handler.d.ts","sourceRoot":"","sources":["../../src/stream-handler.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAKrD,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoB;IAC3C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAW;IAC1B,OAAO,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;IAClC;;OAEG;gBACU,IAAI,EAAE,oBAAoB;IAQvC;;OAEG;IACG,IAAI;IAYV,KAAK,CAAE,GAAG,EAAE,UAAU;IAOtB;;OAEG;IACH,IAAI;IAKJ;;OAEG;IACG,KAAK;CAIZ"}

package/dist/src/stream-handler.js

@@ -0,0 +1,47 @@
+import * as lp from 'it-length-prefixed';
+import { handshake } from 'it-handshake';
+import { logger } from '@libp2p/logger';
+const log = logger('libp2p:daemon-protocol:stream-handler');
+export class StreamHandler {
+    /**
+     * Create a stream handler for connection
+     */
+    constructor(opts) {
+        const { stream, maxLength } = opts;
+        this.stream = stream;
+        this.shake = handshake(this.stream);
+        this.decoder = lp.decode.fromReader(this.shake.reader, { maxDataLength: maxLength ?? 4096 });
+    }
+    /**
+     * Read and decode message
+     */
+    async read() {
+        // @ts-expect-error decoder is really a generator
+        const msg = await this.decoder.next();
+        if (msg.value != null) {
+            return msg.value.slice();
+        }
+        log('read received no value, closing stream');
+        // End the stream, we didn't get data
+        await this.close();
+    }
+    write(msg) {
+        log('write message');
+        this.shake.write(lp.encode.single(msg).slice());
+    }
+    /**
+     * Return the handshake rest stream and invalidate handler
+     */
+    rest() {
+        this.shake.rest();
+        return this.shake.stream;
+    }
+    /**
+     * Close the stream
+     */
+    async close() {
+        log('closing the stream');
+        await this.rest().sink([]);
+    }
+}
+//# sourceMappingURL=stream-handler.js.map

package/dist/src/stream-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-handler.js","sourceRoot":"","sources":["../../src/stream-handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,oBAAoB,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAIvC,MAAM,GAAG,GAAG,MAAM,CAAC,uCAAuC,CAAC,CAAA;AAO3D,MAAM,OAAO,aAAa;IAIxB;;OAEG;IACH,YAAa,IAA0B;QACrC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAA;QAElC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACnC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,SAAS,IAAI,IAAI,EAAE,CAAC,CAAA;IAC9F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,iDAAiD;QACjD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;QACrC,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,EAAE;YACrB,OAAO,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;SACzB;QAED,GAAG,CAAC,wCAAwC,CAAC,CAAA;QAC7C,qCAAqC;QACrC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAA;IACpB,CAAC;IAED,KAAK,CAAE,GAAe;QACpB,GAAG,CAAC,eAAe,CAAC,CAAA;QACpB,IAAI,CAAC,KAAK,CAAC,KAAK,CACd,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAC9B,CAAA;IACH,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAA;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,GAAG,CAAC,oBAAoB,CAAC,CAAA;QACzB,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC5B,CAAC;CACF"}

package/dist/src/upgrader.d.ts

@@ -0,0 +1,3 @@
+import type { Upgrader } from '@libp2p/interfaces/transport';
+export declare const passThroughUpgrader: Upgrader;
+//# sourceMappingURL=upgrader.d.ts.map

package/dist/src/upgrader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgrader.d.ts","sourceRoot":"","sources":["../../src/upgrader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAA;AAE5D,eAAO,MAAM,mBAAmB,EAAE,QAKjC,CAAA"}

package/dist/src/upgrader.js

@@ -0,0 +1,7 @@
+export const passThroughUpgrader = {
+    // @ts-expect-error should return a connection
+    upgradeInbound: async (maConn) => maConn,
+    // @ts-expect-error should return a connection
+    upgradeOutbound: async (maConn) => maConn
+};
+//# sourceMappingURL=upgrader.js.map

package/dist/src/upgrader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgrader.js","sourceRoot":"","sources":["../../src/upgrader.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,mBAAmB,GAAa;IAC3C,8CAA8C;IAC9C,cAAc,EAAE,KAAK,EAAC,MAAM,EAAC,EAAE,CAAC,MAAM;IACtC,8CAA8C;IAC9C,eAAe,EAAE,KAAK,EAAC,MAAM,EAAC,EAAE,CAAC,MAAM;CACxC,CAAA"}

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@libp2p/daemon-protocol",
-  "version": "0.0.0",
-  "description": "",
+  "version": "0.0.1",
+  "description": "Communication protocol between libp2p daemons and clients",
   "author": "",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/libp2p/js-libp2p-daemon-protocol#readme",
+  "homepage": "https://github.com/libp2p/js-libp2p-daemon/tree/master/packages/libp2p-daemon-protocol#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/libp2p/js-libp2p-daemon-protocol.git"
+    "url": "git+https://github.com/libp2p/js-libp2p-daemon.git"
   },
   "bugs": {
-    "url": "https://github.com/libp2p/js-libp2p-daemon-protocol/issues"
+    "url": "https://github.com/libp2p/js-libp2p-daemon/issues"
   },
   "engines": {
     "node": ">=16.0.0",
@@ -18,6 +18,22 @@
   },
   "type": "module",
   "types": "./dist/src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ],
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ]
+    }
+  },
   "files": [
     "src",
     "dist/src",
@@ -27,13 +43,23 @@
   "exports": {
     ".": {
       "import": "./dist/src/index.js"
+    },
+    "./stream-handler": {
+      "import": "./dist/src/stream-handler.js"
+    },
+    "./upgrader": {
+      "import": "./dist/src/upgrader.js"
     }
   },
   "eslintConfig": {
     "extends": "ipfs",
     "parserOptions": {
       "sourceType": "module"
-    }
+    },
+    "ignorePatterns": [
+      "*.d.ts",
+      "src/index.js"
+    ]
   },
   "release": {
     "branches": [
@@ -118,7 +144,7 @@
   },
   "scripts": {
     "lint": "aegir lint",
-    "build": "mkdirp dist/src && cp src/*.js src/*.d.ts dist/src",
+    "build": "tsc && cp src/*.js src/*.d.ts dist/src",
     "generate": "npm run generate:proto && npm run generate:proto-types",
     "generate:proto": "pbjs -t static-module -w es6 -r libp2p-daemon --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/protocol/index.js ./src/protocol/index.proto",
     "generate:proto-types": "pbts -o src/protocol/index.d.ts src/protocol/index.js",

package/src/stream-handler.ts

@@ -0,0 +1,66 @@
+import * as lp from 'it-length-prefixed'
+import { handshake } from 'it-handshake'
+import { logger } from '@libp2p/logger'
+import type { Duplex, Source } from 'it-stream-types'
+import type { Handshake } from 'it-handshake'
+
+const log = logger('libp2p:daemon-protocol:stream-handler')
+
+export interface StreamHandlerOptions {
+  stream: Duplex<Uint8Array>
+  maxLength?: number
+}
+
+export class StreamHandler {
+  private readonly stream: Duplex<Uint8Array>
+  private readonly shake: Handshake
+  public decoder: Source<Uint8Array>
+  /**
+   * Create a stream handler for connection
+   */
+  constructor (opts: StreamHandlerOptions) {
+    const { stream, maxLength } = opts
+
+    this.stream = stream
+    this.shake = handshake(this.stream)
+    this.decoder = lp.decode.fromReader(this.shake.reader, { maxDataLength: maxLength ?? 4096 })
+  }
+
+  /**
+   * Read and decode message
+   */
+  async read () {
+    // @ts-expect-error decoder is really a generator
+    const msg = await this.decoder.next()
+    if (msg.value != null) {
+      return msg.value.slice()
+    }
+
+    log('read received no value, closing stream')
+    // End the stream, we didn't get data
+    await this.close()
+  }
+
+  write (msg: Uint8Array) {
+    log('write message')
+    this.shake.write(
+      lp.encode.single(msg).slice()
+    )
+  }
+
+  /**
+   * Return the handshake rest stream and invalidate handler
+   */
+  rest () {
+    this.shake.rest()
+    return this.shake.stream
+  }
+
+  /**
+   * Close the stream
+   */
+  async close () {
+    log('closing the stream')
+    await this.rest().sink([])
+  }
+}

package/src/upgrader.ts

@@ -0,0 +1,8 @@
+import type { Upgrader } from '@libp2p/interfaces/transport'
+
+export const passThroughUpgrader: Upgrader = {
+  // @ts-expect-error should return a connection
+  upgradeInbound: async maConn => maConn,
+  // @ts-expect-error should return a connection
+  upgradeOutbound: async maConn => maConn
+}