@helia/ipns 0.0.0

package/dist/src/routing/pubsub.js

@@ -0,0 +1,150 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _PubSubRouting_instances, _PubSubRouting_processPubSubMessage;
+import { peerIdToRoutingKey } from 'ipns';
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string';
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string';
+import { logger } from '@libp2p/logger';
+import { CodeError } from '@libp2p/interfaces/errors';
+import { localStore } from './local-store.js';
+import { ipnsValidator } from 'ipns/validator';
+import { ipnsSelector } from 'ipns/selector';
+import { equals as uint8ArrayEquals } from 'uint8arrays/equals';
+import { CustomProgressEvent } from 'progress-events';
+const log = logger('helia:ipns:routing:pubsub');
+/**
+ * This IPNS routing receives IPNS record updates via dedicated
+ * pubsub topic.
+ *
+ * Note we must first be subscribed to the topic in order to receive
+ * updated records, so the first call to `.get` should be expected
+ * to fail!
+ */
+class PubSubRouting {
+    constructor(components) {
+        _PubSubRouting_instances.add(this);
+        this.subscriptions = [];
+        this.localStore = localStore(components.datastore);
+        this.peerId = components.libp2p.peerId;
+        this.pubsub = components.libp2p.pubsub;
+        this.pubsub.addEventListener('message', (evt) => {
+            const message = evt.detail;
+            if (!this.subscriptions.includes(message.topic)) {
+                return;
+            }
+            __classPrivateFieldGet(this, _PubSubRouting_instances, "m", _PubSubRouting_processPubSubMessage).call(this, message).catch(err => {
+                log.error('Error processing message', err);
+            });
+        });
+    }
+    /**
+     * Put a value to the pubsub datastore indexed by the received key properly encoded
+     */
+    async put(routingKey, marshaledRecord, options = {}) {
+        try {
+            const topic = keyToTopic(routingKey);
+            log('publish value for topic %s', topic);
+            const result = await this.pubsub.publish(topic, marshaledRecord);
+            log('published record on topic %s to %d recipients', topic, result.recipients);
+            options.onProgress?.(new CustomProgressEvent('ipns:pubsub:publish', { topic, result }));
+        }
+        catch (err) {
+            options.onProgress?.(new CustomProgressEvent('ipns:pubsub:error', err));
+            throw err;
+        }
+    }
+    /**
+     * Get a value from the pubsub datastore indexed by the received key properly encoded.
+     * Also, the identifier topic is subscribed to and the pubsub datastore records will be
+     * updated once new publishes occur
+     */
+    async get(routingKey, options = {}) {
+        try {
+            const topic = keyToTopic(routingKey);
+            // ensure we are subscribed to topic
+            if (!this.pubsub.getTopics().includes(topic)) {
+                log('add subscription for topic', topic);
+                this.pubsub.subscribe(topic);
+                this.subscriptions.push(topic);
+                options.onProgress?.(new CustomProgressEvent('ipns:pubsub:subscribe', { topic }));
+            }
+            // chain through to local store
+            return await this.localStore.get(routingKey, options);
+        }
+        catch (err) {
+            options.onProgress?.(new CustomProgressEvent('ipns:pubsub:error', err));
+            throw err;
+        }
+    }
+    /**
+     * Get pubsub subscriptions related to ipns
+     */
+    getSubscriptions() {
+        return this.subscriptions;
+    }
+    /**
+     * Cancel pubsub subscriptions related to ipns
+     */
+    cancel(key) {
+        const routingKey = peerIdToRoutingKey(key);
+        const topic = keyToTopic(routingKey);
+        // Not found topic
+        if (!this.subscriptions.includes(topic)) {
+            return;
+        }
+        this.pubsub.unsubscribe(topic);
+        this.subscriptions = this.subscriptions.filter(t => t !== topic);
+    }
+}
+_PubSubRouting_instances = new WeakSet(), _PubSubRouting_processPubSubMessage = async function _PubSubRouting_processPubSubMessage(message) {
+    log('message received for topic', message.topic);
+    if (message.type !== 'signed') {
+        log.error('unsigned message received, this module can only work with signed messages');
+        return;
+    }
+    if (message.from.equals(this.peerId)) {
+        log('not storing record from self');
+        return;
+    }
+    const routingKey = topicToKey(message.topic);
+    await ipnsValidator(routingKey, message.data);
+    if (await this.localStore.has(routingKey)) {
+        const currentRecord = await this.localStore.get(routingKey);
+        if (uint8ArrayEquals(currentRecord, message.data)) {
+            log('not storing record as we already have it');
+            return;
+        }
+        const records = [currentRecord, message.data];
+        const index = ipnsSelector(routingKey, records);
+        if (index === 0) {
+            log('not storing record as the one we have is better');
+            return;
+        }
+    }
+    await this.localStore.put(routingKey, message.data);
+};
+const PUBSUB_NAMESPACE = '/record/';
+/**
+ * converts a binary record key to a pubsub topic key
+ */
+function keyToTopic(key) {
+    const b64url = uint8ArrayToString(key, 'base64url');
+    return `${PUBSUB_NAMESPACE}${b64url}`;
+}
+/**
+ * converts a pubsub topic key to a binary record key
+ */
+function topicToKey(topic) {
+    if (topic.substring(0, PUBSUB_NAMESPACE.length) !== PUBSUB_NAMESPACE) {
+        throw new CodeError('topic received is not from a record', 'ERR_TOPIC_IS_NOT_FROM_RECORD_NAMESPACE');
+    }
+    const key = topic.substring(PUBSUB_NAMESPACE.length);
+    return uint8ArrayFromString(key, 'base64url');
+}
+export function pubsub(components) {
+    return new PubSubRouting(components);
+}
+//# sourceMappingURL=pubsub.js.map

