@libp2p/peer-record 8.0.20-e7e01f58f → 8.0.20-f465c5473

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 CHANGED
@@ -126,9 +126,9 @@ When a libp2p node changes its listen addresses, the identify service will be in
126
126
 
127
127
  ### Subsystem receiving a record
128
128
 
129
- Considering that a node can discover other peers' addresses from a variety of sources, Libp2p Peerstore can differentiate the addresses that were obtained through a signed peer record.
129
+ Considering that a node can discover other peers' addresses from a variety of sources, Libp2p PeerStore can differentiate the addresses that were obtained through a signed peer record.
130
130
 
131
- Once a record is received and its signature properly validated, its envelope is stored in the AddressBook in its byte representation. The `seqNumber` remains unmarshalled so that we can quickly compare it against incoming records to determine the most recent record.
131
+ Once a record is received and its signature properly validated, its envelope is stored in the AddressBook in its byte representation. The `seqNumber` remains unmarshaled so that we can quickly compare it against incoming records to determine the most recent record.
132
132
 
133
133
  The AddressBook Addresses will be updated with the content of the envelope with a certified property. This allows other subsystems to identify the known certified addresses of a peer.
134
134
 
@@ -146,7 +146,7 @@ When a subsystem wants to provide a record, it will get it from the AddressBook,
146
146
  - Some addresses may be ambiguous. For example, addresses on a private subnet are valid within that subnet but are useless on the public internet.
147
147
  - Once all these pieces are in place, we will also need a way to prioritize addresses based on their authenticity, that is, the dialer can prioritize self-certified addresses over addresses from an unknown origin.
148
148
  - Modular dialer? (taken from go PR notes)
149
- - With the modular dialer, users should easily be able to configure precedence. With dialer v1, anything we do to prioritise dials is gonna be spaghetti and adhoc. With the modular dialer, you’d be able to specify the order of dials when instantiating the pipeline.
149
+ - With the modular dialer, users should easily be able to configure precedence. With dialer v1, anything we do to prioritize dials is gonna be spaghetti and adhoc. With the modular dialer, you’d be able to specify the order of dials when instantiating the pipeline.
150
150
  - Multiple parallel dials. We already have the issue where new addresses aren't added to existing dials.
151
151
 
152
152
  # Install
@@ -17,8 +17,8 @@ export declare class RecordEnvelope implements Envelope {
17
17
  */
18
18
  static seal: (record: Record, privateKey: PrivateKey) => Promise<RecordEnvelope>;
19
19
  /**
20
- * Open and certify a given marshalled envelope.
21
- * Data is unmarshalled and the signature validated for the given domain.
20
+ * Open and certify a given marshaled envelope.
21
+ * Data is unmarshaled and the signature validated for the given domain.
22
22
  */
23
23
  static openAndCertify: (data: Uint8Array | Uint8ArrayList, domain: string) => Promise<RecordEnvelope>;
24
24
  publicKey: PublicKey;
@@ -40,8 +40,8 @@ export class RecordEnvelope {
40
40
  });
41
41
  };
42
42
  /**
43
- * Open and certify a given marshalled envelope.
44
- * Data is unmarshalled and the signature validated for the given domain.
43
+ * Open and certify a given marshaled envelope.
44
+ * Data is unmarshaled and the signature validated for the given domain.
45
45
  */
