@streamr/node 100.0.0-rc.0

package/dist/src/plugins/mqtt/Bridge.js

@@ -0,0 +1,136 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Bridge = void 0;
+const protocol_1 = require("@streamr/protocol");
+const utils_1 = require("@streamr/utils");
+const without_1 = __importDefault(require("lodash/without"));
+const parser_1 = require("../../helpers/parser");
+const partitions_1 = require("../../helpers/partitions");
+const DEFAULT_PARTITION = 0;
+const logger = new utils_1.Logger(module);
+const createMessageChainKey = (message) => {
+    const DELIMITER = '-';
+    return [message.streamId, message.streamPartition, message.publisherId, message.msgChainId].join(DELIMITER);
+};
+class Bridge {
+    streamrClient;
+    mqttServer;
+    payloadFormat;
+    streamIdDomain;
+    subscriptions = [];
+    publishMessageChains = new Set();
+    constructor(streamrClient, mqttServer, payloadFormat, streamIdDomain) {
+        this.streamrClient = streamrClient;
+        this.mqttServer = mqttServer;
+        this.payloadFormat = payloadFormat;
+        this.streamIdDomain = streamIdDomain;
+    }
+    async onMessageReceived(topic, payload, clientId) {
+        let message;
+        let streamPart;
+        try {
+            message = this.payloadFormat.createMessage(payload);
+            streamPart = this.getPublishStreamPart(topic);
+        }
+        catch (err) {
+            logger.warn('Unable to form message', { err, topic, clientId });
+            return;
+        }
+        const { content, metadata } = message;
+        try {
+            const publishedMessage = await this.streamrClient.publish({
+                id: streamPart.streamId,
+                partition: streamPart.partition
+            }, content, {
+                timestamp: metadata.timestamp,
+                partitionKey: (0, partitions_1.getPartitionKey)(content, streamPart),
+                msgChainId: clientId
+            });
+            this.publishMessageChains.add(createMessageChainKey(publishedMessage));
+        }
+        catch (err) {
+            logger.warn('Unable to publish message', { err, topic, clientId });
+        }
+    }
+    async onSubscribed(topic, clientId) {
+        logger.info('Handle client subscribe', { clientId, topic });
+        const streamPart = this.getSubscribeStreamPart(topic);
+        const existingSubscription = this.getSubscription(streamPart);
+        if (existingSubscription === undefined) {
+            const streamrClientSubscription = await this.streamrClient.subscribe(streamPart, (content, metadata) => {
+                if (!this.isSelfPublishedMessage(metadata)) {
+                    const payload = this.payloadFormat.createPayload(content, metadata);
+                    this.mqttServer.publish(topic, payload);
+                }
+            });
+            this.subscriptions.push({
+                streamrClientSubscription,
+                clientIds: [clientId]
+            });
+        }
+        else {
+            existingSubscription.clientIds.push(clientId);
+        }
+    }
+    /**
+     *
+     * If a stream is subscribed with a MQTT client and also published with same or another
+     * MQTT client, the message could be delivered to the subscribed client two
+     * ways:
+     *
+     * 1) automatic mirroring by Aedes (delivers all published messages to all subscribers)
+     * 2) via network node: the subscribing MQTT client receives the published message from the
+     *    network node as it subscribes to the stream (by calling streamrClient.subscribe)
+     *
+     * The message should be delivered to the subscribed client only once. Theferore we filter
+     * out the "via network node" case by checking whether the message is one of the messages
+     * which the Bridge published to the network node.
+     *
+     * Each publishing session of a stream yields to a unique MessageChainKey value. We store that
+     * key value when we call streamrClient.publish().
+     *
+     * Here we simply check if the incoming message belongs to one of the publish chains. If it
+     * does, it must have been published by this Bridge.
+     */
+    isSelfPublishedMessage(message) {
+        const messageChainKey = createMessageChainKey(message);
+        return this.publishMessageChains.has(messageChainKey);
+    }
+    onUnsubscribed(topic, clientId) {
+        logger.info('Handle client unsubscribe', { clientId, topic });
+        const streamPart = this.getSubscribeStreamPart(topic);
+        const existingSubscription = this.getSubscription(streamPart);
+        if (existingSubscription !== undefined) {
+            existingSubscription.clientIds = (0, without_1.default)(existingSubscription.clientIds, clientId);
+            if (existingSubscription.clientIds.length === 0) {
+                existingSubscription.streamrClientSubscription.unsubscribe();
+                this.subscriptions = (0, without_1.default)(this.subscriptions, existingSubscription);
+            }
+        }
+    }
+    getSubscribeStreamPart(topic) {
+        const { base, query } = (0, parser_1.parseQueryAndBase)(topic);
+        const partition = (0, parser_1.parseQueryParameter)('partition', query, parser_1.parsePositiveInteger);
+        return (0, protocol_1.toStreamPartID)(this.getStreamId(base), partition ?? DEFAULT_PARTITION);
+    }
+    getPublishStreamPart(topic) {
+        const { base, query } = (0, parser_1.parseQueryAndBase)(topic);
+        return {
+            streamId: this.getStreamId(base),
+            ...(0, partitions_1.parsePublishPartitionDefinition)(query)
+        };
+    }
+    getStreamId(topicBase) {
+        return (0, protocol_1.toStreamID)((this.streamIdDomain !== undefined) ? `${this.streamIdDomain}/${topicBase}` : topicBase);
+    }
+    getSubscription(streamPartId) {
+        return this.subscriptions.find((s) => {
+            return s.streamrClientSubscription.streamPartId === streamPartId;
+        });
+    }
+}
+exports.Bridge = Bridge;
+//# sourceMappingURL=Bridge.js.map

