@helia/interface 6.2.1-73a28eda → 6.2.1-9114743f

package/dist/index.min.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/index.ts", "../../../node_modules/@ipshipyard/crypto/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 { CryptoLoader, Keychain } from '@ipshipyard/keychain'\nimport type { ComponentLogger, Libp2p, Metrics, TypedEventEmitter } from '@libp2p/interface'\nimport type { DNS } from '@multiformats/dns'\nimport type { AbortOptions } from 'abort-error'\nimport type { Datastore } from 'interface-datastore'\nimport type { BlockCodec, MultihashHasher } from 'multiformats'\nimport type { CID } from 'multiformats/cid'\nimport type { ProgressEvent, ProgressOptions } from 'progress-events'\n\nexport interface CodecLoader {\n  <T = any, Code extends number = any>(code: Code, options?: AbortOptions): BlockCodec<Code, T> | Promise<BlockCodec<Code, T>>\n}\n\nexport interface HasherLoader {\n  (code: number, options?: AbortOptions): MultihashHasher | Promise<MultihashHasher>\n}\n\nexport type { CryptoLoader, Keychain } from '@ipshipyard/keychain'\nexport type { Crypto, PrivateKey, PublicKey } from '@ipshipyard/crypto'\nexport { isPrivateKey, isPublicKey } from '@ipshipyard/crypto'\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   * Secure storage for private keys\n   */\n  keychain: Keychain\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  /**\n   * Cryptography implementations securely sign and verify data\n   */\n  getCrypto: CryptoLoader\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", "/**\n * @packageDocumentation\n *\n * WebCrypto-based implementations of ECDSA, Ed25519, and RSA cryptography.\n */\nimport type { AbortOptions } from 'abort-error'\nimport type { CID, MultihashDigest } from 'multiformats/cid'\n\nexport { ecdsaCrypto } from './ecdsa.ts'\nexport { ed25519Crypto } from './ed25519.ts'\nexport { rsaCrypto } from './rsa.ts'\n\nexport interface PublicKey {\n  /**\n   * The type of the crypto implementation, e.g. `Ed15519`\n   */\n  readonly type: string\n\n  /**\n   * The code that is used as the `Type` field in the protobuf representation of\n   * the public/private keys\n   */\n  readonly code: number\n\n  /**\n   * Return a MultihashDigest that represents this key\n   */\n  toMultihash (): MultihashDigest\n\n  /**\n   * Return the libp2p-key CID that represents this key\n   */\n  toCID (): CID<unknown, 0x72, number, 1>\n\n  /**\n   * Return this key encoded as a protobuf PublicKey message\n   */\n  toProtobuf (): Uint8Array<ArrayBuffer>\n\n  /**\n   * Return this key as a RFC 7517 Json Web Key\n   */\n  toJWK (): JsonWebKey\n\n  /**\n   * Verify the passed message against it's signature\n   */\n  verify(message: Uint8Array, signature: Uint8Array, options?: AbortOptions): boolean | Promise<boolean>\n}\n\nexport function isPublicKey (obj?: any): obj is PublicKey {\n  if (obj == null) {\n    return false\n  }\n\n  return typeof obj.type === 'string' && typeof obj.code === 'number' && typeof obj.verify === 'function'\n}\n\nexport interface PrivateKey {\n  /**\n   * The type of the crypto implementation, e.g. `Ed15519`\n   */\n  readonly type: string\n\n  /**\n   * The code that is used as the `Type` field in the protobuf representation of\n   * the public/private keys\n   */\n  readonly code: number\n\n  /**\n   * The public key that corresponds to this private key\n   */\n  readonly publicKey: PublicKey\n\n  /**\n   * Return this key encoded as a protobuf PrivateKey message\n   */\n  toProtobuf (): Uint8Array<ArrayBuffer>\n\n  /**\n   * Return this key as a RFC 7517 Json Web Key\n   */\n  toJWK (): JsonWebKey\n\n  /**\n   * Sign the passed message and return a signature\n   */\n  sign(message: Uint8Array, options?: AbortOptions): Uint8Array<ArrayBuffer> | Promise<Uint8Array<ArrayBuffer>>\n}\n\nexport function isPrivateKey (obj?: any): obj is PrivateKey {\n  if (obj == null) {\n    return false\n  }\n\n  return typeof obj.type === 'string' && typeof obj.code === 'number' && typeof obj.sign === 'function' && isPublicKey(obj.publicKey)\n}\n\nexport interface Crypto {\n  /**\n   * The type of the crypto implementation, e.g. `Ed15519`\n   */\n  type: string\n\n  /**\n   * The code that is used as the `Type` field in the protobuf representation of\n   * the public/private keys\n   */\n  code: number\n\n  /**\n   * Create a new private key\n   */\n  generatePrivateKey(options?: AbortOptions & Record<string, any>): Promise<PrivateKey>\n\n  /**\n   * Convert the passed bytes into a public key. The bytes come from the `.Data`\n   * field of a `PublicKey` protobuf message.\n   */\n  publicKeyFromProtobuf(buf: Uint8Array, options?: AbortOptions): PublicKey | Promise<PublicKey>\n\n  /**\n   * Convert the passed bytes into a public key. The bytes come from the `.Data`\n   * field of a `PublicKey` protobuf message.\n   */\n  privateKeyFromProtobuf(buf: Uint8Array, options?: AbortOptions): PrivateKey | Promise<PrivateKey>\n}\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\nexport class UnknownCryptoError extends Error {\n  static name = 'UnknownCryptoError'\n  name = 'UnknownCryptoError'\n}\n"],
+  "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 { BlockBroker, Blocks } from './blocks.ts'\nimport type { Pins } from './pins.ts'\nimport type { Router, Routing } from './routing.ts'\nimport type { CryptoLoader, Keychain } from '@ipshipyard/keychain'\nimport type { Metrics } from '@libp2p/interface'\nimport type { DNS } from '@multiformats/dns'\nimport type { AbortOptions } from 'abort-error'\nimport type { ComponentLogger } from 'birnam'\nimport type { Datastore } from 'interface-datastore'\nimport type { TypedEventEmitter } from 'main-event'\nimport type { BlockCodec, MultihashHasher } from 'multiformats'\nimport type { CID } from 'multiformats/cid'\nimport type { ProgressEvent, ProgressOptions } from 'progress-events'\n\nexport interface CodecLoader {\n  <T = any, Code extends number = any>(code: Code, options?: AbortOptions): BlockCodec<Code, T> | Promise<BlockCodec<Code, T>>\n}\n\nexport interface HasherLoader {\n  (code: number, options?: AbortOptions): MultihashHasher | Promise<MultihashHasher>\n}\n\nexport type { CryptoLoader, Keychain } from '@ipshipyard/keychain'\nexport type { Crypto, PrivateKey, PublicKey } from '@ipshipyard/crypto'\nexport { isPrivateKey, isPublicKey } from '@ipshipyard/crypto'\n\nexport interface NodeInfo {\n  name: string\n  version: string\n}\n\nexport interface HeliaMixin<Start extends Helia = Helia, Stop = Start> {\n  start?(helia: Start): Promise<void> | void\n  stop?(helia: Stop): Promise<void> | void\n}\n\n/**\n * The API presented by a Helia node\n */\nexport interface Helia {\n  /**\n   * Runtime information about the node\n   */\n  info: NodeInfo\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<this>>\n\n  /**\n   * Secure storage for private keys\n   */\n  keychain: Keychain\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   * The current status of the Helia node\n   */\n  status: 'starting' | 'started' | 'stopping' | 'stopped'\n\n  /**\n   * Starts the Helia node\n   */\n  start(options?: AbortOptions): Promise<this>\n\n  /**\n   * Stops the Helia node\n   */\n  stop(options?: AbortOptions): Promise<this>\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  /**\n   * Cryptography implementations securely sign and verify data\n   */\n  getCrypto: CryptoLoader\n\n  /**\n   * Returns `true` if a router with the passed name has been configured\n   */\n  hasRouter (name: string): boolean\n\n  /**\n   * Add a router\n   */\n  addRouter(router: Router): void\n\n  /**\n   * Returns `true` if a block broker with the passed name has been configured\n   */\n  hasBlockBroker (name: string): boolean\n\n  /**\n   * Add a block broker\n   */\n  addBlockBroker(blockBroker: BlockBroker): void\n\n  /**\n   * Add a mixin to extend runtime functionality\n   */\n  addMixin<T extends Helia = Helia & Record<string, any>>(mixin: HeliaMixin<T>): void\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<H extends Helia = Helia> {\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<H>\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<H>\n}\n\nexport * from './blocks.ts'\nexport * from './errors.ts'\nexport * from './graph-walker.ts'\nexport * from './pins.ts'\nexport * from './routing.ts'\n", "/**\n * @packageDocumentation\n *\n * WebCrypto-based implementations of ECDSA, Ed25519, and RSA cryptography.\n */\nimport type { AbortOptions } from 'abort-error'\nimport type { CID, MultihashDigest } from 'multiformats/cid'\n\nexport { ecdsaCrypto } from './ecdsa.ts'\nexport { ed25519Crypto } from './ed25519.ts'\nexport { rsaCrypto } from './rsa.ts'\n\nexport interface PublicKey {\n  /**\n   * The type of the crypto implementation, e.g. `Ed15519`\n   */\n  readonly type: string\n\n  /**\n   * The code that is used as the `Type` field in the protobuf representation of\n   * the public/private keys\n   */\n  readonly code: number\n\n  /**\n   * Return a MultihashDigest that represents this key\n   */\n  toMultihash (): MultihashDigest\n\n  /**\n   * Return the libp2p-key CID that represents this key\n   */\n  toCID (): CID<unknown, 0x72, number, 1>\n\n  /**\n   * Return this key encoded as a protobuf PublicKey message\n   */\n  toProtobuf (): Uint8Array<ArrayBuffer>\n\n  /**\n   * Return this key as a RFC 7517 Json Web Key\n   */\n  toJWK (): JsonWebKey\n\n  /**\n   * Verify the passed message against it's signature\n   */\n  verify(message: Uint8Array, signature: Uint8Array, options?: AbortOptions): boolean | Promise<boolean>\n}\n\nexport function isPublicKey (obj?: any): obj is PublicKey {\n  if (obj == null) {\n    return false\n  }\n\n  return typeof obj.type === 'string' && typeof obj.code === 'number' && typeof obj.verify === 'function'\n}\n\nexport interface PrivateKey {\n  /**\n   * The type of the crypto implementation, e.g. `Ed15519`\n   */\n  readonly type: string\n\n  /**\n   * The code that is used as the `Type` field in the protobuf representation of\n   * the public/private keys\n   */\n  readonly code: number\n\n  /**\n   * The public key that corresponds to this private key\n   */\n  readonly publicKey: PublicKey\n\n  /**\n   * Return this key encoded as a protobuf PrivateKey message\n   */\n  toProtobuf (): Uint8Array<ArrayBuffer>\n\n  /**\n   * Return this key as a RFC 7517 Json Web Key\n   */\n  toJWK (): JsonWebKey\n\n  /**\n   * Sign the passed message and return a signature\n   */\n  sign(message: Uint8Array, options?: AbortOptions): Uint8Array<ArrayBuffer> | Promise<Uint8Array<ArrayBuffer>>\n}\n\nexport function isPrivateKey (obj?: any): obj is PrivateKey {\n  if (obj == null) {\n    return false\n  }\n\n  return typeof obj.type === 'string' && typeof obj.code === 'number' && typeof obj.sign === 'function' && isPublicKey(obj.publicKey)\n}\n\nexport interface Crypto {\n  /**\n   * The type of the crypto implementation, e.g. `Ed15519`\n   */\n  type: string\n\n  /**\n   * The code that is used as the `Type` field in the protobuf representation of\n   * the public/private keys\n   */\n  code: number\n\n  /**\n   * Create a new private key\n   */\n  generatePrivateKey(options?: AbortOptions & Record<string, any>): Promise<PrivateKey>\n\n  /**\n   * Convert the passed bytes into a public key. The bytes come from the `.Data`\n   * field of a `PublicKey` protobuf message.\n   */\n  publicKeyFromProtobuf(buf: Uint8Array, options?: AbortOptions): PublicKey | Promise<PublicKey>\n\n  /**\n   * Convert the passed bytes into a public key. The bytes come from the `.Data`\n   * field of a `PublicKey` protobuf message.\n   */\n  privateKeyFromProtobuf(buf: Uint8Array, options?: AbortOptions): PrivateKey | Promise<PrivateKey>\n}\n", "import type { RoutingFindProvidersProgressEvents } from './routing.ts'\nimport type { Multiaddr } from '@multiformats/multiaddr'\nimport type { AbortOptions } from 'abort-error'\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<CID | 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: CID\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: CID\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: CID\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: CID\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: CID | 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: CID | 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\nexport class UnknownCryptoError extends Error {\n  static name = 'UnknownCryptoError'\n  name = 'UnknownCryptoError'\n}\n"],
   "mappings": ";kcAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,kCAAAE,EAAA,kCAAAC,EAAA,kCAAAC,EAAA,+BAAAC,EAAA,sBAAAC,EAAA,4BAAAC,EAAA,sBAAAC,EAAA,uBAAAC,EAAA,8BAAAC,EAAA,iBAAAC,EAAA,gBAAAC,ICkDM,SAAUC,EAAaC,EAAS,CACpC,OAAIA,GAAO,KACF,GAGF,OAAOA,EAAI,MAAS,UAAY,OAAOA,EAAI,MAAS,UAAY,OAAOA,EAAI,QAAW,UAC/F,CAmCM,SAAUC,EAAcD,EAAS,CACrC,OAAIA,GAAO,KACF,GAGF,OAAOA,EAAI,MAAS,UAAY,OAAOA,EAAI,MAAS,UAAY,OAAOA,EAAI,MAAS,YAAcD,EAAYC,EAAI,SAAS,CACpI,CC4IO,IAAME,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,GAGWK,EAAP,cAAkC,KAAK,CAC3C,OAAO,KAAO,qBACd,KAAO",
   "names": ["index_exports", "__export", "DEFAULT_CID_PEER_FILTER_SIZE", "DEFAULT_SESSION_MAX_PROVIDERS", "DEFAULT_SESSION_MIN_PROVIDERS", "InsufficientProvidersError", "InvalidCodecError", "NoRoutersAvailableError", "UnknownCodecError", "UnknownCryptoError", "UnknownHashAlgorithmError", "isPrivateKey", "isPublicKey", "isPublicKey", "obj", "isPrivateKey", "DEFAULT_SESSION_MIN_PROVIDERS", "DEFAULT_SESSION_MAX_PROVIDERS", "DEFAULT_CID_PEER_FILTER_SIZE", "InsufficientProvidersError", "message", "NoRoutersAvailableError", "UnknownHashAlgorithmError", "UnknownCodecError", "InvalidCodecError", "UnknownCryptoError"]
 }

