UploadOptions

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

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

onCopyComplete()?

optional onCopyComplete: (providerId, pieceCid) => void

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

Called when a copy to a secondary provider completes successfully

Parameters

Parameter	Type
providerId	bigint
pieceCid	PieceLink

Returns

void

Inherited from

UploadCallbacks.onCopyComplete

---

onCopyFailed()?

optional onCopyFailed: (providerId, pieceCid, error) => void

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

Called when a copy to a secondary provider fails

Parameters

Parameter	Type
providerId	bigint
pieceCid	PieceLink
error	Error

Returns

void

Inherited from

UploadCallbacks.onCopyFailed

---

onPieceAdded()?

optional onPieceAdded: (providerId, pieceCid) => void

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

Called when the addPieces transaction has been submitted for a provider (before on-chain confirmation)

Parameters

Parameter	Type
providerId	bigint
pieceCid	PieceLink

Returns

void

Inherited from

UploadCallbacks.onPieceAdded

---

onPieceConfirmed()?

optional onPieceConfirmed: (providerId, pieceCid, pieceId) => void

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

Called after the addPieces transaction is confirmed on-chain for a provider

Parameters

Parameter	Type
providerId	bigint
pieceCid	PieceLink
pieceId	bigint

Returns

void

Inherited from

UploadCallbacks.onPieceConfirmed

---

onProgress()?

optional onProgress: (bytesUploaded) => void

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

Called periodically during upload with bytes uploaded so far

Parameters

Parameter	Type
bytesUploaded	number

Returns

void

Inherited from

UploadCallbacks.onProgress

---

onPullProgress()?

optional onPullProgress: (providerId, pieceCid, status) => void

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

Called with progress updates during pull to secondary providers

Parameters

Parameter	Type
providerId	bigint
pieceCid	PieceLink
status	PullStatus

Returns

void

Inherited from

UploadCallbacks.onPullProgress

---

onStored()?

optional onStored: (providerId, pieceCid) => void

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

Called after data is stored on a provider (uploaded but not yet committed on-chain)

Parameters

Parameter	Type
providerId	bigint
pieceCid	PieceLink

Returns

void

Inherited from

UploadCallbacks.onStored

---

pieceCid?

optional pieceCid: PieceLink

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

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

---

pieceMetadata?

optional pieceMetadata: MetadataObject

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

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

---

signal?

optional signal: AbortSignal

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

Optional AbortSignal to cancel the upload