Skip to main content

Synapse SDK

Build decentralized applications on Filecoin with multi-copy storage, integrated payments, and seamless Web3 UX.

Key Features

Synapse SDK provides everything you need to build production-ready applications on Filecoin Onchain Cloud.

Multi-Copy Storage

Automatic redundancy with endorsed and approved storage providers for data durability

Integrated Payments

Built-in payment rails supporting ERC20 tokens and FIL for seamless transactions

Session Keys

Delegated signing for gasless transactions and improved user experience

FilBeam CDN

Fast content delivery through integrated CDN infrastructure

Type-Safe API

TypeScript-first SDK with full type inference and IDE support

Browser & Node.js

Universal compatibility for frontend and backend applications

Quick Start

Install Synapse SDK and create your first storage application in minutes.
npm install @filoz/synapse-sdk viem
import { Synapse } from '@filoz/synapse-sdk'
import { calibration } from '@filoz/synapse-sdk/chains'

// Initialize Synapse client
const synapse = await Synapse.create({
  chain: calibration,
  account: privateKeyToAccount('0x...'),
})

// Upload data with automatic multi-copy redundancy
const result = await synapse.storage.upload(fileData)
console.log('Uploaded to providers:', result.copies)

// Download from any available provider
const data = await synapse.storage.download({ 
  pieceCid: result.copies[0].pieceCid 
})

Continue with Quickstart

Build your first application with step-by-step instructions

Documentation

Explore comprehensive guides and API references to build with Synapse.

Core Concepts

Understand the architecture and key concepts

Guides

Learn how to implement storage and payment features

API Reference

Detailed documentation of all SDK methods

Examples

Real-world examples for common use cases

Smart Contracts

Learn about the underlying smart contracts

React Hooks

Use Synapse with React applications

Community & Support

GitHub

View source code, report issues, and contribute

Examples Repository

Browse example applications and integrations

Build docs developers (and LLMs) love