helia 6.1.4 → 7.0.0

package/dist/src/helia.js

@@ -0,0 +1,165 @@
+/**
+ * @packageDocumentation
+ *
+ * This module contains utility code that is shared between various Helia
+ * modules such as `helia`, `@helia/http`, etc.
+ */
+import { InvalidConfigurationError } from '@helia/utils';
+import { keychain } from '@ipshipyard/keychain';
+import { start, stop } from '@libp2p/interface';
+import { dns } from '@multiformats/dns';
+import { defaultLogger } from 'birnam';
+import { MemoryBlockstore } from 'blockstore-core';
+import { MemoryDatastore } from 'datastore-core';
+import drain from 'it-drain';
+import { TypedEventEmitter } from 'main-event';
+import { CustomProgressEvent } from 'progress-events';
+import { BlockStorage } from "./block-storage.js";
+import { assertDatastoreVersionIsCurrent } from "./datastore-version.js";
+import { getCodec } from "./get-codec.js";
+import { getCrypto } from "./get-crypto.js";
+import { getHasher } from "./get-hasher.js";
+import { NetworkedStorage } from "./networked-storage.js";
+import { PinsImpl } from "./pins.js";
+import { Routing as RoutingClass } from "./routing.js";
+export class Helia {
+    info;
+    blockstore;
+    datastore;
+    events;
+    pins;
+    logger;
+    routing;
+    getCodec;
+    getHasher;
+    getCrypto;
+    dns;
+    keychain;
+    metrics;
+    status;
+    log;
+    blockBrokers;
+    mixins;
+    constructor(init) {
+        this.info = {
+            name: init.name,
+            version: init.version
+        };
+        this.logger = init.logger ?? defaultLogger();
+        this.log = this.logger.forComponent('helia');
+        this.getHasher = getHasher(init.hashers, init.loadHasher);
+        this.getCodec = getCodec(init.codecs, init.loadCodec);
+        this.getCrypto = getCrypto(init.cryptos, init.loadCrypto);
+        this.dns = init.dns ?? dns();
+        this.metrics = init.metrics;
+        this.events = new TypedEventEmitter();
+        this.status = 'stopped';
+        this.mixins = [];
+        // @ts-expect-error routing and keychain are not set
+        const components = {
+            blockstore: init.blockstore ?? new MemoryBlockstore(),
+            datastore: init.datastore ?? new MemoryDatastore(),
+            logger: this.logger,
+            blockBrokers: [],
+            getHasher: this.getHasher,
+            getCodec: this.getCodec,
+            getCrypto: this.getCrypto,
+            dns: this.dns,
+            metrics: this.metrics,
+            ...(init.components ?? {})
+        };
+        this.keychain = components.keychain = keychain()(components);
+        this.routing = components.routing = new RoutingClass(components, {
+            routers: (init.routers ?? []).flatMap((router) => {
+                if (typeof router === 'function') {
+                    router = router(components);
+                }
+                // if the router itself is a router
+                const routers = [
+                    router
+                ];
+                return routers;
+            }),
+            providerLookupConcurrency: init.providerLookupConcurrency
+        });
+        this.blockBrokers = components.blockBrokers = (init.blockBrokers ?? []).map((broker) => {
+            if (typeof broker === 'function') {
+                broker = broker(components);
+            }
+            return broker;
+        });
+        const networkedStorage = new NetworkedStorage(components, init);
+        this.pins = new PinsImpl(components.datastore, networkedStorage, this.getCodec);
+        this.blockstore = new BlockStorage(networkedStorage, this.pins, this.routing, {
+            holdGcLock: init.holdGcLock ?? true
+        });
+        this.datastore = components.datastore;
+    }
+    hasRouter(name) {
+        return this.routing.hasRouter(name);
+    }
+    addRouter(router) {
+        this.routing.addRouter(router);
+    }
+    hasBlockBroker(name) {
+        return this.blockBrokers.findIndex(b => b.name === name) !== -1;
+    }
+    addBlockBroker(blockBroker) {
+        this.blockBrokers.push(blockBroker);
+    }
+    addMixin(mixin) {
+        if (this.mixins.find(m => m.name === mixin.name) != null) {
+            throw new InvalidConfigurationError(`A mixin with the name "${mixin.name} is already present`);
+        }
+        this.mixins.push(mixin);
+    }
+    async start() {
+        this.status = 'starting';
+        await assertDatastoreVersionIsCurrent(this.datastore);
+        await start(this.blockstore, this.datastore, this.routing, ...this.blockBrokers);
+        for (const mixin of this.mixins) {
+            await mixin.start?.(this);
+        }
+        this.status = 'started';
+        this.events.dispatchEvent(new CustomEvent('start', { detail: this }));
+        return this;
+    }
+    async stop() {
+        this.status = 'stopping';
+        for (const mixin of this.mixins) {
+            await mixin.stop?.(this);
+        }
+        await stop(this.blockstore, this.datastore, this.routing, ...this.blockBrokers);
+        this.status = 'stopped';
+        this.events.dispatchEvent(new CustomEvent('stop', { detail: this }));
+        return this;
+    }
+    async gc(options = {}) {
+        const releaseLock = await this.blockstore.lock.writeLock();
+        try {
+            const helia = this;
+            const blockstore = this.blockstore.unwrap();
+            this.log('gc start');
+            await drain(blockstore.deleteMany((async function* () {
+                for await (const { cid } of blockstore.getAll()) {
+                    try {
+                        if (await helia.pins.isPinned(cid, options)) {
+                            continue;
+                        }
+                        yield cid;
+                        options.onProgress?.(new CustomProgressEvent('helia:gc:deleted', cid));
+                    }
+                    catch (err) {
+                        helia.log.error('error during gc - %e', err);
+                        options.onProgress?.(new CustomProgressEvent('helia:gc:error', err));
+                    }
+                }
+            }())));
+        }
+        finally {
+            releaseLock();
+        }
+        this.log('gc finished');
+    }
+}
+//# sourceMappingURL=helia.js.map

