@helia/interface 4.3.1 → 5.0.0-0238ed4

package/dist/index.min.js

@@ -1,3 +1,3 @@
 (function (root, factory) {(typeof module === 'object' && module.exports) ? module.exports = factory() : root.HeliaInterface = factory()}(typeof self !== 'undefined' ? self : this, function () {
-"use strict";var HeliaInterface=(()=>{var E=Object.defineProperty;var e=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var x=Object.prototype.hasOwnProperty;var I=(r,o)=>{for(var t in o)E(r,t,{get:o[t],enumerable:!0})},D=(r,o,t,_)=>{if(o&&typeof o=="object"||typeof o=="function")for(let S of p(o))!x.call(r,S)&&S!==t&&E(r,S,{get:()=>o[S],enumerable:!(_=e(o,S))||_.enumerable});return r};var O=r=>D(E({},"__esModule",{value:!0}),r);var R={};I(R,{DEFAULT_SESSION_MAX_PROVIDERS:()=>A,DEFAULT_SESSION_MIN_PROVIDERS:()=>m});var m=1,A=5;return O(R);})();
+"use strict";var HeliaInterface=(()=>{var s=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var x=Object.getOwnPropertyNames;var E=Object.prototype.hasOwnProperty;var u=(o,r)=>{for(var e in r)s(o,e,{get:r[e],enumerable:!0})},l=(o,r,e,p)=>{if(r&&typeof r=="object"||typeof r=="function")for(let t of x(r))!E.call(o,t)&&t!==e&&s(o,t,{get:()=>r[t],enumerable:!(p=m(r,t))||p.enumerable});return o};var d=o=>l(s({},"__esModule",{value:!0}),o);var f={};u(f,{DEFAULT_SESSION_MAX_PROVIDERS:()=>I,DEFAULT_SESSION_MIN_PROVIDERS:()=>S,InsufficientProvidersError:()=>n,NoRoutersAvailableError:()=>a,UnknownCodecError:()=>i,UnknownHashAlgorithmError:()=>c});var S=1,I=5;var n=class extends Error{static name="InsufficientProvidersError";constructor(r="Insufficient providers found"){super(r),this.name="InsufficientProvidersError"}},a=class extends Error{static name="NoRoutersAvailableError";constructor(r="No routers available"){super(r),this.name="NoRoutersAvailableError"}},c=class extends Error{static name="UnknownHashAlgorithmError";constructor(r="Unknown hash algorithm"){super(r),this.name="UnknownHashAlgorithmError"}},i=class extends Error{static name="UnknownCodecError";constructor(r="Unknown codec"){super(r),this.name="UnknownCodecError"}};return d(f);})();
 return HeliaInterface}));

package/dist/src/errors.d.ts

@@ -0,0 +1,17 @@
+export declare class InsufficientProvidersError extends Error {
+    static name: string;
+    constructor(message?: string);
+}
+export declare class NoRoutersAvailableError extends Error {
+    static name: string;
+    constructor(message?: string);
+}
+export declare class UnknownHashAlgorithmError extends Error {
+    static name: string;
+    constructor(message?: string);
+}
+export declare class UnknownCodecError extends Error {
+    static name: string;
+    constructor(message?: string);
+}
+//# sourceMappingURL=errors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,0BAA2B,SAAQ,KAAK;IACnD,MAAM,CAAC,IAAI,SAA+B;gBAE7B,OAAO,SAAiC;CAItD;AAED,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,MAAM,CAAC,IAAI,SAA4B;gBAE1B,OAAO,SAAyB;CAI9C;AAED,qBAAa,yBAA0B,SAAQ,KAAK;IAClD,MAAM,CAAC,IAAI,SAA8B;gBAE5B,OAAO,SAA2B;CAIhD;AAED,qBAAa,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,IAAI,SAAsB;gBAEpB,OAAO,SAAkB;CAIvC"}

package/dist/src/errors.js