package/dist/src/routing/pubsub.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pubsub.js","sourceRoot":"","sources":["../../../src/routing/pubsub.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAA;AACzC,OAAO,EAAE,UAAU,IAAI,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC5E,OAAO,EAAE,QAAQ,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAKvC,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AACrD,OAAO,EAAE,UAAU,EAAc,MAAM,kBAAkB,CAAA;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,MAAM,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,EAAE,mBAAmB,EAAiB,MAAM,iBAAiB,CAAA;AAEpE,MAAM,GAAG,GAAG,MAAM,CAAC,2BAA2B,CAAC,CAAA;AAe/C;;;;;;;GAOG;AACH,MAAM,aAAa;IAMjB,YAAa,UAAmC;;QAC9C,IAAI,CAAC,aAAa,GAAG,EAAE,CAAA;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;QAClD,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CAAA;QACtC,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CAAA;QAEtC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;YAC9C,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAA;YAE1B,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBAC/C,OAAM;aACP;YAED,uBAAA,IAAI,qEAAsB,MAA1B,IAAI,EAAuB,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBAC9C,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAA;YAC5C,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAuCD;;OAEG;IACH,KAAK,CAAC,GAAG,CAAE,UAAsB,EAAE,eAA2B,EAAE,UAAsB,EAAE;QACtF,IAAI;YACF,MAAM,KAAK,GAAG,UAAU,CAAC,UAAU,CAAC,CAAA;YAEpC,GAAG,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAA;YACxC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,eAAe,CAAC,CAAA;YAEhE,GAAG,CAAC,+CAA+C,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;YAC9E,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;SACxF;QAAC,OAAO,GAAQ,EAAE;YACjB,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAQ,mBAAmB,EAAE,GAAG,CAAC,CAAC,CAAA;YAC9E,MAAM,GAAG,CAAA;SACV;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAE,UAAsB,EAAE,UAAsB,EAAE;QACzD,IAAI;YACF,MAAM,KAAK,GAAG,UAAU,CAAC,UAAU,CAAC,CAAA;YAEpC,oCAAoC;YACpC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAC5C,GAAG,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAA;gBACxC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;gBAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;gBAE9B,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;aAClF;YAED,+BAA+B;YAC/B,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;SACtD;QAAC,OAAO,GAAQ,EAAE;YACjB,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAQ,mBAAmB,EAAE,GAAG,CAAC,CAAC,CAAA;YAC9E,MAAM,GAAG,CAAA;SACV;IACH,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED;;OAEG;IACH,MAAM,CAAE,GAAW;QACjB,MAAM,UAAU,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAA;QAC1C,MAAM,KAAK,GAAG,UAAU,CAAC,UAAU,CAAC,CAAA;QAEpC,kBAAkB;QAClB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YACvC,OAAM;SACP;QAED,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;QAC9B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAAA;IAClE,CAAC;CACF;gFAvGC,KAAK,8CAAwB,OAAgB;IAC3C,GAAG,CAAC,4BAA4B,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;IAEhD,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;QAC7B,GAAG,CAAC,KAAK,CAAC,2EAA2E,CAAC,CAAA;QACtF,OAAM;KACP;IAED,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;QACpC,GAAG,CAAC,8BAA8B,CAAC,CAAA;QACnC,OAAM;KACP;IAED,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAE5C,MAAM,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7C,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;QACzC,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAE3D,IAAI,gBAAgB,CAAC,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE;YACjD,GAAG,CAAC,0CAA0C,CAAC,CAAA;YAC/C,OAAM;SACP;QAED,MAAM,OAAO,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;QAC7C,MAAM,KAAK,GAAG,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;QAE/C,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,GAAG,CAAC,iDAAiD,CAAC,CAAA;YACtD,OAAM;SACP;KACF;IAED,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;AACrD,CAAC;AAsEH,MAAM,gBAAgB,GAAG,UAAU,CAAA;AAEnC;;GAEG;AACH,SAAS,UAAU,CAAE,GAAe;IAClC,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,EAAE,WAAW,CAAC,CAAA;IAEnD,OAAO,GAAG,gBAAgB,GAAG,MAAM,EAAE,CAAA;AACvC,CAAC;AAED;;GAEG;AACH,SAAS,UAAU,CAAE,KAAa;IAChC,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,KAAK,gBAAgB,EAAE;QACpE,MAAM,IAAI,SAAS,CAAC,qCAAqC,EAAE,wCAAwC,CAAC,CAAA;KACrG;IAED,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAEpD,OAAO,oBAAoB,CAAC,GAAG,EAAE,WAAW,CAAC,CAAA;AAC/C,CAAC;AAED,MAAM,UAAU,MAAM,CAAE,UAAmC;IACzD,OAAO,IAAI,aAAa,CAAC,UAAU,CAAC,CAAA;AACtC,CAAC"}

