Index
Synapse Core - Warm Storage Contract Operations
Example
Section titled “Example”import * as WarmStorage from '@filoz/synapse-core/warm-storage'Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| DataSet | Data set type |
| GetDataSetsOptions | - |
| PDPOffering | PDP offering details (decoded from capability k/v pairs) |
| PDPProvider | - |
Type Aliases
Section titled “Type Aliases”| Type Alias | Description |
|---|---|
| AddPiecesOptions | - |
| ClientDataSet | ABI Client data set |
| CreateDataSetAndAddPiecesOptions | - |
| CreateDataSetOptions | - |
| DeletePieceOptions | - |
| getClientDataSetsType | ABI function to get the client data sets |
| GetDataSetOptions | - |
| GetPiecesOptions | - |
| GetProviderOptions | - |
| getProviderType | - |
| Piece | - |
| PollForDeletePieceStatusOptions | - |
| ReadAddressesResult | - |
| ServicePriceResult | - |
| ServiceProviderInfo | - |
| TerminateDataSetOptions | - |
| UploadOptions | - |
Functions
Section titled “Functions”| Function | Description |
|---|---|
| addPieces | Add pieces to a data set |
| createDataSet | Create a data set |
| createDataSetAndAddPieces | Create a data set and add pieces to it |
| deletePiece | Delete a piece from a data set |
| getDataSet | Get a data set by ID |
| getDataSetMetadata | Get the metadata for a data set |
| getDataSets | Get all data sets for a client |
| getPieces | Get the pieces for a data set |
| getProvider | - |
| pollForDeletePieceStatus | Poll for the delete piece status. |
| readAddresses | - |
| readProviders | Get the providers for the warm storage. |
| servicePrice | Get the service price for the warm storage. |
| terminateDataSet | - |
| upload | - |