StorageManagerUploadOptions

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

Upload options for StorageManager.upload() - the all-in-one upload method

This is the “uber-shortcut” method that can handle everything from context creation to piece upload in a single call. It combines:

• Storage context creation options (provider selection, data set creation)
• Upload callbacks (both creation and upload progress)
• Piece-specific metadata

Usage patterns:

1. With explicit context: { context, callbacks?, metadata? } - routes to context.upload()
2. Auto-create context: { providerId?, dataSetId?, withCDN?, callbacks?, metadata? } - creates/reuses context
3. Use default context: { callbacks?, metadata? } - uses cached default context

Extends

• StorageServiceOptions

Properties

callbacks?

optional callbacks: Partial<CombinedCallbacks>

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

Callbacks for creation process

Overrides

StorageServiceOptions.callbacks

---

context?

optional context: StorageContext

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

---

contexts?

optional contexts: StorageContext[]

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

---

dataSetId?

optional dataSetId: bigint

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

Specific data set ID to use (optional)

Inherited from

StorageServiceOptions.dataSetId

---

dev?

optional dev: boolean

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

Whether to include providers with serviceStatus=dev in the capabilities list (default: false)

Inherited from

StorageServiceOptions.dev

---

excludeProviderIds?

optional excludeProviderIds: bigint[]

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

Do not select any of these providers

Inherited from

StorageServiceOptions.excludeProviderIds

---

forceCreateDataSet?

optional forceCreateDataSet: boolean

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

Force creation of a new data set, even if a candidate exists

Inherited from

StorageServiceOptions.forceCreateDataSet

---

metadata?

optional metadata: Record<string, string>

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

Custom metadata for the data set (key-value pairs)

Inherited from

StorageServiceOptions.metadata

---

pieceCid?

optional pieceCid: PieceLink

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

Optional pre-calculated PieceCID to skip CommP calculation (BYO PieceCID, it will be checked by the server)

---

providerAddress?

optional providerAddress: `0x${string}`

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

Specific provider address to use (optional)

Inherited from

StorageServiceOptions.providerAddress

---

providerId?

optional providerId: bigint

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

Specific provider ID to use (optional)

Inherited from

StorageServiceOptions.providerId

---

signal?

optional signal: AbortSignal

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

Optional AbortSignal to cancel the upload

---

uploadBatchSize?

optional uploadBatchSize: number

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

Maximum number of uploads to process in a single batch (default: 32, minimum: 1)

Inherited from

StorageServiceOptions.uploadBatchSize

---

withCDN?

optional withCDN: boolean

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

Whether to enable CDN services

Inherited from

StorageServiceOptions.withCDN

---

withIpni?

optional withIpni: boolean

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

Inherited from

StorageServiceOptions.withIpni