StorageContextCreateOptions

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

Options for creating or selecting a storage context

Used by StorageManager.createContext() and indirectly by StorageManager.upload() when auto-creating contexts. Allows specification of:

• Provider selection (by ID or address)
• Data set selection or creation
• CDN enablement and metadata
• Creation process callbacks

Extends

• StorageServiceOptions

Properties

callbacks?

optional callbacks: StorageContextCallbacks

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

Callbacks for creation process

Inherited from

StorageServiceOptions.callbacks

---

dataSetId?

optional dataSetId: bigint

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

Specific data set ID to use (optional)

Inherited from

StorageServiceOptions.dataSetId

---

excludeProviderIds?

optional excludeProviderIds: bigint[]

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

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

---

providerAddress?

optional providerAddress: `0x${string}`

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

Specific provider address to use (optional)

Inherited from

StorageServiceOptions.providerAddress

---

providerId?

optional providerId: bigint

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

Specific provider ID to use (optional)

Inherited from

StorageServiceOptions.providerId

---

synapse

synapse: Synapse

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

The Synapse instance

---

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

---

warmStorageService

warmStorageService: WarmStorageService

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

The WarmStorageService instance

---

withCDN?

optional withCDN: boolean

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

Whether to enable CDN services

Inherited from

StorageServiceOptions.withCDN

---

withIpni?

optional withIpni: boolean

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

Inherited from

StorageServiceOptions.withIpni