@libp2p/peer-record 1.0.12 → 2.0.0

package/README.md

@@ -1,9 +1,16 @@
-# libp2p-peer-record <!-- omit in toc -->
+# @libp2p/peer-record <!-- omit in toc -->
 
-> Peer records are signed records that contain the address information of network peers
+[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![IRC](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
+[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
+[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-peer-record.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-peer-record)
+[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/libp2p/js-libp2p-peer-record/actions/workflows/js-test-and-release.yml)
 
-## Table of Contents <!-- omit in toc -->
+> Used to transfer signed peer data across the network
 
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
 - [Description](#description)
   - [Envelope](#envelope)
 - [Usage](#usage)
@@ -16,9 +23,14 @@
     - [Subsystem providing a record](#subsystem-providing-a-record)
   - [Future Work](#future-work)
 - [Example](#example)
-- [Installation](#installation)
 - [License](#license)
-  - [Contribution](#contribution)
+- [Contribution](#contribution)
+
+## Install
+
+```console
+$ npm i @libp2p/peer-record
+```
 
 ## Description
 
@@ -38,10 +50,10 @@ You can read further about the envelope in [libp2p/specs#217](https://github.com
 
 ```js
 // interface-record implementation example with the "libp2p-example" namespace
-const Record = require('libp2p-interfaces/src/record')
-const { fromString } = require('uint8arrays/from-string')
+import { PeerRecord } from '@libp2p/peer-record'
+import { fromString } from 'uint8arrays/from-string'
 
-class ExampleRecord extends Record {
+class ExampleRecord extends PeerRecord {
   constructor () {
     super ('libp2p-example', fromString('0302', 'hex'))
   }
@@ -55,25 +67,25 @@ ExampleRecord.createFromProtobuf = () => {}
 ```
 
 ```js
-const Envelope = require('libp2p/src/record/envelop')
-const ExampleRecord = require('./example-record')
+import { PeerEnvelope } from '@libp2p/peer-record'
+import { ExampleRecord } from './example-record.js'
 
 const rec = new ExampleRecord()
-const e = await Envelope.seal(rec, peerId)
+const e = await PeerEnvelope.seal(rec, peerId)
 const wireData = e.marshal()
 ```
 
 - consume a received envelope (`wireData`) and transform it back to a record:
 
 ```js
-const Envelope = require('libp2p/src/record/envelop')
-const ExampleRecord = require('./example-record')
+import { PeerEnvelope } from '@libp2p/peer-record'
+import { ExampleRecord } from './example-record.js'
 
 const domain = 'libp2p-example'
 let e
 
 try {
-  e = await Envelope.openAndCertify(wireData, domain)
+  e = await PeerEnvelope.openAndCertify(wireData, domain)
 } catch (err) {}
 
 const rec = ExampleRecord.createFromProtobuf(e.payload)
@@ -94,7 +106,7 @@ You can read further about the Peer Record in [libp2p/specs#217](https://github.
 - create a new Peer Record
 
 ```js
-const PeerRecord = require('libp2p/src/record/peer-record')
+import { PeerRecord } from '@libp2p/peer-record'
 
 const pr = new PeerRecord({
   peerId: node.peerId,
@@ -105,7 +117,7 @@ const pr = new PeerRecord({
 - create a Peer Record from a protobuf
 
 ```js
-const PeerRecord = require('libp2p/src/record/peer-record')
+import { PeerRecord } from '@libp2p/peer-record'
 
 const pr = PeerRecord.createFromProtobuf(data)
 ```
@@ -120,7 +132,7 @@ The identify service is responsible for creating the self record when the identi
 
 #### Self record Updates
 
-**_NOT_YET_IMPLEMENTED_**
+***NOT\_YET\_IMPLEMENTED***
 
 While creating peer records is fairly trivial, addresses are not static and might be modified at arbitrary times. This can happen via an Address Manager API, or even through AutoRelay/AutoNAT.
 
@@ -161,19 +173,13 @@ const map = trackedMap<string, string>({ metrics })
 map.set('key', 'value')
 ```
 
-## Installation
-
-```console
-$ npm i @libp2p/peer-record
-```
-
 ## License
 
 Licensed under either of
 
- * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
- * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-### Contribution
+## Contribution
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

package/dist/src/envelope/index.d.ts

@@ -1,5 +1,5 @@
-import type { PeerId } from '@libp2p/interfaces/peer-id';
-import type { Record, Envelope } from '@libp2p/interfaces/record';
+import type { PeerId } from '@libp2p/interface-peer-id';
+import type { Record, Envelope } from '@libp2p/interface-record';
 export interface EnvelopeInit {
     peerId: PeerId;
     payloadType: Uint8Array;

package/dist/src/envelope/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/envelope/index.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AAEjE,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,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,SAAgB,UAAU,6BAUlD;IAED;;;OAGG;IACH,MAAM,CAAC,IAAI,WAAkB,MAAM,UAAU,MAAM,6BAoBlD;IAED;;;OAGG;IACH,MAAM,CAAC,cAAc,SAAgB,UAAU,UAAU,MAAM,6BAS9D;IAEM,MAAM,EAAE,MAAM,CAAA;IACd,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,YAAY;IAS/B;;OAEG;IACH,OAAO;IAiBP;;OAEG;IACH,MAAM,CAAE,KAAK,EAAE,QAAQ;IAIvB;;OAEG;IACG,QAAQ,CAAE,MAAM,EAAE,MAAM;CAW/B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/envelope/index.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAA;AAEhE,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,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,SAAgB,UAAU,6BAUlD;IAED;;;OAGG;IACH,MAAM,CAAC,IAAI,WAAkB,MAAM,UAAU,MAAM,6BAoBlD;IAED;;;OAGG;IACH,MAAM,CAAC,cAAc,SAAgB,UAAU,UAAU,MAAM,6BAS9D;IAEM,MAAM,EAAE,MAAM,CAAA;IACd,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,YAAY;IAS/B;;OAEG;IACH,OAAO;IAiBP;;OAEG;IACH,MAAM,CAAE,KAAK,EAAE,QAAQ;IAIvB;;OAEG;IACG,QAAQ,CAAE,MAAM,EAAE,MAAM;CAW/B"}

package/dist/src/peer-record/index.d.ts

@@ -1,5 +1,5 @@
 import { Multiaddr } from '@multiformats/multiaddr';
-import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { PeerId } from '@libp2p/interface-peer-id';
 export interface PeerRecordInit {
     peerId: PeerId;
     /**

package/dist/src/peer-record/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/peer-record/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AASxD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,CAAA;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,qBAAa,UAAU;IACrB;;OAEG;IACH,MAAM,CAAC,kBAAkB,QAAS,UAAU,KAAG,UAAU,CAOxD;IAED,MAAM,CAAC,MAAM,SAA8B;IAC3C,MAAM,CAAC,KAAK,aAAoC;IAEzC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,SAAoB;IAC1B,KAAK,aAAmB;IAC/B,OAAO,CAAC,SAAS,CAAC,CAAY;gBAEjB,IAAI,EAAE,cAAc;IAQjC;;OAEG;IACH,OAAO;IAcP;;OAEG;IACH,MAAM,CAAE,KAAK,EAAE,OAAO;CAsBvB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/peer-record/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AASvD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,CAAA;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,qBAAa,UAAU;IACrB;;OAEG;IACH,MAAM,CAAC,kBAAkB,QAAS,UAAU,KAAG,UAAU,CAOxD;IAED,MAAM,CAAC,MAAM,SAA8B;IAC3C,MAAM,CAAC,KAAK,aAAoC;IAEzC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,SAAoB;IAC1B,KAAK,aAAmB;IAC/B,OAAO,CAAC,SAAS,CAAC,CAAY;gBAEjB,IAAI,EAAE,cAAc;IAQjC;;OAEG;IACH,OAAO;IAcP;;OAEG;IACH,MAAM,CAAE,KAAK,EAAE,OAAO;CAsBvB"}

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@libp2p/peer-record",
-  "version": "1.0.12",
+  "version": "2.0.0",
   "description": "Used to transfer signed peer data across the network",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-peer-record#readme",
+  "homepage": "https://github.com/libp2p/js-libp2p-peer-record#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/libp2p/js-libp2p-interfaces.git"
+    "url": "git+https://github.com/libp2p/js-libp2p-peer-record.git"
   },
   "bugs": {
-    "url": "https://github.com/libp2p/js-libp2p-interfaces/issues"
+    "url": "https://github.com/libp2p/js-libp2p-peer-record/issues"
   },
   "keywords": [
     "IPFS"
@@ -28,6 +28,7 @@
   ],
   "exports": {
     ".": {
+      "types": "./src/index.d.ts",
       "import": "./dist/src/index.js"
     }
   },
@@ -140,10 +141,11 @@
     "release": "aegir release"
   },
   "dependencies": {
-    "@libp2p/crypto": "^0.22.8",
-    "@libp2p/interfaces": "^2.0.0",
+    "@libp2p/crypto": "^1.0.0",
+    "@libp2p/interface-peer-id": "^1.0.2",
+    "@libp2p/interface-record": "^1.0.1",
     "@libp2p/logger": "^1.1.0",
-    "@libp2p/peer-id": "^1.1.0",
+    "@libp2p/peer-id": "^1.1.13",
     "@libp2p/utils": "^1.0.9",
     "@multiformats/multiaddr": "^10.1.5",
     "err-code": "^3.0.1",

package/src/envelope/index.ts

@@ -7,8 +7,8 @@ import { equals as uint8arraysEquals } from 'uint8arrays/equals'
 import { codes } from '../errors.js'
 import { Envelope as Protobuf } from './envelope.js'
 import { peerIdFromKeys } from '@libp2p/peer-id'
-import type { PeerId } from '@libp2p/interfaces/peer-id'
-import type { Record, Envelope } from '@libp2p/interfaces/record'
+import type { PeerId } from '@libp2p/interface-peer-id'
+import type { Record, Envelope } from '@libp2p/interface-record'
 
 export interface EnvelopeInit {
   peerId: PeerId

package/src/peer-record/index.ts

@@ -1,5 +1,5 @@
 import { Multiaddr } from '@multiformats/multiaddr'
-import type { PeerId } from '@libp2p/interfaces/peer-id'
+import type { PeerId } from '@libp2p/interface-peer-id'
 import { arrayEquals } from '@libp2p/utils/array-equals'
 import { peerIdFromBytes } from '@libp2p/peer-id'
 import { PeerRecord as Protobuf } from './peer-record.js'