package/dist/src/helia.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helia.js","sourceRoot":"","sources":["../../src/helia.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAA;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,MAAM,UAAU,CAAA;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACpC,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,cAAc,CAAA;AAgKtD,MAAM,OAAO,KAAK;IACT,IAAI,CAAU;IACd,UAAU,CAAc;IACxB,SAAS,CAAW;IACpB,MAAM,CAAsC;IAC5C,IAAI,CAAM;IACV,MAAM,CAAiB;IACvB,OAAO,CAAc;IACrB,QAAQ,CAAa;IACrB,SAAS,CAAc;IACvB,SAAS,CAAc;IACvB,GAAG,CAAK;IACR,QAAQ,CAAU;IAClB,OAAO,CAAU;IACjB,MAAM,CAAiD;IAC7C,GAAG,CAAQ;IACX,YAAY,CAAe;IAC3B,MAAM,CAAc;IAErC,YAAa,IAAmD;QAC9D,IAAI,CAAC,IAAI,GAAG;YACV,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,aAAa,EAAE,CAAA;QAC5C,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAC5C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;QACzD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;QACrD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;QACzD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,GAAG,EAAE,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,iBAAiB,EAA4B,CAAA;QAC/D,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;QACvB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAA;QAEhB,oDAAoD;QACpD,MAAM,UAAU,GAAe;YAC7B,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,IAAI,gBAAgB,EAAE;YACrD,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,IAAI,eAAe,EAAE;YAClD,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,YAAY,EAAE,EAAE;YAChB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC;SAC3B,CAAA;QAED,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,GAAG,QAAQ,EAAE,CAAC,UAAU,CAAC,CAAA;QAE5D,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,GAAG,IAAI,YAAY,CAAC,UAAU,EAAE;YAC/D,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,MAA8C,EAAE,EAAE;gBACvF,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;oBACjC,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAAA;gBAC7B,CAAC;gBAED,mCAAmC;gBACnC,MAAM,OAAO,GAAG;oBACd,MAAM;iBACP,CAAA;gBAED,OAAO,OAAO,CAAA;YAChB,CAAC,CAAC;YACF,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;SAC1D,CAAC,CAAA;QAEF,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACrF,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;gBACjC,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAAA;YAC7B,CAAC;YAED,OAAO,MAAM,CAAA;QACf,CAAC,CAAC,CAAA;QAEF,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QAC/D,IAAI,CAAC,IAAI,GAAG,IAAI,QAAQ,CAAC,UAAU,CAAC,SAAS,EAAE,gBAAgB,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC/E,IAAI,CAAC,UAAU,GAAG,IAAI,YAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE;YAC5E,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,IAAI;SACpC,CAAC,CAAA;QACF,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;IACvC,CAAC;IAED,SAAS,CAAE,IAAY;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IACrC,CAAC;IAED,SAAS,CAAE,MAAc;QACvB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAChC,CAAC;IAED,cAAc,CAAE,IAAY;QAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IACjE,CAAC;IAED,cAAc,CAAE,WAAwB;QACtC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IACrC,CAAC;IAED,QAAQ,CAAE,KAAiB;QACzB,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YACzD,MAAM,IAAI,yBAAyB,CAAC,0BAA0B,KAAK,CAAC,IAAI,qBAAqB,CAAC,CAAA;QAChG,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACzB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,MAAM,GAAG,UAAU,CAAA;QAExB,MAAM,+BAA+B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACrD,MAAM,KAAK,CACT,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,OAAO,EACZ,GAAG,IAAI,CAAC,YAAY,CACrB,CAAA;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,CAAA;QAC3B,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;QACvB,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;QAErE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,MAAM,GAAG,UAAU,CAAA;QAExB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAA;QAC1B,CAAC;QAED,MAAM,IAAI,CACR,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,OAAO,EACZ,GAAG,IAAI,CAAC,YAAY,CACrB,CAAA;QAED,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;QACvB,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;QAEpE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,EAAE,CAAE,UAAqB,EAAE;QAC/B,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE,CAAA;QAE1D,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,IAAI,CAAA;YAClB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAA;YAE3C,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;YAEpB,MAAM,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,KAAK,SAAU,CAAC;gBACjD,IAAI,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;oBAChD,IAAI,CAAC;wBACH,IAAI,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC;4BAC5C,SAAQ;wBACV,CAAC;wBAED,MAAM,GAAG,CAAA;wBAET,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAM,kBAAkB,EAAE,GAAG,CAAC,CAAC,CAAA;oBAC7E,CAAC;oBAAC,OAAO,GAAQ,EAAE,CAAC;wBAClB,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAA;wBAC5C,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAQ,gBAAgB,EAAE,GAAG,CAAC,CAAC,CAAA;oBAC7E,CAAC;gBACH,CAAC;YACH,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QACR,CAAC;gBAAS,CAAC;YACT,WAAW,EAAE,CAAA;QACf,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;IACzB,CAAC;CACF"}

