PDPVerifier
Defined in: packages/synapse-sdk/src/pdp/verifier.ts:28
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PDPVerifier(
options):PDPVerifier
Defined in: packages/synapse-sdk/src/pdp/verifier.ts:45
Create a new PDPVerifier instance
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
options | OptionsType | PDPVerifier.OptionsType |
Returns
Section titled “Returns”PDPVerifier
Methods
Section titled “Methods”dataSetLive()
Section titled “dataSetLive()”dataSetLive(
dataSetId):Promise<boolean>
Defined in: packages/synapse-sdk/src/pdp/verifier.ts:55
Check if a data set is live
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | bigint | The PDPVerifier data set ID |
Returns
Section titled “Returns”Promise<boolean>
Whether the data set exists and is live
getActivePieceCount()
Section titled “getActivePieceCount()”getActivePieceCount(
dataSetId):Promise<bigint>
Defined in: packages/synapse-sdk/src/pdp/verifier.ts:73
Get the count of active pieces (non-zero leaf count) for a data set
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | bigint | The PDPVerifier data set ID |
Returns
Section titled “Returns”Promise<bigint>
The number of active pieces in the data set
getActivePieces()
Section titled “getActivePieces()”getActivePieces(
dataSetId,options?):Promise<{hasMore:boolean;pieces:object[]; }>
Defined in: packages/synapse-sdk/src/pdp/verifier.ts:119
Get active pieces for a data set with pagination
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | bigint | The PDPVerifier data set ID |
options? | { limit?: bigint; offset?: bigint; signal?: AbortSignal; } | Optional configuration object |
options.limit? | bigint | The maximum number of pieces to return (default: 100) |
options.offset? | bigint | The offset to start from (default: 0) |
options.signal? | AbortSignal | Optional AbortSignal to cancel the operation |
Returns
Section titled “Returns”Promise<{ hasMore: boolean; pieces: object[]; }>
Object containing pieces, piece IDs, raw sizes, and hasMore flag
getContractAddress()
Section titled “getContractAddress()”getContractAddress():
`0x${string}`
Defined in: packages/synapse-sdk/src/pdp/verifier.ts:176
Get the PDPVerifier contract address for the current network
Returns
Section titled “Returns”`0x${string}`
getDataSetLeafCount()
Section titled “getDataSetLeafCount()”getDataSetLeafCount(
dataSetId):Promise<bigint>
Defined in: packages/synapse-sdk/src/pdp/verifier.ts:106
Get the leaf count for a data set
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | bigint | The PDPVerifier data set ID |
Returns
Section titled “Returns”Promise<bigint>
The number of leaves in the data set
getDataSetListener()
Section titled “getDataSetListener()”getDataSetListener(
dataSetId):Promise<`0x${string}`>
Defined in: packages/synapse-sdk/src/pdp/verifier.ts:82
Get the data set listener (record keeper)
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | bigint | The PDPVerifier data set ID |
Returns
Section titled “Returns”Promise<`0x${string}`>
The address of the listener contract
getDataSetStorageProvider()
Section titled “getDataSetStorageProvider()”getDataSetStorageProvider(
dataSetId):Promise<{proposedStorageProvider:`0x${string}`;storageProvider:`0x${string}`; }>
Defined in: packages/synapse-sdk/src/pdp/verifier.ts:91
Get the data set storage provider addresses
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | bigint | The PDPVerifier data set ID |
Returns
Section titled “Returns”Promise<{ proposedStorageProvider: `0x${string}`; storageProvider: `0x${string}`; }>
Object with current storage provider and proposed storage provider
getNextPieceId()
Section titled “getNextPieceId()”getNextPieceId(
dataSetId):Promise<bigint>
Defined in: packages/synapse-sdk/src/pdp/verifier.ts:64
Get the next piece ID for a data set
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | bigint | The PDPVerifier data set ID |
Returns
Section titled “Returns”Promise<bigint>
The next piece ID to assign (total pieces ever added; does not decrease when pieces are removed)
getScheduledRemovals()
Section titled “getScheduledRemovals()”getScheduledRemovals(
dataSetId):Promise<readonlybigint[]>
Defined in: packages/synapse-sdk/src/pdp/verifier.ts:168
Get pieces scheduled for removal from a data set
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | bigint | The PDPVerifier data set ID |
Returns
Section titled “Returns”Promise<readonly bigint[]>
Array of piece IDs scheduled for removal