@helia/interface 6.1.1-eaeb734d → 6.2.0-ef5363e8

package/dist/index.min.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/index.ts", "../src/blocks.ts", "../src/errors.ts"],
-  "sourcesContent": ["/**\n * @packageDocumentation\n *\n * The API defined by a {@link Helia} node\n *\n * @example\n *\n * ```typescript\n * import type { Helia } from '@helia/interface'\n *\n * export function doSomething(helia: Helia) {\n *   // use helia node functions here\n * }\n * ```\n */\n\nimport type { Blocks } from './blocks.js'\nimport type { Pins } from './pins.js'\nimport type { Routing } from './routing.js'\nimport type { AbortOptions, ComponentLogger, Libp2p, Metrics, TypedEventEmitter } from '@libp2p/interface'\nimport type { DNS } from '@multiformats/dns'\nimport type { Datastore } from 'interface-datastore'\nimport type { Await } from 'interface-store'\nimport type { BlockCodec, MultihashHasher } from 'multiformats'\nimport type { CID } from 'multiformats/cid'\nimport type { ProgressEvent, ProgressOptions } from 'progress-events'\n\nexport type { Await, AwaitIterable } from 'interface-store'\n\nexport interface CodecLoader {\n  <T = any, Code extends number = any>(code: Code): Await<BlockCodec<Code, T>>\n}\n\nexport interface HasherLoader {\n  (code: number): Await<MultihashHasher>\n}\n\n/**\n * The API presented by a Helia node\n */\nexport interface Helia<T extends Libp2p = Libp2p> {\n  /**\n   * The libp2p instance\n   */\n  libp2p: T\n\n  /**\n   * Where the blocks are stored\n   */\n  blockstore: Blocks\n\n  /**\n   * A key/value store\n   */\n  datastore: Datastore\n\n  /**\n   * Event emitter for Helia start and stop events\n   */\n  events: TypedEventEmitter<HeliaEvents<T>>\n\n  /**\n   * Pinning operations for blocks in the blockstore\n   */\n  pins: Pins\n\n  /**\n   * A logging component that can be reused by consumers\n   */\n  logger: ComponentLogger\n\n  /**\n   * The routing component allows performing operations such as looking up\n   * content providers, information about peers, etc.\n   */\n  routing: Routing\n\n  /**\n   * The DNS property can be used to perform lookups of various record types and\n   * will use a resolver appropriate to the current platform.\n   */\n  dns: DNS\n\n  /**\n   * A metrics object that can be used to collected arbitrary stats about node\n   * usage.\n   */\n  metrics?: Metrics\n\n  /**\n   * Starts the Helia node\n   */\n  start(): Promise<void>\n\n  /**\n   * Stops the Helia node\n   */\n  stop(): Promise<void>\n\n  /**\n   * Remove any unpinned blocks from the blockstore\n   */\n  gc(options?: GCOptions): Promise<void>\n\n  /**\n   * Load an IPLD codec. Implementations may return a promise if, for example,\n   * the codec is being fetched from the network.\n   */\n  getCodec: CodecLoader\n\n  /**\n   * Hashers can be used to hash a piece of data with the specified hashing\n   * algorithm. Implementations may return a promise if, for example,\n   * the hasher is being fetched from the network.\n   */\n  getHasher: HasherLoader\n}\n\nexport type GcEvents =\n  ProgressEvent<'helia:gc:deleted', CID> |\n  ProgressEvent<'helia:gc:error', Error>\n\nexport interface GCOptions extends AbortOptions, ProgressOptions<GcEvents> {\n\n}\n\nexport interface HeliaEvents<T extends Libp2p = Libp2p> {\n  /**\n   * This event notifies listeners that the node has started\n   *\n   * ```TypeScript\n   * helia.addEventListener('start', (event) => {\n   *   console.info(event.detail.libp2p.isStarted()) // true\n   * })\n   * ```\n   */\n  start: CustomEvent<Helia<T>>\n\n  /**\n   * This event notifies listeners that the node has stopped\n   *\n   * ```TypeScript\n   * helia.addEventListener('stop', (event) => {\n   *   console.info(event.detail.libp2p.isStarted()) // false\n   * })\n   * ```\n   */\n  stop: CustomEvent<Helia<T>>\n}\n\nexport * from './blocks.js'\nexport * from './errors.js'\nexport * from './pins.js'\nexport * from './routing.js'\n", "import type { PeerId } from '@libp2p/interface'\nimport type { Multiaddr } from '@multiformats/multiaddr'\nimport type { Blockstore } from 'interface-blockstore'\nimport type { AbortOptions } from 'interface-store'\nimport type { CID } from 'multiformats/cid'\nimport type { ProgressEvent, ProgressOptions } from 'progress-events'\n\nexport type { Pair, InputPair } from 'interface-blockstore'\n\nexport interface ProviderOptions {\n  /**\n   * An optional list of peers known to host at least the root block of the DAG\n   * that will be fetched.\n   *\n   * If this list is omitted, or if the peers cannot supply the root or any\n   * child blocks, a `findProviders` routing query will be run to find peers\n   * that can supply the blocks.\n   */\n  providers?: Array<PeerId | Multiaddr | Multiaddr[]>\n}\n\nexport type HasBlockProgressEvents =\n  ProgressEvent<'blocks:put:duplicate', CID> |\n  ProgressEvent<'blocks:put:providers:notify', CID> |\n  ProgressEvent<'blocks:put:blockstore:put', CID>\n\nexport type PutBlockProgressEvents =\n  ProgressEvent<'blocks:put:duplicate', CID> |\n  ProgressEvent<'blocks:put:providers:notify', CID> |\n  ProgressEvent<'blocks:put:blockstore:put', CID>\n\nexport type PutManyBlocksProgressEvents =\n  ProgressEvent<'blocks:put-many:duplicate', CID> |\n  ProgressEvent<'blocks:put-many:providers:notify', CID> |\n  ProgressEvent<'blocks:put-many:blockstore:put-many'>\n\nexport type GetBlockProgressEvents =\n  ProgressEvent<'blocks:get:providers:want', CID> |\n  ProgressEvent<'blocks:get:blockstore:get', CID> |\n  ProgressEvent<'blocks:get:blockstore:put', CID>\n\nexport type GetManyBlocksProgressEvents =\n  ProgressEvent<'blocks:get-many:blockstore:get-many'> |\n  ProgressEvent<'blocks:get-many:providers:want', CID> |\n  ProgressEvent<'blocks:get-many:blockstore:put', CID>\n\nexport type GetAllBlocksProgressEvents =\n  ProgressEvent<'blocks:get-all:blockstore:get-many'>\n\nexport type DeleteBlockProgressEvents =\n  ProgressEvent<'blocks:delete:blockstore:delete', CID>\n\nexport type DeleteManyBlocksProgressEvents =\n  ProgressEvent<'blocks:delete-many:blockstore:delete-many'>\n\nexport interface GetOfflineOptions {\n  /**\n   * If true, do not attempt to fetch any missing blocks from the network\n   *\n   * @default false\n   */\n  offline?: boolean\n}\n\nexport interface Blocks extends Blockstore<ProgressOptions<HasBlockProgressEvents>,\nProgressOptions<PutBlockProgressEvents>, ProgressOptions<PutManyBlocksProgressEvents>,\nGetOfflineOptions & ProviderOptions & ProgressOptions<GetBlockProgressEvents>,\nGetOfflineOptions & ProviderOptions & ProgressOptions<GetManyBlocksProgressEvents>,\nProgressOptions<GetAllBlocksProgressEvents>,\nProgressOptions<DeleteBlockProgressEvents>, ProgressOptions<DeleteManyBlocksProgressEvents>\n> {\n  /**\n   * A blockstore session only fetches blocks from a subset of network peers to\n   * reduce network traffic and improve performance.\n   *\n   * The initial set of peers can be specified, alternatively a `findProviders`\n   * routing query will occur to populate the set instead.\n   */\n  createSession(root: CID, options?: CreateSessionOptions<GetBlockProgressEvents>): SessionBlockstore\n}\n\n/**\n * A session blockstore is a special blockstore that only pulls content from a\n * subset of network peers which respond as having the block for the initial\n * root CID.\n *\n * Any blocks written to the blockstore as part of the session will propagate\n * to the blockstore the session was created from.\n *\n */\nexport interface SessionBlockstore extends Blockstore<ProgressOptions<HasBlockProgressEvents>,\nProgressOptions<PutBlockProgressEvents>, ProgressOptions<PutManyBlocksProgressEvents>,\nGetOfflineOptions & ProgressOptions<GetBlockProgressEvents>, GetOfflineOptions & ProgressOptions<GetManyBlocksProgressEvents>, ProgressOptions<GetAllBlocksProgressEvents>,\nProgressOptions<DeleteBlockProgressEvents>, ProgressOptions<DeleteManyBlocksProgressEvents>\n> {\n  /**\n   * Any in-progress operations will be aborted.\n   */\n  close(): void\n\n  /**\n   * Adds a new peer to the session if they are supported and are either\n   * not already in the session and have not been evicted previously.\n   */\n  addPeer (peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>\n}\n\nexport interface BlockRetrievalOptions <ProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> extends AbortOptions, ProgressOptions<ProgressEvents>, ProviderOptions {\n  /**\n   * A function that blockBrokers should call prior to returning a block to ensure it can maintain control\n   * of the block request flow. e.g. TrustedGatewayBlockBroker will use this to ensure that the block\n   * is valid from one of the gateways before assuming its work is done. If the block is not valid, it should try another gateway\n   * and WILL consider the gateway that returned the invalid blocks completely unreliable.\n   */\n  validateFn?(block: Uint8Array): Promise<void>\n\n  /**\n   * The maximum size a block can be in bytes.\n   *\n   * Attempts to retrieve a block larger than this will cause an error to be thrown.\n   *\n   * @default 2_097_152\n   */\n  maxSize?: number\n}\n\nexport interface BlockAnnounceOptions <ProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> extends AbortOptions, ProgressOptions<ProgressEvents> {\n\n}\n\nexport interface CreateSessionOptions <ProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> extends AbortOptions, ProgressOptions<ProgressEvents>, ProviderOptions, GetOfflineOptions {\n  /**\n   * The minimum number of providers for the root CID that are required for\n   * successful session creation.\n   *\n   * The session will become usable once this many providers have been\n   * discovered, up to `maxProviders` providers will continue to be added.\n   *\n   * @default 1\n   */\n  minProviders?: number\n\n  /**\n   * The maximum number of providers for the root CID to be added to a session.\n   *\n   * @default 5\n   */\n  maxProviders?: number\n\n  /**\n   * A scalable cuckoo filter is used to ensure we do not query the same peer\n   * multiple times for the same CID. This setting controls how the initial\n   * maximum number of peers that are expected to be in the filter.\n   *\n   * @default 100\n   */\n  cidPeerFilterSize?: number\n}\n\nexport interface BlockBroker<RetrieveProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>, AnnounceProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> {\n  /**\n   * The name of the block broker, used for logging purposes\n   */\n  name: string\n\n  /**\n   * Retrieve a block from a source\n   */\n  retrieve?(cid: CID, options?: BlockRetrievalOptions<RetrieveProgressEvents>): Promise<Uint8Array>\n\n  /**\n   * Make a new block available to peers\n   */\n  announce?(cid: CID, options?: BlockAnnounceOptions<AnnounceProgressEvents>): Promise<void>\n\n  /**\n   * Create a new session\n   */\n  createSession?(options?: CreateSessionOptions<RetrieveProgressEvents>): SessionBlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>\n}\n\nexport interface SessionBlockBroker<RetrieveProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>, AnnounceProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> extends BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents> {\n  /**\n   * Adds a new peer to the session if they are supported and are either\n   * not already in the session and have not been evicted previously.\n   */\n  addPeer (peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>\n}\n\nexport const DEFAULT_SESSION_MIN_PROVIDERS = 1\nexport const DEFAULT_SESSION_MAX_PROVIDERS = 5\nexport const DEFAULT_CID_PEER_FILTER_SIZE = 100\n", "export class InsufficientProvidersError extends Error {\n  static name = 'InsufficientProvidersError'\n\n  constructor (message = 'Insufficient providers found') {\n    super(message)\n    this.name = 'InsufficientProvidersError'\n  }\n}\n\nexport class NoRoutersAvailableError extends Error {\n  static name = 'NoRoutersAvailableError'\n\n  constructor (message = 'No routers available') {\n    super(message)\n    this.name = 'NoRoutersAvailableError'\n  }\n}\n\nexport class UnknownHashAlgorithmError extends Error {\n  static name = 'UnknownHashAlgorithmError'\n\n  constructor (message = 'Unknown hash algorithm') {\n    super(message)\n    this.name = 'UnknownHashAlgorithmError'\n  }\n}\n\nexport class UnknownCodecError extends Error {\n  static name = 'UnknownCodecError'\n\n  constructor (message = 'Unknown codec') {\n    super(message)\n    this.name = 'UnknownCodecError'\n  }\n}\n\nexport class InvalidCodecError extends Error {\n  static name = 'InvalidCodecError'\n\n  constructor (message = 'Invalid codec') {\n    super(message)\n    this.name = 'InvalidCodecError'\n  }\n}\n"],
-  "mappings": ";kcAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,kCAAAE,EAAA,kCAAAC,EAAA,kCAAAC,EAAA,+BAAAC,EAAA,sBAAAC,EAAA,4BAAAC,EAAA,sBAAAC,EAAA,8BAAAC,IC6LO,IAAMC,EAAgC,EAChCC,EAAgC,EAChCC,EAA+B,IC/LtC,IAAOC,EAAP,cAA0C,KAAK,CACnD,OAAO,KAAO,6BAEd,YAAaC,EAAU,+BAA8B,CACnD,MAAMA,CAAO,EACb,KAAK,KAAO,4BACd,GAGWC,EAAP,cAAuC,KAAK,CAChD,OAAO,KAAO,0BAEd,YAAaD,EAAU,uBAAsB,CAC3C,MAAMA,CAAO,EACb,KAAK,KAAO,yBACd,GAGWE,EAAP,cAAyC,KAAK,CAClD,OAAO,KAAO,4BAEd,YAAaF,EAAU,yBAAwB,CAC7C,MAAMA,CAAO,EACb,KAAK,KAAO,2BACd,GAGWG,EAAP,cAAiC,KAAK,CAC1C,OAAO,KAAO,oBAEd,YAAaH,EAAU,gBAAe,CACpC,MAAMA,CAAO,EACb,KAAK,KAAO,mBACd,GAGWI,EAAP,cAAiC,KAAK,CAC1C,OAAO,KAAO,oBAEd,YAAaJ,EAAU,gBAAe,CACpC,MAAMA,CAAO,EACb,KAAK,KAAO,mBACd",
+  "sourcesContent": ["/**\n * @packageDocumentation\n *\n * The API defined by a {@link Helia} node\n *\n * @example\n *\n * ```typescript\n * import type { Helia } from '@helia/interface'\n *\n * export function doSomething(helia: Helia) {\n *   // use helia node functions here\n * }\n * ```\n */\n\nimport type { Blocks } from './blocks.ts'\nimport type { Pins } from './pins.ts'\nimport type { Routing } from './routing.ts'\nimport type { AbortOptions, ComponentLogger, Libp2p, Metrics, TypedEventEmitter } from '@libp2p/interface'\nimport type { DNS } from '@multiformats/dns'\nimport type { Datastore } from 'interface-datastore'\nimport type { Await } from 'interface-store'\nimport type { BlockCodec, MultihashHasher } from 'multiformats'\nimport type { CID } from 'multiformats/cid'\nimport type { ProgressEvent, ProgressOptions } from 'progress-events'\n\nexport type { Await, AwaitIterable } from 'interface-store'\n\nexport interface CodecLoader {\n  <T = any, Code extends number = any>(code: Code): Await<BlockCodec<Code, T>>\n}\n\nexport interface HasherLoader {\n  (code: number): Await<MultihashHasher>\n}\n\n/**\n * The API presented by a Helia node\n */\nexport interface Helia<T extends Libp2p = Libp2p> {\n  /**\n   * The libp2p instance\n   */\n  libp2p: T\n\n  /**\n   * Where the blocks are stored\n   */\n  blockstore: Blocks\n\n  /**\n   * A key/value store\n   */\n  datastore: Datastore\n\n  /**\n   * Event emitter for Helia start and stop events\n   */\n  events: TypedEventEmitter<HeliaEvents<T>>\n\n  /**\n   * Pinning operations for blocks in the blockstore\n   */\n  pins: Pins\n\n  /**\n   * A logging component that can be reused by consumers\n   */\n  logger: ComponentLogger\n\n  /**\n   * The routing component allows performing operations such as looking up\n   * content providers, information about peers, etc.\n   */\n  routing: Routing\n\n  /**\n   * The DNS property can be used to perform lookups of various record types and\n   * will use a resolver appropriate to the current platform.\n   */\n  dns: DNS\n\n  /**\n   * A metrics object that can be used to collected arbitrary stats about node\n   * usage.\n   */\n  metrics?: Metrics\n\n  /**\n   * Starts the Helia node\n   */\n  start(): Promise<void>\n\n  /**\n   * Stops the Helia node\n   */\n  stop(): Promise<void>\n\n  /**\n   * Remove any unpinned blocks from the blockstore\n   */\n  gc(options?: GCOptions): Promise<void>\n\n  /**\n   * Load an IPLD codec. Implementations may return a promise if, for example,\n   * the codec is being fetched from the network.\n   */\n  getCodec: CodecLoader\n\n  /**\n   * Hashers can be used to hash a piece of data with the specified hashing\n   * algorithm. Implementations may return a promise if, for example,\n   * the hasher is being fetched from the network.\n   */\n  getHasher: HasherLoader\n}\n\nexport type GcEvents =\n  ProgressEvent<'helia:gc:deleted', CID> |\n  ProgressEvent<'helia:gc:error', Error>\n\nexport interface GCOptions extends AbortOptions, ProgressOptions<GcEvents> {\n\n}\n\nexport interface HeliaEvents<T extends Libp2p = Libp2p> {\n  /**\n   * This event notifies listeners that the node has started\n   *\n   * ```TypeScript\n   * helia.addEventListener('start', (event) => {\n   *   console.info(event.detail.libp2p.isStarted()) // true\n   * })\n   * ```\n   */\n  start: CustomEvent<Helia<T>>\n\n  /**\n   * This event notifies listeners that the node has stopped\n   *\n   * ```TypeScript\n   * helia.addEventListener('stop', (event) => {\n   *   console.info(event.detail.libp2p.isStarted()) // false\n   * })\n   * ```\n   */\n  stop: CustomEvent<Helia<T>>\n}\n\nexport * from './blocks.ts'\nexport * from './errors.ts'\nexport * from './pins.ts'\nexport * from './routing.ts'\n", "import type { RoutingFindProvidersProgressEvents } from './routing.ts'\nimport type { PeerId, AbortOptions } from '@libp2p/interface'\nimport type { Multiaddr } from '@multiformats/multiaddr'\nimport type { Blockstore } from 'interface-blockstore'\nimport type { CID } from 'multiformats/cid'\nimport type { ProgressEvent, ProgressOptions } from 'progress-events'\n\nexport type { Pair, InputPair } from 'interface-blockstore'\n\nexport interface ProviderOptions {\n  /**\n   * An optional list of peers known to host at least the root block of the DAG\n   * that will be fetched.\n   *\n   * If this list is omitted, or if the peers cannot supply the root or any\n   * child blocks, a `findProviders` routing query will be run to find peers\n   * that can supply the blocks.\n   */\n  providers?: Array<PeerId | Multiaddr | Multiaddr[]>\n}\n\n/**\n * A block broker will contact a provider to retrieve a block\n */\nexport interface BlockBrokerConnectProgressEvent {\n  broker: string\n  type: 'connect'\n  provider: PeerId\n  cid: CID\n}\n\n/**\n * A block broker has contacted a provider to retrieve a block\n */\nexport interface BlockBrokerConnectedProgressEvent {\n  broker: string\n  type: 'connected'\n  provider: PeerId\n  address: Multiaddr\n  cid: CID\n}\n\n/**\n * A block broker has retrieved a block from a provider\n */\nexport interface BlockBrokerRequestBlockProgressEvent {\n  broker: string\n  type: 'request-block'\n  provider: PeerId\n  cid: CID\n}\n\n/**\n * A block broker has retrieved a block from a provider\n */\nexport interface BlockBrokerReceiveBlockProgressEvent {\n  broker: string\n  type: 'receive-block'\n  provider: PeerId\n  cid: CID\n}\n\nexport type BlockBrokerGetBlockProgressEvents = ProgressEvent<'helia:block-broker:connect', BlockBrokerConnectProgressEvent>\n  | ProgressEvent<'helia:block-broker:connected', BlockBrokerConnectedProgressEvent>\n  | ProgressEvent<'helia:block-broker:request-block', BlockBrokerRequestBlockProgressEvent>\n  | ProgressEvent<'helia:block-broker:receive-block', BlockBrokerReceiveBlockProgressEvent>\n\nexport type HasBlockProgressEvents =\n  ProgressEvent<'blocks:put:duplicate', CID> |\n  ProgressEvent<'blocks:put:providers:notify', CID> |\n  ProgressEvent<'blocks:put:blockstore:put', CID>\n\nexport type PutBlockProgressEvents =\n  ProgressEvent<'blocks:put:duplicate', CID> |\n  ProgressEvent<'blocks:put:providers:notify', CID> |\n  ProgressEvent<'blocks:put:blockstore:put', CID>\n\nexport type PutManyBlocksProgressEvents =\n  ProgressEvent<'blocks:put-many:duplicate', CID> |\n  ProgressEvent<'blocks:put-many:providers:notify', CID> |\n  ProgressEvent<'blocks:put-many:blockstore:put-many'>\n\nexport type GetBlockProgressEvents =\n  ProgressEvent<'blocks:get:providers:want', CID> |\n  ProgressEvent<'blocks:get:blockstore:get', CID> |\n  ProgressEvent<'blocks:get:blockstore:put', CID> |\n  RoutingFindProvidersProgressEvents |\n  BlockBrokerGetBlockProgressEvents\n\nexport type GetManyBlocksProgressEvents =\n  ProgressEvent<'blocks:get-many:blockstore:get-many'> |\n  ProgressEvent<'blocks:get-many:providers:want', CID> |\n  ProgressEvent<'blocks:get-many:blockstore:put', CID>\n\nexport type GetAllBlocksProgressEvents =\n  ProgressEvent<'blocks:get-all:blockstore:get-many'>\n\nexport type DeleteBlockProgressEvents =\n  ProgressEvent<'blocks:delete:blockstore:delete', CID>\n\nexport type DeleteManyBlocksProgressEvents =\n  ProgressEvent<'blocks:delete-many:blockstore:delete-many'>\n\nexport interface GetOfflineOptions {\n  /**\n   * If true, do not attempt to fetch any missing blocks from the network\n   *\n   * @default false\n   */\n  offline?: boolean\n}\n\nexport interface Blocks extends Blockstore<ProgressOptions<HasBlockProgressEvents>,\nProgressOptions<PutBlockProgressEvents>, ProgressOptions<PutManyBlocksProgressEvents>,\nGetOfflineOptions & ProviderOptions & ProgressOptions<GetBlockProgressEvents>,\nGetOfflineOptions & ProviderOptions & ProgressOptions<GetManyBlocksProgressEvents>,\nProgressOptions<GetAllBlocksProgressEvents>,\nProgressOptions<DeleteBlockProgressEvents>, ProgressOptions<DeleteManyBlocksProgressEvents>\n> {\n  /**\n   * A blockstore session only fetches blocks from a subset of network peers to\n   * reduce network traffic and improve performance.\n   *\n   * The initial set of peers can be specified, alternatively a `findProviders`\n   * routing query will occur to populate the set instead.\n   */\n  createSession(root: CID, options?: CreateSessionOptions<GetBlockProgressEvents>): SessionBlockstore\n}\n\n/**\n * A session blockstore is a special blockstore that only pulls content from a\n * subset of network peers which respond as having the block for the initial\n * root CID.\n *\n * Any blocks written to the blockstore as part of the session will propagate\n * to the blockstore the session was created from.\n *\n */\nexport interface SessionBlockstore extends Blockstore<ProgressOptions<HasBlockProgressEvents>,\nProgressOptions<PutBlockProgressEvents>, ProgressOptions<PutManyBlocksProgressEvents>,\nGetOfflineOptions & ProgressOptions<GetBlockProgressEvents>, GetOfflineOptions & ProgressOptions<GetManyBlocksProgressEvents>, ProgressOptions<GetAllBlocksProgressEvents>,\nProgressOptions<DeleteBlockProgressEvents>, ProgressOptions<DeleteManyBlocksProgressEvents>\n> {\n  /**\n   * Any in-progress operations will be aborted.\n   */\n  close(): void\n\n  /**\n   * Adds a new peer to the session if they are supported and are either\n   * not already in the session and have not been evicted previously.\n   */\n  addPeer (peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>\n}\n\nexport interface BlockRetrievalOptions <ProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> extends AbortOptions, ProgressOptions<ProgressEvents>, ProviderOptions {\n  /**\n   * A function that blockBrokers should call prior to returning a block to ensure it can maintain control\n   * of the block request flow. e.g. TrustedGatewayBlockBroker will use this to ensure that the block\n   * is valid from one of the gateways before assuming its work is done. If the block is not valid, it should try another gateway\n   * and WILL consider the gateway that returned the invalid blocks completely unreliable.\n   */\n  validateFn?(block: Uint8Array): Promise<void>\n\n  /**\n   * The maximum size a block can be in bytes.\n   *\n   * Attempts to retrieve a block larger than this will cause an error to be thrown.\n   *\n   * @default 2_097_152\n   */\n  maxSize?: number\n}\n\nexport interface BlockAnnounceOptions <ProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> extends AbortOptions, ProgressOptions<ProgressEvents> {\n\n}\n\nexport interface CreateSessionOptions <ProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> extends AbortOptions, ProgressOptions<ProgressEvents>, ProviderOptions, GetOfflineOptions {\n  /**\n   * The minimum number of providers for the root CID that are required for\n   * successful session creation.\n   *\n   * The session will become usable once this many providers have been\n   * discovered, up to `maxProviders` providers will continue to be added.\n   *\n   * @default 1\n   */\n  minProviders?: number\n\n  /**\n   * The maximum number of providers for the root CID to be added to a session.\n   *\n   * @default 5\n   */\n  maxProviders?: number\n\n  /**\n   * A scalable cuckoo filter is used to ensure we do not query the same peer\n   * multiple times for the same CID. This setting controls how the initial\n   * maximum number of peers that are expected to be in the filter.\n   *\n   * @default 100\n   */\n  cidPeerFilterSize?: number\n}\n\nexport interface BlockBroker<RetrieveProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>, AnnounceProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> {\n  /**\n   * The name of the block broker, used for logging purposes\n   */\n  name: string\n\n  /**\n   * Retrieve a block from a source\n   */\n  retrieve?(cid: CID, options?: BlockRetrievalOptions<RetrieveProgressEvents>): Promise<Uint8Array>\n\n  /**\n   * Make a new block available to peers\n   */\n  announce?(cid: CID, options?: BlockAnnounceOptions<AnnounceProgressEvents>): Promise<void>\n\n  /**\n   * Create a new session\n   */\n  createSession?(options?: CreateSessionOptions<RetrieveProgressEvents>): SessionBlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>\n}\n\nexport interface SessionBlockBroker<RetrieveProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>, AnnounceProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> extends BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents> {\n  /**\n   * Adds a new peer to the session if they are supported and are either\n   * not already in the session and have not been evicted previously.\n   */\n  addPeer (peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>\n}\n\nexport const DEFAULT_SESSION_MIN_PROVIDERS = 1\nexport const DEFAULT_SESSION_MAX_PROVIDERS = 5\nexport const DEFAULT_CID_PEER_FILTER_SIZE = 100\n", "export class InsufficientProvidersError extends Error {\n  static name = 'InsufficientProvidersError'\n\n  constructor (message = 'Insufficient providers found') {\n    super(message)\n    this.name = 'InsufficientProvidersError'\n  }\n}\n\nexport class NoRoutersAvailableError extends Error {\n  static name = 'NoRoutersAvailableError'\n\n  constructor (message = 'No routers available') {\n    super(message)\n    this.name = 'NoRoutersAvailableError'\n  }\n}\n\nexport class UnknownHashAlgorithmError extends Error {\n  static name = 'UnknownHashAlgorithmError'\n\n  constructor (message = 'Unknown hash algorithm') {\n    super(message)\n    this.name = 'UnknownHashAlgorithmError'\n  }\n}\n\nexport class UnknownCodecError extends Error {\n  static name = 'UnknownCodecError'\n\n  constructor (message = 'Unknown codec') {\n    super(message)\n    this.name = 'UnknownCodecError'\n  }\n}\n\nexport class InvalidCodecError extends Error {\n  static name = 'InvalidCodecError'\n\n  constructor (message = 'Invalid codec') {\n    super(message)\n    this.name = 'InvalidCodecError'\n  }\n}\n"],
+  "mappings": ";kcAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,kCAAAE,EAAA,kCAAAC,EAAA,kCAAAC,EAAA,+BAAAC,EAAA,sBAAAC,EAAA,4BAAAC,EAAA,sBAAAC,EAAA,8BAAAC,IC6OO,IAAMC,EAAgC,EAChCC,EAAgC,EAChCC,EAA+B,IC/OtC,IAAOC,EAAP,cAA0C,KAAK,CACnD,OAAO,KAAO,6BAEd,YAAaC,EAAU,+BAA8B,CACnD,MAAMA,CAAO,EACb,KAAK,KAAO,4BACd,GAGWC,EAAP,cAAuC,KAAK,CAChD,OAAO,KAAO,0BAEd,YAAaD,EAAU,uBAAsB,CAC3C,MAAMA,CAAO,EACb,KAAK,KAAO,yBACd,GAGWE,EAAP,cAAyC,KAAK,CAClD,OAAO,KAAO,4BAEd,YAAaF,EAAU,yBAAwB,CAC7C,MAAMA,CAAO,EACb,KAAK,KAAO,2BACd,GAGWG,EAAP,cAAiC,KAAK,CAC1C,OAAO,KAAO,oBAEd,YAAaH,EAAU,gBAAe,CACpC,MAAMA,CAAO,EACb,KAAK,KAAO,mBACd,GAGWI,EAAP,cAAiC,KAAK,CAC1C,OAAO,KAAO,oBAEd,YAAaJ,EAAU,gBAAe,CACpC,MAAMA,CAAO,EACb,KAAK,KAAO,mBACd",
   "names": ["index_exports", "__export", "DEFAULT_CID_PEER_FILTER_SIZE", "DEFAULT_SESSION_MAX_PROVIDERS", "DEFAULT_SESSION_MIN_PROVIDERS", "InsufficientProvidersError", "InvalidCodecError", "NoRoutersAvailableError", "UnknownCodecError", "UnknownHashAlgorithmError", "DEFAULT_SESSION_MIN_PROVIDERS", "DEFAULT_SESSION_MAX_PROVIDERS", "DEFAULT_CID_PEER_FILTER_SIZE", "InsufficientProvidersError", "message", "NoRoutersAvailableError", "UnknownHashAlgorithmError", "UnknownCodecError", "InvalidCodecError"]
 }

