sp

Service Provider HTTP Operations

Example

import * as SP from '@filoz/synapse-core/sp'

Namespaces

Namespace	Description
addPieces	-
createDataSetAndAddPieces	-
deletePiece	-
downloadPiece	-
findPiece	-
getDataSet	-
schedulePieceDeletion	-
uploadPiece	-
waitForAddPieces	-
waitForCreateDataSet	-
waitForCreateDataSetAddPieces	-

Classes

Class	Description
AbortError	-
NetworkError	-
TimeoutError	-

Interfaces

Interface	Description
Events	-

Type Aliases

Type Alias	Description
AddPiecesOutput	-
AddPiecesPending	-
AddPiecesRejected	-
AddPiecesResponse	-
AddPiecesSuccess	-
CreateDataSetAndAddPiecesOptions	-
CreateDataSetOptions	-
CreateDataSetPending	-
CreateDataSetRejected	-
CreateDataSetResponse	-
CreateDataSetSuccess	-
DataSet	Data set from the PDP API.
deletePiece	Delete a piece from a data set on the PDP API.
UploadOptions	-
UploadPieceResponse	-
UploadPieceStreamingOptions	-

Variables

Variable	Description
AddPiecesPendingSchema	-
AddPiecesRejectedSchema	-
AddPiecesSuccessSchema	-
CreateDataSetPendingSchema	-
CreateDataSetRejectedSchema	-
CreateDataSetSuccessSchema	-
DataSetSchema	-

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
downloadPiece	Download a piece and verify from the PDP API.
findPiece	Find a piece on the PDP API.
getDataSet	Get a data set from the PDP API.
ping	Ping the PDP API.
schedulePieceDeletion	Schedule a piece deletion
upload	-
uploadPiece	Upload a piece to the PDP API.
uploadPieceStreaming	Upload piece data using the 3-step CommP-last streaming protocol.
waitForAddPieces	Wait for the add pieces status.
waitForCreateDataSet	Wait for the data set creation status.
waitForCreateDataSetAddPieces	Wait for the data set creation status.