UploadCallbacks

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

Extended by

• UploadOptions

Properties

onCopyComplete()?

optional onCopyComplete: (providerId, pieceCid) => void

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

Called when a secondary copy completes successfully

Parameters

Parameter	Type
providerId	bigint
pieceCid	PieceLink

Returns

void

---

onCopyFailed()?

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

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

Called when a secondary copy fails

Parameters

Parameter	Type
providerId	bigint
pieceCid	PieceLink
error	Error

Returns

void

---

onPiecesAdded()?

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

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

Called when the addPieces transaction has been submitted for a provider

Parameters

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

Returns

void

---

onPiecesConfirmed()?

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

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

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

Parameters

Parameter	Type
dataSetId	bigint
providerId	bigint
pieces	PieceRecord[]

Returns

void

---

onProgress()?

optional onProgress: (bytesUploaded) => void

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

Called periodically during upload with bytes uploaded so far

Parameters

Parameter	Type
bytesUploaded	number

Returns

void

---

onPullProgress()?

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

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

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

Parameters

Parameter	Type
providerId	bigint
pieceCid	PieceLink
status	PullStatus

Returns

void

---

onStored()?

optional onStored: (providerId, pieceCid) => void

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

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

Parameters

Parameter	Type
providerId	bigint
pieceCid	PieceLink

Returns

void