diff --git a/packages/interop/package.json b/packages/interop/package.json index 50f46d9f..f27fc5e1 100644 --- a/packages/interop/package.json +++ b/packages/interop/package.json @@ -60,6 +60,7 @@ "@libp2p/peer-id-factory": "^3.0.3", "@libp2p/tcp": "^8.0.4", "@libp2p/websockets": "^7.0.4", + "aegir": "^41.1.14", "blockstore-core": "^4.0.1", "datastore-core": "^9.0.3", "helia": "^2.0.1", diff --git a/packages/ipns/CHANGELOG.md b/packages/ipns/CHANGELOG.md index 909489aa..8d5f61f3 100644 --- a/packages/ipns/CHANGELOG.md +++ b/packages/ipns/CHANGELOG.md @@ -5,6 +5,41 @@ * alters the options object passed to the `ipns` factory function +#### Before + +```typescript +import { createHelia } from 'helia' +import { ipns } from '@helia/ipns' +import { dht, pubsub } from '@helia/ipns/routing' +import { unixfs } from '@helia/unixfs' + +const helia = await createHelia() +const name = ipns(helia, [ + dht(helia), + pubsub(helia) +]) +``` + +#### After + +```typescript +import { createHelia } from 'helia' +import { ipns } from '@helia/ipns' +import { dnsOverHttps } from '@helia/ipns/dns-resolvers' +import { unixfs } from '@helia/unixfs' + +const helia = await createHelia() +const name = ipns(helia, { + routers: [ + dht(helia), + pubsub(helia) + ], + resolvers: [ + dnsOverHttps('https://private-dns-server.me/dns-query'), + ] +}) +``` + ### Features * support DNS over HTTPS and DNS-JSON over HTTPS ([#55](https://github.com/ipfs/helia-ipns/issues/55)) ([2ac0e8b](https://github.com/ipfs/helia-ipns/commit/2ac0e8b26556b73961e67191c564ac2b18d32b31)) diff --git a/packages/ipns/package.json b/packages/ipns/package.json index ddf47a1d..e5353661 100644 --- a/packages/ipns/package.json +++ b/packages/ipns/package.json @@ -177,6 +177,7 @@ "@libp2p/interface": "^0.1.4", "@libp2p/peer-id-factory": "^3.0.3", "@types/dns-packet": "^5.6.4", + "aegir": "^41.1.14", "datastore-core": "^9.0.3", "sinon": "^17.0.0", "sinon-ts": "^1.0.0" diff --git a/packages/ipns/src/index.ts b/packages/ipns/src/index.ts index cb8ca507..93ce0cab 100644 --- a/packages/ipns/src/index.ts +++ b/packages/ipns/src/index.ts @@ -9,6 +9,7 @@ * * ```typescript * import { createHelia } from 'helia' + * import { ipns } from '@helia/ipns' * import { dht, pubsub } from '@helia/ipns/routing' * import { unixfs } from '@helia/unixfs' * @@ -41,8 +42,9 @@ * * ```typescript * import { createHelia } from 'helia' - * import { dht, pubsub } from '@helia/ipns/routing' + * import { ipns } from '@helia/ipns' * import { unixfs } from '@helia/unixfs' + * import { dnsOverHttps } from '@helia/ipns/dns-resolvers' * * const helia = await createHelia() * const name = ipns(helia, { diff --git a/packages/ipns/test/resolveDns.spec.ts b/packages/ipns/test/resolve-dns.spec.ts similarity index 100% rename from packages/ipns/test/resolveDns.spec.ts rename to packages/ipns/test/resolve-dns.spec.ts