46
46
  static openAndCertify = async (data, domain) => {
47
47
  const envelope = await RecordEnvelope.createFromProtobuf(data);
@@ -103,9 +103,9 @@ import { generateKeyPair } from '@libp2p/crypto/keys'
103
103
  *
104
104
  * ### Subsystem receiving a record
105
105
  *
106
- * Considering that a node can discover other peers' addresses from a variety of sources, Libp2p Peerstore can differentiate the addresses that were obtained through a signed peer record.
106
+ * Considering that a node can discover other peers' addresses from a variety of sources, Libp2p PeerStore can differentiate the addresses that were obtained through a signed peer record.
107
107
  *
108
- * Once a record is received and its signature properly validated, its envelope is stored in the AddressBook in its byte representation. The `seqNumber` remains unmarshalled so that we can quickly compare it against incoming records to determine the most recent record.
108
+ * Once a record is received and its signature properly validated, its envelope is stored in the AddressBook in its byte representation. The `seqNumber` remains unmarshaled so that we can quickly compare it against incoming records to determine the most recent record.
109
109
  *
110
110
  * The AddressBook Addresses will be updated with the content of the envelope with a certified property. This allows other subsystems to identify the known certified addresses of a peer.
111
111
  *
@@ -123,7 +123,7 @@ import { generateKeyPair } from '@libp2p/crypto/keys'
123
123
  * - Some addresses may be ambiguous. For example, addresses on a private subnet are valid within that subnet but are useless on the public internet.
124
124
  * - Once all these pieces are in place, we will also need a way to prioritize addresses based on their authenticity, that is, the dialer can prioritize self-certified addresses over addresses from an unknown origin.
125
125
  * - Modular dialer? (taken from go PR notes)
126
- * - With the modular dialer, users should easily be able to configure precedence. With dialer v1, anything we do to prioritise dials is gonna be spaghetti and adhoc. With the modular dialer, you’d be able to specify the order of dials when instantiating the pipeline.
126
+ * - With the modular dialer, users should easily be able to configure precedence. With dialer v1, anything we do to prioritize dials is gonna be spaghetti and adhoc. With the modular dialer, you’d be able to specify the order of dials when instantiating the pipeline.
127
127
  * - Multiple parallel dials. We already have the issue where new addresses aren't added to existing dials.
128
128
  */
129
129
  export { RecordEnvelope } from './envelope/index.js';
package/dist/src/index.js CHANGED
@@ -103,9 +103,9 @@ import { generateKeyPair } from '@libp2p/crypto/keys'
103
103
  *
104
104
  * ### Subsystem receiving a record
105
105
  *
106
- * Considering that a node can discover other peers' addresses from a variety of sources, Libp2p Peerstore can differentiate the addresses that were obtained through a signed peer record.
106
+ * Considering that a node can discover other peers' addresses from a variety of sources, Libp2p PeerStore can differentiate the addresses that were obtained through a signed peer record.
107
107
  *
108
- * Once a record is received and its signature properly validated, its envelope is stored in the AddressBook in its byte representation. The `seqNumber` remains unmarshalled so that we can quickly compare it against incoming records to determine the most recent record.
108
+ * Once a record is received and its signature properly validated, its envelope is stored in the AddressBook in its byte representation. The `seqNumber` remains unmarshaled so that we can quickly compare it against incoming records to determine the most recent record.
109
109
  *
110
110
  * The AddressBook Addresses will be updated with the content of the envelope with a certified property. This allows other subsystems to identify the known certified addresses of a peer.
111
111
  *
@@ -123,7 +123,7 @@ import { generateKeyPair } from '@libp2p/crypto/keys'
123
123
  * - Some addresses may be ambiguous. For example, addresses on a private subnet are valid within that subnet but are useless on the public internet.
124
124
  * - Once all these pieces are in place, we will also need a way to prioritize addresses based on their authenticity, that is, the dialer can prioritize self-certified addresses over addresses from an unknown origin.
125
125
  * - Modular dialer? (taken from go PR notes)
126
- * - With the modular dialer, users should easily be able to configure precedence. With dialer v1, anything we do to prioritise dials is gonna be spaghetti and adhoc. With the modular dialer, you’d be able to specify the order of dials when instantiating the pipeline.
126
+ * - With the modular dialer, users should easily be able to configure precedence. With dialer v1, anything we do to prioritize dials is gonna be spaghetti and adhoc. With the modular dialer, you’d be able to specify the order of dials when instantiating the pipeline.
127
127
  * - Multiple parallel dials. We already have the issue where new addresses aren't added to existing dials.
128
128
  */
129
129
  export { RecordEnvelope } from './envelope/index.js';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@libp2p/peer-record",
3
- "version": "8.0.20-e7e01f58f",
3
+ "version": "8.0.20-f465c5473",
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",
@@ -61,10 +61,10 @@
61
61
  "test:electron-main": "aegir test -t electron-main"
62
62
  },
