@streamr/dht 0.0.1-tatum.0

package/.eslintignore

@@ -0,0 +1,5 @@
+node_modules/**
+coverage/**
+dist/**
+.idea/**
+src/proto/**

package/.eslintrc

@@ -0,0 +1,3 @@
+{
+    "extends": "../../.eslintrc.js"
+}

package/README.md

@@ -0,0 +1,38 @@
+# @streamr/dht (WIP)
+
+An implementation of the Kademlia-based Streamr DHT used for the trackerless network.
+
+## Generating Protobuf code
+
+Auto-generated protobuf/gRPC code is compiled during the build process.
+```bash
+  npm run build
+```
+
+Alternatively
+```bash
+  npm run prebuild
+  # Or
+  ./proto.sh
+```
+
+## Running DHT simulations
+
+Generate test data
+
+```bash
+npm run prepare-dht-simulation
+```
+
+Run simulation
+
+```bash
+npm run run-dht-simulation
+```
+
+In order to change number of nodes, or other simulation settings,
+
+* Edit the chages to the file 'test/simulation/data/generatedhtids.ts'.
+* Then generate new test data by running 'npm run prepare-dht-simulation'
+* Edit the same changes to file 'src/simulation/DhtSimulation.ts'
+* Run the simulation with new settings using 'npm run run-dht-simulation '

package/dist/src/connection/Connection.d.ts

@@ -0,0 +1,11 @@
+import EventEmitter from 'eventemitter3';
+import { PeerDescriptor } from '../proto/packages/dht/protos/DhtRpc';
+import { ConnectionID, ConnectionType, ConnectionEvents } from './IConnection';
+export declare class Connection extends EventEmitter<ConnectionEvents> {
+    connectionId: ConnectionID;
+    connectionType: ConnectionType;
+    private peerDescriptor?;
+    constructor(connectionType: ConnectionType);
+    setPeerDescriptor(peerDescriptor: PeerDescriptor): void;
+    getPeerDescriptor(): PeerDescriptor | undefined;
+}

package/dist/src/connection/Connection.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connection = void 0;
+const eventemitter3_1 = __importDefault(require("eventemitter3"));
+const IConnection_1 = require("./IConnection");
+class Connection extends eventemitter3_1.default {
+    constructor(connectionType) {
+        super();
+        this.connectionId = new IConnection_1.ConnectionID();
+        this.connectionType = connectionType;
+    }
+    setPeerDescriptor(peerDescriptor) {
+        this.peerDescriptor = peerDescriptor;
+    }
+    getPeerDescriptor() {
+        return this.peerDescriptor;
+    }
+}
+exports.Connection = Connection;
+//# sourceMappingURL=Connection.js.map

package/dist/src/connection/Connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Connection.js","sourceRoot":"","sources":["../../../src/connection/Connection.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAwC;AAExC,+CAA8E;AAE9E,MAAa,UAAW,SAAQ,uBAA8B;IAK1D,YAAY,cAA8B;QACtC,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,YAAY,GAAG,IAAI,0BAAY,EAAE,CAAA;QACtC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;IACxC,CAAC;IAED,iBAAiB,CAAC,cAA8B;QAC5C,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;IACxC,CAAC;IAED,iBAAiB;QACb,OAAO,IAAI,CAAC,cAAc,CAAA;IAC9B,CAAC;CACJ;AAlBD,gCAkBC"}

package/dist/src/connection/ConnectionLockHandler.d.ts

@@ -0,0 +1,23 @@
+import { PeerIDKey } from '../helpers/PeerID';
+type ServiceName = string;
+export declare class ConnectionLockHandler {
+    private localLocks;
+    private remoteLocks;
+    private weakLocks;
+    getNumberOfLocalLockedConnections(): number;
+    getNumberOfRemoteLockedConnections(): number;
+    getNumberOfWeakLockedConnections(): number;
+    isLocalLocked(id: PeerIDKey, serviceName?: ServiceName): boolean;
+    isRemoteLocked(id: PeerIDKey, serviceName?: ServiceName): boolean;
+    isWeakLocked(id: PeerIDKey): boolean;
+    isLocked(id: PeerIDKey): boolean;
+    addLocalLocked(id: PeerIDKey, serviceName: ServiceName): void;
+    addRemoteLocked(id: PeerIDKey, serviceName: ServiceName): void;
+    addWeakLocked(id: PeerIDKey): void;
+    removeLocalLocked(id: PeerIDKey, serviceName: ServiceName): void;
+    removeRemoteLocked(id: PeerIDKey, serviceName: ServiceName): void;
+    removeWeakLocked(id: PeerIDKey): void;
+    clearAllLocks(id: PeerIDKey): void;
+    clear(): void;
+}
+export {};

package/dist/src/connection/ConnectionLockHandler.js

@@ -0,0 +1,94 @@
+"use strict";
+// Connection locks are independent of the existence of connections
+// that is why this class is needed
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionLockHandler = void 0;
+class ConnectionLockHandler {
+    constructor() {
+        this.localLocks = new Map();
+        this.remoteLocks = new Map();
+        this.weakLocks = new Set();
+    }
+    getNumberOfLocalLockedConnections() {
+        return this.localLocks.size;
+    }
+    getNumberOfRemoteLockedConnections() {
+        return this.remoteLocks.size;
+    }
+    getNumberOfWeakLockedConnections() {
+        return this.weakLocks.size;
+    }
+    isLocalLocked(id, serviceName) {
+        if (!serviceName) {
+            return this.localLocks.has(id);
+        }
+        else {
+            return this.localLocks.has(id) && this.localLocks.get(id).has(serviceName);
+        }
+    }
+    isRemoteLocked(id, serviceName) {
+        if (!serviceName) {
+            return this.remoteLocks.has(id);
+        }
+        else {
+            if (this.remoteLocks.has(id) && this.remoteLocks.get(id).has(serviceName)) {
+                return true;
+            }
+            else {
+                return false;
+            }
+        }
+    }
+    isWeakLocked(id) {
+        return this.weakLocks.has(id);
+    }
+    isLocked(id) {
+        return (this.isLocalLocked(id) || this.isRemoteLocked(id) || this.isWeakLocked(id));
+    }
+    addLocalLocked(id, serviceName) {
+        if (!this.localLocks.has(id)) {
+            this.localLocks.set(id, new Set());
+        }
+        this.localLocks.get(id).add(serviceName);
+    }
+    addRemoteLocked(id, serviceName) {
+        if (!this.remoteLocks.has(id)) {
+            this.remoteLocks.set(id, new Set());
+        }
+        this.remoteLocks.get(id).add(serviceName);
+    }
+    addWeakLocked(id) {
+        this.weakLocks.add(id);
+    }
+    removeLocalLocked(id, serviceName) {
+        if (this.localLocks.has(id)) {
+            this.localLocks.get(id)?.delete(serviceName);
+            if (this.localLocks.get(id)?.size === 0) {
+                this.localLocks.delete(id);
+            }
+        }
+    }
+    removeRemoteLocked(id, serviceName) {
+        if (this.remoteLocks.has(id)) {
+            this.remoteLocks.get(id)?.delete(serviceName);
+            if (this.remoteLocks.get(id)?.size === 0) {
+                this.remoteLocks.delete(id);
+            }
+        }
+    }
+    removeWeakLocked(id) {
+        this.weakLocks.delete(id);
+    }
+    clearAllLocks(id) {
+        this.localLocks.delete(id);
+        this.remoteLocks.delete(id);
+        this.weakLocks.delete(id);
+    }
+    clear() {
+        this.localLocks.clear();
+        this.remoteLocks.clear();
+        this.weakLocks.clear();
+    }
+}
+exports.ConnectionLockHandler = ConnectionLockHandler;
+//# sourceMappingURL=ConnectionLockHandler.js.map

package/dist/src/connection/ConnectionLockHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectionLockHandler.js","sourceRoot":"","sources":["../../../src/connection/ConnectionLockHandler.ts"],"names":[],"mappings":";AAAA,mEAAmE;AACnE,mCAAmC;;;AAMnC,MAAa,qBAAqB;IAAlC;QAEY,eAAU,GAAqC,IAAI,GAAG,EAAE,CAAA;QACxD,gBAAW,GAAqC,IAAI,GAAG,EAAE,CAAA;QACzD,cAAS,GAAmB,IAAI,GAAG,EAAE,CAAA;IA6FjD,CAAC;IA3FU,iCAAiC;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAA;IAC/B,CAAC;IAEM,kCAAkC;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;IAChC,CAAC;IAEM,gCAAgC;QACnC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAA;IAC9B,CAAC;IAEM,aAAa,CAAC,EAAa,EAAE,WAAyB;QACzD,IAAI,CAAC,WAAW,EAAE;YACd,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;SACjC;aAAM;YACH,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;SAC9E;IACL,CAAC;IAEM,cAAc,CAAC,EAAa,EAAE,WAAyB;QAC1D,IAAI,CAAC,WAAW,EAAE;YACd,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;SAClC;aAAM;YACH,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAE,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;gBACxE,OAAO,IAAI,CAAA;aACd;iBAAM;gBACH,OAAO,KAAK,CAAA;aACf;SACJ;IACL,CAAC;IAEM,YAAY,CAAC,EAAa;QAC7B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IACjC,CAAC;IAEM,QAAQ,CAAC,EAAa;QACzB,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAA;IACvF,CAAC;IAEM,cAAc,CAAC,EAAa,EAAE,WAAwB;QACzD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YAC1B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,GAAG,EAAE,CAAC,CAAA;SACrC;QACD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IAC7C,CAAC;IAEM,eAAe,CAAC,EAAa,EAAE,WAAwB;QAC1D,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YAC3B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,GAAG,EAAE,CAAC,CAAA;SACtC;QACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IAC9C,CAAC;IAEM,aAAa,CAAC,EAAa;QAC9B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAC1B,CAAC;IAEM,iBAAiB,CAAC,EAAa,EAAE,WAAwB;QAC5D,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YACzB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC,CAAA;YAC5C,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,KAAK,CAAC,EAAE;gBACrC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;aAC7B;SACJ;IACL,CAAC;IAEM,kBAAkB,CAAC,EAAa,EAAE,WAAwB;QAC7D,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YAC1B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC,CAAA;YAC7C,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,KAAK,CAAC,EAAE;gBACtC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;aAC9B;SACJ;IACL,CAAC;IAEM,gBAAgB,CAAC,EAAa;QACjC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IAC7B,CAAC;IAEM,aAAa,CAAC,EAAa;QAC9B,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QAC1B,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QAC3B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IAC7B,CAAC;IAEM,KAAK;QACR,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAA;QACvB,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAA;QACxB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAA;IAC1B,CAAC;CACJ;AAjGD,sDAiGC"}

package/dist/src/connection/ConnectionManager.d.ts

@@ -0,0 +1,94 @@
+import { EventEmitter } from 'eventemitter3';
+import { ConnectivityResponse, Message, PeerDescriptor } from '../proto/packages/dht/protos/DhtRpc';
+import { PeerIDKey } from '../helpers/PeerID';
+import { ITransport, TransportEvents } from '../transport/ITransport';
+import { IceServer } from './WebRTC/WebRtcConnector';
+import { MetricsContext } from '@streamr/utils';
+import { ManagedConnection } from './ManagedConnection';
+import { Simulator } from './Simulator/Simulator';
+export declare class ConnectionManagerConfig {
+    transportLayer?: ITransport;
+    webSocketHost?: string;
+    webSocketPort?: number;
+    entryPoints?: PeerDescriptor[];
+    nodeName?: string;
+    maxConnections: number;
+    iceServers?: IceServer[];
+    metricsContext?: MetricsContext;
+    webrtcAllowPrivateAddresses?: boolean;
+    webrtcDatachannelBufferThresholdLow?: number;
+    webrtcDatachannelBufferThresholdHigh?: number;
+    webrtcNewConnectionTimeout?: number;
+    simulator?: Simulator;
+    ownPeerDescriptor?: PeerDescriptor;
+    serviceIdPrefix?: string;
+    constructor(conf: Partial<ConnectionManagerConfig>);
+}
+export declare enum NatType {
+    OPEN_INTERNET = "open_internet",
+    UNKNOWN = "unknown"
+}
+type ServiceId = string;
+export type PeerDescriptorGeneratorCallback = (connectivityResponse: ConnectivityResponse) => PeerDescriptor;
+interface ConnectionManagerEvents {
+    newConnection: (connection: ManagedConnection) => void;
+}
+export interface ConnectionLocker {
+    lockConnection(targetDescriptor: PeerDescriptor, serviceId: ServiceId): void;
+    unlockConnection(targetDescriptor: PeerDescriptor, serviceId: ServiceId): void;
+    weakLockConnection(targetDescriptor: PeerDescriptor): void;
+    weakUnlockConnection(targetDescriptor: PeerDescriptor): void;
+}
+export type Events = TransportEvents & ConnectionManagerEvents;
+export declare class ConnectionManager extends EventEmitter<Events> implements ITransport, ConnectionLocker {
+    static PROTOCOL_VERSION: string;
+    private config;
+    private readonly metricsContext;
+    private ownPeerDescriptor?;
+    private readonly messageDuplicateDetector;
+    private readonly metrics;
+    private locks;
+    private connections;
+    private webSocketConnector?;
+    private webrtcConnector?;
+    private simulatorConnector?;
+    private rpcCommunicator?;
+    private disconnectorIntervalRef?;
+    private serviceId;
+    private state;
+    constructor(conf: Partial<ConnectionManagerConfig>);
+    garbageCollectConnections(maxConnections: number, lastUsedLimit: number): void;
+    start(peerDescriptorGeneratorCallback?: PeerDescriptorGeneratorCallback): Promise<void>;
+    stop(): Promise<void>;
+    getConnectionTo(id: PeerIDKey): ManagedConnection;
+    getNumberOfLocalLockedConnections(): number;
+    getNumberOfRemoteLockedConnections(): number;
+    getNumberOfWeakLockedConnections(): number;
+    send(message: Message, doNotConnect?: boolean, doNotMindStopped?: boolean): Promise<void>;
+    private createConnection;
+    getConnection(peerDescriptor: PeerDescriptor): ManagedConnection | undefined;
+    getPeerDescriptor(): PeerDescriptor;
+    hasConnection(peerDescriptor: PeerDescriptor): boolean;
+    hasLocalLockedConnection(peerDescriptor: PeerDescriptor, _serviceId?: ServiceId): boolean;
+    hasRemoteLockedConnection(peerDescriptor: PeerDescriptor, _serviceId?: ServiceId): boolean;
+    canConnect(peerDescriptor: PeerDescriptor, _ip: string, _port: number): boolean;
+    handleMessage(message: Message): void;
+    private onData;
+    private onConnected;
+    private onDisconnected;
+    private incomingConnectionCallback;
+    private acceptIncomingConnection;
+    private closeConnection;
+    lockConnection(targetDescriptor: PeerDescriptor, serviceId: ServiceId): void;
+    unlockConnection(targetDescriptor: PeerDescriptor, serviceId: ServiceId): void;
+    weakLockConnection(targetDescriptor: PeerDescriptor): void;
+    weakUnlockConnection(targetDescriptor: PeerDescriptor): void;
+    private gracefullyDisconnectAsync;
+    private doGracefullyDisconnectAsync;
+    getAllConnectionPeerDescriptors(): PeerDescriptor[];
+    private lockRequest;
+    private unlockRequest;
+    private gracefulDisconnect;
+    private onConnectionCountChange;
+}
+export {};