Skip to content

Synapse SDK - Main entry point

import {
class Synapse
Synapse
} from '@filoz/synapse-sdk'
NamespaceDescription
asChain-
getUploadCosts-
ClassDescription
SynapseClass for interacting with Filecoin storage and other on-chain services
InterfaceDescription
BaseContextOptionsBase options shared by all context creation methods
Chain-
CommitOptionsOptions for committing pieces on-chain
CommitResultResult of a commit operation
ContextCreateContextsOptionsOptions for creating multiple storage contexts via createContexts()
CopyResultResult for a single successful copy of data on a provider
CreateContextsOptionsOptions for creating multiple storage contexts via createContexts()
DataSetDataData set data returned from the API
DataSetInfoData set information returned from Warm Storage contract
DataSetPieceDataIndividual data set piece data from API
EnhancedDataSetInfoEnhanced data set information with chain details and clear ID separation
FailedAttemptA provider attempt that did not produce a successful copy.
PDPProvider-
PieceFetchOptions-
PieceRecordCanonical representation of a piece within a data set.
PieceRetrieverPieceRetriever interface for fetching pieces from various sources Returns standard Web API Response objects for flexibility
PieceStatusStatus 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.
PrepareOptionsOptions for the prepare() method on StorageManager
PrepareResultResult of the prepare() method on StorageManager
ProviderSelectionResultResult of provider selection and data set resolution
PullOptionsOptions for pulling pieces from a source provider
PullResultResult of a pull operation
SettlementResultSettlement result from settling a payment rail
StorageContextCallbacksCallbacks for storage context creation process
StorageContextCreateOptionsOptions for creating or selecting a single storage context via createContext()
StorageInfoComprehensive storage service information
StorageOptionsStorage service options
StorageServiceOptionsOptions for creating or selecting a single storage context via createContext()
StoreOptionsOptions for storing data on a provider without on-chain commit
StoreResultResult of a store operation
SynapseFromClientOptions-
SynapseOptionsOptions for initializing the Synapse instance
UploadCallbacks-
UploadOptionsOptions for uploading individual pieces to an existing storage context
UploadResultResult of a multi-copy upload operation.
UploadTaskUpload task tracking
Type AliasDescription
CopyRoleRole of a copy in a multi-provider upload.
DataSetId-
DownloadOptionsDownload options Currently empty, reserved for future options
FilecoinNetworkTypeSupported Filecoin network types
FundOptionsOptions for the fund() method on PaymentsService. Re-exported from synapse-core.
getUploadCosts-
GetUploadCostsOptionsAlias for the upload costs options type
MetadataEntry-
MetadataObject-
PieceCID-
PrivateKey-
PullSourceSource for pulling pieces from another provider. Either a base URL string or a function that returns a piece URL for a given PieceCID.
PullStatus-
RailInfo-
ServiceProvider-
TokenAmount-
TokenIdentifierToken identifier for balance queries
UploadCostsAlias for the upload costs return type
VariableDescription
calibration-
DEFAULT_CHAIN-
devnet-
mainnet-
METADATA_KEYSCommon metadata keys
SIZE_CONSTANTS-
TIME_CONSTANTS-
TOKENSToken identifiers
FunctionDescription
asChain-
asClient-
formatUnits-
getChain-
parseUnits-