BaseContextOptions
Defined in: packages/synapse-sdk/src/types.ts:352
Base options shared by all context creation methods
Contains fields common to both single and multi-context creation: CDN enablement, metadata matching, and creation callbacks.
Extended by
Section titled “Extended by”Properties
Section titled “Properties”callbacks?
Section titled “callbacks?”
optionalcallbacks?:StorageContextCallbacks
Defined in: packages/synapse-sdk/src/types.ts:372
Callbacks for creation process
cdnGroup?
Section titled “cdnGroup?”
optionalcdnGroup?:string
Defined in: packages/synapse-sdk/src/types.ts:363
CDN group id used as the withCDN metadata value when CDN is enabled. Every context (primary
and secondaries) that shares this value resolves to the same shared CDN bandwidth rail in FWSS
(keyed by keccak256(payer, cdnGroup)), so a multi-copy CDN upload buys bandwidth once instead
of once per copy. Opt-in and empty by default, which keeps a dedicated bandwidth rail per data
set and preserves exact-metadata reuse.
metadata?
Section titled “metadata?”
optionalmetadata?:Record<string,string>
Defined in: packages/synapse-sdk/src/types.ts:369
Custom metadata for data sets (key-value pairs). Used to match existing data sets during provider selection.
withCDN?
Section titled “withCDN?”
optionalwithCDN?:boolean
Defined in: packages/synapse-sdk/src/types.ts:354
Whether to enable CDN services