OptionsType
OptionsType =
object
Defined in: packages/synapse-core/src/sp/pull-pieces.ts:57
Options for pulling pieces from external SPs.
Properties
Section titled “Properties”dataSetId?
Section titled “dataSetId?”
optionaldataSetId?:bigint
Defined in: packages/synapse-core/src/sp/pull-pieces.ts:65
Optional target dataset ID (omit or 0n to create new).
extraData
Section titled “extraData”extraData:
Hex
Defined in: packages/synapse-core/src/sp/pull-pieces.ts:63
EIP-712 signed extraData for authorization.
pieces
Section titled “pieces”pieces:
PullPieceInput[]
Defined in: packages/synapse-core/src/sp/pull-pieces.ts:67
Pieces to pull with their source URLs.
recordKeeper
Section titled “recordKeeper”recordKeeper:
Address
Defined in: packages/synapse-core/src/sp/pull-pieces.ts:61
The record keeper contract address (e.g., FWSS).
retryCount?
Section titled “retryCount?”
optionalretryCount?:number
Defined in: packages/synapse-core/src/sp/pull-pieces.ts:71
The number of retries. Defaults to 2.
retryDelay?
Section titled “retryDelay?”
optionalretryDelay?:number
Defined in: packages/synapse-core/src/sp/pull-pieces.ts:73
The delay with exponential backoff between retries in milliseconds. Defaults to RETRY_CONSTANTS.RETRY_DELAY.
serviceURL
Section titled “serviceURL”serviceURL:
string
Defined in: packages/synapse-core/src/sp/pull-pieces.ts:59
The service URL of the PDP API.
signal?
Section titled “signal?”
optionalsignal?:AbortSignal
Defined in: packages/synapse-core/src/sp/pull-pieces.ts:69
Optional AbortSignal to cancel the request.