package/dist/src/utils/resolve-dns-link.browser.d.ts

@@ -0,0 +1,6 @@
+import type { AbortOptions } from '@libp2p/interfaces';
+export interface ResolveDnsLinkOptions extends AbortOptions {
+    nocache?: boolean;
+}
+export declare function resolveDnslink(fqdn: string, opts?: ResolveDnsLinkOptions): Promise<string>;
+//# sourceMappingURL=resolve-dns-link.browser.d.ts.map

package/dist/src/utils/resolve-dns-link.browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-dns-link.browser.d.ts","sourceRoot":"","sources":["../../../src/utils/resolve-dns-link.browser.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAoBtD,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,wBAAsB,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,qBAA0B,GAAG,OAAO,CAAC,MAAM,CAAC,CAgCrG"}

package/dist/src/utils/resolve-dns-link.browser.js

@@ -0,0 +1,46 @@
+/* eslint-env browser */
+import { TLRU } from './tlru.js';
+import PQueue from 'p-queue';
+// Avoid sending multiple queries for the same hostname by caching results
+const cache = new TLRU(1000);
+// TODO: /api/v0/dns does not return TTL yet: https://github.com/ipfs/go-ipfs/issues/5884
+// However we know browsers themselves cache DNS records for at least 1 minute,
+// which acts a provisional default ttl: https://stackoverflow.com/a/36917902/11518426
+const ttl = 60 * 1000;
+// browsers limit concurrent connections per host,
+// we don't want preload calls to exhaust the limit (~6)
+const httpQueue = new PQueue({ concurrency: 4 });
+const ipfsPath = (response) => {
+    if (response.Path != null) {
+        return response.Path;
+    }
+    throw new Error(response.Message);
+};
+export async function resolveDnslink(fqdn, opts = {}) {
+    const resolve = async (fqdn, opts = {}) => {
+        // @ts-expect-error - URLSearchParams does not take boolean options, only strings
+        const searchParams = new URLSearchParams(opts);
+        searchParams.set('arg', fqdn);
+        // try cache first
+        const query = searchParams.toString();
+        if (opts.nocache !== true && cache.has(query)) {
+            const response = cache.get(query);
+            if (response != null) {
+                return ipfsPath(response);
+            }
+        }
+        // fallback to delegated DNS resolver
+        const response = await httpQueue.add(async () => {
+            // Delegated HTTP resolver sending DNSLink queries to ipfs.io
+            // TODO: replace hardcoded host with configurable DNS over HTTPS: https://github.com/ipfs/js-ipfs/issues/2212
+            const res = await fetch(`https://ipfs.io/api/v0/dns?${searchParams}`);
+            const query = new URL(res.url).search.slice(1);
+            const json = await res.json();
+            cache.set(query, json, ttl);
+            return json;
+        });
+        return ipfsPath(response);
+    };
+    return await resolve(fqdn, opts);
+}
+//# sourceMappingURL=resolve-dns-link.browser.js.map

