ProviderSelectionOptions
Defined in: packages/synapse-core/src/warm-storage/location-types.ts:62
Options for selectProviders(). Combines pre-fetched chain data with selection parameters in a single argument.
Extends
Section titled “Extends”Properties
Section titled “Properties”clientDataSets
Section titled “clientDataSets”clientDataSets:
SelectionDataSet[]
Defined in: packages/synapse-core/src/warm-storage/location-types.ts:48
Client’s existing datasets with metadata and piece-presence information
Inherited from
Section titled “Inherited from”ProviderSelectionInput.clientDataSets
count?
Section titled “count?”
optionalcount?:number
Defined in: packages/synapse-core/src/warm-storage/location-types.ts:64
Number of providers to select (default: 1)
endorsedIds
Section titled “endorsedIds”endorsedIds:
bigint[]
Defined in: packages/synapse-core/src/warm-storage/location-types.ts:46
Array of endorsed provider IDs (from endorsements.getProviderIds). Non-empty = restrict to endorsed only. Empty = use all providers.
Inherited from
Section titled “Inherited from”ProviderSelectionInput.endorsedIds
excludeProviderIds?
Section titled “excludeProviderIds?”
optionalexcludeProviderIds?:bigint[]
Defined in: packages/synapse-core/src/warm-storage/location-types.ts:66
Provider IDs to exclude (for retry after ping failure or multi-copy exclusion)
legacyPieceStorageIdLimit?
Section titled “legacyPieceStorageIdLimit?”
optionallegacyPieceStorageIdLimit?:bigint
Defined in: packages/synapse-core/src/warm-storage/location-types.ts:55
Data set ID boundary between legacy and compact piece storage (see
FilecoinChain.legacyPieceStorageIdLimit). Data sets at or above this ID
are compact and are preferred over legacy ones. Defaults to 0n (every
data set treated as compact) when omitted.
Inherited from
Section titled “Inherited from”ProviderSelectionInput.legacyPieceStorageIdLimit
metadata?
Section titled “metadata?”
optionalmetadata?:MetadataObject
Defined in: packages/synapse-core/src/warm-storage/location-types.ts:68
Desired metadata for dataset matching (empty object matches only empty-metadata datasets)
providers
Section titled “providers”providers:
PDPProvider[]
Defined in: packages/synapse-core/src/warm-storage/location-types.ts:43
Available PDP providers (typically from getApprovedPDPProviders)