package/dist/src/blocks.d.ts

@@ -1,7 +1,7 @@
-import type { PeerId } from '@libp2p/interface';
+import type { RoutingFindProvidersProgressEvents } from './routing.ts';
+import type { PeerId, AbortOptions } from '@libp2p/interface';
 import type { Multiaddr } from '@multiformats/multiaddr';
 import type { Blockstore } from 'interface-blockstore';
-import type { AbortOptions } from 'interface-store';
 import type { CID } from 'multiformats/cid';
 import type { ProgressEvent, ProgressOptions } from 'progress-events';
 export type { Pair, InputPair } from 'interface-blockstore';
@@ -16,10 +16,48 @@ export interface ProviderOptions {
      */
     providers?: Array<PeerId | Multiaddr | Multiaddr[]>;
 }
+/**
+ * A block broker will contact a provider to retrieve a block
+ */
+export interface BlockBrokerConnectProgressEvent {
+    broker: string;
+    type: 'connect';
+    provider: PeerId;
+    cid: CID;
+}
+/**
+ * A block broker has contacted a provider to retrieve a block
+ */
+export interface BlockBrokerConnectedProgressEvent {
+    broker: string;
+    type: 'connected';
+    provider: PeerId;
+    address: Multiaddr;
+    cid: CID;
+}
+/**
+ * A block broker has retrieved a block from a provider
+ */
+export interface BlockBrokerRequestBlockProgressEvent {
+    broker: string;
+    type: 'request-block';
+    provider: PeerId;
+    cid: CID;
+}
+/**
+ * A block broker has retrieved a block from a provider
+ */
+export interface BlockBrokerReceiveBlockProgressEvent {
+    broker: string;
+    type: 'receive-block';
+    provider: PeerId;
+    cid: CID;
+}
+export type BlockBrokerGetBlockProgressEvents = ProgressEvent<'helia:block-broker:connect', BlockBrokerConnectProgressEvent> | ProgressEvent<'helia:block-broker:connected', BlockBrokerConnectedProgressEvent> | ProgressEvent<'helia:block-broker:request-block', BlockBrokerRequestBlockProgressEvent> | ProgressEvent<'helia:block-broker:receive-block', BlockBrokerReceiveBlockProgressEvent>;
 export type HasBlockProgressEvents = ProgressEvent<'blocks:put:duplicate', CID> | ProgressEvent<'blocks:put:providers:notify', CID> | ProgressEvent<'blocks:put:blockstore:put', CID>;
 export type PutBlockProgressEvents = ProgressEvent<'blocks:put:duplicate', CID> | ProgressEvent<'blocks:put:providers:notify', CID> | ProgressEvent<'blocks:put:blockstore:put', CID>;
 export type PutManyBlocksProgressEvents = ProgressEvent<'blocks:put-many:duplicate', CID> | ProgressEvent<'blocks:put-many:providers:notify', CID> | ProgressEvent<'blocks:put-many:blockstore:put-many'>;