package/dist/src/utils/resolve-dns-link.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-dns-link.browser.js","sourceRoot":"","sources":["../../../src/utils/resolve-dns-link.browser.ts"],"names":[],"mappings":"AAAA,wBAAwB;AAExB,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,MAAM,MAAM,SAAS,CAAA;AAG5B,0EAA0E;AAC1E,MAAM,KAAK,GAAG,IAAI,IAAI,CAAoC,IAAI,CAAC,CAAA;AAC/D,yFAAyF;AACzF,+EAA+E;AAC/E,sFAAsF;AACtF,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI,CAAA;AAErB,kDAAkD;AAClD,wDAAwD;AACxD,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAA;AAEhD,MAAM,QAAQ,GAAG,CAAC,QAA2C,EAAU,EAAE;IACvE,IAAI,QAAQ,CAAC,IAAI,IAAI,IAAI,EAAE;QACzB,OAAO,QAAQ,CAAC,IAAI,CAAA;KACrB;IACD,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;AACnC,CAAC,CAAA;AAMD,MAAM,CAAC,KAAK,UAAU,cAAc,CAAE,IAAY,EAAE,OAA8B,EAAE;IAClF,MAAM,OAAO,GAAG,KAAK,EAAE,IAAY,EAAE,OAA8B,EAAE,EAAmB,EAAE;QACxF,iFAAiF;QACjF,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAA;QAC9C,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAE7B,kBAAkB;QAClB,MAAM,KAAK,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAA;QACrC,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YAC7C,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YAEjC,IAAI,QAAQ,IAAI,IAAI,EAAE;gBACpB,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAA;aAC1B;SACF;QAED,qCAAqC;QACrC,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YAC9C,6DAA6D;YAC7D,6GAA6G;YAC7G,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,8BAA8B,YAAY,EAAE,CAAC,CAAA;YACrE,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC9C,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAA;YAC7B,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;YAE3B,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;QAEF,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAA;IAC3B,CAAC,CAAA;IAED,OAAO,MAAM,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;AAClC,CAAC"}

package/dist/src/utils/resolve-dns-link.d.ts

@@ -0,0 +1,3 @@
+import type { AbortOptions } from '@libp2p/interfaces';
+export declare function resolveDnslink(domain: string, options?: AbortOptions): Promise<string>;
+//# sourceMappingURL=resolve-dns-link.d.ts.map

package/dist/src/utils/resolve-dns-link.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-dns-link.d.ts","sourceRoot":"","sources":["../../../src/utils/resolve-dns-link.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAKtD,wBAAsB,cAAc,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,CAEjG"}

package/dist/src/utils/resolve-dns-link.js

@@ -0,0 +1,54 @@
+import dns from 'dns';
+import { promisify } from 'util';
+import * as isIPFS from 'is-ipfs';
+const MAX_RECURSIVE_DEPTH = 32;
+export async function resolveDnslink(domain, options = {}) {
+    return await recursiveResolveDnslink(domain, MAX_RECURSIVE_DEPTH, options);
+}
+async function recursiveResolveDnslink(domain, depth, options = {}) {
+    if (depth === 0) {
+        throw new Error('recursion limit exceeded');
+    }
+    let dnslinkRecord;
+    try {
+        dnslinkRecord = await resolve(domain);
+    }
+    catch (err) {
+        // If the code is not ENOTFOUND or ERR_DNSLINK_NOT_FOUND or ENODATA then throw the error
+        if (err.code !== 'ENOTFOUND' && err.code !== 'ERR_DNSLINK_NOT_FOUND' && err.code !== 'ENODATA') {
+            throw err;
+        }
+        if (domain.startsWith('_dnslink.')) {
+            // The supplied domain contains a _dnslink component
+            // Check the non-_dnslink domain
+            dnslinkRecord = await resolve(domain.replace('_dnslink.', ''));
+        }
+        else {
+            // Check the _dnslink subdomain
+            const _dnslinkDomain = `_dnslink.${domain}`;
+            // If this throws then we propagate the error
+            dnslinkRecord = await resolve(_dnslinkDomain);
+        }
+    }
+    const result = dnslinkRecord.replace('dnslink=', '');
+    const domainOrCID = result.split('/')[2];
+    const isIPFSCID = isIPFS.cid(domainOrCID);
+    if (isIPFSCID || depth === 0) {
+        return result;
+    }
+    return await recursiveResolveDnslink(domainOrCID, depth - 1, options);
+}
+async function resolve(domain, options = {}) {
+    const DNSLINK_REGEX = /^dnslink=.+$/;
+    const records = await promisify(dns.resolveTxt)(domain);
+    const dnslinkRecords = records.reduce((rs, r) => rs.concat(r), [])
+        .filter(record => DNSLINK_REGEX.test(record));
+    const dnslinkRecord = dnslinkRecords[0];
+    // we now have dns text entries as an array of strings
+    // only records passing the DNSLINK_REGEX text are included
+    if (dnslinkRecord == null) {
+        throw new Error(`No dnslink records found for domain: ${domain}`);
+    }
+    return dnslinkRecord;
+}
+//# sourceMappingURL=resolve-dns-link.js.map

