Synapse

Synapse SDK - Main entry point

Example

import { Synapse } from '@filoz/synapse-sdk'

Namespaces

Namespace	Description
asChain	-

Classes

Class	Description
CommitError	Primary commit failed - data stored but not on-chain. Thrown when the on-chain commit to the primary provider fails after successful store.
StoreError	Primary store failed - no data stored anywhere. Thrown when the initial upload to the primary provider fails.
Synapse	Class for interacting with Filecoin storage and other on-chain services

Interfaces

Interface	Description
AuthSignature	Signature data for authenticated operations
BaseContextOptions	Base options shared by all context creation methods
Chain	-
CommitOptions	Options for the commit() split operation
CommitResult	Result of a commit() operation
CopyResult	Result of a successful copy to a single provider
CreateContextOptions	Options for creating a single storage context
CreateContextsOptions	Options for creating multiple storage contexts
DataSetData	Data set data returned from the API
DataSetInfo	Data set information returned from Warm Storage contract
DataSetPieceData	Individual data set piece data from API
EnhancedDataSetInfo	Enhanced data set information with chain details and clear ID separation
FailedCopy	Information about a failed copy attempt
PDPProvider	-
PieceRecord	Canonical representation of a piece within a data set.
PieceRetriever	PieceRetriever interface for fetching pieces from various sources Returns standard Web API Response objects for flexibility
PieceStatus	Status information for a piece stored on a provider Note: Proofs are submitted for entire data sets, not individual pieces. The timing information reflects the data set’s status.
PreflightInfo	Preflight information for storage uploads
ProviderSelectionResult	Result of provider selection and data set resolution
PullOptions	Options for the pull() split operation
PullResult	Result of a pull() operation
SettlementResult	Settlement result from settling a payment rail
StorageContextCallbacks	Callbacks for storage context creation process
StorageInfo	Comprehensive storage service information
StorageOptions	Storage service options
StoreOptions	Options for the store() split operation
StoreResult	Result of a store() operation
SubgraphConfig	Configuration for the SubgraphService, determining how to connect to a Synapse-compatible subgraph for provider discovery.
SubgraphRetrievalService	Defines the contract for a service that can retrieve provider information from a data source, typically a Synapse-compatible subgraph.
SynapseFromClientOptions	-
SynapseOptions	Options for initializing the Synapse instance
UploadCallbacks	Callbacks for upload operations
UploadOptions	Options for uploading individual pieces to an existing storage context
UploadResult	Upload result information with multi-copy support.
UploadTask	Upload task tracking

Type Aliases

Type Alias	Description
DataSetId	-
DownloadOptions	Download options Currently empty, reserved for future options
FilecoinNetworkType	Supported Filecoin network types
MetadataEntry	-
MetadataObject	-
PieceCID	-
PrivateKey	-
PullSource	Source for pull operations - either a StorageContext or base URL
PullStatus	-
RailInfo	-
ServiceProvider	-
TokenAmount	-
TokenIdentifier	Token identifier for balance queries
UploadData	Input types for upload operations

Variables

Variable	Description
calibration	-
devnet	-
mainnet	-
METADATA_KEYS	Common metadata keys
SIZE_CONSTANTS	Constants for the Synapse SDK
TIME_CONSTANTS	Constants for the Synapse SDK
TIMING_CONSTANTS	Timing constants for blockchain operations
TOKENS	Token identifiers

Functions

Function	Description
asChain	-
formatUnits	-
getChain	-
parseUnits	-