@streamr/dht 100.0.0-testnet-two.1 → 100.0.0-testnet-two.2

package/test/unit/StoreManager.test.ts

@@ -1,19 +1,22 @@
 import { wait, waitForCondition } from '@streamr/utils'
-import crypto from 'crypto'
 import { range, sortBy } from 'lodash'
-import { Key } from 'readline'
 import { getDistance } from '../../src/dht/PeerManager'
 import { StoreManager } from '../../src/dht/store/StoreManager'
-import { NodeID, createRandomNodeId, getNodeIdFromBinary } from '../../src/helpers/nodeId'
+import {
+    DhtAddress,
+    createRandomDhtAddress,
+    getDhtAddressFromRaw,
+    getRawFromDhtAddress,
+} from '../../src/identifiers'
 import { NodeType, ReplicateDataRequest } from '../../src/proto/packages/dht/protos/DhtRpc'
 
 const DATA_ENTRY = {
-    key: createRandomNodeId(),
-    creator: crypto.randomBytes(20)
+    key: getRawFromDhtAddress(createRandomDhtAddress()),
+    creator: getRawFromDhtAddress(createRandomDhtAddress())
 }
 const NODES_CLOSEST_TO_DATA = sortBy(
-    range(5).map(() => createRandomNodeId()),
-    (id: Uint8Array) => getDistance(getNodeIdFromBinary(id), getNodeIdFromBinary(DATA_ENTRY.key))
+    range(5).map(() => createRandomDhtAddress()),
+    (id: DhtAddress) => getDistance(getRawFromDhtAddress(id), DATA_ENTRY.key)
 )
 
 describe('StoreManager', () => {
@@ -21,13 +24,13 @@ describe('StoreManager', () => {
     describe('new contact', () => {
 
         const createStoreManager = (
-            localNodeId: Uint8Array,
-            closestNeighbors: Uint8Array[],
+            localNodeId: DhtAddress,
+            closestNeighbors: DhtAddress[],
             replicateData: (request: ReplicateDataRequest) => unknown,
-            setStale: (key: Key, creator: NodeID, stale: boolean) => unknown
+            setStale: (key: DhtAddress, creator: DhtAddress, stale: boolean) => unknown
         ): StoreManager => {
             const getClosestNeighborsTo = () => {
-                return closestNeighbors.map((nodeId) => ({ nodeId, type: NodeType.NODEJS }))
+                return closestNeighbors.map((nodeId) => ({ nodeId: getRawFromDhtAddress(nodeId), type: NodeType.NODEJS }))
             }
             return new StoreManager({
                 rpcCommunicator: {
@@ -35,7 +38,7 @@ describe('StoreManager', () => {
                     registerRpcNotification: () => {}
                 } as any,
                 recursiveOperationManager: undefined as any,
-                localPeerDescriptor: { nodeId: localNodeId, type: NodeType.NODEJS },
+                localPeerDescriptor: { nodeId: getRawFromDhtAddress(localNodeId), type: NodeType.NODEJS },
                 localDataStore: { values: () => [DATA_ENTRY], setStale } as any,
                 serviceId: undefined as any,
                 highestTtl: undefined as any,
@@ -49,14 +52,14 @@ describe('StoreManager', () => {
 
             it('new node is within redundancy factor', async () => {
                 const replicateData = jest.fn<undefined, [ReplicateDataRequest]>()
-                const setStale = jest.fn<undefined, [Key, NodeID]>()
+                const setStale = jest.fn<undefined, [DhtAddress, DhtAddress]>()
                 const manager = createStoreManager(
                     NODES_CLOSEST_TO_DATA[0],
                     [NODES_CLOSEST_TO_DATA[1], NODES_CLOSEST_TO_DATA[3], NODES_CLOSEST_TO_DATA[4]],
                     replicateData,
                     setStale
                 )
-                manager.onNewContact({ nodeId: NODES_CLOSEST_TO_DATA[2], type: NodeType.NODEJS })
+                manager.onNewContact({ nodeId: getRawFromDhtAddress(NODES_CLOSEST_TO_DATA[2]), type: NodeType.NODEJS })
                 await waitForCondition(() => replicateData.mock.calls.length === 1)
                 expect(replicateData).toHaveBeenCalledWith({
                     entry: DATA_ENTRY
@@ -66,14 +69,14 @@ describe('StoreManager', () => {
     
             it('new node is not within redundancy factor', async () => {
                 const replicateData = jest.fn<undefined, [ReplicateDataRequest]>()
-                const setStale = jest.fn<undefined, [Key, NodeID]>()
+                const setStale = jest.fn<undefined, [DhtAddress, DhtAddress]>()
                 const manager = createStoreManager(
                     NODES_CLOSEST_TO_DATA[0],
                     [NODES_CLOSEST_TO_DATA[1], NODES_CLOSEST_TO_DATA[2], NODES_CLOSEST_TO_DATA[3]],
                     replicateData,
                     setStale
                 )
-                manager.onNewContact({ nodeId: NODES_CLOSEST_TO_DATA[4], type: NodeType.NODEJS })
+                manager.onNewContact({ nodeId: getRawFromDhtAddress(NODES_CLOSEST_TO_DATA[4]), type: NodeType.NODEJS })
                 await wait(50)
                 expect(replicateData).not.toHaveBeenCalled()
                 expect(setStale).not.toHaveBeenCalled()
@@ -84,14 +87,14 @@ describe('StoreManager', () => {
 
             it('this node is within redundancy factor', async () => {
                 const replicateData = jest.fn<undefined, [ReplicateDataRequest]>()
-                const setStale = jest.fn<undefined, [Key, NodeID]>()
+                const setStale = jest.fn<undefined, [DhtAddress, DhtAddress]>()
                 const manager = createStoreManager(
                     NODES_CLOSEST_TO_DATA[1],
                     [NODES_CLOSEST_TO_DATA[0], NODES_CLOSEST_TO_DATA[2], NODES_CLOSEST_TO_DATA[3]],
                     replicateData,
                     setStale
                 )
-                manager.onNewContact({ nodeId: NODES_CLOSEST_TO_DATA[4], type: NodeType.NODEJS })
+                manager.onNewContact({ nodeId: getRawFromDhtAddress(NODES_CLOSEST_TO_DATA[4]), type: NodeType.NODEJS })
                 await wait(50)
                 expect(replicateData).not.toHaveBeenCalled()
                 expect(setStale).not.toHaveBeenCalled()
@@ -99,30 +102,30 @@ describe('StoreManager', () => {
 
             it('this node is not within redundancy factor', async () => {
                 const replicateData = jest.fn<undefined, [ReplicateDataRequest]>()
-                const setStale = jest.fn<undefined, [Key, NodeID]>()
+                const setStale = jest.fn<undefined, [DhtAddress, DhtAddress]>()
                 const manager = createStoreManager(
                     NODES_CLOSEST_TO_DATA[3],
                     [NODES_CLOSEST_TO_DATA[0], NODES_CLOSEST_TO_DATA[1], NODES_CLOSEST_TO_DATA[2]],
                     replicateData,
                     setStale
                 )
-                manager.onNewContact({ nodeId: NODES_CLOSEST_TO_DATA[4], type: NodeType.NODEJS })
+                manager.onNewContact({ nodeId: getRawFromDhtAddress(NODES_CLOSEST_TO_DATA[4]), type: NodeType.NODEJS })
                 await wait(50)
                 expect(replicateData).not.toHaveBeenCalled()
                 expect(setStale).toHaveBeenCalledTimes(1)
-                expect(setStale).toHaveBeenCalledWith(DATA_ENTRY.key, getNodeIdFromBinary(DATA_ENTRY.creator), true)
+                expect(setStale).toHaveBeenCalledWith(getDhtAddressFromRaw(DATA_ENTRY.key), getDhtAddressFromRaw(DATA_ENTRY.creator), true)
             })
 
             it('this node has less than redundancyFactor neighbors', async () => {
                 const replicateData = jest.fn<undefined, [ReplicateDataRequest]>()
-                const setStale = jest.fn<undefined, [Key, NodeID]>()
+                const setStale = jest.fn<undefined, [DhtAddress, DhtAddress]>()
                 const manager = createStoreManager(
                     NODES_CLOSEST_TO_DATA[3],
                     [NODES_CLOSEST_TO_DATA[0], NODES_CLOSEST_TO_DATA[1]],
                     replicateData,
                     setStale
                 )
-                manager.onNewContact({ nodeId: NODES_CLOSEST_TO_DATA[4], type: NodeType.NODEJS })
+                manager.onNewContact({ nodeId: getRawFromDhtAddress(NODES_CLOSEST_TO_DATA[4]), type: NodeType.NODEJS })
                 await wait(50)
                 expect(replicateData).not.toHaveBeenCalled()
                 expect(setStale).toHaveBeenCalledTimes(0)

package/test/utils/customMatchers.ts

@@ -1,7 +1,8 @@
-import { areEqualBinaries, binaryToHex } from '@streamr/utils'
+import { areEqualBinaries } from '@streamr/utils'
 import { printExpected, printReceived } from 'jest-matcher-utils'
 import { isEqual } from 'lodash'
 import { ConnectivityMethod, NodeType, PeerDescriptor } from '../../src/proto/packages/dht/protos/DhtRpc'
+import { getDhtAddressFromRaw } from '../../src/identifiers'
 
 // we could ES2015 module syntax (https://jestjs.io/docs/expect#expectextendmatchers),
 // but the IDE doesn't find custom matchers if we do that
@@ -24,7 +25,7 @@ const toEqualPeerDescriptor = (
 ): jest.CustomMatcherResult => {
     const messages: string[] = []
     if (!areEqualBinaries(expected.nodeId, actual.nodeId)) {
-        messages.push(formErrorMessage('nodeId', binaryToHex(expected.nodeId), binaryToHex(actual.nodeId)))
+        messages.push(formErrorMessage('nodeId', getDhtAddressFromRaw(expected.nodeId), getDhtAddressFromRaw(actual.nodeId)))
     }
     if (!isEqual(expected.type, actual.type)) {
         const typeNames = { [NodeType.NODEJS]: 'NODEJS', [NodeType.BROWSER]: 'BROWSER' }

package/test/utils/mock/mockDataEntry.ts

@@ -1,10 +1,10 @@
 import { MessageType as MessageType$, ScalarType } from '@protobuf-ts/runtime'
 import { randomString } from '@streamr/utils'
-import crypto from 'crypto'
 import { Timestamp } from '../../../src/proto/google/protobuf/timestamp'
 import { Any } from '../../../src/proto/google/protobuf/any'
 import { DataEntry } from '../../../src/proto/packages/dht/protos/DhtRpc'
-import { createRandomNodeId } from '../../../src/helpers/nodeId'
+import { DhtAddress, createRandomDhtAddress, getRawFromDhtAddress } from '../../../src/identifiers'
+import { omit } from 'lodash'
 
 const MockData = new class extends MessageType$<{ foo: string }> {
     constructor() {
@@ -14,16 +14,18 @@ const MockData = new class extends MessageType$<{ foo: string }> {
     }
 }
 
-export const createMockDataEntry = (entry: Partial<DataEntry> = {}): DataEntry => {
+export const createMockDataEntry = (
+    entry: Partial<Omit<DataEntry, 'key' | 'creator'> & { key: DhtAddress, creator: DhtAddress }> = {}
+): DataEntry => {
     return { 
-        key: crypto.randomBytes(10),
+        key: getRawFromDhtAddress(entry.key ?? createRandomDhtAddress()),
         data: Any.pack({ foo: randomString(5) }, MockData),
-        creator: entry.creator ?? createRandomNodeId(),
+        creator: getRawFromDhtAddress(entry.creator ?? createRandomDhtAddress()),
         ttl: 10000,
         stale: false,
         deleted: false,
         createdAt: Timestamp.now(),
-        ...entry
+        ...omit(entry, 'key', 'creator')
     }
 }
 

package/test/utils/utils.ts

@@ -28,11 +28,11 @@ import { Empty } from '../../src/proto/google/protobuf/empty'
 import { Any } from '../../src/proto/google/protobuf/any'
 import { wait, waitForCondition } from '@streamr/utils'
 import { SimulatorTransport } from '../../src/connection/simulator/SimulatorTransport'
-import { createRandomNodeId } from '../../src/helpers/nodeId'
+import { DhtAddress, createRandomDhtAddress, getRawFromDhtAddress } from '../../src/identifiers'
 
 export const createMockPeerDescriptor = (opts?: Partial<Omit<PeerDescriptor, 'nodeId'>>): PeerDescriptor => {
     return {
-        nodeId: createRandomNodeId(),
+        nodeId: getRawFromDhtAddress(createRandomDhtAddress()),
         type: NodeType.NODEJS,
         ...opts
     }
@@ -40,13 +40,13 @@ export const createMockPeerDescriptor = (opts?: Partial<Omit<PeerDescriptor, 'no
 
 export const createMockConnectionDhtNode = async (
     simulator: Simulator,
-    nodeId?: Uint8Array,
+    nodeId?: DhtAddress,
     numberOfNodesPerKBucket?: number,
     maxConnections = 80,
     dhtJoinTimeout = 45000
 ): Promise<DhtNode> => {
     const peerDescriptor: PeerDescriptor = {
-        nodeId: nodeId ?? createRandomNodeId(),
+        nodeId: getRawFromDhtAddress(nodeId ?? createRandomDhtAddress()),
         type: NodeType.NODEJS,
         region: getRandomRegion()
     }

package/dist/src/helpers/nodeId.d.ts

@@ -1,6 +0,0 @@
-import { BrandedString } from '@streamr/utils';
-export declare const createRandomNodeId: () => Uint8Array;
-export type NodeID = BrandedString<'NodeID'>;
-export declare const areEqualNodeIds: (nodeId1: NodeID, nodeId2: NodeID) => boolean;
-export declare const getNodeIdFromDataKey: (key: Uint8Array) => NodeID;
-export declare const getNodeIdFromBinary: (id: Uint8Array) => NodeID;

package/dist/src/helpers/nodeId.js

@@ -1,31 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNodeIdFromBinary = exports.getNodeIdFromDataKey = exports.areEqualNodeIds = exports.createRandomNodeId = void 0;
-const utils_1 = require("@streamr/utils");
-const crypto_1 = __importDefault(require("crypto"));
-// https://www.scs.stanford.edu/~dm/home/papers/kpos.pdf
-const KADEMLIA_ID_LENGTH_IN_BYTES = 20;
-// TODO this should return NodeID
-const createRandomNodeId = () => {
-    return crypto_1.default.randomBytes(KADEMLIA_ID_LENGTH_IN_BYTES);
-};
-exports.createRandomNodeId = createRandomNodeId;
-// TODO remove this or add support for UInt8Array parameters
-const areEqualNodeIds = (nodeId1, nodeId2) => {
-    return nodeId1 === nodeId2;
-};
-exports.areEqualNodeIds = areEqualNodeIds;
-// TODO maybe this is not needed and we can use just getNodeIdFromBinary?
-const getNodeIdFromDataKey = (key) => {
-    return (0, exports.getNodeIdFromBinary)(key);
-};
-exports.getNodeIdFromDataKey = getNodeIdFromDataKey;
-// TODO should we have similar method to convert nodeId to bucketId (which is just hexToBinary)
-const getNodeIdFromBinary = (id) => {
-    return (0, utils_1.binaryToHex)(id);
-};
-exports.getNodeIdFromBinary = getNodeIdFromBinary;
-//# sourceMappingURL=nodeId.js.map

package/dist/src/helpers/nodeId.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeId.js","sourceRoot":"","sources":["../../../src/helpers/nodeId.ts"],"names":[],"mappings":";;;;;;AAAA,0CAA2D;AAC3D,oDAA2B;AAE3B,wDAAwD;AACxD,MAAM,2BAA2B,GAAG,EAAE,CAAA;AAEtC,iCAAiC;AAC1B,MAAM,kBAAkB,GAAG,GAAe,EAAE;IAC/C,OAAO,gBAAM,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAA;AAC1D,CAAC,CAAA;AAFY,QAAA,kBAAkB,sBAE9B;AAKD,4DAA4D;AACrD,MAAM,eAAe,GAAG,CAAC,OAAe,EAAE,OAAe,EAAW,EAAE;IACzE,OAAO,OAAO,KAAK,OAAO,CAAA;AAC9B,CAAC,CAAA;AAFY,QAAA,eAAe,mBAE3B;AAED,yEAAyE;AAClE,MAAM,oBAAoB,GAAG,CAAC,GAAe,EAAU,EAAE;IAC5D,OAAO,IAAA,2BAAmB,EAAC,GAAG,CAAC,CAAA;AACnC,CAAC,CAAA;AAFY,QAAA,oBAAoB,wBAEhC;AAED,+FAA+F;AACxF,MAAM,mBAAmB,GAAG,CAAC,EAAc,EAAU,EAAE;IAC1D,OAAO,IAAA,mBAAW,EAAC,EAAE,CAAsB,CAAA;AAC/C,CAAC,CAAA;AAFY,QAAA,mBAAmB,uBAE/B"}

package/src/helpers/nodeId.ts

@@ -1,28 +0,0 @@
-import { BrandedString, binaryToHex } from '@streamr/utils'
-import crypto from 'crypto'
-
-// https://www.scs.stanford.edu/~dm/home/papers/kpos.pdf
-const KADEMLIA_ID_LENGTH_IN_BYTES = 20
-
-// TODO this should return NodeID
-export const createRandomNodeId = (): Uint8Array => {
-    return crypto.randomBytes(KADEMLIA_ID_LENGTH_IN_BYTES)
-}
-
-// TODO rename the file to be "NodeID.ts" instead of "nodeId.ts"
-export type NodeID = BrandedString<'NodeID'>
-
-// TODO remove this or add support for UInt8Array parameters
-export const areEqualNodeIds = (nodeId1: NodeID, nodeId2: NodeID): boolean => {
-    return nodeId1 === nodeId2
-}
-
-// TODO maybe this is not needed and we can use just getNodeIdFromBinary?
-export const getNodeIdFromDataKey = (key: Uint8Array): NodeID => {
-    return getNodeIdFromBinary(key)
-}
-
-// TODO should we have similar method to convert nodeId to bucketId (which is just hexToBinary)
-export const getNodeIdFromBinary = (id: Uint8Array): NodeID => {
-    return binaryToHex(id) as unknown as NodeID
-}