package/dist/src/blocks.d.ts

@@ -1,6 +1,6 @@
 import type { RoutingFindProvidersProgressEvents } from './routing.ts';
-import type { PeerId, AbortOptions } from '@libp2p/interface';
 import type { Multiaddr } from '@multiformats/multiaddr';
+import type { AbortOptions } from 'abort-error';
 import type { Blockstore } from 'interface-blockstore';
 import type { CID } from 'multiformats/cid';
 import type { ProgressEvent, ProgressOptions } from 'progress-events';
@@ -14,7 +14,7 @@ export interface ProviderOptions {
      * child blocks, a `findProviders` routing query will be run to find peers
      * that can supply the blocks.
      */
-    providers?: Array<PeerId | Multiaddr | Multiaddr[]>;
+    providers?: Array<CID | Multiaddr | Multiaddr[]>;
 }
 /**
  * A block broker will contact a provider to retrieve a block
@@ -22,7 +22,7 @@ export interface ProviderOptions {
 export interface BlockBrokerConnectProgressEvent {
     broker: string;
     type: 'connect';
-    provider: PeerId;
+    provider: CID;
     cid: CID;
 }
 /**
@@ -31,7 +31,7 @@ export interface BlockBrokerConnectProgressEvent {
 export interface BlockBrokerConnectedProgressEvent {
     broker: string;
     type: 'connected';
-    provider: PeerId;
+    provider: CID;
     address: Multiaddr;
     cid: CID;
 }
@@ -41,7 +41,7 @@ export interface BlockBrokerConnectedProgressEvent {
 export interface BlockBrokerRequestBlockProgressEvent {
     broker: string;
     type: 'request-block';
-    provider: PeerId;
+    provider: CID;
     cid: CID;
 }
 /**
@@ -50,7 +50,7 @@ export interface BlockBrokerRequestBlockProgressEvent {
 export interface BlockBrokerReceiveBlockProgressEvent {
     broker: string;
     type: 'receive-block';
-    provider: PeerId;
+    provider: CID;
     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>;
@@ -98,7 +98,7 @@ export interface SessionBlockstore extends Blockstore<ProgressOptions<HasBlockPr
      * Adds a new peer to the session if they are supported and are either
      * not already in the session and have not been evicted previously.
      */
