OptionsType
OptionsType =
object
Defined in: packages/synapse-core/src/sp/create-dataset.ts:102
Properties
Section titled “Properties”cdn:
boolean
Defined in: packages/synapse-core/src/sp/create-dataset.ts:104
Whether the data set should use CDN.
clientDataSetId?
Section titled “clientDataSetId?”
optionalclientDataSetId?:bigint
Defined in: packages/synapse-core/src/sp/create-dataset.ts:117
The client data set id (nonce) to use for the signature. Must be unique for each data set.
metadata?
Section titled “metadata?”
optionalmetadata?:MetadataObject
Defined in: packages/synapse-core/src/sp/create-dataset.ts:115
The metadata for the data set.
payee:
Address
Defined in: packages/synapse-core/src/sp/create-dataset.ts:106
The address that will receive payments (service provider).
payer?
Section titled “payer?”
optionalpayer?:Address
Defined in: packages/synapse-core/src/sp/create-dataset.ts:113
The address that will pay for the storage (client). If not provided, the default is the root address for a session key client, otherwise the client address.
recordKeeper?
Section titled “recordKeeper?”
optionalrecordKeeper?:Address
Defined in: packages/synapse-core/src/sp/create-dataset.ts:119
The address of the record keeper to use for the signature. If not provided, the default is the Warm Storage contract address.
retryCount?
Section titled “retryCount?”
optionalretryCount?:number
Defined in: packages/synapse-core/src/sp/create-dataset.ts:123
The number of retries. Defaults to 2.
retryDelay?
Section titled “retryDelay?”
optionalretryDelay?:number
Defined in: packages/synapse-core/src/sp/create-dataset.ts:125
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/create-dataset.ts:108
The service URL of the PDP API.
signal?
Section titled “signal?”
optionalsignal?:AbortSignal
Defined in: packages/synapse-core/src/sp/create-dataset.ts:121
The signal to abort the request.