UploadOptions

Defined in: packages/synapse-sdk/src/types.ts:430

Options for uploading individual pieces to an existing storage context

Used by StorageContext.upload() for uploading data to a specific provider and data set that has already been created/selected.

Extends

• UploadCallbacks

Properties

metadata?

optional metadata: MetadataObject

Defined in: packages/synapse-sdk/src/types.ts:432

Custom metadata for this specific piece (key-value pairs)

---

onPiecesAdded()?

optional onPiecesAdded: (transaction, pieces?) => void

Defined in: packages/synapse-sdk/src/types.ts:408

Called when the service provider has added the piece(s) and submitted the transaction to the chain

Parameters

Parameter	Type
transaction	`0x${string}`
pieces?	object[]

Returns

void

Inherited from

UploadCallbacks.onPiecesAdded

---

onPiecesConfirmed()?

optional onPiecesConfirmed: (dataSetId, pieces) => void

Defined in: packages/synapse-sdk/src/types.ts:410

Called when the service provider agrees that the piece addition(s) are confirmed on-chain

Parameters

Parameter	Type
dataSetId	bigint
pieces	PieceRecord[]

Returns

void

Inherited from

UploadCallbacks.onPiecesConfirmed

---

onProgress()?

optional onProgress: (bytesUploaded) => void

Defined in: packages/synapse-sdk/src/types.ts:404

Called periodically during upload with bytes uploaded so far

Parameters

Parameter	Type
bytesUploaded	number

Returns

void

Inherited from

UploadCallbacks.onProgress

---

onUploadComplete()?

optional onUploadComplete: (pieceCid) => void

Defined in: packages/synapse-sdk/src/types.ts:406

Called when upload to service provider completes

Parameters

Parameter	Type
pieceCid	PieceLink

Returns

void

Inherited from

UploadCallbacks.onUploadComplete

---

pieceCid?

optional pieceCid: PieceLink

Defined in: packages/synapse-sdk/src/types.ts:434

Optional pre-calculated PieceCID to skip CommP calculation (BYO PieceCID)

---

signal?

optional signal: AbortSignal

Defined in: packages/synapse-sdk/src/types.ts:436

Optional AbortSignal to cancel the upload