PDPVerifier
Defined in: packages/synapse-sdk/src/pdp/verifier.ts:26
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PDPVerifier(provider, contractAddress): PDPVerifier;Defined in: packages/synapse-sdk/src/pdp/verifier.ts:31
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
provider | Provider |
contractAddress | string |
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:42
Check if a data set is live
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | number | The PDPVerifier data set ID |
Returns
Section titled “Returns”Promise<boolean>
Whether the data set exists and is live
extractDataSetIdFromReceipt()
Section titled “extractDataSetIdFromReceipt()”extractDataSetIdFromReceipt(receipt): number | null;Defined in: packages/synapse-sdk/src/pdp/verifier.ts:92
Extract data set ID from a transaction receipt by looking for DataSetCreated events
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
receipt | TransactionReceipt | Transaction receipt |
Returns
Section titled “Returns”number | null
Data set ID if found, null otherwise
getActivePieces()
Section titled “getActivePieces()”getActivePieces(dataSetId, options?): Promise<{ hasMore: boolean; pieces: object[];}>;Defined in: packages/synapse-sdk/src/pdp/verifier.ts:127
Get active pieces for a data set with pagination
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | number | The PDPVerifier data set ID |
options? | { limit?: number; offset?: number; signal?: AbortSignal; } | Optional configuration object |
options.limit? | number | The maximum number of pieces to return (default: 100) |
options.offset? | number | 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(): string;Defined in: packages/synapse-sdk/src/pdp/verifier.ts:171
Get the PDPVerifier contract address for the current network
Returns
Section titled “Returns”string
getDataSetLeafCount()
Section titled “getDataSetLeafCount()”getDataSetLeafCount(dataSetId): Promise<number>;Defined in: packages/synapse-sdk/src/pdp/verifier.ts:82
Get the leaf count for a data set
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | number | The PDPVerifier data set ID |
Returns
Section titled “Returns”Promise<number>
The number of leaves in the data set
getDataSetListener()
Section titled “getDataSetListener()”getDataSetListener(dataSetId): Promise<string>;Defined in: packages/synapse-sdk/src/pdp/verifier.ts:61
Get the data set listener (record keeper)
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | number | The PDPVerifier data set ID |
Returns
Section titled “Returns”Promise<string>
The address of the listener contract
getDataSetStorageProvider()
Section titled “getDataSetStorageProvider()”getDataSetStorageProvider(dataSetId): Promise<{ proposedStorageProvider: string; storageProvider: string;}>;Defined in: packages/synapse-sdk/src/pdp/verifier.ts:70
Get the data set storage provider addresses
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | number | The PDPVerifier data set ID |
Returns
Section titled “Returns”Promise<{
proposedStorageProvider: string;
storageProvider: string;
}>
Object with current storage provider and proposed storage provider
getNextPieceId()
Section titled “getNextPieceId()”getNextPieceId(dataSetId): Promise<number>;Defined in: packages/synapse-sdk/src/pdp/verifier.ts:51
Get the next piece ID for a data set
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
dataSetId | number | The PDPVerifier data set ID |
Returns
Section titled “Returns”Promise<number>
The next piece ID (which equals the current piece count)