package/dist/src/index.d.ts

@@ -18,26 +18,10 @@
  * fs.cat(CID.parse('bafyFoo'))
  * ```
  */
-import { heliaDefaults } from './utils/helia-defaults.ts';
-import { libp2pDefaults } from './utils/libp2p-defaults.ts';
-import type { DefaultLibp2pServices } from './utils/libp2p-defaults.ts';
-import type { Libp2pDefaultsOptions } from './utils/libp2p.ts';
+import type { HeliaInit } from './helia.ts';
 import type { Helia } from '@helia/interface';
-import type { HeliaInit } from '@helia/utils';
-import type { Libp2p } from '@libp2p/interface';
-import type { CID } from 'multiformats/cid';
 export * from '@helia/interface';
 export type { HeliaInit };
-export type { DefaultLibp2pServices, Libp2pDefaultsOptions };
-export { libp2pDefaults };
-export { heliaDefaults };
-/**
- * DAGWalkers take a block and yield CIDs encoded in that block
- */
-export interface DAGWalker {
-    codec: number;
-    walk(block: Uint8Array): Generator<CID, void, undefined>;
-}
 /**
  * Create and return a Helia node
  *
@@ -59,6 +43,33 @@ export interface DAGWalker {
  * }
  * ```
  */
-export declare function createHelia<T extends Libp2p>(init: Partial<HeliaInit<T>>): Promise<Helia<T>>;
-export declare function createHelia(init?: Partial<HeliaInit<Libp2p<DefaultLibp2pServices>>>): Promise<Helia<Libp2p<DefaultLibp2pServices>>>;
+export declare function createHelia(init?: HeliaInit): Helia;
+/**
+ * Create and return a Helia node without and routing or block broker config.
+ *
+ * The only supported codecs are `dag-pb` and `raw`, and the only supported
+ * hashes are `sha2-256` and `identity`.
+ *
+ * This allows more flexible customization and the smallest possible bundle size
+ * in web browsers.
+ *
+ * @example Creating a Helia node
+ *
+ * ```ts
+ * import { createHeliaLight } from 'helia'
+ * import { unixfs } from '@helia/unixfs'
+ * import { CID } from 'multiformats/cid'
+ *
+ * const helia = await createHeliaLight()
+ * const fs = unixfs(helia)
+ * const cid = CID.parse('QmFoo...')
+ *
+ * for await (const buf of fs.cat(cid, {
+ *   signal: AbortSignal.timeout(5_000)
+ * })) {
+ *   console.info(buf)
+ * }
+ * ```
+ */
+export declare function createHeliaLight(init?: HeliaInit): Helia;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AACvE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AAC9D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAI3C,cAAc,kBAAkB,CAAA;AAEhC,YAAY,EAAE,SAAS,EAAE,CAAA;AAEzB,YAAY,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,CAAA;AAG5D,OAAO,EAAE,cAAc,EAAE,CAAA;AACzB,OAAO,EAAE,aAAa,EAAE,CAAA;AAExB;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;CACzD;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,WAAW,CAAE,CAAC,SAAS,MAAM,EAAG,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AACrG,wBAAsB,WAAW,CAAE,IAAI,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAWH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAI7C,cAAc,kBAAkB,CAAA;AAEhC,YAAY,EAAE,SAAS,EAAE,CAAA;AAEzB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,WAAW,CAAE,IAAI,GAAE,SAAc,GAAG,KAAK,CAcxD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,gBAAgB,CAAE,IAAI,GAAE,SAAc,GAAG,KAAK,CAQ7D"}