-    addPeer(peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>;
+    addPeer(peer: CID | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>;
 }
 export interface BlockRetrievalOptions<ProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> extends AbortOptions, ProgressOptions<ProgressEvents>, ProviderOptions {
     /**
@@ -168,7 +168,7 @@ export interface SessionBlockBroker<RetrieveProgressEvents extends ProgressEvent
      * Adds a new peer to the session if they are supported and are either
      * not already in the session and have not been evicted previously.
      */
-    addPeer(peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>;
+    addPeer(peer: CID | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>;
 }
 export declare const DEFAULT_SESSION_MIN_PROVIDERS = 1;
 export declare const DEFAULT_SESSION_MAX_PROVIDERS = 5;

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,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"}
+{"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,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;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,GAAG,GAAG,SAAS,GAAG,SAAS,EAAE,CAAC,CAAA;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,SAAS,CAAA;IACf,QAAQ,EAAE,GAAG,CAAA;IACb,GAAG,EAAE,GAAG,CAAA;CACT;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,WAAW,CAAA;IACjB,QAAQ,EAAE,GAAG,CAAA;IACb,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,GAAG,CAAA;IACb,GAAG,EAAE,GAAG,CAAA;CACT;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,eAAe,CAAA;IACrB,QAAQ,EAAE,GAAG,CAAA;IACb,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,GAAG,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACrF;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,GAAG,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACrF;AAED,eAAO,MAAM,6BAA6B,IAAI,CAAA;AAC9C,eAAO,MAAM,6BAA6B,IAAI,CAAA;AAC9C,eAAO,MAAM,4BAA4B,MAAM,CAAA"}

package/dist/src/graph-walker.d.ts

@@ -0,0 +1,28 @@
+import type { CodecLoader } from './index.js';
+import type { AbortOptions } from '@libp2p/interface';
+import type { Blockstore } from 'interface-blockstore';
+import type { BlockView, CID, Version } from 'multiformats';
+export interface GraphWalkerComponents {
+    blockstore: Blockstore;
+    getCodec: CodecLoader;
+}
+export interface GraphWalkerInit {
+}
+export interface GraphNode<T = unknown, C extends number = number, A extends number = number, V extends Version = 0 | 1> {
+    block: BlockView<T, C, A, V>;
+    depth: number;
+    path: CID[];
+}
+export interface WalkOptions<T> extends AbortOptions {
+    /**
+     * Stop traversal once `node.depth` reaches this value. The root is
+     * depth 0. Default: Infinity (walk the entire DAG).
+     */
+    depth?: number;
+    includeChild?(child: CID, parent: BlockView<T, number, number, 0 | 1>): boolean;
+}
+export interface GraphWalker {
+    walk<T = any>(cid: CID, options?: WalkOptions<T>): AsyncGenerator<GraphNode<T>>;
+}
+export type GraphWalkerFactory = (components: GraphWalkerComponents) => GraphWalker;
+//# sourceMappingURL=graph-walker.d.ts.map

package/dist/src/graph-walker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"graph-walker.d.ts","sourceRoot":"","sources":["../../src/graph-walker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3D,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,WAAW,CAAA;CACtB;AAED,MAAM,WAAW,eAAe;CAAG;AAEnC,MAAM,WAAW,SAAS,CACxB,CAAC,GAAG,OAAO,EACX,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,CAAC,SAAS,OAAO,GAAG,CAAC,GAAG,CAAC;IAEzB,KAAK,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,YAAY;IAClD;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,YAAY,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAA;CAChF;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;CAChF;AAED,MAAM,MAAM,kBAAkB,GAAG,CAAC,UAAU,EAAE,qBAAqB,KAAK,WAAW,CAAA"}

package/dist/src/graph-walker.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=graph-walker.js.map

package/dist/src/graph-walker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"graph-walker.js","sourceRoot":"","sources":["../../src/graph-walker.ts"],"names":[],"mappings":""}

package/dist/src/index.d.ts

@@ -13,14 +13,16 @@
  * }
  * ```
  */
-import type { Blocks } from './blocks.ts';
+import type { BlockBroker, Blocks } from './blocks.ts';
 import type { Pins } from './pins.ts';
-import type { Routing } from './routing.ts';
+import type { Router, Routing } from './routing.ts';
 import type { CryptoLoader, Keychain } from '@ipshipyard/keychain';
-import type { ComponentLogger, Libp2p, Metrics, TypedEventEmitter } from '@libp2p/interface';
+import type { Metrics } from '@libp2p/interface';
 import type { DNS } from '@multiformats/dns';
 import type { AbortOptions } from 'abort-error';
+import type { ComponentLogger } from 'birnam';
 import type { Datastore } from 'interface-datastore';
+import type { TypedEventEmitter } from 'main-event';
 import type { BlockCodec, MultihashHasher } from 'multiformats';
 import type { CID } from 'multiformats/cid';
 import type { ProgressEvent, ProgressOptions } from 'progress-events';
@@ -33,14 +35,22 @@ export interface HasherLoader {
 export type { CryptoLoader, Keychain } from '@ipshipyard/keychain';
 export type { Crypto, PrivateKey, PublicKey } from '@ipshipyard/crypto';
 export { isPrivateKey, isPublicKey } from '@ipshipyard/crypto';
+export interface NodeInfo {
+    name: string;
+    version: string;
+}
+export interface HeliaMixin<Start extends Helia = Helia, Stop = Start> {
+    start?(helia: Start): Promise<void> | void;
+    stop?(helia: Stop): Promise<void> | void;
+}
 /**
  * The API presented by a Helia node
  */
-export interface Helia<T extends Libp2p = Libp2p> {
+export interface Helia {
     /**
-     * The libp2p instance
+     * Runtime information about the node
      */
-    libp2p: T;
+    info: NodeInfo;
     /**
      * Where the blocks are stored
      */
@@ -52,7 +62,7 @@ export interface Helia<T extends Libp2p = Libp2p> {
     /**
      * Event emitter for Helia start and stop events
      */
-    events: TypedEventEmitter<HeliaEvents<T>>;
+    events: TypedEventEmitter<HeliaEvents<this>>;
     /**
      * Secure storage for private keys
      */
@@ -80,14 +90,18 @@ export interface Helia<T extends Libp2p = Libp2p> {
      * usage.
      */
     metrics?: Metrics;
+    /**
+     * The current status of the Helia node
+     */
+    status: 'starting' | 'started' | 'stopping' | 'stopped';
     /**
      * Starts the Helia node
      */
-    start(): Promise<void>;
+    start(options?: AbortOptions): Promise<this>;
     /**
      * Stops the Helia node
      */
-    stop(): Promise<void>;
+    stop(options?: AbortOptions): Promise<this>;
     /**
      * Remove any unpinned blocks from the blockstore
      */
@@ -107,11 +121,31 @@ export interface Helia<T extends Libp2p = Libp2p> {
      * Cryptography implementations securely sign and verify data
      */
     getCrypto: CryptoLoader;
+    /**
+     * Returns `true` if a router with the passed name has been configured
+     */
+    hasRouter(name: string): boolean;
+    /**
+     * Add a router
+     */
+    addRouter(router: Router): void;
+    /**
+     * Returns `true` if a block broker with the passed name has been configured
+     */
+    hasBlockBroker(name: string): boolean;
+    /**
+     * Add a block broker
+     */
+    addBlockBroker(blockBroker: BlockBroker): void;
+    /**
+     * Add a mixin to extend runtime functionality
+     */
+    addMixin<T extends Helia = Helia & Record<string, any>>(mixin: HeliaMixin<T>): void;
 }
 export type GcEvents = ProgressEvent<'helia:gc:deleted', CID> | ProgressEvent<'helia:gc:error', Error>;
 export interface GCOptions extends AbortOptions, ProgressOptions<GcEvents> {
 }
-export interface HeliaEvents<T extends Libp2p = Libp2p> {
+export interface HeliaEvents<H extends Helia = Helia> {
     /**
      * This event notifies listeners that the node has started
      *
@@ -121,7 +155,7 @@ export interface HeliaEvents<T extends Libp2p = Libp2p> {
      * })
      * ```
      */
-    start: CustomEvent<Helia<T>>;
+    start: CustomEvent<H>;
     /**
      * This event notifies listeners that the node has stopped
      *
@@ -131,10 +165,11 @@ export interface HeliaEvents<T extends Libp2p = Libp2p> {
      * })
      * ```
      */
-    stop: CustomEvent<Helia<T>>;
+    stop: CustomEvent<H>;
 }
 export * from './blocks.ts';
 export * from './errors.ts';
