@libp2p/peer-record 8.0.35 → 9.0.0-049bfa0fa
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.
- package/README.md +2 -2
- package/dist/index.min.js +1 -1
- package/dist/index.min.js.map +4 -4
- package/dist/src/envelope/index.d.ts +1 -2
- package/dist/src/envelope/index.d.ts.map +1 -1
- package/dist/src/envelope/index.js.map +1 -1
- package/dist/src/index.d.ts +2 -2
- package/dist/src/index.js +2 -2
- package/dist/src/peer-record/index.js +1 -1
- package/dist/src/peer-record/index.js.map +1 -1
- package/dist/src/peer-record/utils.d.ts +6 -0
- package/dist/src/peer-record/utils.d.ts.map +1 -0
- package/dist/src/peer-record/utils.js +13 -0
- package/dist/src/peer-record/utils.js.map +1 -0
- package/package.json +9 -10
- package/src/envelope/index.ts +1 -2
- package/src/index.ts +2 -2
- package/src/peer-record/index.ts +1 -1
- package/src/peer-record/utils.ts +15 -0
- package/dist/typedoc-urls.json +0 -6
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { Uint8ArrayList } from 'uint8arraylist';
|
|
2
|
-
import type { Record, Envelope, PrivateKey, PublicKey } from '@libp2p/interface';
|
|
3
|
-
import type { AbortOptions } from '@multiformats/multiaddr';
|
|
2
|
+
import type { Record, Envelope, PrivateKey, PublicKey, AbortOptions } from '@libp2p/interface';
|
|
4
3
|
export interface RecordEnvelopeInit {
|
|
5
4
|
publicKey: PublicKey;
|
|
6
5
|
payloadType: Uint8Array;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/envelope/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAK/C,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/envelope/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAK/C,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAE9F,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,SAAS,CAAA;IACpB,WAAW,EAAE,UAAU,CAAA;IACvB,OAAO,EAAE,UAAU,CAAA;IACnB,SAAS,EAAE,UAAU,CAAA;CACtB;AAED,qBAAa,cAAe,YAAW,QAAQ;IAC7C;;OAEG;IACH,MAAM,CAAC,kBAAkB,GAAI,MAAM,UAAU,GAAG,cAAc,KAAG,cAAc,CAU9E;IAED;;;OAGG;IACH,MAAM,CAAC,IAAI,GAAU,QAAQ,MAAM,EAAE,YAAY,UAAU,EAAE,UAAU,YAAY,KAAG,OAAO,CAAC,cAAc,CAAC,CAiB5G;IAED;;;OAGG;IACH,MAAM,CAAC,cAAc,GAAU,MAAM,UAAU,GAAG,cAAc,EAAE,QAAQ,MAAM,EAAE,UAAU,YAAY,KAAG,OAAO,CAAC,cAAc,CAAC,CASjI;IAEM,SAAS,EAAE,SAAS,CAAA;IACpB,WAAW,EAAE,UAAU,CAAA;IACvB,OAAO,EAAE,UAAU,CAAA;IACnB,SAAS,EAAE,UAAU,CAAA;IACrB,SAAS,CAAC,EAAE,UAAU,CAAA;IAE7B;;;OAGG;gBACU,IAAI,EAAE,kBAAkB;IASrC;;OAEG;IACH,OAAO,IAAK,UAAU;IAatB;;OAEG;IACH,MAAM,CAAE,KAAK,CAAC,EAAE,QAAQ,GAAG,OAAO;IAQlC;;OAEG;IACG,QAAQ,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;CAK1E"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/envelope/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAChF,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,MAAM,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,EAAE,UAAU,IAAI,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC7E,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAA;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/envelope/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAChF,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,MAAM,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,EAAE,UAAU,IAAI,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC7E,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAA;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAUnD,MAAM,OAAO,cAAc;IACzB;;OAEG;IACH,MAAM,CAAC,kBAAkB,GAAG,CAAC,IAAiC,EAAkB,EAAE;QAChF,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAC1C,MAAM,SAAS,GAAG,qBAAqB,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;QAE/D,OAAO,IAAI,cAAc,CAAC;YACxB,SAAS;YACT,WAAW,EAAE,YAAY,CAAC,WAAW;YACrC,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,SAAS,EAAE,YAAY,CAAC,SAAS;SAClC,CAAC,CAAA;IACJ,CAAC,CAAA;IAED;;;OAGG;IACH,MAAM,CAAC,IAAI,GAAG,KAAK,EAAE,MAAc,EAAE,UAAsB,EAAE,OAAsB,EAA2B,EAAE;QAC9G,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;QACxC,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QAC5B,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAA;QAChC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,CAAA;QAChC,MAAM,QAAQ,GAAG,sBAAsB,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,CAAA;QACrE,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAA;QAErE,OAAO,IAAI,cAAc,CAAC;YACxB,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,WAAW;YACX,OAAO;YACP,SAAS;SACV,CAAC,CAAA;IACJ,CAAC,CAAA;IAED;;;OAGG;IACH,MAAM,CAAC,cAAc,GAAG,KAAK,EAAE,IAAiC,EAAE,MAAc,EAAE,OAAsB,EAA2B,EAAE;QACnI,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;QACxD,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAEtD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,qBAAqB,CAAC,sDAAsD,CAAC,CAAA;QACzF,CAAC;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC,CAAA;IAEM,SAAS,CAAW;IACpB,WAAW,CAAY;IACvB,OAAO,CAAY;IACnB,SAAS,CAAY;IACrB,SAAS,CAAa;IAE7B;;;OAGG;IACH,YAAa,IAAwB;QACnC,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,CAAA;QAE3D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YAC3B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC;gBAC/B,SAAS,EAAE,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC;gBAC9C,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;gBAChC,SAAS,EAAE,IAAI,CAAC,SAAS;aAC1B,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAED;;OAEG;IACH,MAAM,CAAE,KAAgB;QACtB,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;IAC1D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAE,MAAc,EAAE,OAAsB;QACpD,MAAM,QAAQ,GAAG,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;QAE/E,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;IAC5E,CAAC;;AAGH;;GAEG;AACH,MAAM,sBAAsB,GAAG,CAAC,MAAc,EAAE,WAAuB,EAAE,OAAoC,EAAkB,EAAE;IAC/H,iFAAiF;IACjF,+DAA+D;IAC/D,mDAAmD;IACnD,kDAAkD;IAClD,wCAAwC;IACxC,6CAA6C;IAC7C,mCAAmC;IAEnC,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAA;IACtD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAA;IAC/D,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IAC3D,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAEnD,OAAO,IAAI,cAAc,CACvB,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,aAAa,EACb,OAAO,CACR,CAAA;AACH,CAAC,CAAA"}
|
package/dist/src/index.d.ts
CHANGED
|
@@ -7,13 +7,13 @@
|
|
|
7
7
|
*
|
|
8
8
|
* Libp2p provides an all-purpose data container called **envelope**. It was created to enable the distribution of verifiable records, which we can prove originated from the addressed peer itself. The envelope includes a signature of the data, so that its authenticity is verified.
|
|
9
9
|
*
|
|
10
|
-
* This envelope stores a marshaled record implementing the [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record
|
|
10
|
+
* This envelope stores a marshaled record implementing the [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record.ts). These Records are designed to be serialized to bytes and placed inside of the envelopes before being shared with other peers.
|
|
11
11
|
*
|
|
12
12
|
* You can read further about the envelope in [RFC 0002 - Signed Envelopes](https://github.com/libp2p/specs/blob/master/RFC/0002-signed-envelopes.md). For the original discussion about it you can look at the PR that was used to create it: [libp2p/specs#217](https://github.com/libp2p/specs/pull/217).
|
|
13
13
|
*
|
|
14
14
|
* @example Creating a peer record
|
|
15
15
|
*
|
|
16
|
-
* Create an envelope with an instance of an [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record
|
|
16
|
+
* Create an envelope with an instance of an [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record.ts) implementation and prepare it for being exchanged:
|
|
17
17
|
*
|
|
18
18
|
* ```TypeScript
|
|
19
19
|
* import { PeerRecord, RecordEnvelope } from '@libp2p/peer-record'
|
package/dist/src/index.js
CHANGED
|
@@ -7,13 +7,13 @@
|
|
|
7
7
|
*
|
|
8
8
|
* Libp2p provides an all-purpose data container called **envelope**. It was created to enable the distribution of verifiable records, which we can prove originated from the addressed peer itself. The envelope includes a signature of the data, so that its authenticity is verified.
|
|
9
9
|
*
|
|
10
|
-
* This envelope stores a marshaled record implementing the [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record
|
|
10
|
+
* This envelope stores a marshaled record implementing the [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record.ts). These Records are designed to be serialized to bytes and placed inside of the envelopes before being shared with other peers.
|
|
11
11
|
*
|
|
12
12
|
* You can read further about the envelope in [RFC 0002 - Signed Envelopes](https://github.com/libp2p/specs/blob/master/RFC/0002-signed-envelopes.md). For the original discussion about it you can look at the PR that was used to create it: [libp2p/specs#217](https://github.com/libp2p/specs/pull/217).
|
|
13
13
|
*
|
|
14
14
|
* @example Creating a peer record
|
|
15
15
|
*
|
|
16
|
-
* Create an envelope with an instance of an [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record
|
|
16
|
+
* Create an envelope with an instance of an [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record.ts) implementation and prepare it for being exchanged:
|
|
17
17
|
*
|
|
18
18
|
* ```TypeScript
|
|
19
19
|
* import { PeerRecord, RecordEnvelope } from '@libp2p/peer-record'
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { peerIdFromMultihash } from '@libp2p/peer-id';
|
|
2
|
-
import { arrayEquals } from '@libp2p/utils/array-equals';
|
|
3
2
|
import { multiaddr } from '@multiformats/multiaddr';
|
|
4
3
|
import * as Digest from 'multiformats/hashes/digest';
|
|
5
4
|
import { ENVELOPE_DOMAIN_PEER_RECORD, ENVELOPE_PAYLOAD_TYPE_PEER_RECORD } from './consts.js';
|
|
6
5
|
import { PeerRecord as Protobuf } from './peer-record.js';
|
|
6
|
+
import { arrayEquals } from "./utils.js";
|
|
7
7
|
/**
|
|
8
8
|
* The PeerRecord is used for distributing peer routing records across the network.
|
|
9
9
|
* It contains the peer's reachable listen addresses.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/peer-record/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/peer-record/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAA;AACpD,OAAO,EACL,2BAA2B,EAC3B,iCAAiC,EAClC,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,UAAU,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAmBxC;;;GAGG;AACH,MAAM,OAAO,UAAU;IACrB;;OAEG;IACH,MAAM,CAAC,kBAAkB,GAAG,CAAC,GAAgC,EAAc,EAAE;QAC3E,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACvC,MAAM,MAAM,GAAG,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAA;QACpE,MAAM,UAAU,GAAG,CAAC,UAAU,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAA;QAClF,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAA;QAEhC,OAAO,IAAI,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAA;IAC1D,CAAC,CAAA;IAED,MAAM,CAAC,MAAM,GAAG,2BAA2B,CAAA;IAC3C,MAAM,CAAC,KAAK,GAAG,iCAAiC,CAAA;IAEzC,MAAM,CAAQ;IACd,UAAU,CAAa;IACvB,SAAS,CAAQ;IACjB,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;IAC1B,KAAK,GAAG,UAAU,CAAC,KAAK,CAAA;IACvB,SAAS,CAAa;IAE9B,YAAa,IAAoB;QAC/B,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAA;QAE9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,UAAU,GAAG,UAAU,IAAI,EAAE,CAAA;QAClC,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;IAClD,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YAC3B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC;gBAC/B,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,KAAK;gBACvC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;gBAC3B,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;oBACrC,SAAS,EAAE,CAAC,CAAC,KAAK;iBACnB,CAAC,CAAC;aACJ,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAED;;OAEG;IACH,MAAM,CAAE,KAAc;QACpB,IAAI,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC,EAAE,CAAC;YACnC,OAAO,KAAK,CAAA;QACd,CAAC;QAED,kBAAkB;QAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,OAAO,KAAK,CAAA;QACd,CAAC;QAED,qBAAqB;QACrB,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,EAAE,CAAC;YACvC,OAAO,KAAK,CAAA;QACd,CAAC;QAED,sBAAsB;QACtB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;YACpD,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/peer-record/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,WAAW,CAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,CAUxD"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Verify if two arrays of non primitive types with the "equals" function are equal.
|
|
3
|
+
* Compatible with multiaddr, peer-id and others.
|
|
4
|
+
*/
|
|
5
|
+
export function arrayEquals(a, b) {
|
|
6
|
+
const sort = (a, b) => a.toString().localeCompare(b.toString());
|
|
7
|
+
if (a.length !== b.length) {
|
|
8
|
+
return false;
|
|
9
|
+
}
|
|
10
|
+
b.sort(sort);
|
|
11
|
+
return a.sort(sort).every((item, index) => b[index].equals(item));
|
|
12
|
+
}
|
|
13
|
+
//# sourceMappingURL=utils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/peer-record/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAE,CAAQ,EAAE,CAAQ;IAC7C,MAAM,IAAI,GAAG,CAAC,CAAM,EAAE,CAAM,EAAU,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;IAEjF,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAEZ,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AACnE,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@libp2p/peer-record",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "9.0.0-049bfa0fa",
|
|
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",
|
|
@@ -48,20 +48,19 @@
|
|
|
48
48
|
"test:electron-main": "aegir test -t electron-main"
|
|
49
49
|
},
|
|
50
50
|
"dependencies": {
|
|
51
|
-
"@libp2p/crypto": "
|
|
52
|
-
"@libp2p/interface": "
|
|
53
|
-
"@libp2p/peer-id": "
|
|
54
|
-
"@
|
|
55
|
-
"
|
|
56
|
-
"
|
|
57
|
-
"protons-runtime": "^5.5.0",
|
|
51
|
+
"@libp2p/crypto": "5.1.9-049bfa0fa",
|
|
52
|
+
"@libp2p/interface": "3.0.0-049bfa0fa",
|
|
53
|
+
"@libp2p/peer-id": "6.0.0-049bfa0fa",
|
|
54
|
+
"@multiformats/multiaddr": "^13.0.1",
|
|
55
|
+
"multiformats": "^13.4.0",
|
|
56
|
+
"protons-runtime": "^5.6.0",
|
|
58
57
|
"uint8-varint": "^2.0.4",
|
|
59
58
|
"uint8arraylist": "^2.4.8",
|
|
60
59
|
"uint8arrays": "^5.1.0"
|
|
61
60
|
},
|
|
62
61
|
"devDependencies": {
|
|
63
|
-
"aegir": "^47.0.
|
|
64
|
-
"protons": "^7.
|
|
62
|
+
"aegir": "^47.0.22",
|
|
63
|
+
"protons": "^7.7.0"
|
|
65
64
|
},
|
|
66
65
|
"sideEffects": false
|
|
67
66
|
}
|
package/src/envelope/index.ts
CHANGED
|
@@ -5,8 +5,7 @@ import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
|
|
|
5
5
|
import { fromString as uint8arraysFromString } from 'uint8arrays/from-string'
|
|
6
6
|
import { Envelope as Protobuf } from './envelope.js'
|
|
7
7
|
import { InvalidSignatureError } from './errors.js'
|
|
8
|
-
import type { Record, Envelope, PrivateKey, PublicKey } from '@libp2p/interface'
|
|
9
|
-
import type { AbortOptions } from '@multiformats/multiaddr'
|
|
8
|
+
import type { Record, Envelope, PrivateKey, PublicKey, AbortOptions } from '@libp2p/interface'
|
|
10
9
|
|
|
11
10
|
export interface RecordEnvelopeInit {
|
|
12
11
|
publicKey: PublicKey
|
package/src/index.ts
CHANGED
|
@@ -7,13 +7,13 @@
|
|
|
7
7
|
*
|
|
8
8
|
* Libp2p provides an all-purpose data container called **envelope**. It was created to enable the distribution of verifiable records, which we can prove originated from the addressed peer itself. The envelope includes a signature of the data, so that its authenticity is verified.
|
|
9
9
|
*
|
|
10
|
-
* This envelope stores a marshaled record implementing the [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record
|
|
10
|
+
* This envelope stores a marshaled record implementing the [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record.ts). These Records are designed to be serialized to bytes and placed inside of the envelopes before being shared with other peers.
|
|
11
11
|
*
|
|
12
12
|
* You can read further about the envelope in [RFC 0002 - Signed Envelopes](https://github.com/libp2p/specs/blob/master/RFC/0002-signed-envelopes.md). For the original discussion about it you can look at the PR that was used to create it: [libp2p/specs#217](https://github.com/libp2p/specs/pull/217).
|
|
13
13
|
*
|
|
14
14
|
* @example Creating a peer record
|
|
15
15
|
*
|
|
16
|
-
* Create an envelope with an instance of an [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record
|
|
16
|
+
* Create an envelope with an instance of an [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record.ts) implementation and prepare it for being exchanged:
|
|
17
17
|
*
|
|
18
18
|
* ```TypeScript
|
|
19
19
|
* import { PeerRecord, RecordEnvelope } from '@libp2p/peer-record'
|
package/src/peer-record/index.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { peerIdFromMultihash } from '@libp2p/peer-id'
|
|
2
|
-
import { arrayEquals } from '@libp2p/utils/array-equals'
|
|
3
2
|
import { multiaddr } from '@multiformats/multiaddr'
|
|
4
3
|
import * as Digest from 'multiformats/hashes/digest'
|
|
5
4
|
import {
|
|
@@ -7,6 +6,7 @@ import {
|
|
|
7
6
|
ENVELOPE_PAYLOAD_TYPE_PEER_RECORD
|
|
8
7
|
} from './consts.js'
|
|
9
8
|
import { PeerRecord as Protobuf } from './peer-record.js'
|
|
9
|
+
import { arrayEquals } from './utils.ts'
|
|
10
10
|
import type { PeerId } from '@libp2p/interface'
|
|
11
11
|
import type { Multiaddr } from '@multiformats/multiaddr'
|
|
12
12
|
import type { Uint8ArrayList } from 'uint8arraylist'
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Verify if two arrays of non primitive types with the "equals" function are equal.
|
|
3
|
+
* Compatible with multiaddr, peer-id and others.
|
|
4
|
+
*/
|
|
5
|
+
export function arrayEquals (a: any[], b: any[]): boolean {
|
|
6
|
+
const sort = (a: any, b: any): number => a.toString().localeCompare(b.toString())
|
|
7
|
+
|
|
8
|
+
if (a.length !== b.length) {
|
|
9
|
+
return false
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
b.sort(sort)
|
|
13
|
+
|
|
14
|
+
return a.sort(sort).every((item, index) => b[index].equals(item))
|
|
15
|
+
}
|
package/dist/typedoc-urls.json
DELETED
|
@@ -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
|
-
}
|