UploadOptions

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

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

StoreOptions.UploadCallbacks

Properties

onCopyComplete?

optional onCopyComplete?: (providerId, pieceCid) => void

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

Called when a secondary copy completes successfully

Parameters

Parameter	Type
`providerId`	`bigint`
`pieceCid`	`PieceCID`

Returns

void

Inherited from

UploadCallbacks.onCopyComplete

onCopyFailed?

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

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

Called when a secondary copy fails

Parameters

Parameter	Type
`providerId`	`bigint`
`pieceCid`	`PieceCID`
`error`	`Error`

Returns

void

Inherited from

UploadCallbacks.onCopyFailed

onPiecesAdded?

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

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

Called when the addPieces transaction has been submitted for a provider

Parameters

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

Returns

void

Inherited from

UploadCallbacks.onPiecesAdded

onPiecesConfirmed?

optional onPiecesConfirmed?: (dataSetId, providerId, pieces) => void

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

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

Parameters

Parameter	Type
`dataSetId`	`bigint`
`providerId`	`bigint`
`pieces`	`PieceRecord`[]

Returns

void

Inherited from

UploadCallbacks.onPiecesConfirmed

onProgress?

optional onProgress?: (bytesUploaded) => void

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

Progress callback for upload bytes

Parameters

Parameter	Type
`bytesUploaded`	`number`

Returns

void

Inherited from

StoreOptions.onProgress

onPullProgress?

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

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

Called with pull status updates during SP-to-SP transfer

Parameters

Parameter	Type
`providerId`	`bigint`
`pieceCid`	`PieceCID`
`status`	`PullStatus`

Returns

void

Inherited from

UploadCallbacks.onPullProgress

onStored?

optional onStored?: (providerId, pieceCid) => void

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

Called when piece data has been stored on a provider (before on-chain commit)

Parameters

Parameter	Type
`providerId`	`bigint`
`pieceCid`	`PieceCID`

Returns

void

Inherited from

UploadCallbacks.onStored

pieceCid?

optional pieceCid?: PieceCID

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

Optional pre-calculated PieceCID to skip CommP calculation

Inherited from

StoreOptions.pieceCid

pieceMetadata?

optional pieceMetadata?: MetadataObject

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

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

signal?

optional signal?: AbortSignal

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

Optional AbortSignal to cancel the upload.

With piece batching disabled, it cancels the store and the commit (see CommitOptions.signal). With batching enabled (the default), it cancels the store but not the shared batch commit or its confirmation wait.

Overrides

StoreOptions.signal