@libp2p/kad-dht 9.3.8 → 10.0.0

package/package.json

@@ -1,23 +1,19 @@
 {
   "name": "@libp2p/kad-dht",
-  "version": "9.3.8",
+  "version": "10.0.0",
   "description": "JavaScript implementation of the Kad-DHT for libp2p",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/libp2p/js-libp2p-kad-dht#readme",
+  "homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/kad-dht#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/libp2p/js-libp2p-kad-dht.git"
+    "url": "git+https://github.com/libp2p/js-libp2p.git"
   },
   "bugs": {
-    "url": "https://github.com/libp2p/js-libp2p-kad-dht/issues"
+    "url": "https://github.com/libp2p/js-libp2p/issues"
   },
   "keywords": [
     "IPFS"
   ],
-  "engines": {
-    "node": ">=16.0.0",
-    "npm": ">=7.0.0"
-  },
   "type": "module",
   "types": "./dist/src/index.d.ts",
   "files": [
@@ -41,91 +37,6 @@
       "src/message/dht.d.ts"
     ]
   },
-  "release": {
-    "branches": [
-      "master"
-    ],
-    "plugins": [
-      [
-        "@semantic-release/commit-analyzer",
-        {
-          "preset": "conventionalcommits",
-          "releaseRules": [
-            {
-              "breaking": true,
-              "release": "major"
-            },
-            {
-              "revert": true,
-              "release": "patch"
-            },
-            {
-              "type": "feat",
-              "release": "minor"
-            },
-            {
-              "type": "fix",
-              "release": "patch"
-            },
-            {
-              "type": "docs",
-              "release": "patch"
-            },
-            {
-              "type": "test",
-              "release": "patch"
-            },
-            {
-              "type": "deps",
-              "release": "patch"
-            },
-            {
-              "scope": "no-release",
-              "release": false
-            }
-          ]
-        }
-      ],
-      [
-        "@semantic-release/release-notes-generator",
-        {
-          "preset": "conventionalcommits",
-          "presetConfig": {
-            "types": [
-              {
-                "type": "feat",
-                "section": "Features"
-              },
-              {
-                "type": "fix",
-                "section": "Bug Fixes"
-              },
-              {
-                "type": "chore",
-                "section": "Trivial Changes"
-              },
-              {
-                "type": "docs",
-                "section": "Documentation"
-              },
-              {
-                "type": "deps",
-                "section": "Dependencies"
-              },
-              {
-                "type": "test",
-                "section": "Tests"
-              }
-            ]
-          }
-        }
-      ],
-      "@semantic-release/changelog",
-      "@semantic-release/npm",
-      "@semantic-release/github",
-      "@semantic-release/git"
-    ]
-  },
   "scripts": {
     "clean": "aegir clean",
     "lint": "aegir lint",
@@ -137,46 +48,32 @@
     "test:chrome-webworker": "aegir test -t webworker",
     "test:firefox": "aegir test -t browser -- --browser firefox",
     "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
-    "dep-check": "aegir dep-check -i protons -i events",
-    "release": "aegir release",
-    "docs": "aegir docs"
+    "dep-check": "aegir dep-check -i events"
   },
   "dependencies": {
-    "@libp2p/crypto": "^1.0.4",
-    "@libp2p/interface-address-manager": "^3.0.0",
-    "@libp2p/interface-connection": "^5.0.1",
-    "@libp2p/interface-connection-manager": "^3.0.0",
-    "@libp2p/interface-content-routing": "^2.1.0",
-    "@libp2p/interface-metrics": "^4.0.0",
-    "@libp2p/interface-peer-discovery": "^2.0.0",
-    "@libp2p/interface-peer-id": "^2.0.0",
-    "@libp2p/interface-peer-info": "^1.0.3",
-    "@libp2p/interface-peer-routing": "^1.1.0",
-    "@libp2p/interface-peer-store": "^2.0.0",
-    "@libp2p/interface-registrar": "^2.0.11",
-    "@libp2p/interfaces": "^3.2.0",
-    "@libp2p/logger": "^2.0.1",
-    "@libp2p/peer-collections": "^3.0.0",
-    "@libp2p/peer-id": "^2.0.0",
-    "@libp2p/record": "^3.0.0",
-    "@libp2p/topology": "^4.0.0",
-    "@multiformats/multiaddr": "^12.0.0",
-    "@types/sinon": "^10.0.14",
+    "@libp2p/crypto": "^2.0.0",
+    "@libp2p/interface": "^0.1.0",
+    "@libp2p/interface-internal": "^0.1.0",
+    "@libp2p/logger": "^3.0.0",
+    "@libp2p/peer-collections": "^4.0.0",
+    "@libp2p/peer-id": "^3.0.0",
+    "@multiformats/multiaddr": "^12.1.3",
+    "@types/sinon": "^10.0.15",
     "abortable-iterator": "^5.0.1",
     "any-signal": "^4.1.1",
     "datastore-core": "^9.0.1",
     "events": "^3.3.0",
     "hashlru": "^2.3.0",
-    "interface-datastore": "^8.0.0",
-    "it-all": "^3.0.1",
-    "it-drain": "^3.0.1",
+    "interface-datastore": "^8.2.0",
+    "it-all": "^3.0.2",
+    "it-drain": "^3.0.2",
     "it-first": "^3.0.1",
     "it-length": "^3.0.1",
-    "it-length-prefixed": "^9.0.0",
-    "it-map": "^3.0.1",
+    "it-length-prefixed": "^9.0.1",
+    "it-map": "^3.0.3",
     "it-merge": "^3.0.0",
     "it-parallel": "^3.0.0",
-    "it-pipe": "^3.0.0",
+    "it-pipe": "^3.0.1",
     "it-stream-types": "^2.0.1",
     "it-take": "^3.0.1",
     "multiformats": "^12.0.1",
@@ -186,40 +83,34 @@
     "private-ip": "^3.0.0",
     "progress-events": "^1.0.0",
     "protons-runtime": "^5.0.0",
-    "uint8arraylist": "^2.0.0",
-    "uint8arrays": "^4.0.2",
+    "uint8arraylist": "^2.4.3",
+    "uint8arrays": "^4.0.4",
     "varint": "^6.0.0"
   },
   "devDependencies": {
-    "@libp2p/interface-libp2p": "^3.0.0",
-    "@libp2p/interface-mocks": "^12.0.0",
-    "@libp2p/peer-id-factory": "^2.0.0",
-    "@libp2p/peer-store": "^8.0.0",
+    "@libp2p/interface-compliance-tests": "^4.0.0",
+    "@libp2p/peer-id-factory": "^3.0.0",
+    "@libp2p/peer-store": "^9.0.0",
     "@types/lodash.random": "^3.2.6",
     "@types/lodash.range": "^3.2.6",
     "@types/varint": "^6.0.0",
     "@types/which": "^3.0.0",
-    "aegir": "^39.0.5",
+    "aegir": "^40.0.1",
     "datastore-level": "^10.0.0",
     "delay": "^6.0.0",
-    "execa": "^7.0.0",
+    "execa": "^7.1.1",
     "it-filter": "^3.0.1",
     "it-last": "^3.0.1",
     "lodash.random": "^3.2.0",
     "lodash.range": "^3.2.0",
-    "p-retry": "^5.0.0",
-    "p-wait-for": "^5.0.0",
+    "p-retry": "^5.1.2",
+    "p-wait-for": "^5.0.2",
     "protons": "^7.0.2",
-    "sinon": "^15.0.0",
+    "sinon": "^15.1.2",
     "ts-sinon": "^2.0.2",
     "which": "^3.0.0"
   },
   "browser": {
     "./dist/src/routing-table/generated-prefix-list.js": "./dist/src/routing-table/generated-prefix-list-browser.js"
-  },
-  "typedocs": {
-    "KadDHTComponents": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/KadDHTComponents.html",
-    "KadDHTInit": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/KadDHTInit.html",
-    "kadDHT": "https://libp2p.github.io/js-libp2p-kad-dht/functions/kadDHT.html"
   }
 }

