StorageManager
Defined in: packages/synapse-sdk/src/storage/manager.ts:106
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new StorageManager(
options):StorageManager
Defined in: packages/synapse-sdk/src/storage/manager.ts:118
Creates a new StorageManager
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
options | StorageManagerOptions | The options for the StorageManager StorageManagerOptions |
Returns
Section titled “Returns”StorageManager
Methods
Section titled “Methods”createContext()
Section titled “createContext()”createContext(
options?):Promise<StorageContext>
Defined in: packages/synapse-sdk/src/storage/manager.ts:397
Create a new storage context with specified options
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? | StorageServiceOptions |
Returns
Section titled “Returns”createContexts()
Section titled “createContexts()”createContexts(
options?):Promise<StorageContext[]>
Defined in: packages/synapse-sdk/src/storage/manager.ts:333
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 (
providerIdsorproviderAddresses) - 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
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
options? | CreateContextsOptions | Configuration options CreateContextsOptions |
Returns
Section titled “Returns”Promise resolving to array of storage contexts
download()
Section titled “download()”download(
options):Promise<Uint8Array<ArrayBufferLike>>
Defined in: packages/synapse-sdk/src/storage/manager.ts:215
Download data from storage If context is provided, routes to context.download() Otherwise performs SP-agnostic download
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options | StorageManagerDownloadOptions |
Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike>>
findDataSets()
Section titled “findDataSets()”findDataSets(
options?):Promise<EnhancedDataSetInfo[]>
Defined in: packages/synapse-sdk/src/storage/manager.ts:477
Query data sets for this client
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
options | { address?: `0x${string}`; } | The options for the find data sets |
options.address? | `0x${string}` | The client address, defaults to current signer |
Returns
Section titled “Returns”Promise<EnhancedDataSetInfo[]>
Array of enhanced data set information including management status
getDefaultContext()
Section titled “getDefaultContext()”getDefaultContext():
Promise<StorageContext>
Defined in: packages/synapse-sdk/src/storage/manager.ts:467
Get or create the default context
Returns
Section titled “Returns”getStorageInfo()
Section titled “getStorageInfo()”getStorageInfo():
Promise<StorageInfo>
Defined in: packages/synapse-sdk/src/storage/manager.ts:498
Get comprehensive information about the storage service including approved providers, pricing, contract addresses, and current allowances
Returns
Section titled “Returns”Complete storage service information
preflightUpload()
Section titled “preflightUpload()”preflightUpload(
options):Promise<PreflightInfo>
Defined in: packages/synapse-sdk/src/storage/manager.ts:283
Run preflight checks for an upload without creating a context
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
options | { metadata?: Record<string, string>; size: number; withCDN?: boolean; } | The options for the preflight upload |
options.metadata? | Record<string, string> | The metadata for the preflight upload |
options.size | number | The size of data to upload in bytes |
options.withCDN? | boolean | Whether to enable CDN services |
Returns
Section titled “Returns”Preflight information including costs and allowances
terminateDataSet()
Section titled “terminateDataSet()”terminateDataSet(
options):Promise<`0x${string}`>
Defined in: packages/synapse-sdk/src/storage/manager.ts:489
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
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
options | { dataSetId: bigint; } | The options for the terminate data set |
options.dataSetId | bigint | The ID of the data set to terminate |
Returns
Section titled “Returns”Promise<`0x${string}`>
Transaction hash
upload()
Section titled “upload()”upload(
data,options?):Promise<UploadResult>
Defined in: packages/synapse-sdk/src/storage/manager.ts:138
Upload data to storage Uses the storage contexts or context provided in the options Otherwise creates/reuses default context
Accepts Uint8Array or ReadableStream
Note: Multi-context uploads (uploading to multiple providers simultaneously) currently only support Uint8Array. For streaming uploads with multiple contexts, convert your stream to Uint8Array first or use stream forking (future feature).
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | UploadPieceStreamingData |
options? | StorageManagerUploadOptions |