@libp2p/peer-record 6.0.11 → 7.0.0-5a9362e21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11,7 +11,7 @@
11
11
  *
12
12
  * You can read further about the envelope in [libp2p/specs#217](https://github.com/libp2p/specs/pull/217).
13
13
  *
14
- * @example
14
+ * @example Creating a peer record
15
15
  *
16
16
  * Create an envelope with an instance of an [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record/index.ts) implementation and prepare it for being exchanged:
17
17
  *
@@ -42,7 +42,7 @@
42
42
  * const wireData = e.marshal()
43
43
  * ```
44
44
  *
45
- * @example
45
+ * @example Consuming a peer record
46
46
  *
47
47
  * Consume a received envelope (`wireData`) and transform it back to a record:
48
48
  *
package/dist/src/index.js CHANGED
@@ -11,7 +11,7 @@
11
11
  *
12
12
  * You can read further about the envelope in [libp2p/specs#217](https://github.com/libp2p/specs/pull/217).
13
13
  *
14
- * @example
14
+ * @example Creating a peer record
15
15
  *
16
16
  * Create an envelope with an instance of an [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record/index.ts) implementation and prepare it for being exchanged:
17
17
  *
@@ -42,7 +42,7 @@
42
42
  * const wireData = e.marshal()
43
43
  * ```
44
44
  *
45
- * @example
45
+ * @example Consuming a peer record
46
46
  *
47
47
  * Consume a received envelope (`wireData`) and transform it back to a record:
48
48
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@libp2p/peer-record",
3
- "version": "6.0.11",
3
+ "version": "7.0.0-5a9362e21",
4
4
  "description": "Used to transfer signed peer data across the network",
5
5
  "license": "Apache-2.0 OR MIT",
6
6
  "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/peer-record#readme",
@@ -60,10 +60,10 @@
60
60
  "test:electron-main": "aegir test -t electron-main"
61
61
  },
62
62
  "dependencies": {
63
- "@libp2p/crypto": "^3.0.1",
64
- "@libp2p/interface": "^1.0.1",
65
- "@libp2p/peer-id": "^4.0.1",
66
- "@libp2p/utils": "^5.0.1",
63
+ "@libp2p/crypto": "3.0.1-5a9362e21",
64
+ "@libp2p/interface": "1.0.1-5a9362e21",
65
+ "@libp2p/peer-id": "4.0.1-5a9362e21",
66
+ "@libp2p/utils": "5.0.2-5a9362e21",
67
67
  "@multiformats/multiaddr": "^12.1.10",
68
68
  "protons-runtime": "^5.0.0",
69
69
  "uint8-varint": "^2.0.0",
@@ -71,7 +71,7 @@
71
71
  "uint8arrays": "^4.0.6"
72
72
  },
73
73
  "devDependencies": {
74
- "@libp2p/peer-id-factory": "^3.0.10",
74
+ "@libp2p/peer-id-factory": "4.0.0-5a9362e21",
75
75
  "aegir": "^41.0.2",
76
76
  "protons": "^7.3.0"
77
77
  }
package/src/index.ts CHANGED
@@ -11,7 +11,7 @@
11
11
  *
12
12
  * You can read further about the envelope in [libp2p/specs#217](https://github.com/libp2p/specs/pull/217).
13
13
  *
14
- * @example
14
+ * @example Creating a peer record
15
15
  *
16
16
  * Create an envelope with an instance of an [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record/index.ts) implementation and prepare it for being exchanged:
17
17
  *
@@ -42,7 +42,7 @@
42
42
  * const wireData = e.marshal()
43
43
  * ```
44
44
  *
45
- * @example
45
+ * @example Consuming a peer record
46
46
  *
47
47
  * Consume a received envelope (`wireData`) and transform it back to a record:
48
48
  *
@@ -1,6 +0,0 @@
1
- {
2
- "PeerRecord": "https://libp2p.github.io/js-libp2p/classes/_libp2p_peer_record.PeerRecord.html",
3
- "RecordEnvelope": "https://libp2p.github.io/js-libp2p/classes/_libp2p_peer_record.RecordEnvelope.html",
4
- "PeerRecordInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_peer_record.PeerRecordInit.html",
5
- "RecordEnvelopeInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_peer_record.RecordEnvelopeInit.html"
6
- }