+export * from './graph-walker.ts';
 export * from './pins.ts';
 export * from './routing.ts';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAC5F,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC/D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,WAAW,WAAW;IAC1B,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,SAAS,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;CAC7H;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;CACnF;AAED,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAClE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AACvE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAE9D;;GAEG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC9C;;OAEG;IACH,MAAM,EAAE,CAAC,CAAA;IAET;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;IAEzC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAA;IAElB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;IAEV;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;IAEvB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;;OAGG;IACH,GAAG,EAAE,GAAG,CAAA;IAER;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtB;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAErB;;OAEG;IACH,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtC;;;OAGG;IACH,QAAQ,EAAE,WAAW,CAAA;IAErB;;;;OAIG;IACH,SAAS,EAAE,YAAY,CAAA;IAEvB;;OAEG;IACH,SAAS,EAAE,YAAY,CAAA;CACxB;AAED,MAAM,MAAM,QAAQ,GAClB,aAAa,CAAC,kBAAkB,EAAE,GAAG,CAAC,GACtC,aAAa,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAA;AAExC,MAAM,WAAW,SAAU,SAAQ,YAAY,EAAE,eAAe,CAAC,QAAQ,CAAC;CAEzE;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IACpD;;;;;;;;OAQG;IACH,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAE5B;;;;;;;;OAQG;IACH,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5B;AAED,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC/D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,WAAW,WAAW;IAC1B,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,SAAS,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;CAC7H;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;CACnF;AAED,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAClE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AACvE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAE9D,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,UAAU,CAAC,KAAK,SAAS,KAAK,GAAG,KAAK,EAAE,IAAI,GAAG,KAAK;IACnE,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAC1C,IAAI,CAAC,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAA;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAA;IAE5C;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAA;IAElB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;IAEV;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;IAEvB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;;OAGG;IACH,GAAG,EAAE,GAAG,CAAA;IAER;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,MAAM,EAAE,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAA;IAEvD;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5C;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3C;;OAEG;IACH,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtC;;;OAGG;IACH,QAAQ,EAAE,WAAW,CAAA;IAErB;;;;OAIG;IACH,SAAS,EAAE,YAAY,CAAA;IAEvB;;OAEG;IACH,SAAS,EAAE,YAAY,CAAA;IAEvB;;OAEG;IACH,SAAS,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IAEjC;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAE/B;;OAEG;IACH,cAAc,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IAEtC;;OAEG;IACH,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAA;IAE9C;;OAEG;IACH,QAAQ,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;CACpF;AAED,MAAM,MAAM,QAAQ,GAClB,aAAa,CAAC,kBAAkB,EAAE,GAAG,CAAC,GACtC,aAAa,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAA;AAExC,MAAM,WAAW,SAAU,SAAQ,YAAY,EAAE,eAAe,CAAC,QAAQ,CAAC;CAEzE;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK;IAClD;;;;;;;;OAQG;IACH,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;IAErB;;;;;;;;OAQG;IACH,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;CACrB;AAED,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,mBAAmB,CAAA;AACjC,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}

package/dist/src/index.js

@@ -16,6 +16,7 @@
 export { isPrivateKey, isPublicKey } from '@ipshipyard/crypto';
 export * from "./blocks.js";
 export * from "./errors.js";
