diff --git a/packages/peer-record/README.md b/packages/peer-record/README.md index 95d98a74b2..16e5c42c12 100644 --- a/packages/peer-record/README.md +++ b/packages/peer-record/README.md @@ -30,13 +30,13 @@ Libp2p nodes need to store data in a public location (e.g. a DHT), or rely on po 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. -This envelope stores a marshaled record implementing the [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record/index.ts). These Records are designed to be serialized to bytes and placed inside of the envelopes before being shared with other peers. +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. 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). ## Example - Creating a peer record -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: +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: ```TypeScript import { PeerRecord, RecordEnvelope } from '@libp2p/peer-record' diff --git a/packages/peer-record/src/index.ts b/packages/peer-record/src/index.ts index 9467dfe3ac..e8871f2cff 100644 --- a/packages/peer-record/src/index.ts +++ b/packages/peer-record/src/index.ts @@ -7,13 +7,13 @@ * * 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. * - * This envelope stores a marshaled record implementing the [interface-record](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/record/index.ts). These Records are designed to be serialized to bytes and placed inside of the envelopes before being shared with other peers. + * 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. * * 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). * * @example Creating a peer record * - * 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: + * 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: * * ```TypeScript * import { PeerRecord, RecordEnvelope } from '@libp2p/peer-record'