package/dist/src/index.js

@@ -18,21 +18,87 @@
  * fs.cat(CID.parse('bafyFoo'))
  * ```
  */
-import { Helia as HeliaClass } from '@helia/utils';
-import { heliaDefaults } from "./utils/helia-defaults.js";
-import { libp2pDefaults } from "./utils/libp2p-defaults.js";
+import { withBitswap } from '@helia/bitswap';
+import { withHTTP } from '@helia/http';
+import { withLibp2p } from '@helia/libp2p';
+import * as dagCbor from '@ipld/dag-cbor';
+import * as dagJson from '@ipld/dag-json';
+import * as json from 'multiformats/codecs/json';
+import { sha512 } from 'multiformats/hashes/sha2';
+import { Helia as HeliaClass } from "./helia.js";
+import { name, version } from "./version.js";
 // re-export interface types so people don't have to depend on @helia/interface
 // if they don't want to
 export * from '@helia/interface';
-// allow amending the default config
-export { libp2pDefaults };
-export { heliaDefaults };
-export async function createHelia(init = {}) {
-    const options = await heliaDefaults(init);
-    const helia = new HeliaClass(options);
-    if (options.start !== false) {
-        await helia.start();
-    }
+/**
+ * Create and return a Helia node
+ *
+ * @example Creating a Helia node
+ *
+ * ```ts
+ * import { createHelia } from 'helia'
+ * import { unixfs } from '@helia/unixfs'
+ * import { CID } from 'multiformats/cid'
+ *
+ * const helia = await createHelia()
+ * const fs = unixfs(helia)
+ * const cid = CID.parse('QmFoo...')
+ *
+ * for await (const buf of fs.cat(cid, {
+ *   signal: AbortSignal.timeout(5_000)
+ * })) {
+ *   console.info(buf)
+ * }
+ * ```
+ */
+export function createHelia(init = {}) {
+    return withBitswap(withLibp2p(withHTTP(createHeliaLight({
+        ...init,
+        codecs: [
+            dagCbor,
+            dagJson,
+            json,
+            ...(init.codecs ?? [])
+        ],
+        hashers: [
+            sha512,
+            ...(init.hashers ?? [])
+        ]
+    }))));
+}
+/**
+ * Create and return a Helia node without and routing or block broker config.
+ *
+ * The only supported codecs are `dag-pb` and `raw`, and the only supported
+ * hashes are `sha2-256` and `identity`.
+ *
+ * This allows more flexible customization and the smallest possible bundle size
+ * in web browsers.
+ *
+ * @example Creating a Helia node
+ *
+ * ```ts
+ * import { createHeliaLight } from 'helia'
+ * import { unixfs } from '@helia/unixfs'
+ * import { CID } from 'multiformats/cid'
+ *
+ * const helia = await createHeliaLight()
+ * const fs = unixfs(helia)
+ * const cid = CID.parse('QmFoo...')
+ *
+ * for await (const buf of fs.cat(cid, {
+ *   signal: AbortSignal.timeout(5_000)
+ * })) {
+ *   console.info(buf)
+ * }
+ * ```
+ */
+export function createHeliaLight(init = {}) {
+    const helia = new HeliaClass({
+        name,
+        version,
+        ...init
+    });
     return helia;
 }
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,KAAK,IAAI,UAAU,EAAE,MAAM,cAAc,CAAA;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAQ3D,+EAA+E;AAC/E,wBAAwB;AACxB,cAAc,kBAAkB,CAAA;AAMhC,oCAAoC;AACpC,OAAO,EAAE,cAAc,EAAE,CAAA;AACzB,OAAO,EAAE,aAAa,EAAE,CAAA;AAiCxB,MAAM,CAAC,KAAK,UAAU,WAAW,CAAE,OAA2B,EAAE;IAC9D,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,CAAA;IACzC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAA;IAErC,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;QAC5B,MAAM,KAAK,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAA;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAA;AACjD,OAAO,EAAE,KAAK,IAAI,UAAU,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAI5C,+EAA+E;AAC/E,wBAAwB;AACxB,cAAc,kBAAkB,CAAA;AAIhC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,WAAW,CAAE,OAAkB,EAAE;IAC/C,OAAO,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC;QACtD,GAAG,IAAI;QACP,MAAM,EAAE;YACN,OAAO;YACP,OAAO;YACP,IAAI;YACJ,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;SACvB;QACD,OAAO,EAAE;YACP,MAAM;YACN,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;SACxB;KACF,CAAC,CAAC,CAAC,CAAC,CAAA;AACP,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,gBAAgB,CAAE,OAAkB,EAAE;IACpD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC;QAC3B,IAAI;QACJ,OAAO;QACP,GAAG,IAAI;KACR,CAAC,CAAA;IAEF,OAAO,KAAK,CAAA;AACd,CAAC"}

package/dist/src/networked-storage.d.ts

@@ -0,0 +1,28 @@
+import { Storage } from './storage.ts';
+import type { StorageComponents, StorageInit } from './storage.ts';
+import type { BlockBroker, Blocks, CreateSessionOptions, SessionBlockstore } from '@helia/interface';
+import type { Startable } from '@libp2p/interface';
+import type { AbortOptions } from 'abort-error';
+import type { Blockstore } from 'interface-blockstore';
+import type { CID } from 'multiformats/cid';
+export interface GetOptions extends AbortOptions {
+    progress?(evt: Event): void;
+}
+export type NetworkedStorageComponents = StorageComponents<BlockBroker>;
+/**
+ * Networked storage wraps a regular blockstore - when getting blocks if the
+ * blocks are not present, the configured BlockBrokers will be used to fetch them.
+ */
+export declare class NetworkedStorage extends Storage<BlockBroker> implements Blocks, Startable {
+    private started;
+    /**
+     * Create a new BlockStorage
+     */
+    constructor(components: NetworkedStorageComponents, init?: StorageInit);
+    isStarted(): boolean;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    unwrap(): Blockstore;
+    createSession(root: CID, options?: CreateSessionOptions): SessionBlockstore;
+}
+//# sourceMappingURL=networked-storage.d.ts.map

package/dist/src/networked-storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"networked-storage.d.ts","sourceRoot":"","sources":["../../src/networked-storage.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACpG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAE3C,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,QAAQ,CAAC,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI,CAAA;CAC5B;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAA;AAEvE;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,OAAO,CAAC,WAAW,CAAE,YAAW,MAAM,EAAE,SAAS;IACrF,OAAO,CAAC,OAAO,CAAS;IAExB;;OAEG;gBACU,UAAU,EAAE,0BAA0B,EAAE,IAAI,GAAE,WAAgB;IAM3E,SAAS,IAAK,OAAO;IAIf,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IAKvB,IAAI,IAAK,OAAO,CAAC,IAAI,CAAC;IAK5B,MAAM,IAAK,UAAU;IAIrB,aAAa,CAAE,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,iBAAiB;CAsB7E"}

package/dist/src/networked-storage.js

@@ -0,0 +1,52 @@
+import { InvalidConfigurationError } from '@helia/utils';
+import { start, stop } from '@libp2p/interface';
+import { SessionStorage } from "./session-storage.js";
+import { Storage } from "./storage.js";
+/**
+ * Networked storage wraps a regular blockstore - when getting blocks if the
+ * blocks are not present, the configured BlockBrokers will be used to fetch them.
+ */
+export class NetworkedStorage extends Storage {
+    started;
+    /**
+     * Create a new BlockStorage
+     */
+    constructor(components, init = {}) {
+        super(components, init);
+        this.started = false;
+    }
+    isStarted() {
+        return this.started;
+    }
+    async start() {
+        await start(this.child, ...this.blockBrokers);
+        this.started = true;
+    }
+    async stop() {
+        await stop(this.child, ...this.blockBrokers);
+        this.started = false;
+    }
+    unwrap() {
+        return this.child;
+    }
+    createSession(root, options) {
+        if (this.blockBrokers.length === 0) {
+            throw new InvalidConfigurationError('No block brokers configured');
+        }
+        const blockBrokers = this.blockBrokers
+            .map(broker => broker.createSession?.(options))
+            .filter(broker => broker != null);
+        if (blockBrokers.length === 0) {
+            throw new InvalidConfigurationError(`No configured block brokers support sessions - tried ${this.blockBrokers.map(b => b.name).join(', ')}`);
+        }
+        return new SessionStorage({
+            blockstore: this.child,
+            blockBrokers,
+            getHasher: this.getHasher,
+            logger: this.logger
+        }, {
+            root
+        });
+    }
+}
+//# sourceMappingURL=networked-storage.js.map

package/dist/src/networked-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"networked-storage.js","sourceRoot":"","sources":["../../src/networked-storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAA;AACxD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AActC;;;GAGG;AACH,MAAM,OAAO,gBAAiB,SAAQ,OAAoB;IAChD,OAAO,CAAS;IAExB;;OAEG;IACH,YAAa,UAAsC,EAAE,OAAoB,EAAE;QACzE,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QAEvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAA;QAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAA;QAC5C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED,aAAa,CAAE,IAAS,EAAE,OAA8B;QACtD,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,yBAAyB,CAAC,6BAA6B,CAAC,CAAA;QACpE,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY;aACnC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,CAAC;aAC9C,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,IAAI,IAAI,CAAC,CAAA;QAEnC,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,yBAAyB,CAAC,wDAAwD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC9I,CAAC;QAED,OAAO,IAAI,cAAc,CAAC;YACxB,UAAU,EAAE,IAAI,CAAC,KAAK;YACtB,YAAY;YACZ,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,EAAE;YACD,IAAI;SACL,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/src/pins.d.ts

@@ -0,0 +1,21 @@
+import { CID } from 'multiformats/cid';
+import type { CodecLoader } from '@helia/interface';
+import type { AddOptions, IsPinnedOptions, LsOptions, Pin, Pins, RmOptions } from '@helia/interface';
+import type { AbortOptions } from '@libp2p/interface';
+import type { Blockstore } from 'interface-blockstore';
+import type { Datastore } from 'interface-datastore';
+import type { Version } from 'multiformats/cid';
+export declare class PinsImpl implements Pins {
+    #private;
+    private readonly datastore;
+    private readonly blockstore;
+    private readonly getCodec;
+    constructor(datastore: Datastore, blockstore: Blockstore, getCodec: CodecLoader);
+    add(cid: CID<unknown, number, number, Version>, options?: AddOptions): AsyncGenerator<CID, void, undefined>;
+    rm(cid: CID<unknown, number, number, Version>, options?: RmOptions): AsyncGenerator<CID, void, undefined>;
+    ls(options?: LsOptions): AsyncGenerator<Pin, void, undefined>;
+    isPinned(cid: CID, options?: IsPinnedOptions): Promise<boolean>;
+    get(cid: CID, options?: AbortOptions): Promise<Pin>;
+    setMetadata(cid: CID, metadata: Record<string, string | number | boolean> | undefined, options?: AbortOptions): Promise<void>;
+}
+//# sourceMappingURL=pins.d.ts.map

package/dist/src/pins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pins.d.ts","sourceRoot":"","sources":["../../src/pins.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAGtC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACpG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AA0C/C,qBAAa,QAAS,YAAW,IAAI;;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAa;gBAEzB,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW;IAMxE,GAAG,CAAE,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAE,UAAe,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC;IA8EhH,EAAE,CAAE,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAE,SAAc,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC;IA2B9G,EAAE,CAAE,OAAO,GAAE,SAAc,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC;IAcpE,QAAQ,CAAE,GAAG,EAAE,GAAG,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAMpE,GAAG,CAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;IAOpD,WAAW,CAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,SAAS,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;CASrI"}

package/dist/src/pins.js

@@ -0,0 +1,140 @@
+import { AlreadyPinnedError, depthFirstWalker } from '@helia/utils';
+import { InvalidParametersError } from '@libp2p/interface';
+import * as cborg from 'cborg';
+import { Key } from 'interface-datastore';
+import { base36 } from 'multiformats/bases/base36';
+import { CID } from 'multiformats/cid';
+import { CustomProgressEvent } from 'progress-events';
+import { equals as uint8ArrayEquals } from 'uint8arrays/equals';
+const DATASTORE_PIN_PREFIX = '/pin/';
+const DATASTORE_BLOCK_PREFIX = '/pinned-block/';
+const DATASTORE_ENCODING = base36;
+function toDSKey(cid) {
+    if (cid.version === 0) {
+        cid = cid.toV1();
+    }
+    return new Key(`${DATASTORE_PIN_PREFIX}${cid.toString(DATASTORE_ENCODING)}`);
+}
+export class PinsImpl {
+    datastore;
+    blockstore;
+    getCodec;
+    constructor(datastore, blockstore, getCodec) {
+        this.datastore = datastore;
+        this.blockstore = blockstore;
+        this.getCodec = getCodec;
+    }
+    async *add(cid, options = {}) {
+        const pinKey = toDSKey(cid);
+        if (await this.datastore.has(pinKey)) {
+            throw new AlreadyPinnedError('Already pinned');
+        }
+        const depth = Math.round(options.depth ?? Infinity);
+        if (depth < 0) {
+            throw new InvalidParametersError('Depth must be greater than or equal to 0');
+        }
+        const walker = (options.walker ?? depthFirstWalker())({
+            blockstore: this.blockstore,
+            getCodec: this.getCodec
+        });
+        for await (const node of walker.walk(cid, { ...options, depth })) {
+            const childCid = node.block.cid;
+            await this.#updatePinnedBlock(childCid, (pinnedBlock) => {
+                // do not update pinned block if this block is already pinned by this CID
+                if (pinnedBlock.pinnedBy.find(c => uint8ArrayEquals(c, cid.bytes)) != null) {
+                    return false;
+                }
+                pinnedBlock.pinCount++;
+                pinnedBlock.pinnedBy.push(cid.bytes);
+                return true;
+            }, options);
+            yield childCid;
+        }
+        const pin = {
+            depth,
+            metadata: options.metadata ?? {}
+        };
+        await this.datastore.put(pinKey, cborg.encode(pin), options);
+    }
+    /**
+     * Update the pin count for the CID
+     */
+    async #updatePinnedBlock(cid, withPinnedBlock, options) {
+        const blockKey = new Key(`${DATASTORE_BLOCK_PREFIX}${DATASTORE_ENCODING.encode(cid.multihash.bytes)}`);
+        let pinnedBlock = {
+            pinCount: 0,
+            pinnedBy: []
+        };
+        try {
+            pinnedBlock = cborg.decode(await this.datastore.get(blockKey, options));
+        }
+        catch (err) {
+            if (err.name !== 'NotFoundError') {
+                throw err;
+            }
+        }
+        const shouldContinue = withPinnedBlock(pinnedBlock);
+        if (!shouldContinue) {
+            return;
+        }
+        if (pinnedBlock.pinCount === 0) {
+            if (await this.datastore.has(blockKey)) {
+                await this.datastore.delete(blockKey);
+                return;
+            }
+        }
+        await this.datastore.put(blockKey, cborg.encode(pinnedBlock), options);
+        options.onProgress?.(new CustomProgressEvent('helia:pin:add', cid));
+    }
+    async *rm(cid, options = {}) {
+        const pinKey = toDSKey(cid);
+        const buf = await this.datastore.get(pinKey, options);
+        const pin = cborg.decode(buf);
+        await this.datastore.delete(pinKey, options);
+        const walker = (options.walker ?? depthFirstWalker())({
+            blockstore: this.blockstore,
+            getCodec: this.getCodec
+        });
+        for await (const node of walker.walk(cid, { ...options, depth: pin.depth })) {
+            const childCid = node.block.cid;
+            await this.#updatePinnedBlock(childCid, (pinnedBlock) => {
+                pinnedBlock.pinCount--;
+                pinnedBlock.pinnedBy = pinnedBlock.pinnedBy.filter(c => uint8ArrayEquals(c, cid.bytes));
+                return true;
+            }, {
+                ...options,
+                depth: pin.depth
+            });
+            yield childCid;
+        }
+    }
+    async *ls(options = {}) {
+        for await (const { key, value } of this.datastore.query({
+            prefix: DATASTORE_PIN_PREFIX + (options.cid != null ? `${options.cid.toString(base36)}` : '')
+        }, options)) {
+            const cid = CID.parse(key.toString().substring(5), base36);
+            const pin = cborg.decode(value);
+            yield {
+                cid,
+                ...pin
+            };
+        }
+    }
+    async isPinned(cid, options = {}) {
+        const blockKey = new Key(`${DATASTORE_BLOCK_PREFIX}${DATASTORE_ENCODING.encode(cid.multihash.bytes)}`);
+        return this.datastore.has(blockKey, options);
+    }
+    async get(cid, options) {
+        const pinKey = toDSKey(cid);
+        const buf = await this.datastore.get(pinKey, options);
+        return cborg.decode(buf);
+    }
+    async setMetadata(cid, metadata, options) {
+        const pinKey = toDSKey(cid);
+        const buf = await this.datastore.get(pinKey, options);
+        const pin = cborg.decode(buf);
+        pin.metadata = metadata ?? {};
+        await this.datastore.put(pinKey, cborg.encode(pin), options);
+    }
+}
+//# sourceMappingURL=pins.js.map

package/dist/src/pins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pins.js","sourceRoot":"","sources":["../../src/pins.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAA;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAClD,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,EAAE,MAAM,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAoC/D,MAAM,oBAAoB,GAAG,OAAO,CAAA;AACpC,MAAM,sBAAsB,GAAG,gBAAgB,CAAA;AAC/C,MAAM,kBAAkB,GAAG,MAAM,CAAA;AAEjC,SAAS,OAAO,CAAE,GAAQ;IACxB,IAAI,GAAG,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QACtB,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,CAAA;IAClB,CAAC;IAED,OAAO,IAAI,GAAG,CAAC,GAAG,oBAAoB,GAAG,GAAG,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;AAC9E,CAAC;AAED,MAAM,OAAO,QAAQ;IACF,SAAS,CAAW;IACpB,UAAU,CAAY;IACtB,QAAQ,CAAa;IAEtC,YAAa,SAAoB,EAAE,UAAsB,EAAE,QAAqB;QAC9E,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;IAED,KAAK,CAAC,CAAE,GAAG,CAAE,GAA0C,EAAE,UAAsB,EAAE;QAC/E,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;QAE3B,IAAI,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,kBAAkB,CAAC,gBAAgB,CAAC,CAAA;QAChD,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,QAAQ,CAAC,CAAA;QAEnD,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,MAAM,IAAI,sBAAsB,CAAC,0CAA0C,CAAC,CAAA;QAC9E,CAAC;QAED,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,gBAAgB,EAAE,CAAC,CAAC;YACpD,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC,CAAA;QAEF,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;YACjE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAA;YAC/B,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,WAAiC,EAAE,EAAE;gBAC5E,yEAAyE;gBACzE,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;oBAC3E,OAAO,KAAK,CAAA;gBACd,CAAC;gBAED,WAAW,CAAC,QAAQ,EAAE,CAAA;gBACtB,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;gBACpC,OAAO,IAAI,CAAA;YACb,CAAC,EAAE,OAAO,CAAC,CAAA;YAEX,MAAM,QAAQ,CAAA;QAChB,CAAC;QAED,MAAM,GAAG,GAAiB;YACxB,KAAK;YACL,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;SACjC,CAAA;QAED,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAA;IAC9D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kBAAkB,CAAE,GAAQ,EAAE,eAAwC,EAAE,OAAmB;QAC/F,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,GAAG,sBAAsB,GAAG,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAEtG,IAAI,WAAW,GAAyB;YACtC,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,EAAE;SACb,CAAA;QAED,IAAI,CAAC;YACH,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAA;QACzE,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;gBACjC,MAAM,GAAG,CAAA;YACX,CAAC;QACH,CAAC;QAED,MAAM,cAAc,GAAG,eAAe,CAAC,WAAW,CAAC,CAAA;QAEnD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAM;QACR,CAAC;QAED,IAAI,WAAW,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;YAC/B,IAAI,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACvC,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;gBACrC,OAAM;YACR,CAAC;QACH,CAAC;QAED,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC,CAAA;QACtE,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAM,eAAe,EAAE,GAAG,CAAC,CAAC,CAAA;IAC1E,CAAC;IAED,KAAK,CAAC,CAAE,EAAE,CAAE,GAA0C,EAAE,UAAqB,EAAE;QAC7E,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;QAC3B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACrD,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAE7B,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAE5C,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,gBAAgB,EAAE,CAAC,CAAC;YACpD,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC,CAAA;QAEF,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;YAC5E,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAA;YAC/B,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAW,EAAE;gBAC/D,WAAW,CAAC,QAAQ,EAAE,CAAA;gBACtB,WAAW,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAA;gBACvF,OAAO,IAAI,CAAA;YACb,CAAC,EAAE;gBACD,GAAG,OAAO;gBACV,KAAK,EAAE,GAAG,CAAC,KAAK;aACjB,CAAC,CAAA;YAEF,MAAM,QAAQ,CAAA;QAChB,CAAC;IACH,CAAC;IAED,KAAK,CAAC,CAAE,EAAE,CAAE,UAAqB,EAAE;QACjC,IAAI,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YACtD,MAAM,EAAE,oBAAoB,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC9F,EAAE,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;YAC1D,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;YAE/B,MAAM;gBACJ,GAAG;gBACH,GAAG,GAAG;aACP,CAAA;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,GAAQ,EAAE,UAA2B,EAAE;QACrD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,GAAG,sBAAsB,GAAG,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAEtG,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC9C,CAAC;IAED,KAAK,CAAC,GAAG,CAAE,GAAQ,EAAE,OAAsB;QACzC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;QAC3B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAErD,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC;IAED,KAAK,CAAC,WAAW,CAAE,GAAQ,EAAE,QAA+D,EAAE,OAAsB;QAClH,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;QAC3B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACrD,MAAM,GAAG,GAAiB,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAE3C,GAAG,CAAC,QAAQ,GAAG,QAAQ,IAAI,EAAE,CAAA;QAE7B,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAA;IAC9D,CAAC;CACF"}