StorageManager

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

Constructors

Constructor

new StorageManager(
   synapse,
   warmStorageService,
   pieceRetriever,
   withCDN,
   dev,
   withIpni?): StorageManager;

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

Parameters

Parameter	Type
`synapse`	`Synapse`
`warmStorageService`	`WarmStorageService`
`pieceRetriever`	`PieceRetriever`
`withCDN`	`boolean`
`dev`	`boolean`
`withIpni?`	`boolean`

Returns

StorageManager

Methods

createContext()

createContext(options?): Promise<StorageContext>;

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

Create a new storage context with specified options

Parameters

Parameter	Type
`options?`	`StorageServiceOptions`

Returns

Promise<StorageContext>

download()

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

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

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:315

Query data sets for this client

Parameters

Parameter	Type	Description
`clientAddress?`	`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:306

Get or create the default context

Returns

Promise<StorageContext>

getStorageInfo()

getStorageInfo(): Promise<StorageInfo>;

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

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:212

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<TransactionResponse>;

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

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`	`number`	The ID of the data set to terminate

Returns

Promise<TransactionResponse>

Transaction response

upload()

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

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

Upload data to storage If context is provided, routes to context.upload() Otherwise creates/reuses default context

Parameters

Parameter	Type
`data`	\| `ArrayBuffer` \| `Uint8Array`<`ArrayBufferLike`>
`options?`	`StorageManagerUploadOptions`

Returns

Promise<UploadResult>