@helia/interface 6.1.1-11802dd6 → 6.1.1-1a2ebead

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.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 } 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  RoutingFindProvidersProgressEvents\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,IC+LO,IAAMC,EAAgC,EAChCC,EAAgC,EAChCC,EAA+B,ICjMtC,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 } 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\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,IC8OO,IAAMC,EAAgC,EAChCC,EAAgC,EAChCC,EAA+B,IChPtC,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

@@ -17,10 +17,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> | RoutingFindProvidersProgressEvents;
+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,kCAAkC,EAAE,MAAM,cAAc,CAAA;AACtE,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,GAC/C,kCAAkC,CAAA;AAEpC,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,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;;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":"AA+LA,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":"AA8OA,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAA;AAC9C,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAA;AAC9C,MAAM,CAAC,MAAM,4BAA4B,GAAG,GAAG,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/interface",
-  "version": "6.1.1-11802dd6",
+  "version": "6.1.1-1a2ebead",
   "description": "The Helia API",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia/tree/main/packages/interface#readme",
@@ -68,7 +68,7 @@
     "build": "aegir build"
   },
   "dependencies": {
-    "@libp2p/interface": "^3.1.0",
+    "@libp2p/interface": "^3.2.0",
     "@multiformats/dns": "^1.0.9",
     "@multiformats/multiaddr": "^13.0.1",
     "interface-blockstore": "^6.0.1",

package/src/blocks.ts

@@ -20,6 +20,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> |
@@ -39,7 +85,8 @@ export type GetBlockProgressEvents =
   ProgressEvent<'blocks:get:providers:want', CID> |
   ProgressEvent<'blocks:get:blockstore:get', CID> |
   ProgressEvent<'blocks:get:blockstore:put', CID> |
-  RoutingFindProvidersProgressEvents
+  RoutingFindProvidersProgressEvents |
+  BlockBrokerGetBlockProgressEvents
 
 export type GetManyBlocksProgressEvents =
   ProgressEvent<'blocks:get-many:blockstore:get-many'> |