sp

Service Provider HTTP Operations

Example

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

Namespaces

Namespace	Description
addPieces	-
addPiecesApiRequest	-
addPiecesFits	-
checkAddPiecesFit	-
createDataSet	-
createDataSetAndAddPieces	-
createDataSetAndAddPiecesApiRequest	-
createDataSetApiRequest	-
createPieceBatcher	-
deletePiece	-
deletePieces	-
findPiece	-
getDataSet	-
maxFittingPieces	-
ping	-
pullPieces	-
pullPiecesApiRequest	-
schedulePieceDeletion	-
schedulePieceDeletions	-
terminateService	-
terminateServiceApiRequest	-
upload	-
uploadPiece	-
uploadPieces	-
uploadPieceStreaming	-
waitForAddPieces	-
waitForCreateDataSet	-
waitForCreateDataSetAddPieces	-
waitForFlushReceipt	-
waitForPullPieces	-
waitForPullPiecesApiRequest	-
waitForSubmission	-
waitForTerminateService	-

Classes

Class	Description
AbortError	-
NetworkError	-
TimeoutError	-

Type Aliases

Type Alias	Description
AddPiecesFitResult	Why a piece list does not fit in one addPieces / createAndAdd message.
BasePullPiecesOptions	Base options for pulling pieces.
CreateDataSetAndAddPiecesOptions	-
DataSet	Data set from the PDP API.
EnqueuePiece	-
FlushResult	-
Limiter	`true` if `pieces` still fit in one addPieces / createAndAdd operation.
LimiterOptions	-
LimiterPiece	-
OnParked	Called after the piece is on this SP, before it joins the addPieces window. The callback is awaited, so a thrown error keeps the piece out of the batch (retry with PieceBatcher.enqueue). PieceBatcher.close waits for it the same way it waits for park/pull I/O.
PieceBatcher	-
PieceBatcherWait	When to flush a tumbling addPieces window (limiter overflow, `flush()`, and `close()` always flush regardless).
PieceResult	-
PullInput	-
PullPieceInput	Input piece for a pull request with typed PieceCID.
PullPieceResult	Status of one input piece, matched back to its position in the `pieces` input.
PullToExistingDataSetOptions	Options for pulling pieces into an existing data set.
PullToNewDataSetOptions	Options for creating a new data set and pulling pieces into it.
TerminateServiceStatusPending	-
TerminateServiceStatusResponse	-
TerminateServiceStatusSuccess	-
UploadInput	-
UploadPieceStreamingData	-
UploadResult	-

Variables

Variable	Description
DataSetSchema	-
TerminateServiceStatusPendingSchema	Schema for the termination status while the provider’s transaction is pending. The hash is empty until the provider’s relay task sends the transaction.
TerminateServiceStatusSuccessSchema	Schema for the confirmed termination status. The hash may be empty when the service was already terminated on chain without a provider transaction.

Functions

Function	Description
addPieces	Add pieces to a data set
addPiecesApiRequest	Add pieces to a data set on the PDP API.
addPiecesFits	Whether a candidate piece list fits in one addPieces / createAndAdd message.
assertAddPiecesFit	Throw if `pieces` is empty, a PieceCID is outside Curio’s size bounds, or the list does not fit in one addPieces / createAndAdd message.
assertPieceCidSize	Throw if a PieceCID’s encoded raw size is outside Curio’s upload bounds (SIZE_CONSTANTS.MIN_UPLOAD_SIZE–SIZE_CONSTANTS.MAX_UPLOAD_SIZE).
assertPieceValid	Throw if a piece can never be added: its PieceCID size is outside Curio’s upload bounds or its metadata exceeds the contract limits. Use it to reject bad pieces before any network work.
checkAddPiecesFit	Whether a candidate piece list fits in one addPieces / createAndAdd message, and why not.
createDataSet	Create a data set
createDataSetAndAddPieces	Create a data set and add pieces to it
createDataSetAndAddPiecesApiRequest	Create a data set and add pieces to it on PDP API
createDataSetApiRequest	Create a data set on PDP API
createPieceBatcher	Create a stateful piece batcher that parks/pulls immediately and coalesces addPieces.
~~deletePiece~~	Delete one piece from a data set on the PDP API.
deletePieces	Delete pieces from a data set on the PDP API in one transaction.
estimateAddPiecesCalldataSize	Estimated on-chain calldata size in bytes for the given piece list.
findPiece	Find a piece on the PDP API.
~~getDataSet~~	Get a data set from the PDP API.
maxFittingPieces	Length of the longest prefix of `options.pieces` that fits in one addPieces / createAndAdd message.
ping	Ping the PDP API.
pullPieces	Pull pieces from external storage providers into a data set.
pullPiecesApiRequest	Initiate a piece pull request or get status of an existing one.
~~schedulePieceDeletion~~	Schedule one piece deletion.
schedulePieceDeletions	Schedule piece deletions in one transaction.
terminateService	Terminate a data set service via the service provider
terminateServiceApiRequest	Request data set termination on the PDP API.
terminateServiceStatusUrl	Build the termination status URL for a data set, pollable with waitForTerminateService. Useful for resuming tracking of a previously requested termination.
upload	Upload multiple pieces to a data set on the PDP API.
uploadPiece	Upload a piece to the PDP API.
uploadPieces	Upload pieces to an existing data set and add them in one signed request.
uploadPieceStreaming	Upload piece data using the 3-step CommP-last streaming protocol.
validateDeletePiecesBatch	Validate a delete-pieces batch before signing or sending it.
waitForAddPieces	Wait for an add pieces transaction on chain, following replace-by-fee replacements.
waitForCreateDataSet	Wait for a create data set transaction on chain, following replace-by-fee replacements.
waitForCreateDataSetAddPieces	Wait for a create data set and add pieces transaction on chain, following replace-by-fee replacements.
waitForFlushReceipt	Wait for a flushed batch to land on chain and get its piece IDs.
waitForPullPieces	Wait for pull pieces completion.
waitForPullPiecesApiRequest	Wait for pull pieces completion API request.
waitForTerminateService	Wait for the data set termination status.