# warm-storage

Warm Storage Contract Operations

## Example

```ts
import * as WarmStorage from '@filoz/synapse-core/warm-storage'
```

## Interfaces

| Interface | Description |
| ------ | ------ |
| [DataSet](/reference/filoz/synapse-core/warm-storage/interfaces/dataset/) | Data set type |
| [GetDataSetsOptions](/reference/filoz/synapse-core/warm-storage/interfaces/getdatasetsoptions/) | - |
| [PDPOffering](/reference/filoz/synapse-core/warm-storage/interfaces/pdpoffering/) | PDP offering details (decoded from capability k/v pairs) |
| [PDPProvider](/reference/filoz/synapse-core/warm-storage/interfaces/pdpprovider/) | - |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [AddPiecesOptions](/reference/filoz/synapse-core/warm-storage/type-aliases/addpiecesoptions/) | - |
| [ClientDataSet](/reference/filoz/synapse-core/warm-storage/type-aliases/clientdataset/) | ABI Client data set |
| [CreateDataSetAndAddPiecesOptions](/reference/filoz/synapse-core/warm-storage/type-aliases/createdatasetandaddpiecesoptions/) | - |
| [CreateDataSetOptions](/reference/filoz/synapse-core/warm-storage/type-aliases/createdatasetoptions/) | - |
| [DeletePieceOptions](/reference/filoz/synapse-core/warm-storage/type-aliases/deletepieceoptions/) | - |
| [getClientDataSetsType](/reference/filoz/synapse-core/warm-storage/type-aliases/getclientdatasetstype/) | ABI function to get the client data sets |
| [GetDataSetOptions](/reference/filoz/synapse-core/warm-storage/type-aliases/getdatasetoptions/) | - |
| [GetPiecesOptions](/reference/filoz/synapse-core/warm-storage/type-aliases/getpiecesoptions/) | - |
| [GetProviderOptions](/reference/filoz/synapse-core/warm-storage/type-aliases/getprovideroptions/) | - |
| [getProviderType](/reference/filoz/synapse-core/warm-storage/type-aliases/getprovidertype/) | - |
| [Piece](/reference/filoz/synapse-core/warm-storage/type-aliases/piece/) | - |
| [PollForDeletePieceStatusOptions](/reference/filoz/synapse-core/warm-storage/type-aliases/pollfordeletepiecestatusoptions/) | - |
| [ReadAddressesResult](/reference/filoz/synapse-core/warm-storage/type-aliases/readaddressesresult/) | - |
| [ServicePriceResult](/reference/filoz/synapse-core/warm-storage/type-aliases/servicepriceresult/) | - |
| [ServiceProviderInfo](/reference/filoz/synapse-core/warm-storage/type-aliases/serviceproviderinfo/) | - |
| [TerminateDataSetOptions](/reference/filoz/synapse-core/warm-storage/type-aliases/terminatedatasetoptions/) | - |
| [UploadOptions](/reference/filoz/synapse-core/warm-storage/type-aliases/uploadoptions/) | - |

## Functions

| Function | Description |
| ------ | ------ |
| [addPieces](/reference/filoz/synapse-core/warm-storage/functions/addpieces/) | Add pieces to a data set |
| [createDataSet](/reference/filoz/synapse-core/warm-storage/functions/createdataset/) | Create a data set |
| [createDataSetAndAddPieces](/reference/filoz/synapse-core/warm-storage/functions/createdatasetandaddpieces/) | Create a data set and add pieces to it |
| [deletePiece](/reference/filoz/synapse-core/warm-storage/functions/deletepiece/) | Delete a piece from a data set |
| [getDataSet](/reference/filoz/synapse-core/warm-storage/functions/getdataset/) | Get a data set by ID |
| [getDataSetMetadata](/reference/filoz/synapse-core/warm-storage/functions/getdatasetmetadata/) | Get the metadata for a data set |
| [getDataSets](/reference/filoz/synapse-core/warm-storage/functions/getdatasets/) | Get all data sets for a client |
| [getPieces](/reference/filoz/synapse-core/warm-storage/functions/getpieces/) | Get the pieces for a data set |
| [getProvider](/reference/filoz/synapse-core/warm-storage/functions/getprovider/) | - |
| [pollForDeletePieceStatus](/reference/filoz/synapse-core/warm-storage/functions/pollfordeletepiecestatus/) | Poll for the delete piece status. |
| [readAddresses](/reference/filoz/synapse-core/warm-storage/functions/readaddresses/) | - |
| [readProviders](/reference/filoz/synapse-core/warm-storage/functions/readproviders/) | Get the providers for the warm storage. |
| [servicePrice](/reference/filoz/synapse-core/warm-storage/functions/serviceprice/) | Get the service price for the warm storage. |
| [terminateDataSet](/reference/filoz/synapse-core/warm-storage/functions/terminatedataset/) | - |
| [upload](/reference/filoz/synapse-core/warm-storage/functions/upload/) | - |