Skip to content

EnhancedDataSetInfo

Defined in: packages/synapse-sdk/src/types.ts:228

Enhanced data set information with chain details and clear ID separation

activePieceCount: number;

Defined in: packages/synapse-sdk/src/types.ts:232

Number of active pieces in the data set (excludes removed pieces)


cacheMissRailId: number;

Defined in: packages/synapse-sdk/src/types.ts:202

For CDN add-on: ID of the cache miss payment rail

DataSetInfo.cacheMissRailId


cdnRailId: number;

Defined in: packages/synapse-sdk/src/types.ts:204

For CDN add-on: ID of the CDN payment rail

DataSetInfo.cdnRailId


clientDataSetId: bigint;

Defined in: packages/synapse-sdk/src/types.ts:214

Client’s sequential dataset ID within this Warm Storage contract

DataSetInfo.clientDataSetId


commissionBps: number;

Defined in: packages/synapse-sdk/src/types.ts:212

Commission rate in basis points (dynamic based on CDN usage)

DataSetInfo.commissionBps


dataSetId: number | bigint;

Defined in: packages/synapse-sdk/src/types.ts:222

PDP Data Set ID

DataSetInfo.dataSetId


isLive: boolean;

Defined in: packages/synapse-sdk/src/types.ts:234

Whether the data set is live on-chain


isManaged: boolean;

Defined in: packages/synapse-sdk/src/types.ts:236

Whether this data set is managed by the current Warm Storage contract


metadata: Record<string, string>;

Defined in: packages/synapse-sdk/src/types.ts:240

Metadata associated with this data set (key-value pairs)


payee: string;

Defined in: packages/synapse-sdk/src/types.ts:208

SP’s beneficiary address

DataSetInfo.payee


payer: string;

Defined in: packages/synapse-sdk/src/types.ts:206

Address paying for storage

DataSetInfo.payer


optional paymentEndEpoch: number;

Defined in: packages/synapse-sdk/src/types.ts:220

DataSetInfo.paymentEndEpoch


pdpEndEpoch: number;

Defined in: packages/synapse-sdk/src/types.ts:216

Epoch when PDP payments end (0 if not terminated)

DataSetInfo.pdpEndEpoch


pdpRailId: number;

Defined in: packages/synapse-sdk/src/types.ts:200

ID of the PDP payment rail

DataSetInfo.pdpRailId


pdpVerifierDataSetId: number;

Defined in: packages/synapse-sdk/src/types.ts:230

PDPVerifier global data set ID


providerId: number;

Defined in: packages/synapse-sdk/src/types.ts:218

Provider ID from the ServiceProviderRegistry

DataSetInfo.providerId


serviceProvider: string;

Defined in: packages/synapse-sdk/src/types.ts:210

Service provider address (operator)

DataSetInfo.serviceProvider


withCDN: boolean;

Defined in: packages/synapse-sdk/src/types.ts:238

Whether the data set is using CDN (cdnRailId > 0 and withCDN metadata key present)