EnhancedDataSetInfo
Defined in: packages/synapse-sdk/src/types.ts:265
Enhanced data set information with chain details and clear ID separation
Extends
Section titled “Extends”Properties
Section titled “Properties”cacheMissRailId
Section titled “cacheMissRailId”cacheMissRailId:
bigint
Defined in: packages/synapse-sdk/src/types.ts:235
For CDN add-on: ID of the cache miss payment rail
Inherited from
Section titled “Inherited from”cdnRailId
Section titled “cdnRailId”cdnRailId:
bigint
Defined in: packages/synapse-sdk/src/types.ts:237
For CDN add-on: ID of the CDN payment rail
Inherited from
Section titled “Inherited from”clientDataSetId
Section titled “clientDataSetId”clientDataSetId:
bigint
Defined in: packages/synapse-sdk/src/types.ts:247
Client’s sequential dataset ID within this Warm Storage contract
Inherited from
Section titled “Inherited from”commissionBps
Section titled “commissionBps”commissionBps:
bigint
Defined in: packages/synapse-sdk/src/types.ts:245
Commission rate in basis points (dynamic based on CDN usage)
Inherited from
Section titled “Inherited from”dataSetId
Section titled “dataSetId”dataSetId:
bigint
Defined in: packages/synapse-sdk/src/types.ts:259
PDP Data Set ID
Inherited from
Section titled “Inherited from”hasActivePieces
Section titled “hasActivePieces”hasActivePieces:
boolean
Defined in: packages/synapse-sdk/src/types.ts:269
Whether the data set contains at least one active piece (non-zero leaf count).
isLive
Section titled “isLive”isLive:
boolean
Defined in: packages/synapse-sdk/src/types.ts:271
Whether the data set is live on-chain
isManaged
Section titled “isManaged”isManaged:
boolean
Defined in: packages/synapse-sdk/src/types.ts:273
Whether this data set is managed by the current Warm Storage contract
lifecycleReserveBalance
Section titled “lifecycleReserveBalance”lifecycleReserveBalance:
bigint
Defined in: packages/synapse-sdk/src/types.ts:255
Current fixed lifecycle reserve balance mirrored from the PDP payment rail.
Inherited from
Section titled “Inherited from”DataSetInfo.lifecycleReserveBalance
metadata
Section titled “metadata”metadata:
Record<string,string>
Defined in: packages/synapse-sdk/src/types.ts:277
Metadata associated with this data set (key-value pairs)
payee:
`0x${string}`
Defined in: packages/synapse-sdk/src/types.ts:241
SP’s beneficiary address
Inherited from
Section titled “Inherited from”payer:
`0x${string}`
Defined in: packages/synapse-sdk/src/types.ts:239
Address paying for storage
Inherited from
Section titled “Inherited from”paymentEndEpoch?
Section titled “paymentEndEpoch?”
optionalpaymentEndEpoch?:bigint
Defined in: packages/synapse-sdk/src/types.ts:257
Inherited from
Section titled “Inherited from”pdpEndEpoch
Section titled “pdpEndEpoch”pdpEndEpoch:
bigint
Defined in: packages/synapse-sdk/src/types.ts:249
Epoch when PDP payments end (0 if not terminated)
Inherited from
Section titled “Inherited from”pdpRailId
Section titled “pdpRailId”pdpRailId:
bigint
Defined in: packages/synapse-sdk/src/types.ts:233
ID of the PDP payment rail
Inherited from
Section titled “Inherited from”pdpVerifierDataSetId
Section titled “pdpVerifierDataSetId”pdpVerifierDataSetId:
bigint
Defined in: packages/synapse-sdk/src/types.ts:267
PDPVerifier global data set ID
pendingOneTimePayments
Section titled “pendingOneTimePayments”pendingOneTimePayments:
bigint
Defined in: packages/synapse-sdk/src/types.ts:253
One-time operation fees waiting to be flushed from the lifecycle reserve.
Inherited from
Section titled “Inherited from”DataSetInfo.pendingOneTimePayments
providerId
Section titled “providerId”providerId:
bigint
Defined in: packages/synapse-sdk/src/types.ts:251
Provider ID from the ServiceProviderRegistry
Inherited from
Section titled “Inherited from”serviceProvider
Section titled “serviceProvider”serviceProvider:
`0x${string}`
Defined in: packages/synapse-sdk/src/types.ts:243
Service provider address (operator)
Inherited from
Section titled “Inherited from”withCDN
Section titled “withCDN”withCDN:
boolean
Defined in: packages/synapse-sdk/src/types.ts:275
Whether the data set is using CDN (cdnRailId > 0 and withCDN metadata key present)