+export * from "./graph-walker.js";
 export * from "./pins.js";
 export * from "./routing.js";
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAwBH,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AA6H9D,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AA0BH,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAqK9D,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,mBAAmB,CAAA;AACjC,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}

package/dist/src/pins.d.ts

@@ -1,5 +1,6 @@
 import type { GetBlockProgressEvents } from './blocks.ts';
-import type { AbortOptions } from '@libp2p/interface';
+import type { GraphWalkerFactory } from './graph-walker.ts';
+import type { AbortOptions } from 'abort-error';
 import type { CID } from 'multiformats/cid';
 import type { ProgressEvent, ProgressOptions } from 'progress-events';
 export type PinType = 'recursive' | 'direct' | 'indirect';
@@ -14,12 +15,20 @@ export interface AddOptions extends AbortOptions, ProgressOptions<AddPinEvents |
      * How deeply to pin the DAG, defaults to Infinity
      */
     depth?: number;
+    /**
+     * Walker factory used to traverse the DAG. Default: `depthFirstWalker()`.
+     */
+    walker?: GraphWalkerFactory;
     /**
      * Optional user-defined metadata to store with the pin
      */
     metadata?: Record<string, string | number | boolean>;
 }
 export interface RmOptions extends AbortOptions {
+    /**
+     * Walker factory used to traverse the DAG. Default: `depthFirstWalker()`.
+     */
+    walker?: GraphWalkerFactory;
 }
 export interface LsOptions extends AbortOptions {
     cid?: CID;

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

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

package/dist/src/routing.d.ts

@@ -1,4 +1,5 @@
-import type { AbortOptions, PeerId, PeerInfo, TraceOptions } from '@libp2p/interface';
+import type { Multiaddr } from '@multiformats/multiaddr';
+import type { AbortOptions } from 'abort-error';
 import type { CID } from 'multiformats/cid';
 import type { ProgressEvent, ProgressOptions } from 'progress-events';
 /**
@@ -7,7 +8,7 @@ import type { ProgressEvent, 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<Event extends ProgressEvent = any> extends AbortOptions, ProgressOptions<Event>, TraceOptions {
+export interface RoutingOptions<Event extends ProgressEvent = any> extends AbortOptions, ProgressOptions<Event> {
     /**
      * Pass `false` to not use the network
      *
@@ -26,11 +27,36 @@ export interface RoutingOptions<Event extends ProgressEvent = any> extends Abort
      * @default true
      */
     validate?: boolean;
+    /**
+     * Where tracing is used, this value carries tracing context
+     */
+    trace?: any;
+}
+/**
+ * A Peer is another node on the network
+ */
+export interface Peer {
+    /**
+     * The identifier of the remote peer
+     */
+    id: CID;
+    /**
+     * The multiaddrs a peer is listening on
+     */
+    multiaddrs: Multiaddr[];
 }
 /**
  * A provider can supply the content for a CID
  */
