Skip to content

EnhancedDataSetInfo

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

Enhanced data set information with chain details and clear ID separation

cacheMissRailId: number;

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

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

DataSetInfo.cacheMissRailId


cdnRailId: number;

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

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

DataSetInfo.cdnRailId


clientDataSetId: bigint;

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

Client’s sequential dataset ID within this Warm Storage contract

DataSetInfo.clientDataSetId


commissionBps: number;

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

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

DataSetInfo.commissionBps


currentPieceCount: number;

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

Current number of pieces in the data set


dataSetId: number | bigint;

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

PDP Data Set ID

DataSetInfo.dataSetId


isLive: boolean;

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

Whether the data set is live on-chain


isManaged: boolean;

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

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


metadata: Record<string, string>;

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

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


nextPieceId: number;

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

Next piece ID to use when adding pieces


payee: string;

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

SP’s beneficiary address

DataSetInfo.payee


payer: string;

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

Address paying for storage

DataSetInfo.payer


optional paymentEndEpoch: number;

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

DataSetInfo.paymentEndEpoch


pdpEndEpoch: number;

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

Epoch when PDP payments end (0 if not terminated)

DataSetInfo.pdpEndEpoch


pdpRailId: number;

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

ID of the PDP payment rail

DataSetInfo.pdpRailId


pdpVerifierDataSetId: number;

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

PDPVerifier global data set ID


providerId: number;

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

Provider ID from the ServiceProviderRegistry

DataSetInfo.providerId


serviceProvider: string;

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

Service provider address (operator)

DataSetInfo.serviceProvider


withCDN: boolean;

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

Whether the data set is using CDN (derived from cdnRailId > 0)