filecoin-pin
    Preparing search index...

    Interface DataSetSummary

    Summary information for a dataset

    Extends EnhancedDataSetInfo from synapse-sdk with optional provider enrichment. This includes all fields needed by both the CLI and website:

    • Rail IDs (pdpRailId, cdnRailId, cacheMissRailId)
    • Contract details (commissionBps, pdpEndEpoch, cdnEndEpoch)
    • Piece tracking (nextPieceId, currentPieceCount)
    • Provider enrichment (optional provider field)
    • Dataset metadata (inherited from EnhancedDataSetInfo.metadata - key-value pairs from WarmStorage)
    • Filecoin-pin creation flag (indicates if created by filecoin-pin)
    • Optional detailed information (pieces, metadata, size calculations, warnings)

    The dataSetId alias makes pdpVerifierDataSetId more discoverable.

    interface DataSetSummary {
        createdWithFilecoinPin: boolean;
        dataSetId: number;
        pieces?: PieceInfo[];
        provider: ProviderInfo | undefined;
        totalSizeBytes?: bigint;
    }

    Hierarchy

    • EnhancedDataSetInfo
      • DataSetSummary
    Index

    Properties

    createdWithFilecoinPin dataSetId pieces? provider totalSizeBytes?

    Properties

    createdWithFilecoinPin: boolean

    Indicates if this dataset was created by filecoin-pin (has WITH_IPFS_INDEXING and source='filecoin-pin' metadata)

    dataSetId: number

    PDP Verifier dataset ID (alias for pdpVerifierDataSetId)

    pieces?: PieceInfo[]

    Pieces in the dataset (optional, populated when fetching detailed info)

    provider: ProviderInfo | undefined

    Provider information (enriched from getStorageInfo if available)

    totalSizeBytes?: bigint

    Total size in bytes (optional, calculated from piece sizes)

    Settings

    Member Visibility

    On This Page

    Properties