Overview
The Synapse SDK is fully typed with TypeScript. This page documents key types used throughout the SDK.Core Types
PieceCID
Content identifier for Filecoin pieces.
Address
Ethereum/Filecoin address (from Viem).
Hash
Transaction hash (from Viem).
Storage Types
UploadResult
Result of a storage upload operation.
CopyResult
Information about a successful copy.
FailedCopy
Information about a failed copy attempt.
StoreResult
Result of a store operation.
CommitResult
Result of a commit operation.
PullResult
Result of a pull operation.
Data Set Types
DataSetInfo
Basic data set information from contract.
EnhancedDataSetInfo
Enhanced data set information with additional details.
Provider Types
PDPProvider
Service provider information.
Callback Types
UploadCallbacks
Callbacks for upload progress.
StorageContextCallbacks
Callbacks for context creation.
Options Types
SynapseOptions
Options for creating a Synapse instance.
CreateContextsOptions
Options for creating multiple contexts.
StorageManagerUploadOptions
Options for StorageManager upload.
Metadata Types
MetadataObject
User-facing metadata format.
MetadataEntry
Internal metadata format for EIP-712.
Payment Types
RailInfo
Payment rail information.
SettlementResult
Payment settlement result.
Service Info Types
StorageInfo
Comprehensive storage service information.
PreflightInfo
Preflight check results.
Utility Types
PullStatus
Pull operation status.
TokenIdentifier
Supported token identifier.
TokenAmount
Token amount in base units.
See Also
- Synapse API - Main SDK interface
- StorageManager - Storage operations
- TypeScript Handbook - TypeScript basics