package/dist/src/plugins/mqtt/Bridge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bridge.js","sourceRoot":"","sources":["../../../../src/plugins/mqtt/Bridge.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAsF;AACtF,0CAAuC;AACvC,6DAAoC;AAGpC,iDAAmG;AACnG,yDAAuH;AAGvH,MAAM,iBAAiB,GAAG,CAAC,CAAA;AAE3B,MAAM,MAAM,GAAG,IAAI,cAAM,CAAC,MAAM,CAAC,CAAA;AASjC,MAAM,qBAAqB,GAAG,CAAC,OAAwB,EAAE,EAAE;IACvD,MAAM,SAAS,GAAG,GAAG,CAAA;IACrB,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,eAAe,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;AAC/G,CAAC,CAAA;AAED,MAAa,MAAM;IAEE,aAAa,CAAe;IAC5B,UAAU,CAAY;IACtB,aAAa,CAAe;IAC5B,cAAc,CAAS;IAChC,aAAa,GAAyB,EAAE,CAAA;IACxC,oBAAoB,GAAG,IAAI,GAAG,EAAmB,CAAA;IAEzD,YAAY,aAA4B,EAAE,UAAsB,EAAE,aAA4B,EAAE,cAAuB;QACnH,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;IACxC,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,KAAa,EAAE,OAAe,EAAE,QAAgB;QACpE,IAAI,OAAgB,CAAA;QACpB,IAAI,UAA+D,CAAA;QACnE,IAAI,CAAC;YACD,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;YACnD,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAA;QACjD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAA;YAC/D,OAAM;QACV,CAAC;QACD,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAA;QACrC,IAAI,CAAC;YACD,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;gBACtD,EAAE,EAAE,UAAU,CAAC,QAAQ;gBACvB,SAAS,EAAE,UAAU,CAAC,SAAS;aAClC,EAAE,OAAO,EAAE;gBACR,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,YAAY,EAAE,IAAA,4BAAe,EAAC,OAAO,EAAE,UAAU,CAAC;gBAClD,UAAU,EAAE,QAAQ;aACvB,CAAC,CAAA;YACF,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,CAAA;QAC1E,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAA;QACtE,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,KAAa,EAAE,QAAgB;QAC9C,MAAM,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAA;QAC3D,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAA;QACrD,MAAM,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAA;QAC7D,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,OAAY,EAAE,QAAyB,EAAE,EAAE;gBACzH,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACzC,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;oBACnE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;gBAC3C,CAAC;YACL,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;gBACpB,yBAAyB;gBACzB,SAAS,EAAE,CAAC,QAAQ,CAAC;aACxB,CAAC,CAAA;QACN,CAAC;aAAM,CAAC;YACJ,oBAAoB,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACjD,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACK,sBAAsB,CAAC,OAAwB;QACnD,MAAM,eAAe,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAA;QACtD,OAAO,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;IACzD,CAAC;IAED,cAAc,CAAC,KAAa,EAAE,QAAgB;QAC1C,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAA;QAC7D,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAA;QACrD,MAAM,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAA;QAC7D,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACrC,oBAAoB,CAAC,SAAS,GAAG,IAAA,iBAAO,EAAC,oBAAoB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAA;YAClF,IAAI,oBAAoB,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9C,oBAAoB,CAAC,yBAAyB,CAAC,WAAW,EAAE,CAAA;gBAC5D,IAAI,CAAC,aAAa,GAAG,IAAA,iBAAO,EAAC,IAAI,CAAC,aAAa,EAAE,oBAAoB,CAAC,CAAA;YAC1E,CAAC;QACL,CAAC;IACL,CAAC;IAEO,sBAAsB,CAAC,KAAa;QACxC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAA,0BAAiB,EAAC,KAAK,CAAC,CAAA;QAChD,MAAM,SAAS,GAAG,IAAA,4BAAmB,EAAC,WAAW,EAAE,KAAK,EAAE,6BAAoB,CAAC,CAAA;QAC/E,OAAO,IAAA,yBAAc,EAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,SAAS,IAAI,iBAAiB,CAAC,CAAA;IACjF,CAAC;IAEO,oBAAoB,CAAC,KAAa;QACtC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAA,0BAAiB,EAAC,KAAK,CAAC,CAAA;QAChD,OAAO;YACH,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YAChC,GAAG,IAAA,4CAA+B,EAAC,KAAK,CAAC;SAC5C,CAAA;IACL,CAAC;IAEO,WAAW,CAAC,SAAiB;QACjC,OAAO,IAAA,qBAAU,EAAC,CAAC,IAAI,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,cAAc,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAC9G,CAAC;IAEO,eAAe,CAAC,YAA0B;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAqB,EAAE,EAAE;YACrD,OAAO,CAAC,CAAC,yBAAyB,CAAC,YAAY,KAAK,YAAY,CAAA;QACpE,CAAC,CAAC,CAAA;IACN,CAAC;CACJ;AA3HD,wBA2HC"}

