feat!: update deps (#163)

BREAKING CHANGE: update to new libp2p interface versions

Author: achingbrain

.github/workflows/js-test-and-release.yml

@@ -35,9 +35,8 @@ jobs:
           node-version: ${{ matrix.node }}
       - uses: ipfs/aegir/actions/cache-node-modules@master
       - run: npm run --if-present test:node
-      - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
+      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
         with:
-          directory: ./.nyc_output
           flags: node
 
   test-chrome:
@@ -50,9 +49,8 @@ jobs:
           node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
       - run: npm run --if-present test:chrome
-      - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
+      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
         with:
-          directory: ./.nyc_output
           flags: chrome
 
   test-chrome-webworker:
@@ -65,9 +63,8 @@ jobs:
           node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
       - run: npm run --if-present test:chrome-webworker
-      - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
+      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
         with:
-          directory: ./.nyc_output
           flags: chrome-webworker
 
   test-firefox:
@@ -80,9 +77,8 @@ jobs:
           node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
       - run: npm run --if-present test:firefox
-      - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
+      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
         with:
-          directory: ./.nyc_output
           flags: firefox
 
   test-firefox-webworker:
@@ -95,9 +91,8 @@ jobs:
           node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
       - run: npm run --if-present test:firefox-webworker
-      - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
+      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
         with:
-          directory: ./.nyc_output
           flags: firefox-webworker
 
   test-electron-main:
@@ -110,9 +105,8 @@ jobs:
           node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
       - run: npx xvfb-maybe npm run --if-present test:electron-main
-      - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
+      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
         with:
-          directory: ./.nyc_output
           flags: electron-main
 
   test-electron-renderer:
@@ -125,9 +119,8 @@ jobs:
           node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
       - run: npx xvfb-maybe npm run --if-present test:electron-renderer
-      - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
+      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
         with:
-          directory: ./.nyc_output
           flags: electron-renderer
 
   release:

README.md

@@ -1,25 +1,19 @@
-# IPNS <!-- omit in toc -->
+# ipns <!-- omit in toc -->
 
-[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
-[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
-[![Matrix](https://img.shields.io/badge/matrix-%23ipfs%3Amatrix.org-blue.svg?style=flat-square)](https://matrix.to/#/#ipfs:matrix.org)
+[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
 [![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![Discord](https://img.shields.io/discord/475789330380488707?color=blueviolet&label=discord&style=flat-square)](https://discord.gg/24fmuwR)
-[![standard-readme](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
+[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
+[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipns.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipns)
+[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipns/actions/workflows/js-test-and-release.yml)
 
 > ipns record definitions
 
-This module contains all the necessary code for creating, understanding and validating IPNS records.
-
-## Lead Maintainer <!-- omit in toc -->
-
-[Vasco Santos](https://github.com/vasco-santos).
-
-## Table of Contents <!-- omit in toc -->
+## Table of contents <!-- omit in toc -->
 
+- [Install](#install)
+- [Lead Maintainer <!-- omit in toc -->](#lead-maintainer----omit-in-toc---)
 - [Usage](#usage)
-    - [Create record](#create-record)
+  - - [Create record](#create-record)
     - [Validate record](#validate-record)
     - [Embed public key to record](#embed-public-key-to-record)
     - [Extract public key from record](#extract-public-key-from-record)
@@ -28,7 +22,7 @@ This module contains all the necessary code for creating, understanding and vali
     - [Unmarshal data from proto buffer](#unmarshal-data-from-proto-buffer)
     - [Validator](#validator)
 - [API](#api)
-    - [Create record](#create-record-1)
+  - - [Create record](#create-record-1)
     - [Validate record](#validate-record-1)
     - [Datastore key](#datastore-key-1)
     - [Marshal data with proto buffer](#marshal-data-with-proto-buffer-1)
@@ -38,10 +32,19 @@ This module contains all the necessary code for creating, understanding and vali
     - [Namespace](#namespace)
 - [Contribute](#contribute)
 - [License](#license)
+- [Contribute](#contribute-1)
 
-### Install
+## Install
 
-> npm install ipns
+```console
+$ npm i ipns
+```
+
+This module contains all the necessary code for creating, understanding and validating IPNS records.
+
+## Lead Maintainer <!-- omit in toc -->
+
+[Vasco Santos](https://github.com/vasco-santos).
 
 ## Usage
 
@@ -88,9 +91,7 @@ ipns.getLocalKey(peerId)
 
 Returns a key to be used for storing the ipns entry locally, that is:
 
-```
-/ipns/${base32(<HASH>)}
-```
+    /ipns/${base32(<HASH>)}
 
 #### Marshal data with proto buffer
 
@@ -211,7 +212,7 @@ Embed a public key in an IPNS entry. If it is possible to extract the public key
 - `publicKey` (`PubKey` [RSA Instance](https://github.com/libp2p/js-libp2p-crypto/blob/master/src/keys/rsa-class.js)): key to be used for cryptographic operations.
 - `ipnsEntry` (Object): ipns entry record (obtained using the create function).
 
- Returns a `Promise`. If the promise resolves to null it means the public key can be extracted directly from the `peer-id`.
+Returns a `Promise`. If the promise resolves to null it means the public key can be extracted directly from the `peer-id`.
 
 #### Extract public key from record
 
@@ -252,4 +253,15 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
 
 ## License
 
-Copyright (c) Protocol Labs, Inc. under the **MIT License**. See [LICENSE file](./LICENSE) for details.
+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>)
+
+## Contribute
+
+Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
+
+This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

package.json

@@ -46,12 +46,15 @@
   ],
   "exports": {
     ".": {
+      "types": "./dist/src/index.d.ts",
       "import": "./dist/src/index.js"
     },
     "./selector": {
+      "types": "./dist/src/selector.d.ts",
       "import": "./dist/src/selector.js"
     },
     "./validator": {
+      "types": "./dist/src/validator.d.ts",
       "import": "./dist/src/validator.js"
     }
   },
@@ -161,9 +164,11 @@
     "generate": "protons src/pb/ipns.proto"
   },
   "dependencies": {
-    "@libp2p/crypto": "^0.22.12",
-    "@libp2p/interfaces": "^2.0.2",
-    "@libp2p/logger": "^1.1.3",
+    "@libp2p/crypto": "^1.0.0",
+    "@libp2p/interface-dht": "^1.0.1",
+    "@libp2p/interface-keys": "^1.0.3",
+    "@libp2p/interface-peer-id": "^1.0.4",
+    "@libp2p/logger": "^2.0.0",
     "@libp2p/peer-id": "^1.1.9",
     "cborg": "^1.3.3",
     "debug": "^4.2.0",

src/index.ts

@@ -11,8 +11,8 @@ import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
 import * as Digest from 'multiformats/hashes/digest'
 import { identity } from 'multiformats/hashes/identity'
 import { IpnsEntry } from './pb/ipns.js'
-import type { PrivateKey } from '@libp2p/interfaces/keys'
-import type { PeerId } from '@libp2p/interfaces/peer-id'
+import type { PrivateKey } from '@libp2p/interface-keys'
+import type { PeerId } from '@libp2p/interface-peer-id'
 
 const log = logger('ipns')
 const ID_MULTIHASH_CODE = identity.code

src/selector.ts

@@ -1,7 +1,7 @@
 import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
 import { IpnsEntry } from './pb/ipns.js'
 import { parseRFC3339 } from './utils.js'
-import type { SelectFn } from '@libp2p/interfaces/dht'
+import type { SelectFn } from '@libp2p/interface-dht'
 
 export const ipnsSelector: SelectFn = (key, data) => {
   const entries = data.map((buf, index) => ({

src/utils.ts

@@ -1,5 +1,5 @@
 import errCode from 'err-code'
-import type { PeerId } from '@libp2p/interfaces/peer-id'
+import type { PeerId } from '@libp2p/interface-peer-id'
 import type { IPNSEntry, IPNSEntryData } from './index.js'
 import * as ERRORS from './errors.js'
 import { unmarshalPublicKey } from '@libp2p/crypto/keys'

src/validator.ts

@@ -5,8 +5,8 @@ import { IpnsEntry } from './pb/ipns.js'
 import { parseRFC3339, extractPublicKey, ipnsEntryDataForV1Sig, ipnsEntryDataForV2Sig, unmarshal, peerIdFromRoutingKey, parseCborData } from './utils.js'
 import * as ERRORS from './errors.js'
 import type { IPNSEntry } from './index.js'
-import type { PublicKey } from '@libp2p/interfaces/keys'
-import type { ValidateFn } from '@libp2p/interfaces/dht'
+import type { PublicKey } from '@libp2p/interface-keys'
+import type { ValidateFn } from '@libp2p/interface-dht'
 import { logger } from '@libp2p/logger'
 
 const log = logger('ipns:validator')

test/index.spec.ts

@@ -8,7 +8,7 @@ import { generateKeyPair } from '@libp2p/crypto/keys'
 import { randomBytes } from '@libp2p/crypto'
 import * as ipns from '../src/index.js'
 import * as ERRORS from '../src/errors.js'
-import type { PeerId } from '@libp2p/interfaces/peer-id'
+import type { PeerId } from '@libp2p/interface-peer-id'
 import { unmarshal, marshal, extractPublicKey, peerIdToRoutingKey } from '../src/utils.js'
 import { ipnsValidator } from '../src/validator.js'
 import { createEd25519PeerId } from '@libp2p/peer-id-factory'

test/selector.spec.ts

@@ -7,7 +7,7 @@ import { generateKeyPair } from '@libp2p/crypto/keys'
 import * as ipns from '../src/index.js'
 import { marshal, peerIdToRoutingKey } from '../src/utils.js'
 import { ipnsSelector } from '../src/selector.js'
-import type { PeerId } from '@libp2p/interfaces/peer-id'
+import type { PeerId } from '@libp2p/interface-peer-id'
 
 describe('selector', function () {
   this.timeout(20 * 1000)

test/validator.spec.ts

@@ -9,7 +9,7 @@ import { generateKeyPair } from '@libp2p/crypto/keys'
 import { randomBytes } from '@libp2p/crypto'
 import * as ipns from '../src/index.js'
 import * as ERRORS from '../src/errors.js'
-import type { PeerId } from '@libp2p/interfaces/peer-id'
+import type { PeerId } from '@libp2p/interface-peer-id'
 import { marshal, peerIdToRoutingKey } from '../src/utils.js'
 import { ipnsValidator } from '../src/validator.js'