StorageManager

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

Constructors

Constructor

new StorageManager(synapse, warmStorageService, pieceRetriever, withCDN): StorageManager

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

Parameters

Parameter	Type
`synapse`	`Synapse`
`warmStorageService`	`WarmStorageService`
`pieceRetriever`	`PieceRetriever`
`withCDN`	`boolean`

Returns

StorageManager

Methods

createContext()

createContext(options?): Promise<StorageContext>

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

Create a single storage context with specified options

Uses singular providerId and dataSetId to match single-context semantics. For creating multiple contexts, use createContexts() with plural options.

Parameters

Parameter	Type
`options?`	`CreateContextOptions`

Returns

Promise<StorageContext>

Example

// Create context for specific provider
const ctx = await storage.createContext({ providerId: 1n })

// Create context for specific data set
const ctx = await storage.createContext({ dataSetId: 5n })

// Let smart selection choose (with CDN enabled)
const ctx = await storage.createContext({ withCDN: true })

createContexts()

createContexts(options?): Promise<StorageContext[]>

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

Creates storage contexts for multi-provider storage deals and other operations.

By storing data with multiple independent providers, you reduce dependency on any single provider and improve overall data availability. Use contexts together as a group.

Contexts are selected by priority:

Specified datasets (dataSetIds) - uses their existing providers
Specified providers (providerIds or providerAddresses) - finds or creates matching datasets
Automatically selected from remaining approved providers

For automatic selection, existing datasets matching the metadata are reused unless forceCreateDataSets is true. Providers are randomly chosen to distribute across the network.

Parameters

Parameter	Type	Description
`options?`	`CreateContextsOptions`	Configuration options CreateContextsOptions

Returns

Promise<StorageContext[]>

Promise resolving to array of storage contexts

download()

download(pieceCid, options?): Promise<Uint8Array<ArrayBufferLike>>

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

Download data from storage If context is provided, routes to context.download() Otherwise performs SP-agnostic download

Parameters

Parameter	Type
`pieceCid`	`string` \| `PieceLink`
`options?`	`StorageManagerDownloadOptions`

Returns

Promise<Uint8Array<ArrayBufferLike>>

findDataSets()

findDataSets(clientAddress?): Promise<EnhancedDataSetInfo[]>

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

Query data sets for this client

Parameters

Parameter	Type	Description
`clientAddress?`	`0x${string}`	Optional client address, defaults to current signer

Returns

Promise<EnhancedDataSetInfo[]>

Array of enhanced data set information including management status

getDefaultContext()

getDefaultContext(): Promise<StorageContext>

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

Get or create the default context

Returns

Promise<StorageContext>

getStorageInfo()

getStorageInfo(): Promise<StorageInfo>

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

Get comprehensive information about the storage service including approved providers, pricing, contract addresses, and current allowances

Returns

Promise<StorageInfo>

Complete storage service information

preflightUpload()

preflightUpload(size, options?): Promise<PreflightInfo>

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

Run preflight checks for an upload without creating a context

Parameters

Parameter	Type	Description
`size`	`number`	The size of data to upload in bytes
`options?`	{ `metadata?`: `Record`<`string`, `string`>; `withCDN?`: `boolean`; }	Optional settings including withCDN flag and/or metadata
`options.metadata?`	`Record`<`string`, `string`>	-
`options.withCDN?`	`boolean`	-

Returns

Promise<PreflightInfo>

Preflight information including costs and allowances

terminateDataSet()

terminateDataSet(dataSetId): Promise<`0x${string}`>

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

Terminate a data set with given ID that belongs to the synapse signer. This will also result in the removal of all pieces in the data set.

Parameters

Parameter	Type	Description
`dataSetId`	`bigint`	The ID of the data set to terminate

Returns

Promise<`0x${string}`>

Transaction hash

upload()

upload(data, options?): Promise<UploadResult>

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

Upload data to Filecoin Onchain Cloud using a store→pull→commit flow across multiple providers.

By default, uploads to 2 providers (primary + secondary) for redundancy. Data is uploaded once to the primary, then secondaries pull from the primary via SP-to-SP transfer.

Important: This method only throws if zero copies succeed. Individual copy failures (including primary) are recorded in result.failures. Always check result.copies.length against your requested count. See UploadResult for details on interpreting results.

For large files, prefer streaming to minimize memory usage.

For uploading multiple files, use the split operations API directly: createContexts() → store() → presignForCommit() → pull() → commit()

Parameters

Parameter	Type	Description
`data`	`UploadData`	Data to upload (Uint8Array or ReadableStream)
`options?`	`StorageManagerUploadOptions`	Upload options including count, provider selection, callbacks

Returns

Promise<UploadResult>

Upload result with copies array and any failures - check copies.length

Throws

StoreError if primary store fails (before any data is committed)

Throws

CommitError if all commit attempts fail (data stored but not on-chain)