UploadCallbacks

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

Extended by

• UploadOptions

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

---

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

---

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

---

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

---

onProgress?

optional onProgress?: (bytesUploaded) => void

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

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

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

Parameters

Parameter	Type
providerId	bigint
pieceCid	PieceCID
status	PullStatus

Returns

void

---

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