UploadCallbacks
Defined in: packages/synapse-sdk/src/types.ts:396
Callbacks for tracking upload progress
These callbacks provide visibility into the upload process stages:
- Upload completion (piece uploaded to provider)
- Piece addition (transaction submitted to chain)
- Confirmation (transaction confirmed on-chain)
Extended by
Section titled “Extended by”Properties
Section titled “Properties”onPieceAdded()?
Section titled “onPieceAdded()?”optional onPieceAdded: (transaction?) => void;Defined in: packages/synapse-sdk/src/types.ts:400
Called when the service provider has added the piece and submitted the transaction to the chain
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
transaction? | TransactionResponse |
Returns
Section titled “Returns”void
onPieceConfirmed()?
Section titled “onPieceConfirmed()?”optional onPieceConfirmed: (pieceIds) => void;Defined in: packages/synapse-sdk/src/types.ts:402
Called when the service provider agrees that the piece addition is confirmed on-chain
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pieceIds | number[] |
Returns
Section titled “Returns”void
onUploadComplete()?
Section titled “onUploadComplete()?”optional onUploadComplete: (pieceCid) => void;Defined in: packages/synapse-sdk/src/types.ts:398
Called when upload to service provider completes
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pieceCid | PieceLink |
Returns
Section titled “Returns”void