@streamr/dht 100.0.0-pretestnet.4 → 100.0.0-rc.0

package/protos/DhtRpc.proto

@@ -10,6 +10,7 @@ import "packages/proto-rpc/protos/ProtoRpc.proto";
 
 service DhtNodeRpc {
   rpc getClosestPeers (ClosestPeersRequest) returns (ClosestPeersResponse);
+  rpc getClosestRingPeers (ClosestRingPeersRequest) returns (ClosestRingPeersResponse);
   rpc ping (PingRequest) returns (PingResponse);
   rpc leaveNotice (LeaveNotice) returns (google.protobuf.Empty);
 }
@@ -19,22 +20,21 @@ service RouterRpc {
   rpc forwardMessage (RouteMessageWrapper) returns (RouteMessageAck);
 }
 
-service FindRpc {
-  rpc routeFindRequest (RouteMessageWrapper) returns (RouteMessageAck);
+service RecursiveOperationRpc {
+  rpc routeRequest (RouteMessageWrapper) returns (RouteMessageAck);
 }
 
 service StoreRpc {
   rpc storeData (StoreDataRequest) returns (StoreDataResponse);
-  rpc migrateData (MigrateDataRequest) returns (MigrateDataResponse);
-  rpc deleteData (DeleteDataRequest) returns (DeleteDataResponse);
+  rpc replicateData (ReplicateDataRequest) returns (google.protobuf.Empty);
 }
 
-service FindSessionRpc {
-  rpc sendFindResponse(FindResponse) returns (google.protobuf.Empty);
+service RecursiveOperationSessionRpc {
+  rpc sendResponse(RecursiveOperationResponse) returns (google.protobuf.Empty);
 }
 
 service WebsocketConnectorRpc {
-  rpc requestConnection (WebsocketConnectionRequest) returns (WebsocketConnectionResponse);
+  rpc requestConnection (WebsocketConnectionRequest) returns (google.protobuf.Empty);
 }
 
 service WebrtcConnectorRpc {
@@ -47,25 +47,25 @@ service WebrtcConnectorRpc {
 service ConnectionLockRpc {
   rpc lockRequest (LockRequest) returns (LockResponse);
   rpc unlockRequest (UnlockRequest) returns (google.protobuf.Empty);
-  rpc gracefulDisconnect (DisconnectNotice) returns (DisconnectNoticeResponse);
+  rpc gracefulDisconnect (DisconnectNotice) returns (google.protobuf.Empty);
 }
 
 service ExternalApiRpc {
-  rpc externalFindData (ExternalFindDataRequest) returns (ExternalFindDataResponse);
+  rpc externalFetchData (ExternalFetchDataRequest) returns (ExternalFetchDataResponse);
   rpc externalStoreData (ExternalStoreDataRequest) returns (ExternalStoreDataResponse);
 }
 
 // Used inside RpcMessage
 
 message StoreDataRequest {
-  bytes kademliaId = 1;
+  bytes key = 1;
   google.protobuf.Any data = 2;
-  uint32 ttl = 3;
-  google.protobuf.Timestamp storerTime = 4;
+  bytes creator = 3;
+  google.protobuf.Timestamp createdAt = 4;
+  uint32 ttl = 5;
 }
 
 message StoreDataResponse {
-  string error = 1;
 }
 
 message ExternalStoreDataRequest {
@@ -77,35 +77,23 @@ message ExternalStoreDataResponse {
   repeated PeerDescriptor storers = 1;
 }
 
-message MigrateDataRequest {
-  DataEntry dataEntry = 1;
-}
-  
-message MigrateDataResponse {
-  string error = 1;
-}
-
-message DeleteDataRequest {
-  bytes kademliaId = 1;
-}
-
-message DeleteDataResponse {
-  bool deleted = 1;
+message ReplicateDataRequest {
+  DataEntry entry = 1;
 }
 
 message DataEntry {
-  PeerDescriptor storer = 1;
-  bytes kademliaId = 2;
-  google.protobuf.Any data = 3;
-  google.protobuf.Timestamp storedAt = 4; 
-  uint32 ttl = 5;   // milliseconds
-  bool stale = 6;
-  bool deleted = 7;
-  google.protobuf.Timestamp storerTime = 8;
+  bytes key = 1;
+  google.protobuf.Any data = 2;
+  bytes creator = 3;
+  google.protobuf.Timestamp createdAt = 4;
+  google.protobuf.Timestamp storedAt = 5; 
+  uint32 ttl = 6;   // milliseconds
+  bool stale = 7;
+  bool deleted = 8;
 }
 
 message ClosestPeersRequest {
-  bytes kademliaId = 1;
+  bytes nodeId = 1;
   string requestId = 2;
 }
 
@@ -114,15 +102,32 @@ message ClosestPeersResponse {
   string requestId = 2;
 }
 
-message FindRequest {
+message ClosestRingPeersRequest {
+  bytes ringId = 1;
+  string requestId = 2;
+}
+
+message ClosestRingPeersResponse {
+  repeated PeerDescriptor leftPeers = 1;
+  repeated PeerDescriptor rightPeers = 2;
+  string requestId = 3;
+}
+
+message RecursiveOperationRequest {
   string sessionId = 1;
-  bool fetchData = 2;
+  RecursiveOperation operation = 2;
 }
 
-message FindResponse {
+enum RecursiveOperation {
+  FIND_CLOSEST_NODES = 0;
+  FETCH_DATA = 1;
+  DELETE_DATA = 2;
+}
+
+message RecursiveOperationResponse {
   repeated PeerDescriptor closestConnectedPeers = 1;
   repeated DataEntry dataEntries = 2;
-  optional bool noCloserNodesFound = 3;
+  bool noCloserNodesFound = 3;
   repeated PeerDescriptor routingPath = 4;
 }
 
@@ -135,16 +140,19 @@ message PingResponse {
 }
 
 message LeaveNotice {
-  string serviceId = 1;
 }
 
 message PeerDescriptor {
-  bytes kademliaId = 1;
+  bytes nodeId = 1;
   NodeType type = 2;
   ConnectivityMethod udp = 3;
   ConnectivityMethod tcp = 4;
   ConnectivityMethod websocket = 5;
   optional uint32 region = 6;
+  optional uint32 ipAddress = 7;
+  optional bytes publicKey = 8;
+  // signature of fields 2-8
+  optional bytes signature = 9; 
 }
 
 message ConnectivityMethod {
@@ -156,7 +164,6 @@ message ConnectivityMethod {
 enum NodeType {
   NODEJS = 0;
   BROWSER = 1;
-  VIRTUAL = 3;
 }
 
 enum RpcResponseError {
@@ -167,20 +174,27 @@ enum RpcResponseError {
 }
 
 message RouteMessageWrapper {
-  PeerDescriptor sourcePeer = 1;
-  string requestId = 2;
-  PeerDescriptor destinationPeer = 3;
+  string requestId = 1;
+  PeerDescriptor sourcePeer = 2;
+  bytes target = 3;
   Message message = 4;
   repeated PeerDescriptor reachableThrough = 5;
   repeated PeerDescriptor routingPath = 6;
+  repeated string parallelRootNodeIds = 7;
 }
 
 message RouteMessageAck {
   string requestId = 1;
-  string error = 2;
+  optional RouteMessageError error = 2;
 }
 
-// Correspond to the MessageType Enum
+enum RouteMessageError {
+  NO_TARGETS = 0;
+  DUPLICATE = 1;
+  // TODO: can this be removed? If DhtNode is already stopped the server side requests
+  // should not be processed
+  STOPPED = 2;
+}
 
 message ConnectivityRequest {
   uint32 port = 1;
@@ -193,47 +207,42 @@ message ConnectivityResponse {
   string host = 1;
   string natType = 2;
   ConnectivityMethod websocket = 3;
+  uint32 ipAddress = 4;
+  string version = 5;
 }
 
 message HandshakeRequest {
   PeerDescriptor sourcePeerDescriptor = 1;
   optional PeerDescriptor targetPeerDescriptor = 2;
+  string version = 3;
 }
 
 message HandshakeResponse {
   PeerDescriptor sourcePeerDescriptor = 1;
   optional HandshakeError error = 2;
+  string version = 3;
 }
 
 enum HandshakeError {
   DUPLICATE_CONNECTION = 0;
   INVALID_TARGET_PEER_DESCRIPTOR = 1;
+  UNSUPPORTED_VERSION = 2;
 }
 
 // Wraps all messages
 
-enum MessageType {
-  RPC = 0;
-  CONNECTIVITY_REQUEST = 1;
-  CONNECTIVITY_RESPONSE = 2;
-  HANDSHAKE_REQUEST = 3;
-  HANDSHAKE_RESPONSE = 4;
-  FIND_REQUEST = 5;
-}
-
 message Message {
   string messageId = 1;
-  MessageType messageType = 2;
-  PeerDescriptor sourceDescriptor = 3;
-  PeerDescriptor targetDescriptor = 4;
-  string serviceId = 5; // id of the RPC service
+  PeerDescriptor sourceDescriptor = 2;
+  PeerDescriptor targetDescriptor = 3;
+  string serviceId = 4; // id of the RPC service
   oneof body {
+    protorpc.RpcMessage rpcMessage = 5;
     ConnectivityRequest connectivityRequest = 6;
     ConnectivityResponse connectivityResponse = 7;
     HandshakeRequest handshakeRequest = 8;
     HandshakeResponse handshakeResponse = 9;
-    protorpc.RpcMessage rpcMessage = 10;
-    FindRequest findRequest = 11;
+    RecursiveOperationRequest recursiveOperationRequest = 10;
   };
 }
 
@@ -243,10 +252,6 @@ message Message {
 message WebsocketConnectionRequest {
 }
 
-message WebsocketConnectionResponse {
-  bool accepted = 1;
-}
-
 // WebRTC
 message WebrtcConnectionRequest {
 }
@@ -277,7 +282,6 @@ message UnlockRequest {
 
 message LockResponse {
   bool accepted = 1;
-  optional bool reason = 2;
 }
 
 enum DisconnectMode {
@@ -289,14 +293,10 @@ message DisconnectNotice {
   DisconnectMode disconnectMode = 1;
 }
 
-message DisconnectNoticeResponse {
-}
-
-message ExternalFindDataRequest {
-  bytes kademliaId = 1;
+message ExternalFetchDataRequest {
+  bytes key = 1;
 }
 
-message ExternalFindDataResponse {
-  repeated DataEntry dataEntries = 1;
-  optional string error = 2;
+message ExternalFetchDataResponse {
+  repeated DataEntry entries = 1;
 }

package/src/connection/Connection.ts

@@ -1,6 +1,7 @@
 import EventEmitter from 'eventemitter3'
 import { PeerDescriptor } from '../proto/packages/dht/protos/DhtRpc'
 import { ConnectionID, ConnectionType, ConnectionEvents } from './IConnection'
+import { v4 as uuid } from 'uuid'
 
 export class Connection extends EventEmitter<ConnectionEvents> {
     public connectionId: ConnectionID
@@ -9,7 +10,7 @@ export class Connection extends EventEmitter<ConnectionEvents> {
     
     constructor(connectionType: ConnectionType) {
         super()
-        this.connectionId = new ConnectionID()
+        this.connectionId = createRandomConnectionId()
         this.connectionType = connectionType
     }
 
@@ -21,3 +22,7 @@ export class Connection extends EventEmitter<ConnectionEvents> {
         return this.peerDescriptor
     }
 }
+
+export const createRandomConnectionId = (): ConnectionID => {
+    return uuid() as ConnectionID
+}

package/src/connection/ConnectionLockHandler.ts

@@ -1,40 +1,40 @@
 // Connection locks are independent of the existence of connections
 // that is why this class is needed
 
-import { PeerIDKey } from '../helpers/PeerID'
+import { DhtAddress } from '../identifiers'
 
 export type LockID = string
 
 export class ConnectionLockHandler {
 
-    private localLocks: Map<PeerIDKey, Set<LockID>> = new Map()
-    private remoteLocks: Map<PeerIDKey, Set<LockID>> = new Map()
+    private localLocks: Map<DhtAddress, Set<LockID>> = new Map()
+    private remoteLocks: Map<DhtAddress, Set<LockID>> = new Map()
     // TODO: remove weakLocks use localLocks instead. When opening weakLocks from the ConnectioManager,
     // simply do not send lock requests.
-    private weakLocks: Set<PeerIDKey> = new Set()
+    private weakLocks: Map<DhtAddress, Set<LockID>> = new Map()
 
-    public getNumberOfLocalLockedConnections(): number {
+    public getLocalLockedConnectionCount(): number {
         return this.localLocks.size
     }
 
-    public getNumberOfRemoteLockedConnections(): number {
+    public getRemoteLockedConnectionCount(): number {
         return this.remoteLocks.size
     }
 
-    public getNumberOfWeakLockedConnections(): number {
+    public getWeakLockedConnectionCount(): number {
         return this.weakLocks.size
     }
 
-    public isLocalLocked(id: PeerIDKey, lockId?: LockID): boolean {
-        if (!lockId) {
+    public isLocalLocked(id: DhtAddress, lockId?: LockID): boolean {
+        if (lockId === undefined) {
             return this.localLocks.has(id)
         } else {
             return this.localLocks.has(id) && this.localLocks.get(id)!.has(lockId)
         }
     }
 
-    public isRemoteLocked(id: PeerIDKey, lockId?: LockID): boolean {
-        if (!lockId) {
+    public isRemoteLocked(id: DhtAddress, lockId?: LockID): boolean {
+        if (lockId === undefined) {
             return this.remoteLocks.has(id)
         } else {
             if (this.remoteLocks.has(id) && this.remoteLocks.get(id)!.has(lockId)) {
@@ -45,33 +45,36 @@ export class ConnectionLockHandler {
         }
     }
 
-    private isWeakLocked(id: PeerIDKey): boolean {
+    private isWeakLocked(id: DhtAddress): boolean {
         return this.weakLocks.has(id)
     }
 
-    public isLocked(id: PeerIDKey): boolean {
+    public isLocked(id: DhtAddress): boolean {
         return (this.isLocalLocked(id) || this.isRemoteLocked(id) || this.isWeakLocked(id))
     }
 
-    public addLocalLocked(id: PeerIDKey, lockId: LockID): void {
+    public addLocalLocked(id: DhtAddress, lockId: LockID): void {
         if (!this.localLocks.has(id)) {
             this.localLocks.set(id, new Set())
         }
         this.localLocks.get(id)!.add(lockId)
     }
 
-    public addRemoteLocked(id: PeerIDKey, lockId: LockID): void {
+    public addRemoteLocked(id: DhtAddress, lockId: LockID): void {
         if (!this.remoteLocks.has(id)) {
             this.remoteLocks.set(id, new Set())
         }
         this.remoteLocks.get(id)!.add(lockId)
     }
 
-    public addWeakLocked(id: PeerIDKey): void {
-        this.weakLocks.add(id)
+    public addWeakLocked(id: DhtAddress, lockId: LockID): void {
+        if (!this.weakLocks.has(id)) {
+            this.weakLocks.set(id, new Set())
+        }
+        this.weakLocks.get(id)!.add(lockId)
     }
 
-    public removeLocalLocked(id: PeerIDKey, lockId: LockID): void {
+    public removeLocalLocked(id: DhtAddress, lockId: LockID): void {
         if (this.localLocks.has(id)) {
             this.localLocks.get(id)?.delete(lockId)
             if (this.localLocks.get(id)?.size === 0) {
@@ -80,7 +83,7 @@ export class ConnectionLockHandler {
         }
     }
 
-    public removeRemoteLocked(id: PeerIDKey, lockId: LockID): void {
+    public removeRemoteLocked(id: DhtAddress, lockId: LockID): void {
         if (this.remoteLocks.has(id)) {
             this.remoteLocks.get(id)?.delete(lockId)
             if (this.remoteLocks.get(id)?.size === 0) {
@@ -89,11 +92,16 @@ export class ConnectionLockHandler {
         }
     }
 
-    public removeWeakLocked(id: PeerIDKey): void {
-        this.weakLocks.delete(id)
+    public removeWeakLocked(id: DhtAddress, lockId: LockID): void {
+        if (this.weakLocks.has(id)) {
+            this.weakLocks.get(id)?.delete(lockId)
+            if (this.weakLocks.get(id)?.size === 0) {
+                this.weakLocks.delete(id)
+            }
+        }
     }
 
-    public clearAllLocks(id: PeerIDKey): void {
+    public clearAllLocks(id: DhtAddress): void {
         this.localLocks.delete(id)
         this.remoteLocks.delete(id)
         this.weakLocks.delete(id)

package/src/connection/ConnectionLockRpcLocal.ts

@@ -1,10 +1,5 @@
 import { ServerCallContext } from '@protobuf-ts/runtime-rpc'
 import { Logger } from '@streamr/utils'
-import {
-    areEqualPeerDescriptors,
-    keyFromPeerDescriptor,
-    peerIdFromPeerDescriptor
-} from '../helpers/peerIdFromPeerDescriptor'
 import { Empty } from '../proto/google/protobuf/empty'
 import {
     DisconnectMode,
@@ -16,13 +11,13 @@ import {
 } from '../proto/packages/dht/protos/DhtRpc'
 import { IConnectionLockRpc } from '../proto/packages/dht/protos/DhtRpc.server'
 import { DhtCallContext } from '../rpc-protocol/DhtCallContext'
-import { PeerIDKey } from '../helpers/PeerID'
 import { getNodeIdOrUnknownFromPeerDescriptor } from './ConnectionManager'
 import { LockID } from './ConnectionLockHandler'
+import { DhtAddress, areEqualPeerDescriptors, getNodeIdFromPeerDescriptor } from '../identifiers'
 
 interface ConnectionLockRpcLocalConfig {
-    addRemoteLocked: (id: PeerIDKey, lockId: LockID) => void
-    removeRemoteLocked: (id: PeerIDKey, lockId: LockID) => void
+    addRemoteLocked: (id: DhtAddress, lockId: LockID) => void
+    removeRemoteLocked: (id: DhtAddress, lockId: LockID) => void
     closeConnection: (peerDescriptor: PeerDescriptor, gracefulLeave: boolean, reason?: string) => void
     getLocalPeerDescriptor: () => PeerDescriptor
 }
@@ -39,14 +34,14 @@ export class ConnectionLockRpcLocal implements IConnectionLockRpc {
 
     async lockRequest(lockRequest: LockRequest, context: ServerCallContext): Promise<LockResponse> {
         const senderPeerDescriptor = (context as DhtCallContext).incomingSourceDescriptor!
-        const remotePeerId = peerIdFromPeerDescriptor(senderPeerDescriptor)
         if (areEqualPeerDescriptors(senderPeerDescriptor, this.config.getLocalPeerDescriptor())) {
             const response: LockResponse = {
                 accepted: false
             }
             return response
         }
-        this.config.addRemoteLocked(remotePeerId.toKey(), lockRequest.lockId)
+        const remoteNodeId = getNodeIdFromPeerDescriptor(senderPeerDescriptor)
+        this.config.addRemoteLocked(remoteNodeId, lockRequest.lockId)
         const response: LockResponse = {
             accepted: true
         }
@@ -55,8 +50,8 @@ export class ConnectionLockRpcLocal implements IConnectionLockRpc {
 
     async unlockRequest(unlockRequest: UnlockRequest, context: ServerCallContext): Promise<Empty> {
         const senderPeerDescriptor = (context as DhtCallContext).incomingSourceDescriptor!
-        const peerIdKey = keyFromPeerDescriptor(senderPeerDescriptor)
-        this.config.removeRemoteLocked(peerIdKey, unlockRequest.lockId)
+        const nodeId = getNodeIdFromPeerDescriptor(senderPeerDescriptor)
+        this.config.removeRemoteLocked(nodeId, unlockRequest.lockId)
         return {}
     }
 

package/src/connection/ConnectionLockRpcRemote.ts

@@ -1,23 +1,13 @@
 import { Logger } from '@streamr/utils'
-import { ProtoRpcClient } from '@streamr/proto-rpc'
-import { IConnectionLockRpcClient } from '../proto/packages/dht/protos/DhtRpc.client'
-import { LockRequest, UnlockRequest, PeerDescriptor, DisconnectNotice, DisconnectMode } from '../proto/packages/dht/protos/DhtRpc'
-import * as Err from '../helpers/errors'
-import { getNodeIdFromPeerDescriptor } from '../helpers/peerIdFromPeerDescriptor'
-import { Remote } from '../dht/contact/Remote'
+import { RpcRemote } from '../dht/contact/RpcRemote'
+import { DisconnectMode, DisconnectNotice, LockRequest, UnlockRequest } from '../proto/packages/dht/protos/DhtRpc'
+import { ConnectionLockRpcClient } from '../proto/packages/dht/protos/DhtRpc.client'
 import { LockID } from './ConnectionLockHandler'
+import { getNodeIdFromPeerDescriptor } from '../identifiers'
 
 const logger = new Logger(module)
 
-export class ConnectionLockRpcRemote extends Remote<IConnectionLockRpcClient> {
-
-    constructor(
-        localPeerDescriptor: PeerDescriptor,
-        targetPeerDescriptor: PeerDescriptor,
-        client: ProtoRpcClient<IConnectionLockRpcClient>
-    ) {
-        super(localPeerDescriptor, targetPeerDescriptor, 'DUMMY', client)
-    }
+export class ConnectionLockRpcRemote extends RpcRemote<ConnectionLockRpcClient> {
 
     public async lockRequest(lockId: LockID): Promise<boolean> {
         logger.trace(`Requesting locked connection to ${getNodeIdFromPeerDescriptor(this.getPeerDescriptor())}`)
@@ -29,7 +19,7 @@ export class ConnectionLockRpcRemote extends Remote<IConnectionLockRpcClient> {
             const res = await this.getClient().lockRequest(request, options)
             return res.accepted
         } catch (err) {
-            logger.debug(new Err.ConnectionLocker('Connection lock rejected', err).stack!)
+            logger.debug('Connection lock rejected', { error: err })
             return false
         }
     }
@@ -53,9 +43,9 @@ export class ConnectionLockRpcRemote extends Remote<IConnectionLockRpcClient> {
             disconnectMode
         }
         const options = this.formDhtRpcOptions({
-            doNotConnect: true,
-            doNotMindStopped: true,
-            timeout: 2000
+            connect: false,
+            sendIfStopped: true,
+            timeout: 2000  // TODO use config option or named constant?
         })
         await this.getClient().gracefulDisconnect(request, options)
     }