package/dist/src/utils/resolve-dns-link.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-dns-link.js","sourceRoot":"","sources":["../../../src/utils/resolve-dns-link.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AACrB,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAEhC,OAAO,KAAK,MAAM,MAAM,SAAS,CAAA;AAEjC,MAAM,mBAAmB,GAAG,EAAE,CAAA;AAE9B,MAAM,CAAC,KAAK,UAAU,cAAc,CAAE,MAAc,EAAE,UAAwB,EAAE;IAC9E,OAAO,MAAM,uBAAuB,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAA;AAC5E,CAAC;AAED,KAAK,UAAU,uBAAuB,CAAE,MAAc,EAAE,KAAa,EAAE,UAAwB,EAAE;IAC/F,IAAI,KAAK,KAAK,CAAC,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;KAC5C;IAED,IAAI,aAAa,CAAA;IAEjB,IAAI;QACF,aAAa,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;KACtC;IAAC,OAAO,GAAQ,EAAE;QACjB,wFAAwF;QACxF,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,IAAI,GAAG,CAAC,IAAI,KAAK,uBAAuB,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE;YAC9F,MAAM,GAAG,CAAA;SACV;QAED,IAAI,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;YAClC,oDAAoD;YACpD,gCAAgC;YAChC,aAAa,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAA;SAC/D;aAAM;YACL,+BAA+B;YAC/B,MAAM,cAAc,GAAG,YAAY,MAAM,EAAE,CAAA;YAC3C,6CAA6C;YAC7C,aAAa,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,CAAA;SAC9C;KACF;IAED,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;IACpD,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IACxC,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IAEzC,IAAI,SAAS,IAAI,KAAK,KAAK,CAAC,EAAE;QAC5B,OAAO,MAAM,CAAA;KACd;IAED,OAAO,MAAM,uBAAuB,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,EAAE,OAAO,CAAC,CAAA;AACvE,CAAC;AAED,KAAK,UAAU,OAAO,CAAE,MAAc,EAAE,UAAwB,EAAE;IAChE,MAAM,aAAa,GAAG,cAAc,CAAA;IACpC,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAA;IACvD,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;SAC/D,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;IAE/C,MAAM,aAAa,GAAG,cAAc,CAAC,CAAC,CAAC,CAAA;IAEvC,sDAAsD;IACtD,2DAA2D;IAC3D,IAAI,aAAa,IAAI,IAAI,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,wCAAwC,MAAM,EAAE,CAAC,CAAA;KAClE;IAED,OAAO,aAAa,CAAA;AACtB,CAAC"}

package/dist/src/utils/tlru.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Time Aware Least Recent Used Cache
+ *
+ * @see https://arxiv.org/pdf/1801.00390
+ */
+export declare class TLRU<T> {
+    private readonly lru;
+    constructor(maxSize: number);
+    get(key: string): T | undefined;
+    set(key: string, value: T, ttl: number): void;
+    has(key: string): boolean;
+    remove(key: string): void;
+    clear(): void;
+}
+//# sourceMappingURL=tlru.d.ts.map

package/dist/src/utils/tlru.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tlru.d.ts","sourceRoot":"","sources":["../../../src/utils/tlru.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,qBAAa,IAAI,CAAC,CAAC;IACjB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAA4B;gBAEnC,OAAO,EAAE,MAAM;IAI5B,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAgBhC,GAAG,CAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAI9C,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAU1B,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAI1B,KAAK,IAAK,IAAI;CAGf"}

