StorageManagerUploadOptions

Defined in: packages/synapse-sdk/src/storage/manager.ts:91

Upload options for StorageManager.upload()

Extends CreateContextsOptions to inherit multi-copy provider selection. Adds upload-specific options: explicit contexts, pre-calculated PieceCID, and abort signal.

Usage patterns:

1. With explicit contexts: { contexts } - uses the given contexts directly
2. Auto-create contexts: { providerIds?, dataSetIds?, count? } - creates/reuses contexts
3. Use default contexts: no options - uses cached default contexts (2 copies)

Extends

• CreateContextsOptions

Properties

callbacks?

optional callbacks: Partial<CombinedCallbacks>

Defined in: packages/synapse-sdk/src/storage/manager.ts:96

Callbacks for both context creation and upload lifecycle

Overrides

CreateContextsOptions.callbacks

---

contexts?

optional contexts: StorageContext[]

Defined in: packages/synapse-sdk/src/storage/manager.ts:93

Pre-created contexts to use. If provided, other selection options are invalid.

---

count?

optional count: number

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

Number of contexts to create (optional, defaults to 2)

Inherited from

CreateContextsOptions.count

---

dataSetIds?

optional dataSetIds: bigint[]

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

Specific data set IDs to use (mutually exclusive with providerIds)

Inherited from

CreateContextsOptions.dataSetIds

---

excludeProviderIds?

optional excludeProviderIds: bigint[]

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

Do not select any of these providers

Inherited from

CreateContextsOptions.excludeProviderIds

---

metadata?

optional metadata: Record<string, string>

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

Custom metadata for data sets (key-value pairs). Used to match existing data sets during provider selection.

Inherited from

CreateContextsOptions.metadata

---

pieceCid?

optional pieceCid: PieceLink

Defined in: packages/synapse-sdk/src/storage/manager.ts:99

Optional pre-calculated PieceCID to skip CommP calculation (verified by server)

---

pieceMetadata?

optional pieceMetadata: Record<string, string>

Defined in: packages/synapse-sdk/src/storage/manager.ts:105

Custom metadata for pieces being uploaded (key-value pairs)

---

providerIds?

optional providerIds: bigint[]

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

Specific provider IDs to use (mutually exclusive with dataSetIds)

Inherited from

CreateContextsOptions.providerIds

---

signal?

optional signal: AbortSignal

Defined in: packages/synapse-sdk/src/storage/manager.ts:102

Optional AbortSignal to cancel the upload

---

withCDN?

optional withCDN: boolean

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

Whether to enable CDN services

Inherited from

CreateContextsOptions.withCDN