PullOptions

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

Options for pulling pieces from a source provider

Properties

dedupe?

optional dedupe?: boolean

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

Remove pieces whose PieceCID already appeared earlier in pieces before signing and pulling. The first one wins. Removed pieces still get a result that shares the kept piece’s status, and are listed in the result’s dropped. A pre-built extraData must be signed over the deduped pieces. Defaults to false.

---

extraData?

optional extraData?: `0x${string}`

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

Pre-built signed extraData (avoids double wallet prompts)

---

from

from: PullSource

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

Source provider to pull from (URL or context with getPieceUrl)

---

onProgress?

optional onProgress?: (pieceCid, status) => void

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

Pull progress callback

Parameters

Parameter	Type
pieceCid	PieceCID
status	PullStatus

Returns

void

---

pieces

pieces: PieceCID[]

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

Pieces to pull

---

signal?

optional signal?: AbortSignal

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

Optional AbortSignal

---

timeout?

optional timeout?: number

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

Total time in milliseconds to wait for the pull to finish. Defaults to 2 hours.