UploadOptions

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

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:418

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

onPieceAdded()?

optional onPieceAdded: (transaction?) => void

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

Parameters

Parameter	Type
`transaction?`	`0x${string}`

Returns

void

Inherited from

UploadCallbacks.onPieceAdded

onPieceConfirmed()?

optional onPieceConfirmed: (pieceIds) => void

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

Parameters

Parameter	Type
`pieceIds`	`bigint`[]

Returns

void

Inherited from

UploadCallbacks.onPieceConfirmed

onPiecesAdded()?

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

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

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:394

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:386

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:388

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:420

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

signal?

optional signal: AbortSignal

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

Optional AbortSignal to cancel the upload