Overview
This page describes the available Synapse packages and how to choose the one that fits your use case.
Packages
Section titled “Packages”| Package | Best for | Builds on |
|---|---|---|
| Synapse SDK | Most applications | Core |
| Synapse React | React applications | Core + Wagmi |
| Synapse Core | Fine-grained control, custom integrations | Viem |
Synapse SDK
Section titled “Synapse SDK”Synapse SDK is the recommended starting point. A single Synapse class coordinates payments, storage, provider discovery, and session keys behind a high-level API.
- Payments: Deposits, withdrawals, operator approvals (Payments Operations Guide →)
- Storage: Upload and download files to storage providers (Storage Operations Guide →)
- Provider Discovery: Query registered storage providers and products
- Session Keys: Delegate signing authority for automated workflows
Synapse Core
Section titled “Synapse Core”Synapse Core composes low-level building blocks that the SDK and React packages build on. Use when you need direct control over individual operations.
- Contract functions - Filecoin Pay, Warm Storage, PDP Verifier, Service Provider Registry
- Storage provider HTTP API: Data set creation, piece uploads, deletions
- PieceCID utilities - Calculate, parse, and validate piece identifiers
- EIP-712 typed data - Sign operations for data set and piece management
Synapse React
Section titled “Synapse React”React hooks for payments, storage, and provider operations. Built on Wagmi and TanStack Query.
Complete Data Flow
Section titled “Complete Data Flow”The sequence below shows the complete lifecycle of a file upload — from initialization through on-chain verification.