package/src/content-fetching/index.ts

@@ -1,8 +1,5 @@
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import { logger } from '@libp2p/logger'
-import { Libp2pRecord } from '@libp2p/record'
-import { bestRecord } from '@libp2p/record/selectors'
-import { verifyRecord } from '@libp2p/record/validators'
 import map from 'it-map'
 import parallel from 'it-parallel'
 import { pipe } from 'it-pipe'
@@ -15,13 +12,16 @@ import {
   valueEvent,
   queryErrorEvent
 } from '../query/events.js'
+import { Libp2pRecord } from '../record/index.js'
+import { bestRecord } from '../record/selectors.js'
+import { verifyRecord } from '../record/validators.js'
 import { createPutRecord, bufferToRecordKey } from '../utils.js'
 import type { KadDHTComponents, Validators, Selectors, ValueEvent, QueryOptions, QueryEvent } from '../index.js'
 import type { Network } from '../network.js'
 import type { PeerRouting } from '../peer-routing/index.js'
 import type { QueryManager } from '../query/manager.js'
 import type { QueryFunc } from '../query/types.js'
-import type { AbortOptions } from '@libp2p/interfaces'
+import type { AbortOptions } from '@libp2p/interface'
 import type { Logger } from '@libp2p/logger'
 
 export interface ContentFetchingInit {

package/src/content-routing/index.ts

@@ -16,7 +16,7 @@ import type { Providers } from '../providers.js'
 import type { QueryManager } from '../query/manager.js'
 import type { QueryFunc } from '../query/types.js'
 import type { RoutingTable } from '../routing-table/index.js'
-import type { PeerInfo } from '@libp2p/interface-peer-info'
+import type { PeerInfo } from '@libp2p/interface/peer-info'
 import type { Logger } from '@libp2p/logger'
 import type { Multiaddr } from '@multiformats/multiaddr'
 import type { CID } from 'multiformats/cid'

package/src/dual-kad-dht.ts

@@ -1,8 +1,8 @@
-import { type ContentRouting, contentRouting } from '@libp2p/interface-content-routing'
-import { type PeerDiscovery, peerDiscovery, type PeerDiscoveryEvents } from '@libp2p/interface-peer-discovery'
-import { type PeerRouting, peerRouting } from '@libp2p/interface-peer-routing'
-import { CodeError } from '@libp2p/interfaces/errors'
-import { EventEmitter, CustomEvent } from '@libp2p/interfaces/events'
+import { type ContentRouting, contentRouting } from '@libp2p/interface/content-routing'
+import { CodeError } from '@libp2p/interface/errors'
+import { EventEmitter, CustomEvent } from '@libp2p/interface/events'
+import { type PeerDiscovery, peerDiscovery, type PeerDiscoveryEvents } from '@libp2p/interface/peer-discovery'
+import { type PeerRouting, peerRouting } from '@libp2p/interface/peer-routing'
 import { logger } from '@libp2p/logger'
 import drain from 'it-drain'
 import merge from 'it-merge'
@@ -10,8 +10,8 @@ import isPrivate from 'private-ip'
 import { DefaultKadDHT } from './kad-dht.js'
 import { queryErrorEvent } from './query/events.js'
 import type { DualKadDHT, KadDHT, KadDHTComponents, KadDHTInit, QueryEvent, QueryOptions } from './index.js'
-import type { PeerId } from '@libp2p/interface-peer-id'
-import type { PeerInfo } from '@libp2p/interface-peer-info'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { PeerInfo } from '@libp2p/interface/peer-info'
 import type { Multiaddr } from '@multiformats/multiaddr'
 import type { CID } from 'multiformats/cid'
 

package/src/index.ts

@@ -1,15 +1,14 @@
 import { DefaultDualKadDHT } from './dual-kad-dht.js'
 import type { ProvidersInit } from './providers.js'
-import type { AddressManager } from '@libp2p/interface-address-manager'
-import type { ConnectionManager } from '@libp2p/interface-connection-manager'
-import type { Libp2pEvents } from '@libp2p/interface-libp2p'
-import type { Metrics } from '@libp2p/interface-metrics'
-import type { PeerId } from '@libp2p/interface-peer-id'
-import type { PeerInfo } from '@libp2p/interface-peer-info'
-import type { PeerStore } from '@libp2p/interface-peer-store'
-import type { Registrar } from '@libp2p/interface-registrar'
-import type { AbortOptions } from '@libp2p/interfaces'
-import type { EventEmitter } from '@libp2p/interfaces/events'
+import type { Libp2pEvents, AbortOptions } from '@libp2p/interface'
+import type { EventEmitter } from '@libp2p/interface/events'
+import type { Metrics } from '@libp2p/interface/metrics'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { PeerInfo } from '@libp2p/interface/peer-info'
+import type { PeerStore } from '@libp2p/interface/peer-store'
+import type { AddressManager } from '@libp2p/interface-internal/address-manager'
+import type { ConnectionManager } from '@libp2p/interface-internal/connection-manager'
+import type { Registrar } from '@libp2p/interface-internal/registrar'
 import type { Datastore } from 'interface-datastore'
 import type { CID } from 'multiformats/cid'
 import type { ProgressOptions, ProgressEvent } from 'progress-events'

package/src/kad-dht.ts

@@ -1,7 +1,5 @@
-import { CustomEvent, EventEmitter } from '@libp2p/interfaces/events'
+import { CustomEvent, EventEmitter } from '@libp2p/interface/events'
 import { type Logger, logger } from '@libp2p/logger'
-import { selectors as recordSelectors } from '@libp2p/record/selectors'
-import { validators as recordValidators } from '@libp2p/record/validators'
 import pDefer from 'p-defer'
 import { PROTOCOL_DHT, PROTOCOL_PREFIX, LAN_PREFIX } from './constants.js'
 import { ContentFetching } from './content-fetching/index.js'
@@ -11,6 +9,8 @@ import { PeerRouting } from './peer-routing/index.js'
 import { Providers } from './providers.js'
 import { QueryManager } from './query/manager.js'
 import { QuerySelf } from './query-self.js'
+import { selectors as recordSelectors } from './record/selectors.js'
+import { validators as recordValidators } from './record/validators.js'
 import { RoutingTable } from './routing-table/index.js'
 import { RoutingTableRefresh } from './routing-table/refresh.js'
 import { RPC } from './rpc/index.js'
@@ -20,9 +20,9 @@ import {
   removePublicAddresses
 } from './utils.js'
 import type { KadDHTComponents, KadDHTInit, QueryOptions, Validators, Selectors, KadDHT, QueryEvent } from './index.js'
-import type { PeerDiscoveryEvents } from '@libp2p/interface-peer-discovery'
-import type { PeerId } from '@libp2p/interface-peer-id'
-import type { PeerInfo } from '@libp2p/interface-peer-info'
+import type { PeerDiscoveryEvents } from '@libp2p/interface/peer-discovery'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { PeerInfo } from '@libp2p/interface/peer-info'
 import type { CID } from 'multiformats/cid'
 
 export const DEFAULT_MAX_INBOUND_STREAMS = 32

package/src/message/index.ts

@@ -1,8 +1,8 @@
 import { peerIdFromBytes } from '@libp2p/peer-id'
-import { Libp2pRecord } from '@libp2p/record'
 import { multiaddr } from '@multiformats/multiaddr'
+import { Libp2pRecord } from '../record/index.js'
 import { Message as PBMessage } from './dht.js'
-import type { PeerInfo } from '@libp2p/interface-peer-info'
+import type { PeerInfo } from '@libp2p/interface/peer-info'
 import type { Uint8ArrayList } from 'uint8arraylist'
 
 export const MESSAGE_TYPE = PBMessage.MessageType

package/src/network.ts

@@ -1,5 +1,5 @@
-import { CodeError } from '@libp2p/interfaces/errors'
-import { EventEmitter, CustomEvent } from '@libp2p/interfaces/events'
+import { CodeError } from '@libp2p/interface/errors'
+import { EventEmitter, CustomEvent } from '@libp2p/interface/events'
 import { logger } from '@libp2p/logger'
 import { abortableDuplex } from 'abortable-iterator'
 import drain from 'it-drain'
@@ -14,11 +14,11 @@ import {
   queryErrorEvent
 } from './query/events.js'
 import type { KadDHTComponents, QueryEvent, QueryOptions } from './index.js'
-import type { Stream } from '@libp2p/interface-connection'
-import type { PeerId } from '@libp2p/interface-peer-id'
-import type { PeerInfo } from '@libp2p/interface-peer-info'
-import type { AbortOptions } from '@libp2p/interfaces'
-import type { Startable } from '@libp2p/interfaces/startable'
+import type { AbortOptions } from '@libp2p/interface'
+import type { Stream } from '@libp2p/interface/connection'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { PeerInfo } from '@libp2p/interface/peer-info'
+import type { Startable } from '@libp2p/interface/startable'
 import type { Logger } from '@libp2p/logger'
 import type { Duplex, Source } from 'it-stream-types'
 import type { Uint8ArrayList } from 'uint8arraylist'
@@ -110,7 +110,7 @@ export class Network extends EventEmitter<NetworkEvents> implements Startable {
       yield queryErrorEvent({ from: to, error: err }, options)
     } finally {
       if (stream != null) {
-        stream.close()
+        await stream.close()
       }
     }
   }