63
63
  "dependencies": {
64
- "@libp2p/crypto": "5.0.12-e7e01f58f",
65
- "@libp2p/interface": "2.6.0-e7e01f58f",
66
- "@libp2p/peer-id": "5.0.13-e7e01f58f",
67
- "@libp2p/utils": "6.5.4-e7e01f58f",
64
+ "@libp2p/crypto": "5.0.12-f465c5473",
65
+ "@libp2p/interface": "2.6.0-f465c5473",
66
+ "@libp2p/peer-id": "5.0.13-f465c5473",
67
+ "@libp2p/utils": "6.5.4-f465c5473",
68
68
  "@multiformats/multiaddr": "^12.3.3",
69
69
  "multiformats": "^13.3.1",
70
70
  "protons-runtime": "^5.5.0",
@@ -54,8 +54,8 @@ export class RecordEnvelope implements Envelope {
54
54
  }
55
55
 
56
56
  /**
57
- * Open and certify a given marshalled envelope.
58
- * Data is unmarshalled and the signature validated for the given domain.
57
+ * Open and certify a given marshaled envelope.
58
+ * Data is unmarshaled and the signature validated for the given domain.
59
59
  */
60
60
  static openAndCertify = async (data: Uint8Array | Uint8ArrayList, domain: string): Promise<RecordEnvelope> => {
61
61
  const envelope = await RecordEnvelope.createFromProtobuf(data)
package/src/index.ts CHANGED
@@ -103,9 +103,9 @@ import { generateKeyPair } from '@libp2p/crypto/keys'
103
103
  *
104
104
  * ### Subsystem receiving a record
105
105
  *
106
- * Considering that a node can discover other peers' addresses from a variety of sources, Libp2p Peerstore can differentiate the addresses that were obtained through a signed peer record.
106
+ * Considering that a node can discover other peers' addresses from a variety of sources, Libp2p PeerStore can differentiate the addresses that were obtained through a signed peer record.
107
107
  *
108
- * Once a record is received and its signature properly validated, its envelope is stored in the AddressBook in its byte representation. The `seqNumber` remains unmarshalled so that we can quickly compare it against incoming records to determine the most recent record.
108
+ * Once a record is received and its signature properly validated, its envelope is stored in the AddressBook in its byte representation. The `seqNumber` remains unmarshaled so that we can quickly compare it against incoming records to determine the most recent record.
109
109
  *
110
110
  * The AddressBook Addresses will be updated with the content of the envelope with a certified property. This allows other subsystems to identify the known certified addresses of a peer.
111
111
  *
@@ -123,7 +123,7 @@ import { generateKeyPair } from '@libp2p/crypto/keys'
123
123
  * - Some addresses may be ambiguous. For example, addresses on a private subnet are valid within that subnet but are useless on the public internet.
124
124
  * - Once all these pieces are in place, we will also need a way to prioritize addresses based on their authenticity, that is, the dialer can prioritize self-certified addresses over addresses from an unknown origin.
125
125
  * - Modular dialer? (taken from go PR notes)
126
- * - With the modular dialer, users should easily be able to configure precedence. With dialer v1, anything we do to prioritise dials is gonna be spaghetti and adhoc. With the modular dialer, you’d be able to specify the order of dials when instantiating the pipeline.
126
+ * - With the modular dialer, users should easily be able to configure precedence. With dialer v1, anything we do to prioritize dials is gonna be spaghetti and adhoc. With the modular dialer, you’d be able to specify the order of dials when instantiating the pipeline.
127
127
  * - Multiple parallel dials. We already have the issue where new addresses aren't added to existing dials.
128
128
  */
129
129