-export interface Provider extends PeerInfo {
+export interface Provider {
+    /**
+     * The identifier of the remote peer, a CID
+     */
+    id: CID;
+    /**
+     * The multiaddrs a peer is listening on
+     */
+    multiaddrs: Multiaddr[];
     /**
      * If present these are the methods that the peer can supply the content via.
      *
@@ -61,14 +87,14 @@ export interface RoutingFindProvidersEndEvent {
 export interface RoutingFindProvidersHttpGatewayProvider {
     routing: 'http-gateway-router';
     cid: CID;
-    provider: PeerInfo & {
+    provider: Peer & {
         protocols: ['transport-ipfs-gateway-http'];
     };
 }
 export interface RoutingFindProvidersDelegatedHttpRoutingProvider {
     routing: 'delegated-http-router';
     cid: CID;
-    provider: PeerInfo & {
+    provider: Peer & {
         routing: 'delegated-http-routing';
         protocols: string[];
     };
@@ -76,7 +102,7 @@ export interface RoutingFindProvidersDelegatedHttpRoutingProvider {
 export interface RoutingFindProvidersLibp2pProvider {
     routing: 'libp2p-router';
     cid: CID;
-    provider: PeerInfo;
+    provider: Peer;
 }
 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;
@@ -120,11 +146,11 @@ export interface RoutingGetEndEvent {
 export type RoutingGetProgressEvents = ProgressEvent<'helia:routing:get:start', RoutingGetStartEvent> | ProgressEvent<'helia:routing:get:end', RoutingGetEndEvent>;
 export interface RoutingFindPeerStartEvent {
     routing: string;
-    peerId: PeerId;
+    peerId: CID;
 }
 export interface RoutingFindPeerEndEvent {
     routing: string;
-    peerId: PeerId;
+    peerId: CID;
 }
 export type RoutingFindPeerProgressEvents = ProgressEvent<'helia:routing:find-peer:start', RoutingFindPeerStartEvent> | ProgressEvent<'helia:routing:find-peer:end', RoutingFindPeerEndEvent>;
 export interface RoutingGetClosestPeersStartEvent {
@@ -136,7 +162,7 @@ export interface RoutingGetClosestPeersEndEvent {
     key: Uint8Array;
 }
 export type RoutingGetClosestPeersProgressEvents = ProgressEvent<'helia:routing:get-closest-peers:start', RoutingGetClosestPeersStartEvent> | ProgressEvent<'helia:routing:get-closest-peers:end', RoutingGetClosestPeersEndEvent>;
-export interface Routing {
+export interface Router {
     /**
      * The name of this routing implementation
      */
@@ -149,10 +175,12 @@ export interface Routing {
      *
      * ```js
      * // ...
-     * await contentRouting.provide(cid)
+     * await contentRouting.provide(cid, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })
      * ```
      */
-    provide(cid: CID, options?: RoutingOptions<RoutingProvideProgressEvents>): 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.
@@ -161,10 +189,12 @@ export interface Routing {
      *
      * ```js
      * // ...
-     * await contentRouting.cancelReprovide(cid)
+     * await contentRouting.cancelReprovide(cid, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })
      * ```
      */
-    cancelReprovide(key: CID, options?: AbortOptions): Promise<void>;
+    cancelReprovide?(key: CID, options?: AbortOptions): Promise<void>;
     /**
      * Find the providers of the passed CID.
      *
@@ -172,12 +202,14 @@ export interface Routing {
      *
      * ```js
      * // Iterate over the providers found for the given cid
-     * for await (const provider of contentRouting.findProviders(cid)) {
+     * for await (const provider of contentRouting.findProviders(cid, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })) {
      *  console.log(provider.id, provider.multiaddrs)
      * }
      * ```
      */
-    findProviders(cid: CID, options?: RoutingOptions<RoutingFindProvidersProgressEvents>): 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.
@@ -186,13 +218,15 @@ export interface Routing {
      *
      * ```js
      * // ...
-     * const key = '/key'
+     * const key = uint8ArrayFromString('/key')
      * const value = uint8ArrayFromString('oh hello there')
      *
-     * await contentRouting.put(key, value)
+     * await contentRouting.put(key, value, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })
      * ```
      */
-    put(key: Uint8Array, value: Uint8Array, options?: RoutingOptions<RoutingPutProgressEvents>): Promise<void>;
+    put?(key: Uint8Array, value: Uint8Array, options?: RoutingOptions<RoutingPutProgressEvents>): Promise<void>;
     /**
      * Retrieves a value from the network corresponding to the passed key.
      *
@@ -201,11 +235,13 @@ export interface Routing {
      * ```js
      * // ...
      *
-     * const key = '/key'
-     * const value = await contentRouting.get(key)
+     * const key = uint8ArrayFromString('/key')
+     * const value = await contentRouting.get(key, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })
      * ```
      */
-    get(key: Uint8Array, options?: RoutingOptions<RoutingGetProgressEvents>): Promise<Uint8Array>;
+    get?(key: Uint8Array, options?: RoutingOptions<RoutingGetProgressEvents>): Promise<Uint8Array>;
     /**
      * Searches the network for peer info corresponding to the passed peer id.
      *
@@ -213,10 +249,12 @@ export interface Routing {
      *
      * ```js
      * // ...
-     * const peer = await peerRouting.findPeer(peerId, options)
+     * const peer = await peerRouting.findPeer(peerId, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })
      * ```
      */
-    findPeer(peerId: PeerId, options?: RoutingOptions<RoutingFindPeerProgressEvents>): Promise<PeerInfo>;
+    findPeer?(peer: CID, options?: RoutingOptions<RoutingFindPeerProgressEvents>): Promise<Peer>;
     /**
      * Search the network for peers that are closer to the passed key. Peer
      * info should be yielded in ever-increasing closeness to the key.
@@ -225,11 +263,14 @@ export interface Routing {
      *
      * ```js
      * // Iterate over the closest peers found for the given key
-     * for await (const peer of peerRouting.getClosestPeers(key)) {
+     * for await (const peer of peerRouting.getClosestPeers(key, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })) {
      *   console.log(peer.id, peer.multiaddrs)
      * }
      * ```
      */
-    getClosestPeers(key: Uint8Array, options?: RoutingOptions<RoutingGetClosestPeersProgressEvents>): AsyncIterable<PeerInfo>;
+    getClosestPeers?(key: Uint8Array, options?: RoutingOptions<RoutingGetClosestPeersProgressEvents>): AsyncIterable<Peer>;
 }
+export type Routing = Required<Omit<Router, 'name'>>;
 //# 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,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"}
+{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../../src/routing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,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;IAC7G;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,GAAG,CAAA;IAEP;;OAEG;IACH,UAAU,EAAE,SAAS,EAAE,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,GAAG,CAAA;IAEP;;OAEG;IACH,UAAU,EAAE,SAAS,EAAE,CAAA;IAEvB;;;;;;;;;;;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,IAAI,GAAG;QACf,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,IAAI,GAAG;QACf,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,IAAI,CAAA;CACf;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,GAAG,CAAA;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,GAAG,CAAA;CACZ;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,MAAM;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,4BAA4B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzF;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjE;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,kCAAkC,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;IAE/G;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3G;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE9F;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,6BAA6B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5F;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,oCAAoC,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,CAAA;CACvH;AAED,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/interface",
-  "version": "6.2.1-73a28eda",
+  "version": "6.2.1-9114743f",
   "description": "The Helia API",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia/tree/main/packages/interface#readme",
@@ -74,17 +74,19 @@
   "dependencies": {
     "@ipshipyard/crypto": "^1.1.0",
     "@ipshipyard/keychain": "^1.0.2",
-    "@libp2p/interface": "^3.2.0",
+    "@libp2p/interface": "^3.2.3",
     "@multiformats/dns": "^1.0.13",
-    "@multiformats/multiaddr": "^13.0.1",
+    "@multiformats/multiaddr": "^13.0.3",
     "abort-error": "^1.0.2",
+    "birnam": "^1.0.0",
     "interface-blockstore": "^7.0.1",
     "interface-datastore": "^10.0.1",
+    "main-event": "^1.0.4",
     "multiformats": "^14.0.0",
     "progress-events": "^1.1.0"
   },
   "devDependencies": {
-    "aegir": "^48.0.4"
+    "aegir": "^48.0.11"
   },
   "sideEffects": false
 }

package/src/blocks.ts

@@ -1,6 +1,6 @@
 import type { RoutingFindProvidersProgressEvents } from './routing.ts'
-import type { PeerId, AbortOptions } from '@libp2p/interface'
 import type { Multiaddr } from '@multiformats/multiaddr'
+import type { AbortOptions } from 'abort-error'
 import type { Blockstore } from 'interface-blockstore'
 import type { CID } from 'multiformats/cid'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'
@@ -16,7 +16,7 @@ export interface ProviderOptions {
    * child blocks, a `findProviders` routing query will be run to find peers
    * that can supply the blocks.
    */
-  providers?: Array<PeerId | Multiaddr | Multiaddr[]>
+  providers?: Array<CID | Multiaddr | Multiaddr[]>
 }
 
 /**
@@ -25,7 +25,7 @@ export interface ProviderOptions {
 export interface BlockBrokerConnectProgressEvent {
   broker: string
   type: 'connect'
-  provider: PeerId
+  provider: CID
   cid: CID
 }
 
@@ -35,7 +35,7 @@ export interface BlockBrokerConnectProgressEvent {
 export interface BlockBrokerConnectedProgressEvent {
   broker: string
   type: 'connected'
-  provider: PeerId
+  provider: CID
   address: Multiaddr
   cid: CID
 }
@@ -46,7 +46,7 @@ export interface BlockBrokerConnectedProgressEvent {
 export interface BlockBrokerRequestBlockProgressEvent {
   broker: string
   type: 'request-block'
-  provider: PeerId
+  provider: CID
   cid: CID
 }
 
@@ -56,7 +56,7 @@ export interface BlockBrokerRequestBlockProgressEvent {
 export interface BlockBrokerReceiveBlockProgressEvent {
   broker: string
   type: 'receive-block'
-  provider: PeerId
+  provider: CID
   cid: CID
 }
 
@@ -150,7 +150,7 @@ ProgressOptions<DeleteBlockProgressEvents>, ProgressOptions<DeleteManyBlocksProg
    * Adds a new peer to the session if they are supported and are either
    * not already in the session and have not been evicted previously.
    */
-  addPeer (peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>
+  addPeer (peer: CID | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>
 }
 
 export interface BlockRetrievalOptions <ProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> extends AbortOptions, ProgressOptions<ProgressEvents>, ProviderOptions {
@@ -232,7 +232,7 @@ export interface SessionBlockBroker<RetrieveProgressEvents extends ProgressEvent
    * Adds a new peer to the session if they are supported and are either
    * not already in the session and have not been evicted previously.
    */
-  addPeer (peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>
+  addPeer (peer: CID | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>
 }
 
 export const DEFAULT_SESSION_MIN_PROVIDERS = 1

package/src/graph-walker.ts

@@ -0,0 +1,38 @@
+import type { CodecLoader } from './index.js'
+import type { AbortOptions } from '@libp2p/interface'
+import type { Blockstore } from 'interface-blockstore'
+import type { BlockView, CID, Version } from 'multiformats'
+
+export interface GraphWalkerComponents {
+  blockstore: Blockstore
+  getCodec: CodecLoader
+}
+
+export interface GraphWalkerInit {}
+
+export interface GraphNode<
+  T = unknown,
+  C extends number = number,
+  A extends number = number,
+  V extends Version = 0 | 1
+> {
+  block: BlockView<T, C, A, V>
+  depth: number
+  path: CID[]
+}
+
+export interface WalkOptions<T> extends AbortOptions {
+  /**
+   * Stop traversal once `node.depth` reaches this value. The root is
+   * depth 0. Default: Infinity (walk the entire DAG).
+   */
+  depth?: number
+
+  includeChild?(child: CID, parent: BlockView<T, number, number, 0 | 1>): boolean
+}
+
+export interface GraphWalker {
+  walk<T = any>(cid: CID, options?: WalkOptions<T>): AsyncGenerator<GraphNode<T>>
+}
+
+export type GraphWalkerFactory = (components: GraphWalkerComponents) => GraphWalker

package/src/index.ts

@@ -14,14 +14,16 @@
  * ```
  */
 
-import type { Blocks } from './blocks.ts'
+import type { BlockBroker, Blocks } from './blocks.ts'
 import type { Pins } from './pins.ts'
-import type { Routing } from './routing.ts'
+import type { Router, Routing } from './routing.ts'
 import type { CryptoLoader, Keychain } from '@ipshipyard/keychain'
-import type { ComponentLogger, Libp2p, Metrics, TypedEventEmitter } from '@libp2p/interface'
+import type { Metrics } from '@libp2p/interface'
 import type { DNS } from '@multiformats/dns'
 import type { AbortOptions } from 'abort-error'
+import type { ComponentLogger } from 'birnam'
 import type { Datastore } from 'interface-datastore'
+import type { TypedEventEmitter } from 'main-event'
 import type { BlockCodec, MultihashHasher } from 'multiformats'
 import type { CID } from 'multiformats/cid'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'
@@ -38,14 +40,24 @@ export type { CryptoLoader, Keychain } from '@ipshipyard/keychain'
 export type { Crypto, PrivateKey, PublicKey } from '@ipshipyard/crypto'
 export { isPrivateKey, isPublicKey } from '@ipshipyard/crypto'
 
+export interface NodeInfo {
+  name: string
+  version: string
+}
+
+export interface HeliaMixin<Start extends Helia = Helia, Stop = Start> {
+  start?(helia: Start): Promise<void> | void
+  stop?(helia: Stop): Promise<void> | void
+}
+
 /**
  * The API presented by a Helia node
  */
-export interface Helia<T extends Libp2p = Libp2p> {
+export interface Helia {
   /**
-   * The libp2p instance
+   * Runtime information about the node
    */
-  libp2p: T
+  info: NodeInfo
 
   /**
    * Where the blocks are stored
@@ -60,7 +72,7 @@ export interface Helia<T extends Libp2p = Libp2p> {
   /**
    * Event emitter for Helia start and stop events
    */
-  events: TypedEventEmitter<HeliaEvents<T>>
+  events: TypedEventEmitter<HeliaEvents<this>>
 
   /**
    * Secure storage for private keys
@@ -95,15 +107,20 @@ export interface Helia<T extends Libp2p = Libp2p> {
    */
   metrics?: Metrics
 
+  /**
+   * The current status of the Helia node
+   */
+  status: 'starting' | 'started' | 'stopping' | 'stopped'
+
   /**
    * Starts the Helia node
    */
-  start(): Promise<void>
+  start(options?: AbortOptions): Promise<this>
 
   /**
    * Stops the Helia node
    */
-  stop(): Promise<void>
+  stop(options?: AbortOptions): Promise<this>
 
   /**
    * Remove any unpinned blocks from the blockstore
@@ -127,6 +144,31 @@ export interface Helia<T extends Libp2p = Libp2p> {
    * Cryptography implementations securely sign and verify data
    */
   getCrypto: CryptoLoader
+
+  /**
+   * Returns `true` if a router with the passed name has been configured
+   */
+  hasRouter (name: string): boolean
+
+  /**
+   * Add a router
+   */
+  addRouter(router: Router): void
+
+  /**
+   * Returns `true` if a block broker with the passed name has been configured
+   */
+  hasBlockBroker (name: string): boolean
+
+  /**
+   * Add a block broker
+   */
+  addBlockBroker(blockBroker: BlockBroker): void
+
+  /**
+   * Add a mixin to extend runtime functionality
+   */
+  addMixin<T extends Helia = Helia & Record<string, any>>(mixin: HeliaMixin<T>): void
 }
 
 export type GcEvents =
@@ -137,7 +179,7 @@ export interface GCOptions extends AbortOptions, ProgressOptions<GcEvents> {
 
 }
 
-export interface HeliaEvents<T extends Libp2p = Libp2p> {
+export interface HeliaEvents<H extends Helia = Helia> {
   /**
    * This event notifies listeners that the node has started
    *
@@ -147,7 +189,7 @@ export interface HeliaEvents<T extends Libp2p = Libp2p> {
    * })
    * ```
    */
-  start: CustomEvent<Helia<T>>
+  start: CustomEvent<H>
 
   /**
    * This event notifies listeners that the node has stopped
@@ -158,10 +200,11 @@ export interface HeliaEvents<T extends Libp2p = Libp2p> {
    * })
    * ```
    */
-  stop: CustomEvent<Helia<T>>
+  stop: CustomEvent<H>
 }
 
 export * from './blocks.ts'
 export * from './errors.ts'
+export * from './graph-walker.ts'
 export * from './pins.ts'
 export * from './routing.ts'

package/src/pins.ts

@@ -1,5 +1,6 @@
 import type { GetBlockProgressEvents } from './blocks.ts'
-import type { AbortOptions } from '@libp2p/interface'
+import type { GraphWalkerFactory } from './graph-walker.ts'
+import type { AbortOptions } from 'abort-error'
 import type { CID } from 'multiformats/cid'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'
 
@@ -20,6 +21,11 @@ export interface AddOptions extends AbortOptions, ProgressOptions<AddPinEvents |
    */
   depth?: number
 
+  /**
+   * Walker factory used to traverse the DAG. Default: `depthFirstWalker()`.
+   */
+  walker?: GraphWalkerFactory
+
   /**
    * Optional user-defined metadata to store with the pin
    */
@@ -27,7 +33,10 @@ export interface AddOptions extends AbortOptions, ProgressOptions<AddPinEvents |
 }
 
 export interface RmOptions extends AbortOptions {
-
+  /**
+   * Walker factory used to traverse the DAG. Default: `depthFirstWalker()`.
+   */
+  walker?: GraphWalkerFactory
 }
 
 export interface LsOptions extends AbortOptions {

package/src/routing.ts

@@ -1,4 +1,5 @@
-import type { AbortOptions, PeerId, PeerInfo, TraceOptions } from '@libp2p/interface'
+import type { Multiaddr } from '@multiformats/multiaddr'
+import type { AbortOptions } from 'abort-error'
 import type { CID } from 'multiformats/cid'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'
 
@@ -8,7 +9,7 @@ import type { ProgressEvent, 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<Event extends ProgressEvent = any> extends AbortOptions, ProgressOptions<Event>, TraceOptions {
+export interface RoutingOptions<Event extends ProgressEvent = any> extends AbortOptions, ProgressOptions<Event> {
   /**
    * Pass `false` to not use the network
    *
@@ -29,12 +30,42 @@ export interface RoutingOptions<Event extends ProgressEvent = any> extends Abort
    * @default true
    */
   validate?: boolean
+
+  /**
+   * Where tracing is used, this value carries tracing context
+   */
+  trace?: any
+}
+
+/**
+ * A Peer is another node on the network
+ */
+export interface Peer {
+  /**
+   * The identifier of the remote peer
+   */
+  id: CID
+
+  /**
+   * The multiaddrs a peer is listening on
+   */
+  multiaddrs: Multiaddr[]
 }
 
 /**
  * A provider can supply the content for a CID
  */
-export interface Provider extends PeerInfo {
+export interface Provider {
+  /**
+   * The identifier of the remote peer, a CID
+   */
+  id: CID
+
+  /**
+   * The multiaddrs a peer is listening on
+   */
+  multiaddrs: Multiaddr[]
+
   /**
    * If present these are the methods that the peer can supply the content via.
    *
@@ -69,7 +100,7 @@ export interface RoutingFindProvidersEndEvent {
 export interface RoutingFindProvidersHttpGatewayProvider {
   routing: 'http-gateway-router'
   cid: CID
-  provider: PeerInfo & {
+  provider: Peer & {
     protocols: ['transport-ipfs-gateway-http']
   }
 }
@@ -77,7 +108,7 @@ export interface RoutingFindProvidersHttpGatewayProvider {
 export interface RoutingFindProvidersDelegatedHttpRoutingProvider {
   routing: 'delegated-http-router'
   cid: CID
-  provider: PeerInfo & {
+  provider: Peer & {
     routing: 'delegated-http-routing'
     protocols: string[]
   }
@@ -86,7 +117,7 @@ export interface RoutingFindProvidersDelegatedHttpRoutingProvider {
 export interface RoutingFindProvidersLibp2pProvider {
   routing: 'libp2p-router'
   cid: CID
-  provider: PeerInfo
+  provider: Peer
 }
 
 export type RoutingFindProvidersProviderEvent = RoutingFindProvidersHttpGatewayProvider | RoutingFindProvidersDelegatedHttpRoutingProvider | RoutingFindProvidersLibp2pProvider
@@ -157,12 +188,12 @@ export type RoutingGetProgressEvents =
 
 export interface RoutingFindPeerStartEvent {
   routing: string
-  peerId: PeerId
+  peerId: CID
 }
 
 export interface RoutingFindPeerEndEvent {
   routing: string
-  peerId: PeerId
+  peerId: CID
 }
 
 export type RoutingFindPeerProgressEvents =
@@ -183,7 +214,7 @@ export type RoutingGetClosestPeersProgressEvents =
   ProgressEvent<'helia:routing:get-closest-peers:start', RoutingGetClosestPeersStartEvent> |
   ProgressEvent<'helia:routing:get-closest-peers:end', RoutingGetClosestPeersEndEvent>
 
-export interface Routing {
+export interface Router {
   /**
    * The name of this routing implementation
    */
@@ -197,10 +228,12 @@ export interface Routing {
    *
    * ```js
    * // ...
-   * await contentRouting.provide(cid)
+   * await contentRouting.provide(cid, {
+   *   signal: AbortSignal.timeout(5_000)
+   * })
    * ```
    */
-  provide(cid: CID, options?: RoutingOptions<RoutingProvideProgressEvents>): Promise<void>
+  provide?(cid: CID, options?: RoutingOptions<RoutingProvideProgressEvents>): Promise<void>
 
   /**
    * Helia will periodically re-provide every previously provided CID. Use this
@@ -210,10 +243,12 @@ export interface Routing {
    *
    * ```js
    * // ...
-   * await contentRouting.cancelReprovide(cid)
+   * await contentRouting.cancelReprovide(cid, {
+   *   signal: AbortSignal.timeout(5_000)
+   * })
    * ```
    */
-  cancelReprovide(key: CID, options?: AbortOptions): Promise<void>
+  cancelReprovide?(key: CID, options?: AbortOptions): Promise<void>
 
   /**
    * Find the providers of the passed CID.
@@ -222,12 +257,14 @@ export interface Routing {
    *
    * ```js
    * // Iterate over the providers found for the given cid
-   * for await (const provider of contentRouting.findProviders(cid)) {
+   * for await (const provider of contentRouting.findProviders(cid, {
+   *   signal: AbortSignal.timeout(5_000)
+   * })) {
    *  console.log(provider.id, provider.multiaddrs)
    * }
    * ```
    */
-  findProviders(cid: CID, options?: RoutingOptions<RoutingFindProvidersProgressEvents>): 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
@@ -237,13 +274,15 @@ export interface Routing {
    *
    * ```js
    * // ...
-   * const key = '/key'
+   * const key = uint8ArrayFromString('/key')
    * const value = uint8ArrayFromString('oh hello there')
    *
-   * await contentRouting.put(key, value)
+   * await contentRouting.put(key, value, {
+   *   signal: AbortSignal.timeout(5_000)
+   * })
    * ```
    */
-  put(key: Uint8Array, value: Uint8Array, options?: RoutingOptions<RoutingPutProgressEvents>): Promise<void>
+  put?(key: Uint8Array, value: Uint8Array, options?: RoutingOptions<RoutingPutProgressEvents>): Promise<void>
 
   /**
    * Retrieves a value from the network corresponding to the passed key.
@@ -253,11 +292,13 @@ export interface Routing {
    * ```js
    * // ...
    *
-   * const key = '/key'
-   * const value = await contentRouting.get(key)
+   * const key = uint8ArrayFromString('/key')
+   * const value = await contentRouting.get(key, {
+   *   signal: AbortSignal.timeout(5_000)
+   * })
    * ```
    */
-  get(key: Uint8Array, options?: RoutingOptions<RoutingGetProgressEvents>): Promise<Uint8Array>
+  get?(key: Uint8Array, options?: RoutingOptions<RoutingGetProgressEvents>): Promise<Uint8Array>
 
   /**
    * Searches the network for peer info corresponding to the passed peer id.
@@ -266,10 +307,12 @@ export interface Routing {
    *
    * ```js
    * // ...
-   * const peer = await peerRouting.findPeer(peerId, options)
+   * const peer = await peerRouting.findPeer(peerId, {
+   *   signal: AbortSignal.timeout(5_000)
+   * })
    * ```
    */
-  findPeer(peerId: PeerId, options?: RoutingOptions<RoutingFindPeerProgressEvents>): Promise<PeerInfo>
+  findPeer?(peer: CID, options?: RoutingOptions<RoutingFindPeerProgressEvents>): Promise<Peer>
 
   /**
    * Search the network for peers that are closer to the passed key. Peer
@@ -279,10 +322,14 @@ export interface Routing {
    *
    * ```js
    * // Iterate over the closest peers found for the given key
-   * for await (const peer of peerRouting.getClosestPeers(key)) {
+   * for await (const peer of peerRouting.getClosestPeers(key, {
+   *   signal: AbortSignal.timeout(5_000)
+   * })) {
    *   console.log(peer.id, peer.multiaddrs)
    * }
    * ```
    */
-  getClosestPeers(key: Uint8Array, options?: RoutingOptions<RoutingGetClosestPeersProgressEvents>): AsyncIterable<PeerInfo>
+  getClosestPeers?(key: Uint8Array, options?: RoutingOptions<RoutingGetClosestPeersProgressEvents>): AsyncIterable<Peer>
 }
+
+export type Routing = Required<Omit<Router, 'name'>>