CreateDataSetAndAddPiecesOptions
CreateDataSetAndAddPiecesOptions =
object
Defined in: packages/synapse-core/src/sp/create-dataset-add-pieces.ts:108
Properties
Section titled “Properties”
optionalcdn?:boolean
Defined in: packages/synapse-core/src/sp/create-dataset-add-pieces.ts:128
Whether the data set should use CDN.
clientDataSetId?
Section titled “clientDataSetId?”
optionalclientDataSetId?:bigint
Defined in: packages/synapse-core/src/sp/create-dataset-add-pieces.ts:124
The client data set id (nonce) to use for the signature. Must be unique for each data set.
extraData?
Section titled “extraData?”
optionalextraData?:Hex
Defined in: packages/synapse-core/src/sp/create-dataset-add-pieces.ts:126
Pre-built signed extraData. When provided, skips internal EIP-712 signing.
metadata?
Section titled “metadata?”
optionalmetadata?:MetadataObject
Defined in: packages/synapse-core/src/sp/create-dataset-add-pieces.ts:122
The metadata for the data set.
payee:
Address
Defined in: packages/synapse-core/src/sp/create-dataset-add-pieces.ts:112
The address that will receive payments (service provider).
payer?
Section titled “payer?”
optionalpayer?:Address
Defined in: packages/synapse-core/src/sp/create-dataset-add-pieces.ts:120
The address that will pay for the storage (client). If not provided, the default is the client address.
If client is from a session key this should be set to the actual payer address
pieces
Section titled “pieces”pieces:
object[]
Defined in: packages/synapse-core/src/sp/create-dataset-add-pieces.ts:114
The pieces and metadata to add to the data set.
metadata?
Section titled “metadata?”
optionalmetadata?:MetadataObject
pieceCid
Section titled “pieceCid”pieceCid:
PieceCID
recordKeeper?
Section titled “recordKeeper?”
optionalrecordKeeper?:Address
Defined in: packages/synapse-core/src/sp/create-dataset-add-pieces.ts:130
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-add-pieces.ts:134
The number of retries. Defaults to 2.
retryDelay?
Section titled “retryDelay?”
optionalretryDelay?:number
Defined in: packages/synapse-core/src/sp/create-dataset-add-pieces.ts:136
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-add-pieces.ts:110
The service URL of the PDP API.
signal?
Section titled “signal?”
optionalsignal?:AbortSignal
Defined in: packages/synapse-core/src/sp/create-dataset-add-pieces.ts:132
The signal to abort the request.