warm-storage
Warm Storage Contract Operations
Example
Section titled “Example”import * as WarmStorage from '@filoz/synapse-core/warm-storage'Namespaces
Section titled “Namespaces”Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| DataSet | Data set type |
| Events | - |
| GetDataSetsOptions | - |
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 | - |
| Piece | - |
| PieceInputWithMetadata | - |
| PullPieceInput | Input piece for a pull request with typed PieceCID. |
| PullToExistingDataSetOptions | Options for pulling pieces into an existing data set. |
| PullToNewDataSetOptions | Options for creating a new data set and pulling pieces into it. |
| ReadAddressesResult | - |
| TerminateDataSetOptions | - |
| UploadOptions | - |
| WaitForDeletePieceStatusOptions | - |
Functions
Section titled “Functions”| Function | Description |
|---|---|
| addApprovedProvider | Add an approved provider for the client |
| addApprovedProviderCall | Create a call to the addApprovedProvider function |
| addApprovedProviderSync | Add an approved provider for the client and wait for confirmation |
| 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 |
| extractAddApprovedProviderEvent | Extracts the ProviderApproved event from transaction logs |
| extractRemoveApprovedProviderEvent | Extracts the ProviderUnapproved event from transaction logs |
| getAllDataSetMetadata | Get all metadata for a data set formatted as a MetadataObject |
| getAllDataSetMetadataCall | Create a call to the getAllDataSetMetadata function |
| getAllPieceMetadata | Get all metadata for a piece formatted as a MetadataObject |
| getAllPieceMetadataCall | Create a call to the getAllPieceMetadata function |
| getApprovedProviders | Get approved provider IDs with optional pagination |
| getApprovedProvidersCall | Create a call to the getApprovedProviders function |
| getDataSet | Get a data set by ID |
| getDataSets | Get all data sets for a client |
| getPieces | Get the pieces for a data set |
| getServicePrice | Get the service price for the warm storage |
| getServicePriceCall | Create a call to the getServicePrice function |
| parseAllDataSetMetadata | Parse the contract output into a MetadataObject |
| parseAllPieceMetadata | Parse the contract output into a MetadataObject |
| pullPieces | - |
| readAddresses | - |
| removeApprovedProvider | Remove an approved provider for the client |
| removeApprovedProviderCall | Create a call to the removeApprovedProvider function |
| removeApprovedProviderSync | Remove an approved provider for the client and wait for confirmation |
| terminateDataSet | - |
| upload | - |
| waitForDeletePieceStatus | Wait for the delete piece status. |
| waitForPullStatus | Wait for pull completion. |