Skip to content

fix: allow configuring cid peer filter size #955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
achingbrain merged 1 commit into from
Feb 5, 2026
+14 −2
Merged

fix: allow configuring cid peer filter size #955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions packages/interface/src/blocks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,15 @@ export interface CreateSessionOptions <ProgressEvents extends ProgressEvent<any,
* @default 5
*/
maxProviders?: number

/**
* A scalable cuckoo filter is used to ensure we do not query the same peer
* multiple times for the same CID. This setting controls how the initial
* maximum number of peers that are expected to be in the filter.
*
* @default 100
*/
cidPeerFilterSize?: number
}

export interface BlockBroker<RetrieveProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>, AnnounceProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> {
Expand Down Expand Up @@ -180,3 +189,4 @@ export interface SessionBlockBroker<RetrieveProgressEvents extends ProgressEvent

export const DEFAULT_SESSION_MIN_PROVIDERS = 1
export const DEFAULT_SESSION_MAX_PROVIDERS = 5
export const DEFAULT_CID_PEER_FILTER_SIZE = 100
6 changes: 4 additions & 2 deletions packages/utils/src/abstract-session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { DEFAULT_SESSION_MIN_PROVIDERS, DEFAULT_SESSION_MAX_PROVIDERS, InsufficientProvidersError } from '@helia/interface'
import { DEFAULT_SESSION_MIN_PROVIDERS, DEFAULT_SESSION_MAX_PROVIDERS, DEFAULT_CID_PEER_FILTER_SIZE, InsufficientProvidersError } from '@helia/interface'
import { AbortError, TypedEventEmitter, setMaxListeners } from '@libp2p/interface'
import { createScalableCuckooFilter, Queue } from '@libp2p/utils'
import { base64 } from 'multiformats/bases/base64'
Expand Down Expand Up @@ -42,6 +42,7 @@ export abstract class AbstractSession<Provider, RetrieveBlockProgressEvents exte
public readonly providers: Provider[]
private readonly evictionFilter: Filter
private readonly initialProviders: Array<PeerId | Multiaddr | Multiaddr[]>
private readonly cidPeerFilterSize: number

constructor (components: AbstractSessionComponents, init: AbstractCreateSessionOptions) {
super()
Expand All @@ -53,6 +54,7 @@ export abstract class AbstractSession<Provider, RetrieveBlockProgressEvents exte
this.requests = new Map()
this.minProviders = init.minProviders ?? DEFAULT_SESSION_MIN_PROVIDERS
this.maxProviders = init.maxProviders ?? DEFAULT_SESSION_MAX_PROVIDERS
this.cidPeerFilterSize = init.cidPeerFilterSize ?? DEFAULT_CID_PEER_FILTER_SIZE
this.providers = []
this.evictionFilter = createScalableCuckooFilter(this.maxProviders)
this.initialProviders = [...(init.providers ?? [])]
Expand All @@ -73,7 +75,7 @@ export abstract class AbstractSession<Provider, RetrieveBlockProgressEvents exte
const request = {
promise: deferred.promise,
observers: 1,
queryFilter: createScalableCuckooFilter(1024)
queryFilter: createScalableCuckooFilter(this.cidPeerFilterSize)
}
this.requests.set(cidStr, request)

Expand Down