@@ -0,0 +1,29 @@
+export class InsufficientProvidersError extends Error {
+    static name = 'InsufficientProvidersError';
+    constructor(message = 'Insufficient providers found') {
+        super(message);
+        this.name = 'InsufficientProvidersError';
+    }
+}
+export class NoRoutersAvailableError extends Error {
+    static name = 'NoRoutersAvailableError';
+    constructor(message = 'No routers available') {
+        super(message);
+        this.name = 'NoRoutersAvailableError';
+    }
+}
+export class UnknownHashAlgorithmError extends Error {
+    static name = 'UnknownHashAlgorithmError';
+    constructor(message = 'Unknown hash algorithm') {
+        super(message);
+        this.name = 'UnknownHashAlgorithmError';
+    }
+}
+export class UnknownCodecError extends Error {
+    static name = 'UnknownCodecError';
+    constructor(message = 'Unknown codec') {
+        super(message);
+        this.name = 'UnknownCodecError';
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/src/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,0BAA2B,SAAQ,KAAK;IACnD,MAAM,CAAC,IAAI,GAAG,4BAA4B,CAAA;IAE1C,YAAa,OAAO,GAAG,8BAA8B;QACnD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,4BAA4B,CAAA;IAC1C,CAAC;;AAGH,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAChD,MAAM,CAAC,IAAI,GAAG,yBAAyB,CAAA;IAEvC,YAAa,OAAO,GAAG,sBAAsB;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAA;IACvC,CAAC;;AAGH,MAAM,OAAO,yBAA0B,SAAQ,KAAK;IAClD,MAAM,CAAC,IAAI,GAAG,2BAA2B,CAAA;IAEzC,YAAa,OAAO,GAAG,wBAAwB;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAA;IACzC,CAAC;;AAGH,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,IAAI,GAAG,mBAAmB,CAAA;IAEjC,YAAa,OAAO,GAAG,eAAe;QACpC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAA;IACjC,CAAC"}

package/dist/src/index.d.ts

@@ -19,10 +19,17 @@ import type { Routing } from './routing.js';
 import type { AbortOptions, ComponentLogger, Metrics } from '@libp2p/interface';
 import type { DNS } from '@multiformats/dns';
 import type { Datastore } from 'interface-datastore';
-import type { MultihashHasher } from 'multiformats';
+import type { Await } from 'interface-store';
+import type { BlockCodec, MultihashHasher } from 'multiformats';
 import type { CID } from 'multiformats/cid';
 import type { ProgressEvent, ProgressOptions } from 'progress-events';
 export type { Await, AwaitIterable } from 'interface-store';
+export interface CodecLoader {
+    <T = any, Code extends number = any>(code: Code): Await<BlockCodec<Code, T>>;
+}
+export interface HasherLoader {
+    (code: number): Await<MultihashHasher>;
+}
 /**
  * The API presented by a Helia node
  */
@@ -48,16 +55,6 @@ export interface Helia {
      * content providers, information about peers, etc.
      */
     routing: Routing;
-    /**
-     * DAGWalkers are codec-specific implementations that know how to yield all
-     * CIDs contained within a block that corresponds to that codec.
-     */
-    dagWalkers: Record<number, DAGWalker>;
-    /**
-     * Hashers can be used to hash a piece of data with the specified hashing
-     * algorithm.
-     */
-    hashers: Record<number, MultihashHasher>;
     /**
      * The DNS property can be used to perform lookups of various record types and
      * will use a resolver appropriate to the current platform.
@@ -80,18 +77,23 @@ export interface Helia {
      * Remove any unpinned blocks from the blockstore
      */
     gc(options?: GCOptions): Promise<void>;
+    /**
+     * Load an IPLD codec. Implementations may return a promise if, for example,
+     * the codec is being fetched from the network.
+     */
+    getCodec: CodecLoader;
+    /**
+     * Hashers can be used to hash a piece of data with the specified hashing
+     * algorithm. Implementations may return a promise if, for example,
+     * the hasher is being fetched from the network.
+     */
+    getHasher: HasherLoader;
 }
 export type GcEvents = ProgressEvent<'helia:gc:deleted', CID> | ProgressEvent<'helia:gc:error', Error>;
 export interface GCOptions extends AbortOptions, ProgressOptions<GcEvents> {
 }
-/**
- * DAGWalkers take a block and yield CIDs encoded in that block
- */
-export interface DAGWalker {
-    codec: number;
-    walk(block: Uint8Array): Generator<CID, void, undefined>;
-}
 export * from './blocks.js';
+export * from './errors.js';
 export * from './pins.js';
 export * from './routing.js';
 //# 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;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC/E,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE3D;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;IAEV;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;IAEvB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAErC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IAExC;;;OAGG;IACH,GAAG,EAAE,GAAG,CAAA;IAER;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtB;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAErB;;OAEG;IACH,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACvC;AAED,MAAM,MAAM,QAAQ,GAClB,aAAa,CAAC,kBAAkB,EAAE,GAAG,CAAC,GACtC,aAAa,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAA;AAExC,MAAM,WAAW,SAAU,SAAQ,YAAY,EAAE,eAAe,CAAC,QAAQ,CAAC;CAEzE;AAED;;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,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC/E,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC/D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE3D,MAAM,WAAW,WAAW;IAC1B,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,SAAS,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;CAC7E;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,eAAe,CAAC,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;IAEV;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;IAEvB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;;OAGG;IACH,GAAG,EAAE,GAAG,CAAA;IAER;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtB;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAErB;;OAEG;IACH,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtC;;;OAGG;IACH,QAAQ,EAAE,WAAW,CAAA;IAErB;;;;OAIG;IACH,SAAS,EAAE,YAAY,CAAA;CACxB;AAED,MAAM,MAAM,QAAQ,GAClB,aAAa,CAAC,kBAAkB,EAAE,GAAG,CAAC,GACtC,aAAa,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAA;AAExC,MAAM,WAAW,SAAU,SAAQ,YAAY,EAAE,eAAe,CAAC,QAAQ,CAAC;CAEzE;AAED,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}

package/dist/src/index.js

@@ -14,6 +14,7 @@
  * ```
  */
 export * from './blocks.js';
+export * from './errors.js';
 export * from './pins.js';
 export * from './routing.js';
 //# 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;;;;;;;;;;;;;;GAcG;AAoGH,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAsGH,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}

package/dist/src/pins.d.ts

@@ -6,7 +6,7 @@ export type PinType = 'recursive' | 'direct' | 'indirect';
 export interface Pin {
     cid: CID;
     depth: number;
-    metadata: Record<string, any>;
+    metadata: Record<string, string | number | boolean>;
 }
 export type AddPinEvents = ProgressEvent<'helia:pin:add', CID>;
 export interface AddOptions extends AbortOptions, ProgressOptions<AddPinEvents | GetBlockProgressEvents> {
@@ -28,22 +28,31 @@ export interface IsPinnedOptions extends AbortOptions {
 }
 export interface Pins {
     /**
-     * Pin a block in the blockstore. It will not be deleted
-     * when garbage collection is run.
+     * Pin a block in the blockstore. It will not be deleted when garbage
+     * collection is run.
      */
     add(cid: CID, options?: AddOptions): AsyncGenerator<CID, void, undefined>;
     /**
-     * Unpin the block that corresponds to the passed CID. The block will
-     * be deleted when garbage collection is run.
+     * Unpin the block that corresponds to the passed CID. The block will be
+     * deleted when garbage collection is run.
      */
     rm(cid: CID, options?: RmOptions): AsyncGenerator<CID, void, undefined>;
     /**
      * List all blocks that have been pinned.
      */
     ls(options?: LsOptions): AsyncGenerator<Pin, void, undefined>;
+    /**
+     * If the CID is pinned, return details of the pin, otherwise throw an error
+     */
+    get(cid: CID, options?: AbortOptions): Promise<Pin>;
     /**
      * Return true if the passed CID is pinned
      */
     isPinned(cid: CID, options?: IsPinnedOptions): Promise<boolean>;
+    /**
+     * If the CID is pinned, update the metadata associated with the pin,
+     * otherwise throw an error
+     */
+    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

@@ -1 +1 @@
-{"version":3,"file":"pins.d.ts","sourceRoot":"","sources":["../../src/pins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAA;AAEzD,MAAM,WAAW,GAAG;IAClB,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED,MAAM,MAAM,YAAY,GACtB,aAAa,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;AAErC,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,eAAe,CAAC,YAAY,GAAG,sBAAsB,CAAC;IACtG;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;CAE9C;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,GAAG,CAAC,EAAE,GAAG,CAAA;CACV;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;CAEpD;AAED,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IAEzE;;;OAGG;IACH,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,SAAS,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IAEvE;;OAEG;IACH,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IAE7D;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAChE"}
+{"version":3,"file":"pins.d.ts","sourceRoot":"","sources":["../../src/pins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAA;AAEzD,MAAM,WAAW,GAAG;IAClB,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CACpD;AAED,MAAM,MAAM,YAAY,GACtB,aAAa,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;AAErC,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,eAAe,CAAC,YAAY,GAAG,sBAAsB,CAAC;IACtG;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;CAE9C;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,GAAG,CAAC,EAAE,GAAG,CAAA;CACV;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;CAEpD;AAED,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IAEzE;;;OAGG;IACH,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,SAAS,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IAEvE;;OAEG;IACH,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IAE7D;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAEnD;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE/D;;;OAGG;IACH,WAAW,CAAC,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,CAAA;CAC9H"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/interface",
-  "version": "4.3.1",
+  "version": "5.0.0-0238ed4",
   "description": "The Helia API",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia/tree/main/packages/interface#readme",
@@ -67,14 +67,15 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build"
   },
   "dependencies": {
-    "@libp2p/interface": "^1.1.4",
+    "@libp2p/interface": "^2.0.0",
     "@multiformats/dns": "^1.0.1",
     "interface-blockstore": "^5.2.10",
     "interface-datastore": "^8.2.11",
-    "interface-store": "^5.1.8",
+    "interface-store": "^6.0.0",
     "multiformats": "^13.1.0",
     "progress-events": "^1.0.0"
   },

package/src/errors.ts

@@ -0,0 +1,35 @@
+export class InsufficientProvidersError extends Error {
+  static name = 'InsufficientProvidersError'
+
+  constructor (message = 'Insufficient providers found') {
+    super(message)
+    this.name = 'InsufficientProvidersError'
+  }
+}
+
+export class NoRoutersAvailableError extends Error {
+  static name = 'NoRoutersAvailableError'
+
+  constructor (message = 'No routers available') {
+    super(message)
+    this.name = 'NoRoutersAvailableError'
+  }
+}
+
+export class UnknownHashAlgorithmError extends Error {
+  static name = 'UnknownHashAlgorithmError'
+
+  constructor (message = 'Unknown hash algorithm') {
+    super(message)
+    this.name = 'UnknownHashAlgorithmError'
+  }
+}
+
+export class UnknownCodecError extends Error {
+  static name = 'UnknownCodecError'
+
+  constructor (message = 'Unknown codec') {
+    super(message)
+    this.name = 'UnknownCodecError'
+  }
+}

package/src/index.ts

@@ -20,12 +20,21 @@ import type { Routing } from './routing.js'
 import type { AbortOptions, ComponentLogger, Metrics } from '@libp2p/interface'
 import type { DNS } from '@multiformats/dns'
 import type { Datastore } from 'interface-datastore'
-import type { MultihashHasher } from 'multiformats'
+import type { Await } from 'interface-store'
+import type { BlockCodec, MultihashHasher } from 'multiformats'
 import type { CID } from 'multiformats/cid'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'
 
 export type { Await, AwaitIterable } from 'interface-store'
 
+export interface CodecLoader {
+  <T = any, Code extends number = any>(code: Code): Await<BlockCodec<Code, T>>
+}
+
+export interface HasherLoader {
+  (code: number): Await<MultihashHasher>
+}
+
 /**
  * The API presented by a Helia node
  */
@@ -56,18 +65,6 @@ export interface Helia {
    */
   routing: Routing
 
-  /**
-   * DAGWalkers are codec-specific implementations that know how to yield all
-   * CIDs contained within a block that corresponds to that codec.
-   */
-  dagWalkers: Record<number, DAGWalker>
-
-  /**
-   * Hashers can be used to hash a piece of data with the specified hashing
-   * algorithm.
-   */
-  hashers: Record<number, MultihashHasher>
-
   /**
    * The DNS property can be used to perform lookups of various record types and
    * will use a resolver appropriate to the current platform.
@@ -94,6 +91,19 @@ export interface Helia {
    * Remove any unpinned blocks from the blockstore
    */
   gc(options?: GCOptions): Promise<void>
+
+  /**
+   * Load an IPLD codec. Implementations may return a promise if, for example,
+   * the codec is being fetched from the network.
+   */
+  getCodec: CodecLoader
+
+  /**
+   * Hashers can be used to hash a piece of data with the specified hashing
+   * algorithm. Implementations may return a promise if, for example,
+   * the hasher is being fetched from the network.
+   */
+  getHasher: HasherLoader
 }
 
 export type GcEvents =
@@ -104,14 +114,7 @@ export interface GCOptions extends AbortOptions, ProgressOptions<GcEvents> {
 
 }
 
-/**
- * DAGWalkers take a block and yield CIDs encoded in that block
- */
-export interface DAGWalker {
-  codec: number
-  walk(block: Uint8Array): Generator<CID, void, undefined>
-}
-
 export * from './blocks.js'
+export * from './errors.js'
 export * from './pins.js'
 export * from './routing.js'

package/src/pins.ts

@@ -8,7 +8,7 @@ export type PinType = 'recursive' | 'direct' | 'indirect'
 export interface Pin {
   cid: CID
   depth: number
-  metadata: Record<string, any>
+  metadata: Record<string, string | number | boolean>
 }
 
 export type AddPinEvents =
@@ -40,14 +40,14 @@ export interface IsPinnedOptions extends AbortOptions {
 
 export interface Pins {
   /**
-   * Pin a block in the blockstore. It will not be deleted
-   * when garbage collection is run.
+   * Pin a block in the blockstore. It will not be deleted when garbage
+   * collection is run.
    */
   add(cid: CID, options?: AddOptions): AsyncGenerator<CID, void, undefined>
 
   /**
-   * Unpin the block that corresponds to the passed CID. The block will
-   * be deleted when garbage collection is run.
+   * Unpin the block that corresponds to the passed CID. The block will be
+   * deleted when garbage collection is run.
    */
   rm(cid: CID, options?: RmOptions): AsyncGenerator<CID, void, undefined>
 
@@ -56,8 +56,19 @@ export interface Pins {
    */
   ls(options?: LsOptions): AsyncGenerator<Pin, void, undefined>
 
+  /**
+   * If the CID is pinned, return details of the pin, otherwise throw an error
+   */
+  get(cid: CID, options?: AbortOptions): Promise<Pin>
+
   /**
    * Return true if the passed CID is pinned
    */
   isPinned(cid: CID, options?: IsPinnedOptions): Promise<boolean>
+
+  /**
+   * If the CID is pinned, update the metadata associated with the pin,
+   * otherwise throw an error
+   */
+  setMetadata(cid: CID, metadata: Record<string, string | number | boolean> | undefined, options?: AbortOptions): Promise<void>
 }

package/dist/typedoc-urls.json

@@ -1,65 +0,0 @@
-{
-  "AddOptions": "https://ipfs.github.io/helia/interfaces/helia.AddOptions.html",
-  "./pins:AddOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.pins.AddOptions.html",
-  "BlockAnnounceOptions": "https://ipfs.github.io/helia/interfaces/helia.BlockAnnounceOptions.html",
-  "./blocks:BlockAnnounceOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.BlockAnnounceOptions.html",
-  "BlockBroker": "https://ipfs.github.io/helia/interfaces/helia.BlockBroker.html",
-  "./blocks:BlockBroker": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.BlockBroker.html",
-  "BlockRetrievalOptions": "https://ipfs.github.io/helia/interfaces/helia.BlockRetrievalOptions.html",
-  "./blocks:BlockRetrievalOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.BlockRetrievalOptions.html",
-  "Blocks": "https://ipfs.github.io/helia/interfaces/helia.Blocks.html",
-  "./blocks:Blocks": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.Blocks.html",
-  "CreateSessionOptions": "https://ipfs.github.io/helia/interfaces/helia.CreateSessionOptions.html",
-  "./blocks:CreateSessionOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.CreateSessionOptions.html",
-  "GCOptions": "https://ipfs.github.io/helia/interfaces/helia.GCOptions.html",
-  ".:GCOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.index.GCOptions.html",
-  "GetOfflineOptions": "https://ipfs.github.io/helia/interfaces/helia.GetOfflineOptions.html",
-  "./blocks:GetOfflineOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.GetOfflineOptions.html",
-  "Helia": "https://ipfs.github.io/helia/interfaces/helia.Helia.html",
-  ".:Helia": "https://ipfs.github.io/helia/interfaces/_helia_interface.index.Helia.html",
-  "IsPinnedOptions": "https://ipfs.github.io/helia/interfaces/helia.IsPinnedOptions.html",
-  "./pins:IsPinnedOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.pins.IsPinnedOptions.html",
-  "LsOptions": "https://ipfs.github.io/helia/interfaces/helia.LsOptions.html",
-  "./pins:LsOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.pins.LsOptions.html",
-  "Pair": "https://ipfs.github.io/helia/interfaces/helia.Pair.html",
-  "./blocks:Pair": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.Pair.html",
-  "Pin": "https://ipfs.github.io/helia/interfaces/helia.Pin.html",
-  "./pins:Pin": "https://ipfs.github.io/helia/interfaces/_helia_interface.pins.Pin.html",
-  "Pins": "https://ipfs.github.io/helia/interfaces/helia.Pins.html",
-  "./pins:Pins": "https://ipfs.github.io/helia/interfaces/_helia_interface.pins.Pins.html",
-  "Provider": "https://ipfs.github.io/helia/interfaces/helia.Provider.html",
-  "RmOptions": "https://ipfs.github.io/helia/interfaces/helia.RmOptions.html",
-  "./pins:RmOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.pins.RmOptions.html",
-  "Routing": "https://ipfs.github.io/helia/interfaces/helia.Routing.html",
-  "RoutingOptions": "https://ipfs.github.io/helia/interfaces/helia.RoutingOptions.html",
-  "SessionBlockstore": "https://ipfs.github.io/helia/interfaces/helia.SessionBlockstore.html",
-  "./blocks:SessionBlockstore": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.SessionBlockstore.html",
-  "AddPinEvents": "https://ipfs.github.io/helia/types/helia.AddPinEvents.html",
-  "./pins:AddPinEvents": "https://ipfs.github.io/helia/types/_helia_interface.pins.AddPinEvents.html",
-  "DeleteBlockProgressEvents": "https://ipfs.github.io/helia/types/helia.DeleteBlockProgressEvents.html",
-  "./blocks:DeleteBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.DeleteBlockProgressEvents.html",
-  "DeleteManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/helia.DeleteManyBlocksProgressEvents.html",
-  "./blocks:DeleteManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.DeleteManyBlocksProgressEvents.html",
-  "GcEvents": "https://ipfs.github.io/helia/types/helia.GcEvents.html",
-  ".:GcEvents": "https://ipfs.github.io/helia/types/_helia_interface.index.GcEvents.html",
-  "GetAllBlocksProgressEvents": "https://ipfs.github.io/helia/types/helia.GetAllBlocksProgressEvents.html",
-  "./blocks:GetAllBlocksProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.GetAllBlocksProgressEvents.html",
-  "GetBlockProgressEvents": "https://ipfs.github.io/helia/types/helia.GetBlockProgressEvents.html",
-  "./blocks:GetBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.GetBlockProgressEvents.html",
-  "GetManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/helia.GetManyBlocksProgressEvents.html",
-  "./blocks:GetManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.GetManyBlocksProgressEvents.html",
-  "HasBlockProgressEvents": "https://ipfs.github.io/helia/types/helia.HasBlockProgressEvents.html",
-  "./blocks:HasBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.HasBlockProgressEvents.html",
-  "PinType": "https://ipfs.github.io/helia/types/helia.PinType.html",
-  "./pins:PinType": "https://ipfs.github.io/helia/types/_helia_interface.pins.PinType.html",
-  "PutBlockProgressEvents": "https://ipfs.github.io/helia/types/helia.PutBlockProgressEvents.html",
-  "./blocks:PutBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.PutBlockProgressEvents.html",
-  "PutManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/helia.PutManyBlocksProgressEvents.html",
-  "./blocks:PutManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.PutManyBlocksProgressEvents.html",
-  "DEFAULT_SESSION_MAX_PROVIDERS": "https://ipfs.github.io/helia/variables/helia.DEFAULT_SESSION_MAX_PROVIDERS.html",
-  "./blocks:DEFAULT_SESSION_MAX_PROVIDERS": "https://ipfs.github.io/helia/variables/_helia_interface.blocks.DEFAULT_SESSION_MAX_PROVIDERS.html",
-  "DEFAULT_SESSION_MIN_PROVIDERS": "https://ipfs.github.io/helia/variables/helia.DEFAULT_SESSION_MIN_PROVIDERS.html",
-  "./blocks:DEFAULT_SESSION_MIN_PROVIDERS": "https://ipfs.github.io/helia/variables/_helia_interface.blocks.DEFAULT_SESSION_MIN_PROVIDERS.html",
-  "DAGWalker": "https://ipfs.github.io/helia/interfaces/_helia_http.DAGWalker.html",
-  ".:DAGWalker": "https://ipfs.github.io/helia/interfaces/_helia_interface.index.DAGWalker.html"
-}