package/dist/src/utils/tlru.js

@@ -0,0 +1,39 @@
+import hashlru from 'hashlru';
+/**
+ * Time Aware Least Recent Used Cache
+ *
+ * @see https://arxiv.org/pdf/1801.00390
+ */
+export class TLRU {
+    constructor(maxSize) {
+        this.lru = hashlru(maxSize);
+    }
+    get(key) {
+        const value = this.lru.get(key);
+        if (value != null) {
+            if (value.expire != null && value.expire < Date.now()) {
+                this.lru.remove(key);
+                return undefined;
+            }
+            return value.value;
+        }
+        return undefined;
+    }
+    set(key, value, ttl) {
+        this.lru.set(key, { value, expire: Date.now() + ttl });
+    }
+    has(key) {
+        const value = this.get(key);
+        if (value != null) {
+            return true;
+        }
+        return false;
+    }
+    remove(key) {
+        this.lru.remove(key);
+    }
+    clear() {
+        this.lru.clear();
+    }
+}
+//# sourceMappingURL=tlru.js.map

package/dist/src/utils/tlru.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tlru.js","sourceRoot":"","sources":["../../../src/utils/tlru.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAE7B;;;;GAIG;AACH,MAAM,OAAO,IAAI;IAGf,YAAa,OAAe;QAC1B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC7B,CAAC;IAED,GAAG,CAAE,GAAW;QACd,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAE/B,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE;gBACrD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;gBAEpB,OAAO,SAAS,CAAA;aACjB;YAED,OAAO,KAAK,CAAC,KAAK,CAAA;SACnB;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,GAAG,CAAE,GAAW,EAAE,KAAQ,EAAE,GAAW;QACrC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,CAAA;IACxD,CAAC;IAED,GAAG,CAAE,GAAW;QACd,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAE3B,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,CAAE,GAAW;QACjB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACtB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAA;IAClB,CAAC;CACF"}

package/package.json

@@ -0,0 +1,191 @@
+{
+  "name": "@helia/ipns",
+  "version": "0.0.0",
+  "description": "An implementation of IPNS for Helia",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/ipfs/helia-ipns/tree/master/packages/ipns#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ipfs/helia-ipns.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ipfs/helia-ipns/issues"
+  },
+  "keywords": [
+    "IPFS"
+  ],
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ],
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    },
+    "./routing": {
+      "types": "./dist/src/routing/index.d.ts",
+      "import": "./dist/src/routing/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "type": "deps",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Documentation"
+              },
+              {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
+  "scripts": {
+    "clean": "aegir clean",
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check",
+    "build": "aegir build",
+    "docs": "aegir docs",
+    "test": "aegir test",
+    "test:chrome": "aegir test -t browser --cov",
+    "test:chrome-webworker": "aegir test -t webworker",
+    "test:firefox": "aegir test -t browser -- --browser firefox",
+    "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
+    "test:node": "aegir test -t node --cov",
+    "test:electron-main": "aegir test -t electron-main",
+    "release": "aegir release"
+  },
+  "dependencies": {
+    "@helia/interface": "next",
+    "@libp2p/interface-dht": "^2.0.1",
+    "@libp2p/interface-peer-id": "^2.0.1",
+    "@libp2p/interface-pubsub": "^3.0.6",
+    "@libp2p/interfaces": "^3.3.1",
+    "@libp2p/logger": "^2.0.5",
+    "@libp2p/peer-id": "^2.0.1",
+    "@libp2p/record": "^3.0.0",
+    "hashlru": "^2.3.0",
+    "interface-datastore": "^7.0.4",
+    "ipns": "^5.0.1",
+    "is-ipfs": "^8.0.1",
+    "multiformats": "^11.0.1",
+    "p-queue": "^7.3.0",
+    "progress-events": "^1.0.0",
+    "uint8arrays": "^4.0.3"
+  },
+  "devDependencies": {
+    "@libp2p/peer-id-factory": "^2.0.1",
+    "aegir": "^38.1.0",
+    "datastore-core": "^8.0.4",
+    "sinon": "^15.0.1"
+  },
+  "browser": {
+    "./dist/src/utils/resolve-dns-link.js": "./dist/src/utils/resolve-dns-link.browser.js"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts"
+  }
+}