package/dist/src/plugins/mqtt/MqttPlugin.d.ts

@@ -0,0 +1,14 @@
+import { Schema } from 'ajv';
+import { StreamrClient } from '@streamr/sdk';
+import { ApiPluginConfig, Plugin } from '../../Plugin';
+export interface MqttPluginConfig extends ApiPluginConfig {
+    port: number;
+    streamIdDomain?: string;
+    payloadMetadata: boolean;
+}
+export declare class MqttPlugin extends Plugin<MqttPluginConfig> {
+    private server?;
+    start(streamrClient: StreamrClient): Promise<void>;
+    stop(): Promise<void>;
+    getConfigSchema(): Schema;
+}

package/dist/src/plugins/mqtt/MqttPlugin.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MqttPlugin = void 0;
+const Plugin_1 = require("../../Plugin");
+const PayloadFormat_1 = require("../../helpers/PayloadFormat");
+const Bridge_1 = require("./Bridge");
+const MqttServer_1 = require("./MqttServer");
+const config_schema_json_1 = __importDefault(require("./config.schema.json"));
+class MqttPlugin extends Plugin_1.Plugin {
+    server;
+    async start(streamrClient) {
+        this.server = new MqttServer_1.MqttServer(this.pluginConfig.port, this.getApiAuthentication());
+        const bridge = new Bridge_1.Bridge(streamrClient, this.server, (0, PayloadFormat_1.getPayloadFormat)(this.pluginConfig.payloadMetadata), this.pluginConfig.streamIdDomain);
+        this.server.setListener(bridge);
+        return this.server.start();
+    }
+    // eslint-disable-next-line class-methods-use-this
+    async stop() {
+        await this.server.stop();
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getConfigSchema() {
+        return config_schema_json_1.default;
+    }
+}
+exports.MqttPlugin = MqttPlugin;
+//# sourceMappingURL=MqttPlugin.js.map

package/dist/src/plugins/mqtt/MqttPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MqttPlugin.js","sourceRoot":"","sources":["../../../../src/plugins/mqtt/MqttPlugin.ts"],"names":[],"mappings":";;;;;;AAEA,yCAAsD;AACtD,+DAA8D;AAC9D,qCAAiC;AACjC,6CAAyC;AACzC,8EAAuD;AAQvD,MAAa,UAAW,SAAQ,eAAwB;IAE5C,MAAM,CAAa;IAE3B,KAAK,CAAC,KAAK,CAAC,aAA4B;QACpC,IAAI,CAAC,MAAM,GAAG,IAAI,uBAAU,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAA;QACjF,MAAM,MAAM,GAAG,IAAI,eAAM,CACrB,aAAa,EACb,IAAI,CAAC,MAAM,EACX,IAAA,gCAAgB,EAAC,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,EACnD,IAAI,CAAC,YAAY,CAAC,cAAc,CACnC,CAAA;QACD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IAC9B,CAAC;IAED,kDAAkD;IAClD,KAAK,CAAC,IAAI;QACN,MAAM,IAAI,CAAC,MAAO,CAAC,IAAI,EAAE,CAAA;IAC7B,CAAC;IAED,kDAAkD;IACzC,eAAe;QACpB,OAAO,4BAAoB,CAAA;IAC/B,CAAC;CACJ;AAzBD,gCAyBC"}

package/dist/src/plugins/mqtt/MqttServer.d.ts

@@ -0,0 +1,22 @@
+import { ApiAuthentication } from '../../apiAuthentication';
+export interface MqttServerListener {
+    onMessageReceived(topic: string, payload: string, clientId: string): void;
+    onSubscribed(topics: string, clientId: string): void;
+    onUnsubscribed(topics: string, clientId: string): void;
+}
+export declare class MqttServer {
+    private static COMMAND_PUBLISH;
+    private static QOS_EXACTLY_ONCE;
+    private static BAD_USERNAME_OR_PASSWORD;
+    private static NOT_AUTHORIZED;
+    private readonly port;
+    private readonly aedes;
+    private server?;
+    private listener?;
+    constructor(port: number, apiAuthentication?: ApiAuthentication);
+    setListener(listener: MqttServerListener): void;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    publish(topic: string, payload: string): void;
+    private static createAuthenicationHandler;
+}

package/dist/src/plugins/mqtt/MqttServer.js

@@ -0,0 +1,109 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MqttServer = void 0;
+const net = __importStar(require("net"));
+const util_1 = __importDefault(require("util"));
+const utils_1 = require("@streamr/utils");
+const apiAuthentication_1 = require("../../apiAuthentication");
+const aedes_1 = __importDefault(require("aedes"));
+const logger = new utils_1.Logger(module);
+class MqttServer {
+    static COMMAND_PUBLISH = 'publish';
+    static QOS_EXACTLY_ONCE = 2;
+    static BAD_USERNAME_OR_PASSWORD = 4;
+    static NOT_AUTHORIZED = 5;
+    port;
+    aedes;
+    server;
+    listener;
+    constructor(port, apiAuthentication) {
+        this.port = port;
+        this.aedes = new aedes_1.default({
+            authenticate: MqttServer.createAuthenicationHandler(apiAuthentication)
+        });
+        this.aedes.on('publish', (packet, client) => {
+            if (client !== null) { // is null if the this server sent the message
+                this.listener?.onMessageReceived(packet.topic, packet.payload.toString(), client.id);
+            }
+        });
+        this.aedes.on('subscribe', (subscriptions, client) => {
+            const topics = subscriptions.map((subscription) => subscription.topic);
+            topics.forEach((topic) => this.listener?.onSubscribed(topic, client.id));
+        });
+        this.aedes.on('unsubscribe', (topics, client) => {
+            topics.forEach((topic) => this.listener?.onUnsubscribed(topic, client.id));
+        });
+    }
+    setListener(listener) {
+        this.listener = listener;
+    }
+    async start() {
+        this.server = net.createServer(this.aedes.handle);
+        await util_1.default.promisify((callback) => this.server.listen(this.port, callback))();
+        logger.info(`Started MQTT server on port ${this.port}`);
+    }
+    async stop() {
+        if (!this.aedes.closed) {
+            const closeAedes = util_1.default.promisify((callback) => this.aedes.close(callback))();
+            const closeServer = util_1.default.promisify((callback) => this.server.close(callback))();
+            await Promise.all([closeAedes, closeServer]);
+            logger.info('Stopped MQTT server');
+        }
+    }
+    publish(topic, payload) {
+        const packet = {
+            topic,
+            payload,
+            cmd: MqttServer.COMMAND_PUBLISH,
+            qos: MqttServer.QOS_EXACTLY_ONCE,
+            dup: false,
+            retain: false
+        };
+        this.aedes.publish(packet, (error) => {
+            if (error) {
+                logger.warn('Failed to publish', { error, topic });
+            }
+        });
+    }
+    static createAuthenicationHandler(apiAuthentication) {
+        return (_client, _username, password, done) => {
+            if ((0, apiAuthentication_1.isValidAuthentication)(password?.toString(), apiAuthentication)) {
+                done(null, true);
+            }
+            else {
+                const error = Object.assign(new Error(), {
+                    returnCode: (password !== undefined) ? MqttServer.BAD_USERNAME_OR_PASSWORD : MqttServer.NOT_AUTHORIZED
+                });
+                done(error, false);
+            }
+        };
+    }
+}
+exports.MqttServer = MqttServer;
+//# sourceMappingURL=MqttServer.js.map

package/dist/src/plugins/mqtt/MqttServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MqttServer.js","sourceRoot":"","sources":["../../../../src/plugins/mqtt/MqttServer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,yCAA0B;AAC1B,gDAAuB;AAEvB,0CAAuC;AACvC,+DAAkF;AAClF,kDAAyB;AAEzB,MAAM,MAAM,GAAG,IAAI,cAAM,CAAC,MAAM,CAAC,CAAA;AAQjC,MAAa,UAAU;IACX,MAAM,CAAC,eAAe,GAAG,SAAS,CAAA;IAClC,MAAM,CAAC,gBAAgB,GAAG,CAAC,CAAA;IAC3B,MAAM,CAAC,wBAAwB,GAAG,CAAC,CAAA;IACnC,MAAM,CAAC,cAAc,GAAG,CAAC,CAAA;IAEhB,IAAI,CAAQ;IACZ,KAAK,CAAO;IACrB,MAAM,CAAa;IACnB,QAAQ,CAAqB;IAErC,YAAY,IAAY,EAAE,iBAAqC;QAC3D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC;YACnB,YAAY,EAAE,UAAU,CAAC,0BAA0B,CAAC,iBAAiB,CAAC;SACzE,CAAC,CAAA;QACF,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;YACxC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC,CAAE,8CAA8C;gBAClE,IAAI,CAAC,QAAQ,EAAE,iBAAiB,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,CAAA;YACxF,CAAC;QACL,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,aAA8B,EAAE,MAAoB,EAAE,EAAE;YAChF,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;YACtE,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;QAC5E,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,MAAgB,EAAE,MAAoB,EAAE,EAAE;YACpE,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;QAC9E,CAAC,CAAC,CAAA;IACN,CAAC;IAED,WAAW,CAAC,QAA4B;QACpC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC5B,CAAC;IAED,KAAK,CAAC,KAAK;QACP,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QACjD,MAAM,cAAI,CAAC,SAAS,CAAC,CAAC,QAAa,EAAE,EAAE,CAAC,IAAI,CAAC,MAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAA;QACnF,MAAM,CAAC,IAAI,CAAC,+BAA+B,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;IAC3D,CAAC;IAED,KAAK,CAAC,IAAI;QACN,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACrB,MAAM,UAAU,GAAG,cAAI,CAAC,SAAS,CAAC,CAAC,QAAa,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAA;YAClF,MAAM,WAAW,GAAG,cAAI,CAAC,SAAS,CAAC,CAAC,QAAa,EAAE,EAAE,CAAC,IAAI,CAAC,MAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAA;YACrF,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAA;YAC5C,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;QACtC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,KAAa,EAAE,OAAe;QAClC,MAAM,MAAM,GAAwB;YAChC,KAAK;YACL,OAAO;YACP,GAAG,EAAE,UAAU,CAAC,eAAsB;YACtC,GAAG,EAAE,UAAU,CAAC,gBAAuB;YACvC,GAAG,EAAE,KAAK;YACV,MAAM,EAAE,KAAK;SAChB,CAAA;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;YACzC,IAAI,KAAK,EAAE,CAAC;gBACR,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;YACtD,CAAC;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAEO,MAAM,CAAC,0BAA0B,CAAC,iBAAqC;QAC3E,OAAO,CACH,OAAqB,EACrB,SAAuC,EACvC,QAAsC,EACtC,IAA8E,EAChF,EAAE;YACA,IAAI,IAAA,yCAAqB,EAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,iBAAiB,CAAC,EAAE,CAAC;gBACjE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YACpB,CAAC;iBAAM,CAAC;gBACJ,MAAM,KAAK,GAA4B,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,EAAE;oBAC9D,UAAU,EAAE,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC,CAAC,UAAU,CAAC,cAAc;iBACzG,CAAC,CAAA;gBACF,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;YACtB,CAAC;QACL,CAAC,CAAA;IACL,CAAC;;AAjFL,gCAkFC"}

package/dist/src/plugins/mqtt/config.schema.json

@@ -0,0 +1,26 @@
+{
+    "$id": "config.schema.json",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "description": "MQTT plugin configuration",
+    "additionalProperties": false,
+    "properties": {
+        "port": {
+            "type": "integer",
+            "description": "Port to start plugin on",
+            "default": 1883
+        },
+        "streamIdDomain": {
+            "type": "string",
+            "description": "All topics are mapped to streamIds by prepending the domain to the topic: streamIdDomain + '/' + topic"
+        },
+        "payloadMetadata": {
+            "type": "boolean",
+            "description": "The format of payloads: payload is wrapped as { content, metadata } or is a plain content JSON",
+            "default": false
+        },
+        "apiAuthentication": {
+            "$ref": "definitions.schema.json#/definitions/apiAuthenticationOverride"
+        }
+    }
+}

package/dist/src/plugins/operator/ConsistentHashRing.d.ts

@@ -0,0 +1,20 @@
+import { DhtAddress } from '@streamr/dht';
+import { StreamPartID } from '@streamr/protocol';
+/**
+ * A wrapper for "consistent-hash" library that provides us with additional guarantees such as
+ *
+ * (1) node insertion order doesn't affect result
+ *
+ * (2) minor variations in resource suffixes are properly assigned around
+ *
+ * See the corresponding test, ConstHash.test.ts, for details.
+ */
+export declare class ConsistentHashRing {
+    private readonly nodes;
+    private consistentHash?;
+    private readonly redundancyFactor;
+    constructor(redundancyFactor: number);
+    add(nodeId: DhtAddress): void;
+    remove(nodeId: DhtAddress): void;
+    get(streamPartId: StreamPartID): DhtAddress[];
+}

package/dist/src/plugins/operator/ConsistentHashRing.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsistentHashRing = void 0;
+const protocol_1 = require("@streamr/protocol");
+const consistent_hash_1 = __importDefault(require("consistent-hash"));
+/**
+ * Slight variations at the very end of a string will not result in the keys
+ * being sufficiently assigned around. By having the partition number first,
+ * we properly randomize the assignments of stream parts of a stream.
+ *
+ * TODO: use md5 instead?
+ */
+function formKey(streamPartId) {
+    const [streamId, partition] = protocol_1.StreamPartIDUtils.getStreamIDAndPartition(streamPartId);
+    return `${partition}#${streamId}`;
+}
+/**
+ * A wrapper for "consistent-hash" library that provides us with additional guarantees such as
+ *
+ * (1) node insertion order doesn't affect result
+ *
+ * (2) minor variations in resource suffixes are properly assigned around
+ *
+ * See the corresponding test, ConstHash.test.ts, for details.
+ */
+class ConsistentHashRing {
+    nodes = new Array();
+    consistentHash;
+    redundancyFactor;
+    constructor(redundancyFactor) {
+        this.redundancyFactor = redundancyFactor;
+    }
+    add(nodeId) {
+        if (!this.nodes.includes(nodeId)) {
+            this.nodes.push(nodeId);
+            this.consistentHash = undefined;
+        }
+    }
+    remove(nodeId) {
+        const idx = this.nodes.indexOf(nodeId);
+        if (idx !== -1) {
+            this.nodes.splice(idx, 1);
+            this.consistentHash = undefined;
+        }
+    }
+    get(streamPartId) {
+        if (this.consistentHash === undefined) {
+            this.consistentHash = new consistent_hash_1.default({
+                distribution: 'uniform'
+            });
+            this.nodes.sort();
+            for (const nodeId of this.nodes) {
+                this.consistentHash.add(nodeId);
+            }
+        }
+        const result = this.consistentHash.get(formKey(streamPartId), this.redundancyFactor);
+        return result ?? [];
+    }
+}
+exports.ConsistentHashRing = ConsistentHashRing;
+//# sourceMappingURL=ConsistentHashRing.js.map

package/dist/src/plugins/operator/ConsistentHashRing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConsistentHashRing.js","sourceRoot":"","sources":["../../../../src/plugins/operator/ConsistentHashRing.ts"],"names":[],"mappings":";;;;;;AACA,gDAAmE;AACnE,sEAA4C;AAE5C;;;;;;GAMG;AACH,SAAS,OAAO,CAAC,YAA0B;IACvC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG,4BAAiB,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAA;IACrF,OAAO,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAA;AACrC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAa,kBAAkB;IACV,KAAK,GAAG,IAAI,KAAK,EAAc,CAAA;IACxC,cAAc,CAAiB;IACtB,gBAAgB,CAAQ;IAEzC,YAAY,gBAAwB;QAChC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;IAC5C,CAAC;IAED,GAAG,CAAC,MAAkB;QAClB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YACvB,IAAI,CAAC,cAAc,GAAG,SAAS,CAAA;QACnC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAkB;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QACtC,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;YACb,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;YACzB,IAAI,CAAC,cAAc,GAAG,SAAS,CAAA;QACnC,CAAC;IACL,CAAC;IAED,GAAG,CAAC,YAA0B;QAC1B,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAc,CAAC;gBACrC,YAAY,EAAE,SAAS;aAC1B,CAAC,CAAA;YACF,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAA;YACjB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC9B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YACnC,CAAC;QACL,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACpF,OAAO,MAAsB,IAAI,EAAE,CAAA;IACvC,CAAC;CACJ;AArCD,gDAqCC"}

package/dist/src/plugins/operator/ContractFacade.d.ts

@@ -0,0 +1,80 @@
+/// <reference types="node" />
+import { Provider } from '@ethersproject/providers';
+import { Operator } from '@streamr/network-contracts';
+import { StreamID } from '@streamr/protocol';
+import { EthereumAddress, TheGraphClient } from '@streamr/utils';
+import { Overrides } from 'ethers';
+import { NetworkPeerDescriptor } from '@streamr/sdk';
+import { OperatorServiceConfig } from './OperatorPlugin';
+interface EarningsData {
+    sponsorshipAddresses: EthereumAddress[];
+    sumDataWei: bigint;
+    maxAllowedEarningsDataWei: bigint;
+}
+export declare const VOTE_KICK = "0x0000000000000000000000000000000000000000000000000000000000000001";
+export declare const VOTE_NO_KICK = "0x0000000000000000000000000000000000000000000000000000000000000000";
+export declare class ParseError extends Error {
+    readonly reasonText: string;
+    constructor(reasonText: string);
+}
+export declare function parsePartitionFromReviewRequestMetadata(metadataAsString: string | undefined): number | never;
+export type ReviewRequestListener = (sponsorship: EthereumAddress, operatorContractAddress: EthereumAddress, partition: number, votingPeriodStartTime: number, votingPeriodEndTime: number) => void;
+export interface SponsorshipResult {
+    sponsorshipAddress: EthereumAddress;
+    streamId: StreamID;
+    operatorCount: number;
+}
+export interface Flag {
+    id: string;
+    flaggingTimestamp: number;
+    target: {
+        id: string;
+    };
+    sponsorship: {
+        id: string;
+    };
+}
+export declare class ContractFacade {
+    private readonly operatorContract;
+    private readonly theGraphClient;
+    private readonly config;
+    constructor(operatorContract: Operator, theGraphClient: TheGraphClient, config: OperatorServiceConfig);
+    static createInstance(config: OperatorServiceConfig): ContractFacade;
+    writeHeartbeat(nodeDescriptor: NetworkPeerDescriptor): Promise<void>;
+    getTimestampOfLastHeartbeat(): Promise<number | undefined>;
+    getOperatorContractAddress(): EthereumAddress;
+    getSponsorshipsOfOperator(operatorAddress: EthereumAddress): Promise<SponsorshipResult[]>;
+    getExpiredFlags(sponsorships: EthereumAddress[], maxAgeInMs: number): Promise<Flag[]>;
+    getOperatorsInSponsorship(sponsorshipAddress: EthereumAddress): Promise<EthereumAddress[]>;
+    flag(sponsorship: EthereumAddress, operator: EthereumAddress, partition: number): Promise<void>;
+    getRandomOperator(): Promise<EthereumAddress | undefined>;
+    /**
+     * Find the sum of earnings in Sponsorships (that the Operator must withdraw before the sum reaches a limit),
+     * SUBJECT TO the constraints, set in the OperatorServiceConfig:
+     *  - only take at most maxSponsorshipsInWithdraw addresses (those with most earnings), or all if undefined
+     *  - only take sponsorships that have more than minSponsorshipEarningsInWithdraw, or all if undefined
+     */
+    getEarningsOf(operatorContractAddress: EthereumAddress, minSponsorshipEarningsInWithdraw: number, maxSponsorshipsInWithdraw: number): Promise<EarningsData>;
+    getMyEarnings(minSponsorshipEarningsInWithdraw: number, maxSponsorshipsInWithdraw: number): Promise<EarningsData>;
+    withdrawMyEarningsFromSponsorships(sponsorshipAddresses: EthereumAddress[]): Promise<void>;
+    triggerWithdraw(targetOperatorAddress: EthereumAddress, sponsorshipAddresses: EthereumAddress[]): Promise<void>;
+    private getOperatorAddresses;
+    pullStakedStreams(requiredBlockNumber: number): AsyncGenerator<{
+        sponsorship: {
+            id: string;
+            stream: {
+                id: string;
+            };
+        };
+    }>;
+    hasOpenFlag(operatorAddress: EthereumAddress, sponsorshipAddress: EthereumAddress): Promise<boolean>;
+    addReviewRequestListener(listener: ReviewRequestListener, abortSignal: AbortSignal): void;
+    getStreamId(sponsorshipAddress: string): Promise<StreamID>;
+    voteOnFlag(sponsorship: string, targetOperator: string, kick: boolean): Promise<void>;
+    closeFlag(sponsorship: string, targetOperator: string): Promise<void>;
+    addOperatorContractStakeEventListener(eventName: 'Staked' | 'Unstaked', listener: (sponsorship: string) => unknown): void;
+    removeOperatorContractStakeEventListener(eventName: 'Staked' | 'Unstaked', listener: (sponsorship: string) => unknown): void;
+    getProvider(): Provider;
+    getEthersOverrides(): Overrides;
+}
+export {};