Skip to content
Close
SEARCH
Support
Get Started
Support
Get Started
Synapse

Filecoin Synapse SDK

Where Others Store, Synapse Builds.
The SDK for the Onchain Cloud.

Get Started Now

Meet Synapse SDK

The easiest way to build on the Filecoin Onchain Cloud — a verifiable, programmable cloud for data, logic, and payments.

Synapse is a TypeScript SDK for developers who want to integrate decentralized storage and automated payments into their apps with minimal friction; handling blockchain complexity, provider selection, and proofs so you can focus on building — not protocol wiring.

 

zoomed_pink-datacenter

Synapse SDK. Cloud Simplicity. Onchain Guarantees.

TOUCH
Storage Storage, Simplified.

Upload, download, and verify data on Filecoin’s Warm Storage in just a few lines of code.

TOUCH
payments Programmable Payments.

Pay per epoch, per retrieval, or per dataset — all enforced by smart contracts via Filecoin Pay.

TOUCH
Simple Integration Web2 Familiar. Web3 Powerful.

Works with MetaMask, ethers.js, and REST APIs — no blockchain experience required.

TOUCH
Proven cryptography Proven by Cryptography. Every transaction, proof, and payment is verifiable onchain. Transparency comes standard.
TOUCH
puzzle Composable and Extensible.

Use the full Synapse class or import individual modules for fine-grained control.

Synapse Quick Start

A JavaScript/TypeScript SDK for interacting with Filecoin Onchain Cloud - a smart-contract based marketplace for storage and other services in the Filecoin ecosystem. The Synapse SDK provides an interface to Filecoin’s decentralized services ecosystem:

  • Recommended Usage: Use the high-level Synapse class for a streamlined experience with sensible defaults
  • Composable Components: Import and use individual components for fine-grained control over specific functionality

The SDK handles all the complexity of blockchain interactions, provider selection, and data management, so you can focus on building your application.

TOUCH
Synapse Quick Start
Synapse Quick Start

Bash

pnpm install @filoz/synapse-sdk ethers


typescript

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

// Initialize SDK
const synapse = await Synapse.create({
  rpcURL: RPC_URLS.calibration.websocket,
  privateKey: '0x...'
})

// Upload data
const upload = await synapse.storage.upload(
  new TextEncoder().encode('🚀 Welcome to Filecoin Onchain Cloud!')
)
console.log(`Uploaded PieceCID: ${upload.pieceCid}`)

// Download data
const data = await synapse.storage.download(upload.pieceCid)
console.log(new TextDecoder().decode(data))

Tabs are an effective way to organize information on a website page when there is a large amount of content that needs to be separated into distinct categories. Label your tabs with one or two words that define each category of information.

When styling your tabs, highlight the selected tab by giving it a color that differs from your unselected tabs, so that it's easy for your visitors to navigate.

Why Switch to Filecoin DeStor SDK Solutions?

Incorporating decentralized storage with Filecoin DeStor SDK solutions into your development strategy not only optimizes technical performance but also drives meaningful business results.

Improved Operational Efficiency Improved Operational Efficiency Streamlined data management processes lead to reduced downtime and increased productivity.  
Scalable Growth Scalable Growth

Flexible storage solutions support business expansion without significant infrastructure investments.

  
Enhanced Customer Trust Enhanced Customer Trust

Robust data security measures build confidence among users and partners.

  
Cost Savings Cost Savings

Competitive pricing models contribute to a healthier bottom line.

  

Why Devs Choose Synapse SDK

  • Unified Interface: A single SDK for storage, payments, and retrieval.
  • Open Source: Transparent and auditable codebase.
  • Scalable: Connects directly to Filecoin’s global provider network.
  • Compatible: Works with any EVM-compatible stack and browser.
  • Verifiable: Every byte, payment, and retrieval is backed by proof.
rainbow_datacenter

Synapse SDK Architecture at a Glance

Client / SDK → Smart Contracts (Warm Storage, Payments) → Providers (Storage Nodes)
  • Synapse abstracts the blockchain layer.
  • RPC nodes handle reads, writes, and payments.
  • Smart contracts enforce Proof of Data Possession (PDP).
  • Providers store and prove — payments flow automatically.
  • Result: verifiable storage + programmable payments + transparent infrastructure.
background email data center (1)

Get Started with Filecoin Synapse SDK

Cloud Simplicity. Onchain Guarantees.

Start building with Filecoin Synapse SDK.

SYNAPSE DOCS
EXPLORE ON GITHUB
TALK WITH AN EXPERT