-export type GetBlockProgressEvents = ProgressEvent<'blocks:get:providers:want', CID> | ProgressEvent<'blocks:get:blockstore:get', CID> | ProgressEvent<'blocks:get:blockstore:put', CID>;
+export type GetBlockProgressEvents = ProgressEvent<'blocks:get:providers:want', CID> | ProgressEvent<'blocks:get:blockstore:get', CID> | ProgressEvent<'blocks:get:blockstore:put', CID> | RoutingFindProvidersProgressEvents | BlockBrokerGetBlockProgressEvents;
 export type GetManyBlocksProgressEvents = ProgressEvent<'blocks:get-many:blockstore:get-many'> | ProgressEvent<'blocks:get-many:providers:want', CID> | ProgressEvent<'blocks:get-many:blockstore:put', CID>;
 export type GetAllBlocksProgressEvents = ProgressEvent<'blocks:get-all:blockstore:get-many'>;
 export type DeleteBlockProgressEvents = ProgressEvent<'blocks:delete:blockstore:delete', CID>;

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

@@ -1 +1 @@
-{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../../src/blocks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAE3D,MAAM,WAAW,eAAe;IAC9B;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,CAAC,CAAA;CACpD;AAED,MAAM,MAAM,sBAAsB,GAChC,aAAa,CAAC,sBAAsB,EAAE,GAAG,CAAC,GAC1C,aAAa,CAAC,6BAA6B,EAAE,GAAG,CAAC,GACjD,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;AAEjD,MAAM,MAAM,sBAAsB,GAChC,aAAa,CAAC,sBAAsB,EAAE,GAAG,CAAC,GAC1C,aAAa,CAAC,6BAA6B,EAAE,GAAG,CAAC,GACjD,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;AAEjD,MAAM,MAAM,2BAA2B,GACrC,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,aAAa,CAAC,kCAAkC,EAAE,GAAG,CAAC,GACtD,aAAa,CAAC,qCAAqC,CAAC,CAAA;AAEtD,MAAM,MAAM,sBAAsB,GAChC,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;AAEjD,MAAM,MAAM,2BAA2B,GACrC,aAAa,CAAC,qCAAqC,CAAC,GACpD,aAAa,CAAC,gCAAgC,EAAE,GAAG,CAAC,GACpD,aAAa,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAA;AAEtD,MAAM,MAAM,0BAA0B,GACpC,aAAa,CAAC,oCAAoC,CAAC,CAAA;AAErD,MAAM,MAAM,yBAAyB,GACnC,aAAa,CAAC,iCAAiC,EAAE,GAAG,CAAC,CAAA;AAEvD,MAAM,MAAM,8BAA8B,GACxC,aAAa,CAAC,2CAA2C,CAAC,CAAA;AAE5D,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,MAAO,SAAQ,UAAU,CAAC,eAAe,CAAC,sBAAsB,CAAC,EAClF,eAAe,CAAC,sBAAsB,CAAC,EAAE,eAAe,CAAC,2BAA2B,CAAC,EACrF,iBAAiB,GAAG,eAAe,GAAG,eAAe,CAAC,sBAAsB,CAAC,EAC7E,iBAAiB,GAAG,eAAe,GAAG,eAAe,CAAC,2BAA2B,CAAC,EAClF,eAAe,CAAC,0BAA0B,CAAC,EAC3C,eAAe,CAAC,yBAAyB,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,CAC1F;IACC;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,sBAAsB,CAAC,GAAG,iBAAiB,CAAA;CACpG;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU,CAAC,eAAe,CAAC,sBAAsB,CAAC,EAC7F,eAAe,CAAC,sBAAsB,CAAC,EAAE,eAAe,CAAC,2BAA2B,CAAC,EACrF,iBAAiB,GAAG,eAAe,CAAC,sBAAsB,CAAC,EAAE,iBAAiB,GAAG,eAAe,CAAC,2BAA2B,CAAC,EAAE,eAAe,CAAC,0BAA0B,CAAC,EAC1K,eAAe,CAAC,yBAAyB,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,CAC1F;IACC;;OAEG;IACH,KAAK,IAAI,IAAI,CAAA;IAEb;;;OAGG;IACH,OAAO,CAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACxF;AAED,MAAM,WAAW,qBAAqB,CAAE,cAAc,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,cAAc,CAAC,EAAE,eAAe;IACtL;;;;;OAKG;IACH,UAAU,CAAC,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7C;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,oBAAoB,CAAE,cAAc,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,cAAc,CAAC;CAErK;AAED,MAAM,WAAW,oBAAoB,CAAE,cAAc,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,cAAc,CAAC,EAAE,eAAe,EAAE,iBAAiB;IACxM;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,WAAW,CAAC,sBAAsB,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,sBAAsB,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC;IAC7L;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,qBAAqB,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEjG;;OAEG;IACH,QAAQ,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1F;;OAEG;IACH,aAAa,CAAC,CAAC,OAAO,CAAC,EAAE,oBAAoB,CAAC,sBAAsB,CAAC,GAAG,kBAAkB,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAA;CAC3I;AAED,MAAM,WAAW,kBAAkB,CAAC,sBAAsB,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,sBAAsB,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAE,SAAQ,WAAW,CAAC,sBAAsB,EAAE,sBAAsB,CAAC;IACzQ;;;OAGG;IACH,OAAO,CAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACxF;AAED,eAAO,MAAM,6BAA6B,IAAI,CAAA;AAC9C,eAAO,MAAM,6BAA6B,IAAI,CAAA;AAC9C,eAAO,MAAM,4BAA4B,MAAM,CAAA"}
+{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../../src/blocks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,cAAc,CAAA;AACtE,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAE3D,MAAM,WAAW,eAAe;IAC9B;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,CAAC,CAAA;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,SAAS,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,GAAG,CAAA;CACT;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,WAAW,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,SAAS,CAAA;IAClB,GAAG,EAAE,GAAG,CAAA;CACT;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,eAAe,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,GAAG,CAAA;CACT;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,eAAe,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,MAAM,iCAAiC,GAAG,aAAa,CAAC,4BAA4B,EAAE,+BAA+B,CAAC,GACxH,aAAa,CAAC,8BAA8B,EAAE,iCAAiC,CAAC,GAChF,aAAa,CAAC,kCAAkC,EAAE,oCAAoC,CAAC,GACvF,aAAa,CAAC,kCAAkC,EAAE,oCAAoC,CAAC,CAAA;AAE3F,MAAM,MAAM,sBAAsB,GAChC,aAAa,CAAC,sBAAsB,EAAE,GAAG,CAAC,GAC1C,aAAa,CAAC,6BAA6B,EAAE,GAAG,CAAC,GACjD,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;AAEjD,MAAM,MAAM,sBAAsB,GAChC,aAAa,CAAC,sBAAsB,EAAE,GAAG,CAAC,GAC1C,aAAa,CAAC,6BAA6B,EAAE,GAAG,CAAC,GACjD,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;AAEjD,MAAM,MAAM,2BAA2B,GACrC,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,aAAa,CAAC,kCAAkC,EAAE,GAAG,CAAC,GACtD,aAAa,CAAC,qCAAqC,CAAC,CAAA;AAEtD,MAAM,MAAM,sBAAsB,GAChC,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,kCAAkC,GAClC,iCAAiC,CAAA;AAEnC,MAAM,MAAM,2BAA2B,GACrC,aAAa,CAAC,qCAAqC,CAAC,GACpD,aAAa,CAAC,gCAAgC,EAAE,GAAG,CAAC,GACpD,aAAa,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAA;AAEtD,MAAM,MAAM,0BAA0B,GACpC,aAAa,CAAC,oCAAoC,CAAC,CAAA;AAErD,MAAM,MAAM,yBAAyB,GACnC,aAAa,CAAC,iCAAiC,EAAE,GAAG,CAAC,CAAA;AAEvD,MAAM,MAAM,8BAA8B,GACxC,aAAa,CAAC,2CAA2C,CAAC,CAAA;AAE5D,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,MAAO,SAAQ,UAAU,CAAC,eAAe,CAAC,sBAAsB,CAAC,EAClF,eAAe,CAAC,sBAAsB,CAAC,EAAE,eAAe,CAAC,2BAA2B,CAAC,EACrF,iBAAiB,GAAG,eAAe,GAAG,eAAe,CAAC,sBAAsB,CAAC,EAC7E,iBAAiB,GAAG,eAAe,GAAG,eAAe,CAAC,2BAA2B,CAAC,EAClF,eAAe,CAAC,0BAA0B,CAAC,EAC3C,eAAe,CAAC,yBAAyB,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,CAC1F;IACC;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,sBAAsB,CAAC,GAAG,iBAAiB,CAAA;CACpG;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU,CAAC,eAAe,CAAC,sBAAsB,CAAC,EAC7F,eAAe,CAAC,sBAAsB,CAAC,EAAE,eAAe,CAAC,2BAA2B,CAAC,EACrF,iBAAiB,GAAG,eAAe,CAAC,sBAAsB,CAAC,EAAE,iBAAiB,GAAG,eAAe,CAAC,2BAA2B,CAAC,EAAE,eAAe,CAAC,0BAA0B,CAAC,EAC1K,eAAe,CAAC,yBAAyB,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,CAC1F;IACC;;OAEG;IACH,KAAK,IAAI,IAAI,CAAA;IAEb;;;OAGG;IACH,OAAO,CAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACxF;AAED,MAAM,WAAW,qBAAqB,CAAE,cAAc,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,cAAc,CAAC,EAAE,eAAe;IACtL;;;;;OAKG;IACH,UAAU,CAAC,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7C;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,oBAAoB,CAAE,cAAc,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,cAAc,CAAC;CAErK;AAED,MAAM,WAAW,oBAAoB,CAAE,cAAc,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,cAAc,CAAC,EAAE,eAAe,EAAE,iBAAiB;IACxM;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,WAAW,CAAC,sBAAsB,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,sBAAsB,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC;IAC7L;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,qBAAqB,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEjG;;OAEG;IACH,QAAQ,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1F;;OAEG;IACH,aAAa,CAAC,CAAC,OAAO,CAAC,EAAE,oBAAoB,CAAC,sBAAsB,CAAC,GAAG,kBAAkB,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAA;CAC3I;AAED,MAAM,WAAW,kBAAkB,CAAC,sBAAsB,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,sBAAsB,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAE,SAAQ,WAAW,CAAC,sBAAsB,EAAE,sBAAsB,CAAC;IACzQ;;;OAGG;IACH,OAAO,CAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACxF;AAED,eAAO,MAAM,6BAA6B,IAAI,CAAA;AAC9C,eAAO,MAAM,6BAA6B,IAAI,CAAA;AAC9C,eAAO,MAAM,4BAA4B,MAAM,CAAA"}

package/dist/src/blocks.js.map

@@ -1 +1 @@
-{"version":3,"file":"blocks.js","sourceRoot":"","sources":["../../src/blocks.ts"],"names":[],"mappings":"AA6LA,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAA;AAC9C,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAA;AAC9C,MAAM,CAAC,MAAM,4BAA4B,GAAG,GAAG,CAAA"}
+{"version":3,"file":"blocks.js","sourceRoot":"","sources":["../../src/blocks.ts"],"names":[],"mappings":"AA6OA,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAA;AAC9C,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAA;AAC9C,MAAM,CAAC,MAAM,4BAA4B,GAAG,GAAG,CAAA"}

package/dist/src/index.d.ts

@@ -13,9 +13,9 @@
  * }
  * ```
  */
-import type { Blocks } from './blocks.js';
-import type { Pins } from './pins.js';
-import type { Routing } from './routing.js';
+import type { Blocks } from './blocks.ts';
+import type { Pins } from './pins.ts';
+import type { Routing } from './routing.ts';
 import type { AbortOptions, ComponentLogger, Libp2p, Metrics, TypedEventEmitter } from '@libp2p/interface';
 import type { DNS } from '@multiformats/dns';
 import type { Datastore } from 'interface-datastore';
@@ -122,8 +122,8 @@ export interface HeliaEvents<T extends Libp2p = Libp2p> {
      */
     stop: CustomEvent<Helia<T>>;
 }
-export * from './blocks.js';
-export * from './errors.js';
-export * from './pins.js';
-export * from './routing.js';
+export * from './blocks.ts';
+export * from './errors.ts';
+export * from './pins.ts';
+export * from './routing.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.js

@@ -13,8 +13,8 @@
  * }
  * ```
  */
-export * from './blocks.js';
-export * from './errors.js';
-export * from './pins.js';
-export * from './routing.js';
+export * from "./blocks.js";
+export * from "./errors.js";
+export * from "./pins.js";
+export * from "./routing.js";
 //# sourceMappingURL=index.js.map

package/dist/src/pins.d.ts

@@ -1,4 +1,4 @@
-import type { GetBlockProgressEvents } from './blocks.js';
+import type { GetBlockProgressEvents } from './blocks.ts';
 import type { AbortOptions } from '@libp2p/interface';
 import type { CID } from 'multiformats/cid';
 import type { ProgressEvent, ProgressOptions } from 'progress-events';

package/dist/src/routing.d.ts

@@ -1,13 +1,13 @@
 import type { AbortOptions, PeerId, PeerInfo, TraceOptions } from '@libp2p/interface';
 import type { CID } from 'multiformats/cid';
-import type { ProgressOptions } from 'progress-events';
+import type { ProgressEvent, ProgressOptions } from 'progress-events';
 /**
  * When a routing operation involves reading values, these options allow
  * controlling where the values are read from. Some implementations support a
  * local cache that may be used in preference over network calls, for example
  * when a record has a TTL.
  */
-export interface RoutingOptions extends AbortOptions, ProgressOptions, TraceOptions {
+export interface RoutingOptions<Event extends ProgressEvent = any> extends AbortOptions, ProgressOptions<Event>, TraceOptions {
     /**
      * Pass `false` to not use the network
      *
@@ -49,7 +49,98 @@ export interface Provider extends PeerInfo {
      */
     routing: string;
 }
+export interface RoutingFindProvidersStartEvent {
+    routing: string;
+    cid: CID;
+}
+export interface RoutingFindProvidersEndEvent {
+    routing: string;
+    cid: CID;
+    found: number;
+}
+export interface RoutingFindProvidersHttpGatewayProvider {
+    routing: 'http-gateway-router';
+    cid: CID;
+    provider: PeerInfo & {
+        protocols: ['transport-ipfs-gateway-http'];
+    };
+}
+export interface RoutingFindProvidersDelegatedHttpRoutingProvider {
+    routing: 'delegated-http-router';
+    cid: CID;
+    provider: PeerInfo & {
+        routing: 'delegated-http-routing';
+        protocols: string[];
+    };
+}
+export interface RoutingFindProvidersLibp2pProvider {
+    routing: 'libp2p-router';
+    cid: CID;
+    provider: PeerInfo;
+}
+export type RoutingFindProvidersProviderEvent = RoutingFindProvidersHttpGatewayProvider | RoutingFindProvidersDelegatedHttpRoutingProvider | RoutingFindProvidersLibp2pProvider;
+export type RoutingFindProvidersProgressEvents = ProgressEvent<'helia:routing:find-providers:start', RoutingFindProvidersStartEvent> | ProgressEvent<'helia:routing:find-providers:provider', RoutingFindProvidersProviderEvent> | ProgressEvent<'helia:routing:find-providers:end', RoutingFindProvidersEndEvent> | RoutingFindPeerProgressEvents;
+export interface RoutingProvideStartEvent {
+    routing: string;
+    cid: CID;
+}
+export interface RoutingProvideEndEvent {
+    routing: string;
+    cid: CID;
+}
+export type RoutingProvideProgressEvents = ProgressEvent<'helia:routing:provide:start', RoutingProvideStartEvent> | ProgressEvent<'helia:routing:provide:end', RoutingProvideEndEvent>;
+export interface RoutingCancelReprovideStartEvent {
+    routing: string;
+    cid: CID;
+}
+export interface RoutingCancelReprovideEndEvent {
+    routing: string;
+    cid: CID;
+}
+export type RoutingCancelReprovideProgressEvents = ProgressEvent<'helia:routing:cancel-reprovide:start', RoutingCancelReprovideStartEvent> | ProgressEvent<'helia:routing:cancel-reprovide:end', RoutingCancelReprovideEndEvent>;
+export interface RoutingPutStartEvent {
+    routing: string;
+    key: Uint8Array;
+    value: Uint8Array;
+}
+export interface RoutingPutEndEvent {
+    routing: string;
+    key: Uint8Array;
+    value: Uint8Array;
+}
+export type RoutingPutProgressEvents = ProgressEvent<'helia:routing:put:start', RoutingPutStartEvent> | ProgressEvent<'helia:routing:put:end', RoutingPutEndEvent>;
+export interface RoutingGetStartEvent {
+    routing: string;
+    key: Uint8Array;
+}
+export interface RoutingGetEndEvent {
+    routing: string;
+    key: Uint8Array;
+}
+export type RoutingGetProgressEvents = ProgressEvent<'helia:routing:get:start', RoutingGetStartEvent> | ProgressEvent<'helia:routing:get:end', RoutingGetEndEvent>;
+export interface RoutingFindPeerStartEvent {
+    routing: string;
+    peerId: PeerId;
+}
+export interface RoutingFindPeerEndEvent {
+    routing: string;
+    peerId: PeerId;
+}
+export type RoutingFindPeerProgressEvents = ProgressEvent<'helia:routing:find-peer:start', RoutingFindPeerStartEvent> | ProgressEvent<'helia:routing:find-peer:end', RoutingFindPeerEndEvent>;
+export interface RoutingGetClosestPeersStartEvent {
+    routing: string;
+    key: Uint8Array;
+}
+export interface RoutingGetClosestPeersEndEvent {
+    routing: string;
+    key: Uint8Array;
+}
+export type RoutingGetClosestPeersProgressEvents = ProgressEvent<'helia:routing:get-closest-peers:start', RoutingGetClosestPeersStartEvent> | ProgressEvent<'helia:routing:get-closest-peers:end', RoutingGetClosestPeersEndEvent>;
 export interface Routing {
+    /**
+     * The name of this routing implementation
+     */
+    name: string;
     /**
      * The implementation of this method should ensure that network peers know the
      * caller can provide content that corresponds to the passed CID.
@@ -61,7 +152,7 @@ export interface Routing {
      * await contentRouting.provide(cid)
      * ```
      */
-    provide(cid: CID, options?: RoutingOptions): Promise<void>;
+    provide(cid: CID, options?: RoutingOptions<RoutingProvideProgressEvents>): Promise<void>;
     /**
      * Helia will periodically re-provide every previously provided CID. Use this
      * method to no longer re-provide the passed CID.
@@ -86,7 +177,7 @@ export interface Routing {
      * }
      * ```
      */
-    findProviders(cid: CID, options?: RoutingOptions): AsyncIterable<Provider>;
+    findProviders(cid: CID, options?: RoutingOptions<RoutingFindProvidersProgressEvents>): AsyncIterable<Provider>;
     /**
      * Puts a value corresponding to the passed key in a way that can later be
      * retrieved by another network peer using the get method.
@@ -101,7 +192,7 @@ export interface Routing {
      * await contentRouting.put(key, value)
      * ```
      */
-    put(key: Uint8Array, value: Uint8Array, options?: RoutingOptions): Promise<void>;
+    put(key: Uint8Array, value: Uint8Array, options?: RoutingOptions<RoutingPutProgressEvents>): Promise<void>;
     /**
      * Retrieves a value from the network corresponding to the passed key.
      *
@@ -114,7 +205,7 @@ export interface Routing {
      * const value = await contentRouting.get(key)
      * ```
      */
-    get(key: Uint8Array, options?: RoutingOptions): Promise<Uint8Array>;
+    get(key: Uint8Array, options?: RoutingOptions<RoutingGetProgressEvents>): Promise<Uint8Array>;
     /**
      * Searches the network for peer info corresponding to the passed peer id.
      *
@@ -125,7 +216,7 @@ export interface Routing {
      * const peer = await peerRouting.findPeer(peerId, options)
      * ```
      */
-    findPeer(peerId: PeerId, options?: RoutingOptions): Promise<PeerInfo>;
+    findPeer(peerId: PeerId, options?: RoutingOptions<RoutingFindPeerProgressEvents>): Promise<PeerInfo>;
     /**
      * Search the network for peers that are closer to the passed key. Peer
      * info should be yielded in ever-increasing closeness to the key.
@@ -139,6 +230,6 @@ export interface Routing {
      * }
      * ```
      */
-    getClosestPeers(key: Uint8Array, options?: RoutingOptions): AsyncIterable<PeerInfo>;
+    getClosestPeers(key: Uint8Array, options?: RoutingOptions<RoutingGetClosestPeersProgressEvents>): AsyncIterable<PeerInfo>;
 }
 //# sourceMappingURL=routing.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../../src/routing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrF,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD;;;;;GAKG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY,EAAE,eAAe,EAAE,YAAY;IACjF;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,OAAO;IACtB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1D;;;;;;;;;;OAUG;IACH,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhE;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;IAE1E;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhF;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEnE;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAErE;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;CACpF"}
+{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../../src/routing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrF,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAAC,KAAK,SAAS,aAAa,GAAG,GAAG,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,YAAY;IAC3H;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,uCAAuC;IACtD,OAAO,EAAE,qBAAqB,CAAA;IAC9B,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,QAAQ,GAAG;QACnB,SAAS,EAAE,CAAC,6BAA6B,CAAC,CAAA;KAC3C,CAAA;CACF;AAED,MAAM,WAAW,gDAAgD;IAC/D,OAAO,EAAE,uBAAuB,CAAA;IAChC,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,QAAQ,GAAG;QACnB,OAAO,EAAE,wBAAwB,CAAA;QACjC,SAAS,EAAE,MAAM,EAAE,CAAA;KACpB,CAAA;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,MAAM,iCAAiC,GAAG,uCAAuC,GAAG,gDAAgD,GAAG,kCAAkC,CAAA;AAE/K,MAAM,MAAM,kCAAkC,GAC5C,aAAa,CAAC,oCAAoC,EAAE,8BAA8B,CAAC,GACnF,aAAa,CAAC,uCAAuC,EAAE,iCAAiC,CAAC,GACzF,aAAa,CAAC,kCAAkC,EAAE,4BAA4B,CAAC,GAC/E,6BAA6B,CAAA;AAE/B,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,MAAM,4BAA4B,GACtC,aAAa,CAAC,6BAA6B,EAAE,wBAAwB,CAAC,GACtE,aAAa,CAAC,2BAA2B,EAAE,sBAAsB,CAAC,CAAA;AAEpE,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,MAAM,oCAAoC,GAC9C,aAAa,CAAC,sCAAsC,EAAE,gCAAgC,CAAC,GACvF,aAAa,CAAC,oCAAoC,EAAE,8BAA8B,CAAC,CAAA;AAErF,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;IACf,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;IACf,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,MAAM,wBAAwB,GAClC,aAAa,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,GAC9D,aAAa,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;AAE5D,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,MAAM,wBAAwB,GAClC,aAAa,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,GAC9D,aAAa,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;AAE5D,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,6BAA6B,GACvC,aAAa,CAAC,+BAA+B,EAAE,yBAAyB,CAAC,GACzE,aAAa,CAAC,6BAA6B,EAAE,uBAAuB,CAAC,CAAA;AAEvE,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,MAAM,oCAAoC,GAC9C,aAAa,CAAC,uCAAuC,EAAE,gCAAgC,CAAC,GACxF,aAAa,CAAC,qCAAqC,EAAE,8BAA8B,CAAC,CAAA;AAEtF,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;;;;;;OAUG;IACH,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,4BAA4B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAExF;;;;;;;;;;OAUG;IACH,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhE;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,kCAAkC,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;IAE9G;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1G;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE7F;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,6BAA6B,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAEpG;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,oCAAoC,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;CAC1H"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/interface",
-  "version": "6.1.1-eaeb734d",
+  "version": "6.2.0-ef5363e8",
   "description": "The Helia API",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia/tree/main/packages/interface#readme",
@@ -45,19 +45,23 @@
   "exports": {
     ".": {
       "types": "./dist/src/index.d.ts",
-      "import": "./dist/src/index.js"
+      "import": "./dist/src/index.js",
+      "module-sync": "./dist/src/index.js"
     },
     "./blocks": {
       "types": "./dist/src/blocks.d.ts",
-      "import": "./dist/src/blocks.js"
+      "import": "./dist/src/blocks.js",
+      "module-sync": "./dist/src/blocks.js"
     },
     "./pins": {
       "types": "./dist/src/pins.d.ts",
-      "import": "./dist/src/pins.js"
+      "import": "./dist/src/pins.js",
+      "module-sync": "./dist/src/pins.js"
     },
     "./routing": {
       "types": "./dist/src/routing.d.ts",
-      "import": "./dist/src/routing.js"
+      "import": "./dist/src/routing.js",
+      "module-sync": "./dist/src/routing.js"
     }
   },
   "scripts": {
@@ -68,17 +72,17 @@
     "build": "aegir build"
   },
   "dependencies": {
-    "@libp2p/interface": "^3.1.0",
-    "@multiformats/dns": "^1.0.9",
+    "@libp2p/interface": "^3.2.0",
+    "@multiformats/dns": "^1.0.13",
     "@multiformats/multiaddr": "^13.0.1",
-    "interface-blockstore": "^6.0.1",
-    "interface-datastore": "^9.0.2",
-    "interface-store": "^7.0.0",
-    "multiformats": "^13.4.1",
-    "progress-events": "^1.0.1"
+    "interface-blockstore": "^6.0.2",
+    "interface-datastore": "^9.0.3",
+    "interface-store": "^7.0.2",
+    "multiformats": "^13.4.2",
+    "progress-events": "^1.1.0"
   },
   "devDependencies": {
-    "aegir": "^47.0.22"
+    "aegir": "^47.1.5"
   },
   "sideEffects": false
 }

package/src/blocks.ts

@@ -1,7 +1,7 @@
-import type { PeerId } from '@libp2p/interface'
+import type { RoutingFindProvidersProgressEvents } from './routing.ts'
+import type { PeerId, AbortOptions } from '@libp2p/interface'
 import type { Multiaddr } from '@multiformats/multiaddr'
 import type { Blockstore } from 'interface-blockstore'
-import type { AbortOptions } from 'interface-store'
 import type { CID } from 'multiformats/cid'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'
 
@@ -19,6 +19,52 @@ export interface ProviderOptions {
   providers?: Array<PeerId | Multiaddr | Multiaddr[]>
 }
 
+/**
+ * A block broker will contact a provider to retrieve a block
+ */
+export interface BlockBrokerConnectProgressEvent {
+  broker: string
+  type: 'connect'
+  provider: PeerId
+  cid: CID
+}
+
+/**
+ * A block broker has contacted a provider to retrieve a block
+ */
+export interface BlockBrokerConnectedProgressEvent {
+  broker: string
+  type: 'connected'
+  provider: PeerId
+  address: Multiaddr
+  cid: CID
+}
+
+/**
+ * A block broker has retrieved a block from a provider
+ */
+export interface BlockBrokerRequestBlockProgressEvent {
+  broker: string
+  type: 'request-block'
+  provider: PeerId
+  cid: CID
+}
+
+/**
+ * A block broker has retrieved a block from a provider
+ */
+export interface BlockBrokerReceiveBlockProgressEvent {
+  broker: string
+  type: 'receive-block'
+  provider: PeerId
+  cid: CID
+}
+
+export type BlockBrokerGetBlockProgressEvents = ProgressEvent<'helia:block-broker:connect', BlockBrokerConnectProgressEvent>
+  | ProgressEvent<'helia:block-broker:connected', BlockBrokerConnectedProgressEvent>
+  | ProgressEvent<'helia:block-broker:request-block', BlockBrokerRequestBlockProgressEvent>
+  | ProgressEvent<'helia:block-broker:receive-block', BlockBrokerReceiveBlockProgressEvent>
+
 export type HasBlockProgressEvents =
   ProgressEvent<'blocks:put:duplicate', CID> |
   ProgressEvent<'blocks:put:providers:notify', CID> |
@@ -37,7 +83,9 @@ export type PutManyBlocksProgressEvents =
 export type GetBlockProgressEvents =
   ProgressEvent<'blocks:get:providers:want', CID> |
   ProgressEvent<'blocks:get:blockstore:get', CID> |
-  ProgressEvent<'blocks:get:blockstore:put', CID>
+  ProgressEvent<'blocks:get:blockstore:put', CID> |
+  RoutingFindProvidersProgressEvents |
+  BlockBrokerGetBlockProgressEvents
 
 export type GetManyBlocksProgressEvents =
   ProgressEvent<'blocks:get-many:blockstore:get-many'> |

package/src/index.ts

@@ -14,9 +14,9 @@
  * ```
  */
 
-import type { Blocks } from './blocks.js'
-import type { Pins } from './pins.js'
-import type { Routing } from './routing.js'
+import type { Blocks } from './blocks.ts'
+import type { Pins } from './pins.ts'
+import type { Routing } from './routing.ts'
 import type { AbortOptions, ComponentLogger, Libp2p, Metrics, TypedEventEmitter } from '@libp2p/interface'
 import type { DNS } from '@multiformats/dns'
 import type { Datastore } from 'interface-datastore'
@@ -148,7 +148,7 @@ export interface HeliaEvents<T extends Libp2p = Libp2p> {
   stop: CustomEvent<Helia<T>>
 }
 
-export * from './blocks.js'
-export * from './errors.js'
-export * from './pins.js'
-export * from './routing.js'
+export * from './blocks.ts'
+export * from './errors.ts'
+export * from './pins.ts'
+export * from './routing.ts'

package/src/pins.ts

@@ -1,4 +1,4 @@
-import type { GetBlockProgressEvents } from './blocks.js'
+import type { GetBlockProgressEvents } from './blocks.ts'
 import type { AbortOptions } from '@libp2p/interface'
 import type { CID } from 'multiformats/cid'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'

package/src/routing.ts

@@ -1,6 +1,6 @@
 import type { AbortOptions, PeerId, PeerInfo, TraceOptions } from '@libp2p/interface'
 import type { CID } from 'multiformats/cid'
-import type { ProgressOptions } from 'progress-events'
+import type { ProgressEvent, ProgressOptions } from 'progress-events'
 
 /**
  * When a routing operation involves reading values, these options allow
@@ -8,7 +8,7 @@ import type { ProgressOptions } from 'progress-events'
  * local cache that may be used in preference over network calls, for example
  * when a record has a TTL.
  */
-export interface RoutingOptions extends AbortOptions, ProgressOptions, TraceOptions {
+export interface RoutingOptions<Event extends ProgressEvent = any> extends AbortOptions, ProgressOptions<Event>, TraceOptions {
   /**
    * Pass `false` to not use the network
    *
@@ -55,7 +55,140 @@ export interface Provider extends PeerInfo {
   routing: string
 }
 
+export interface RoutingFindProvidersStartEvent {
+  routing: string
+  cid: CID
+}
+
+export interface RoutingFindProvidersEndEvent {
+  routing: string
+  cid: CID
+  found: number
+}
+
+export interface RoutingFindProvidersHttpGatewayProvider {
+  routing: 'http-gateway-router'
+  cid: CID
+  provider: PeerInfo & {
+    protocols: ['transport-ipfs-gateway-http']
+  }
+}
+
+export interface RoutingFindProvidersDelegatedHttpRoutingProvider {
+  routing: 'delegated-http-router'
+  cid: CID
+  provider: PeerInfo & {
+    routing: 'delegated-http-routing'
+    protocols: string[]
+  }
+}
+
+export interface RoutingFindProvidersLibp2pProvider {
+  routing: 'libp2p-router'
+  cid: CID
+  provider: PeerInfo
+}
+
+export type RoutingFindProvidersProviderEvent = RoutingFindProvidersHttpGatewayProvider | RoutingFindProvidersDelegatedHttpRoutingProvider | RoutingFindProvidersLibp2pProvider
+
+export type RoutingFindProvidersProgressEvents =
+  ProgressEvent<'helia:routing:find-providers:start', RoutingFindProvidersStartEvent> |
+  ProgressEvent<'helia:routing:find-providers:provider', RoutingFindProvidersProviderEvent> |
+  ProgressEvent<'helia:routing:find-providers:end', RoutingFindProvidersEndEvent> |
+  RoutingFindPeerProgressEvents
+
+export interface RoutingProvideStartEvent {
+  routing: string
+  cid: CID
+}
+
+export interface RoutingProvideEndEvent {
+  routing: string
+  cid: CID
+}
+
+export type RoutingProvideProgressEvents =
+  ProgressEvent<'helia:routing:provide:start', RoutingProvideStartEvent> |
+  ProgressEvent<'helia:routing:provide:end', RoutingProvideEndEvent>
+
+export interface RoutingCancelReprovideStartEvent {
+  routing: string
+  cid: CID
+}
+
+export interface RoutingCancelReprovideEndEvent {
+  routing: string
+  cid: CID
+}
+
+export type RoutingCancelReprovideProgressEvents =
+  ProgressEvent<'helia:routing:cancel-reprovide:start', RoutingCancelReprovideStartEvent> |
+  ProgressEvent<'helia:routing:cancel-reprovide:end', RoutingCancelReprovideEndEvent>
+
+export interface RoutingPutStartEvent {
+  routing: string
+  key: Uint8Array
+  value: Uint8Array
+}
+
+export interface RoutingPutEndEvent {
+  routing: string
+  key: Uint8Array
+  value: Uint8Array
+}
+
+export type RoutingPutProgressEvents =
+  ProgressEvent<'helia:routing:put:start', RoutingPutStartEvent> |
+  ProgressEvent<'helia:routing:put:end', RoutingPutEndEvent>
+
+export interface RoutingGetStartEvent {
+  routing: string
+  key: Uint8Array
+}
+
+export interface RoutingGetEndEvent {
+  routing: string
+  key: Uint8Array
+}
+
+export type RoutingGetProgressEvents =
+  ProgressEvent<'helia:routing:get:start', RoutingGetStartEvent> |
+  ProgressEvent<'helia:routing:get:end', RoutingGetEndEvent>
+
+export interface RoutingFindPeerStartEvent {
+  routing: string
+  peerId: PeerId
+}
+
+export interface RoutingFindPeerEndEvent {
+  routing: string
+  peerId: PeerId
+}
+
+export type RoutingFindPeerProgressEvents =
+  ProgressEvent<'helia:routing:find-peer:start', RoutingFindPeerStartEvent> |
+  ProgressEvent<'helia:routing:find-peer:end', RoutingFindPeerEndEvent>
+
+export interface RoutingGetClosestPeersStartEvent {
+  routing: string
+  key: Uint8Array
+}
+
+export interface RoutingGetClosestPeersEndEvent {
+  routing: string
+  key: Uint8Array
+}
+
+export type RoutingGetClosestPeersProgressEvents =
+  ProgressEvent<'helia:routing:get-closest-peers:start', RoutingGetClosestPeersStartEvent> |
+  ProgressEvent<'helia:routing:get-closest-peers:end', RoutingGetClosestPeersEndEvent>
+
 export interface Routing {
+  /**
+   * The name of this routing implementation
+   */
+  name: string
+
   /**
    * The implementation of this method should ensure that network peers know the
    * caller can provide content that corresponds to the passed CID.
@@ -67,7 +200,7 @@ export interface Routing {
    * await contentRouting.provide(cid)
    * ```
    */
-  provide(cid: CID, options?: RoutingOptions): Promise<void>
+  provide(cid: CID, options?: RoutingOptions<RoutingProvideProgressEvents>): Promise<void>
 
   /**
    * Helia will periodically re-provide every previously provided CID. Use this
@@ -94,7 +227,7 @@ export interface Routing {
    * }
    * ```
    */
-  findProviders(cid: CID, options?: RoutingOptions): AsyncIterable<Provider>
+  findProviders(cid: CID, options?: RoutingOptions<RoutingFindProvidersProgressEvents>): AsyncIterable<Provider>
 
   /**
    * Puts a value corresponding to the passed key in a way that can later be
@@ -110,7 +243,7 @@ export interface Routing {
    * await contentRouting.put(key, value)
    * ```
    */
-  put(key: Uint8Array, value: Uint8Array, options?: RoutingOptions): Promise<void>
+  put(key: Uint8Array, value: Uint8Array, options?: RoutingOptions<RoutingPutProgressEvents>): Promise<void>
 
   /**
    * Retrieves a value from the network corresponding to the passed key.
@@ -124,7 +257,7 @@ export interface Routing {
    * const value = await contentRouting.get(key)
    * ```
    */
-  get(key: Uint8Array, options?: RoutingOptions): Promise<Uint8Array>
+  get(key: Uint8Array, options?: RoutingOptions<RoutingGetProgressEvents>): Promise<Uint8Array>
 
   /**
    * Searches the network for peer info corresponding to the passed peer id.
@@ -136,7 +269,7 @@ export interface Routing {
    * const peer = await peerRouting.findPeer(peerId, options)
    * ```
    */
-  findPeer(peerId: PeerId, options?: RoutingOptions): Promise<PeerInfo>
+  findPeer(peerId: PeerId, options?: RoutingOptions<RoutingFindPeerProgressEvents>): Promise<PeerInfo>
 
   /**
    * Search the network for peers that are closer to the passed key. Peer
@@ -151,5 +284,5 @@ export interface Routing {
    * }
    * ```
    */
-  getClosestPeers(key: Uint8Array, options?: RoutingOptions): AsyncIterable<PeerInfo>
+  getClosestPeers(key: Uint8Array, options?: RoutingOptions<RoutingGetClosestPeersProgressEvents>): AsyncIterable<PeerInfo>
 }