@@ -140,7 +140,7 @@ export class Network extends EventEmitter<NetworkEvents> implements Startable {
       yield queryErrorEvent({ from: to, error: err }, options)
     } finally {
       if (stream != null) {
-        stream.close()
+        await stream.close()
       }
     }
   }

package/src/peer-list/index.ts

@@ -1,4 +1,4 @@
-import type { PeerId } from '@libp2p/interface-peer-id'
+import type { PeerId } from '@libp2p/interface/peer-id'
 
 /**
  * A list of unique peers.

package/src/peer-list/peer-distance-list.ts

@@ -1,7 +1,7 @@
 import { compare as uint8ArrayCompare } from 'uint8arrays/compare'
 import { xor as uint8ArrayXor } from 'uint8arrays/xor'
 import * as utils from '../utils.js'
-import type { PeerId } from '@libp2p/interface-peer-id'
+import type { PeerId } from '@libp2p/interface/peer-id'
 
 interface PeerDistance {
   peerId: PeerId

package/src/peer-routing/index.ts

@@ -1,9 +1,7 @@
 import { keys } from '@libp2p/crypto'
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import { logger } from '@libp2p/logger'
 import { peerIdFromKeys } from '@libp2p/peer-id'
-import { Libp2pRecord } from '@libp2p/record'
-import { verifyRecord } from '@libp2p/record/validators'
 import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
 import { Message, MESSAGE_TYPE } from '../message/index.js'
 import { PeerDistanceList } from '../peer-list/peer-distance-list.js'
@@ -12,15 +10,17 @@ import {
   finalPeerEvent,
   valueEvent
 } from '../query/events.js'
+import { Libp2pRecord } from '../record/index.js'
+import { verifyRecord } from '../record/validators.js'
 import * as utils from '../utils.js'
 import type { KadDHTComponents, DHTRecord, DialPeerEvent, FinalPeerEvent, QueryEvent, Validators } from '../index.js'
 import type { Network } from '../network.js'
 import type { QueryManager, QueryOptions } from '../query/manager.js'
 import type { QueryFunc } from '../query/types.js'
 import type { RoutingTable } from '../routing-table/index.js'
-import type { PeerId } from '@libp2p/interface-peer-id'
-import type { PeerInfo } from '@libp2p/interface-peer-info'
-import type { AbortOptions } from '@libp2p/interfaces'
+import type { AbortOptions } from '@libp2p/interface'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { PeerInfo } from '@libp2p/interface/peer-info'
 import type { Logger } from '@libp2p/logger'
 
 export interface PeerRoutingInit {

package/src/providers.ts

@@ -11,8 +11,8 @@ import {
   PROVIDERS_LRU_CACHE_SIZE,
   PROVIDER_KEY_PREFIX
 } from './constants.js'
-import type { PeerId } from '@libp2p/interface-peer-id'
-import type { Startable } from '@libp2p/interfaces/startable'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { Startable } from '@libp2p/interface/startable'
 import type { Datastore } from 'interface-datastore'
 import type { CID } from 'multiformats'
 

package/src/query/events.ts

@@ -1,10 +1,10 @@
-import { CustomEvent } from '@libp2p/interfaces/events'
+import { CustomEvent } from '@libp2p/interface/events'
 import { MESSAGE_TYPE_LOOKUP } from '../message/index.js'
 import type { SendQueryEvent, PeerResponseEvent, DialPeerEvent, AddPeerEvent, ValueEvent, ProviderEvent, QueryErrorEvent, FinalPeerEvent, QueryOptions } from '../index.js'
 import type { Message } from '../message/dht.js'
-import type { PeerId } from '@libp2p/interface-peer-id'
-import type { PeerInfo } from '@libp2p/interface-peer-info'
-import type { Libp2pRecord } from '@libp2p/record'
+import type { Libp2pRecord } from '../record/index.js'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { PeerInfo } from '@libp2p/interface/peer-info'
 
 export interface QueryEventFields {
   to: PeerId

package/src/query/manager.ts

@@ -1,6 +1,6 @@
 import { setMaxListeners } from 'events'
-import { AbortError } from '@libp2p/interfaces/errors'
-import { EventEmitter, CustomEvent } from '@libp2p/interfaces/events'
+import { AbortError } from '@libp2p/interface/errors'
+import { EventEmitter, CustomEvent } from '@libp2p/interface/events'
 import { logger } from '@libp2p/logger'
 import { PeerSet } from '@libp2p/peer-collections'
 import { anySignal } from 'any-signal'
@@ -14,9 +14,9 @@ import { queryPath } from './query-path.js'
 import type { QueryFunc } from './types.js'
 import type { QueryEvent, QueryOptions as RootQueryOptions } from '../index.js'
 import type { RoutingTable } from '../routing-table/index.js'
-import type { Metric, Metrics } from '@libp2p/interface-metrics'
-import type { PeerId } from '@libp2p/interface-peer-id'
-import type { Startable } from '@libp2p/interfaces/startable'
+import type { Metric, Metrics } from '@libp2p/interface/metrics'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { Startable } from '@libp2p/interface/startable'
 import type { DeferredPromise } from 'p-defer'
 
 export interface CleanUpEvents {

package/src/query/query-path.ts

@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import { anySignal } from 'any-signal'
 import defer from 'p-defer'
 import Queue from 'p-queue'
@@ -9,8 +9,8 @@ import { queryErrorEvent } from './events.js'
 import type { CleanUpEvents } from './manager.js'
 import type { QueryEvent, QueryOptions } from '../index.js'
 import type { QueryFunc } from '../query/types.js'
-import type { PeerId } from '@libp2p/interface-peer-id'
-import type { EventEmitter } from '@libp2p/interfaces/events'
+import type { EventEmitter } from '@libp2p/interface/events'
+import type { PeerId } from '@libp2p/interface/peer-id'
 import type { Logger } from '@libp2p/logger'
 import type { PeerSet } from '@libp2p/peer-collections'
 

package/src/query/types.ts

@@ -1,5 +1,5 @@
 import type { QueryEvent } from '../index.js'
-import type { PeerId } from '@libp2p/interface-peer-id'
+import type { PeerId } from '@libp2p/interface/peer-id'
 
 export interface QueryContext {
   // the key we are looking up

package/src/query-self.ts

@@ -9,8 +9,8 @@ import { pEvent } from 'p-event'
 import { QUERY_SELF_INTERVAL, QUERY_SELF_TIMEOUT, K, QUERY_SELF_INITIAL_INTERVAL } from './constants.js'
 import type { PeerRouting } from './peer-routing/index.js'
 import type { RoutingTable } from './routing-table/index.js'
-import type { PeerId } from '@libp2p/interface-peer-id'
-import type { Startable } from '@libp2p/interfaces/startable'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { Startable } from '@libp2p/interface/startable'
 import type { DeferredPromise } from 'p-defer'
 
 export interface QuerySelfInit {

package/src/record/index.ts

@@ -0,0 +1,70 @@
+import {
+  Record
+} from './record.js'
+import * as utils from './utils.js'
+import type { Uint8ArrayList } from 'uint8arraylist'
+
+export class Libp2pRecord {
+  public key: Uint8Array
+  public value: Uint8Array
+  public timeReceived: Date
+
+  constructor (key: Uint8Array, value: Uint8Array, timeReceived: Date) {
+    if (!(key instanceof Uint8Array)) {
+      throw new Error('key must be a Uint8Array')
+    }
+
+    if (!(value instanceof Uint8Array)) {
+      throw new Error('value must be a Uint8Array')
+    }
+
+    this.key = key
+    this.value = value
+    this.timeReceived = timeReceived
+  }
+
+  serialize (): Uint8Array {
+    return Record.encode(this.prepareSerialize())
+  }
+
+  /**
+   * Return the object format ready to be given to the protobuf library.
+   */
+  prepareSerialize (): Record {
+    return {
+      key: this.key,
+      value: this.value,
+      timeReceived: utils.toRFC3339(this.timeReceived)
+    }
+  }
+
+  /**
+   * Decode a protobuf encoded record
+   */
+  static deserialize (raw: Uint8Array | Uint8ArrayList): Libp2pRecord {
+    const rec = Record.decode(raw)
+
+    return new Libp2pRecord(rec.key, rec.value, new Date(rec.timeReceived))
+  }
+
+  /**
+   * Create a record from the raw object returned from the protobuf library
+   */
+  static fromDeserialized (obj: Record): Libp2pRecord {
+    const recvtime = utils.parseRFC3339(obj.timeReceived)
+
+    if (obj.key == null) {
+      throw new Error('key missing from deserialized object')
+    }
+
+    if (obj.value == null) {
+      throw new Error('value missing from deserialized object')
+    }
+
+    const rec = new Libp2pRecord(
+      obj.key, obj.value, recvtime
+    )
+
+    return rec
+  }
+}

package/src/record/record.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+
+// Record represents a dht record that contains a value
+// for a key value pair
+message Record {
+  // The key that references this record
+  bytes key = 1;
+
+  // The actual value this record is storing
+  bytes value = 2;
+
+  // Note: These fields were removed from the Record message
+  // hash of the authors public key
+  // optional bytes author = 3;
+  // A PKI signature for the key+value+author
+  // optional bytes signature = 4;
+
+  // Time the record was received, set by receiver
+  string timeReceived = 5;
+}