Upload Pipeline

What You’ll Learn

How to upload data to Filecoin Onchain Cloud, from the simplest one-liner to full manual control over each phase. Pick the level of control you need:

1. upload() handles everything automatically (most users)
2. Split operations give you manual control over store, pull, and commit phases

Simple Upload

Upload data with a single call. The SDK selects providers and handles multi-copy replication automatically:

import { Synapse } from "@filoz/synapse-sdk";
import { privateKeyToAccount } from 'viem/accounts'

const synapse = Synapse.create({ account: privateKeyToAccount('0x...'), source: 'my-app' });

const data = new Uint8Array([1, 2, 3, 4, 5])

const { pieceCid, size, complete, copies, failedAttempts } = await synapse.storage.upload(data)

console.log("PieceCID:", pieceCid.toString())
console.log("Size:", size, "bytes")
console.log("Stored on", copies.length, "providers")

for (const copy of copies) {
  console.log(`  Provider ${copy.providerId}: role=${copy.role}, dataSet=${copy.dataSetId}`)
}

if (!complete) {
  console.warn("Some copies failed:", failedAttempts)
}

Copy to clipboard

Always check the result

upload() returns a result as long as at least one copy commits on-chain. It only throws when zero copies succeed. You must check complete to know whether all requested copies were stored.

The result contains:

• complete - true when all requested copies were stored and committed on-chain. This is the primary field to check.
• requestedCopies - the number of copies that were requested (default: 2)
• pieceCid - content address of your data, used for downloads
• size - size of the uploaded data in bytes
• copies - array of successful copies, each with providerId, dataSetId, pieceId, role ('primary' or 'secondary'), retrievalUrl, and isNewDataSet
• failedAttempts - providers that were tried but did not produce a copy. The SDK retries failed secondaries with alternate providers, so a non-empty array often just means a provider was swapped out. These are diagnostic, check complete for the actual outcome.

Uploading Multiple Files

Piece batching is enabled by default. Compatible uploads that run concurrently can share an on-chain transaction when they use the same provider and data set. Each provider maintains its own batch.

The SDK automatically splits compatible concurrent uploads according to the encoded Filecoin message-size budget. Legacy data sets additionally have an 80-piece safety cap. Start uploads together without manually grouping them or waiting between groups. See Larger, Cheaper Storage Batches for details.

For browser File objects, start the uploads together to give them an opportunity to join the same batch:

const results = await Promise.all(
  files.map((file) => synapse.storage.upload(file.stream()))
)

Copy to clipboard

Sequential uploads cannot share a batch because each call waits for its own on-chain confirmation before the next call starts:

for (const file of files) {
  await synapse.storage.upload(file.stream())
}

Copy to clipboard

By default, the SDK submits a batch after a zero-delay window once its uploads and pulls finish parking. You can instead hold compatible pieces until the next piece would exceed a piece-count cap or encoded message-size budget, or until you explicitly flush them:

const synapse = Synapse.create({
  account: privateKeyToAccount("0x..."),
  source: 'my-app',
  pieceBatching: { wait: { kind: "limiter" } },
})

const resultsPromise = Promise.allSettled(
  files.map((file) => synapse.storage.upload(file.stream()))
)
await synapse.storage.flush()
const results = await resultsPromise

Copy to clipboard

flush() waits for accepted uploads and pulls to finish parking, then submits their pending batch windows. It does not report whether every upload was submitted or confirmed successfully. Inspect the settled results for rejections and check complete on fulfilled upload results. Start uploads before flushing; awaiting an upload first in limiter mode can leave it waiting indefinitely.

Compatible uploads can report the same transaction hash in their callbacks. Batched secondary pulls sign their per-piece authorization separately from the eventual commit batch, so interactive wallets can prompt again at commit time. To reuse one signature for pull and commit, disable batching or use the split operations with the same presigned extraData.

Set pieceBatching: false when creating Synapse to disable batching. Use the split operations when you need manual control over provider selection, signing, or each store, pull, and commit phase.

Upload with Metadata

Attach metadata to organize uploads. The SDK reuses existing data sets when metadata matches, avoiding duplicate payment rails:

import { Synapse } from "@filoz/synapse-sdk";
import { privateKeyToAccount } from 'viem/accounts'

const synapse = Synapse.create({ account: privateKeyToAccount('0x...'), source: 'my-app' });

const data = new TextEncoder().encode("Hello, Filecoin!")

const result = await synapse.storage.upload(data, {
  metadata: {
    Application: "My DApp",
    Version: "1.0.0",
    Category: "Documents",
  },
  pieceMetadata: {
    filename: "hello.txt",
    contentType: "text/plain",
  },
})

console.log("Uploaded:", result.pieceCid.toString())

Copy to clipboard

Subsequent uploads with the same metadata reuse the same data sets and payment rails.

Prepare Before Uploading

Before your first upload, call prepare() to ensure your account is funded and the storage service is approved. It computes the exact deposit needed and returns a single transaction to execute:

import { Synapse } from "@filoz/synapse-sdk"
import { privateKeyToAccount } from "viem/accounts"

const synapse = Synapse.create({ account: privateKeyToAccount("0x...") })

const prep = await synapse.storage.prepare({ pieceSizes: [1073741824n] }) // one 1 GiB piece
if (prep.transaction) {
  await prep.transaction.execute()
}

Copy to clipboard

See the Storage Costs guide for a full breakdown.

Controlling Copy Count

Adjust the number of copies for your durability requirements:

import { Synapse } from "@filoz/synapse-sdk"
import { privateKeyToAccount } from "viem/accounts"

const synapse = Synapse.create({ account: privateKeyToAccount("0x..."), source: 'my-app' })

const data = new Uint8Array(256)

// Store 3 copies for higher redundancy
const result3 = await synapse.storage.upload(data, { copies: 3 })
console.log("3 copies:", result3.copies.length)

// Store a single copy when redundancy isn't needed
const result1 = await synapse.storage.upload(data, { copies: 1 })
console.log("1 copy:", result1.copies.length)

Copy to clipboard

The default is 2 copies. The first copy is stored on an endorsed provider (high trust, curated), and secondary copies are stored with approved providers, which pull the data from the primary via SP-to-SP transfer.

Upload with Callbacks

Track the lifecycle of a multi-copy upload with callbacks:

import { Synapse } from "@filoz/synapse-sdk"
import { privateKeyToAccount } from "viem/accounts"

const synapse = Synapse.create({ account: privateKeyToAccount("0x..."), source: 'my-app' })

const data = new Uint8Array(1024) // 1KB of data

const result = await synapse.storage.upload(data, {
  callbacks: {
    onStored: (providerId, pieceCid) => {
      console.log(`Data stored on provider ${providerId}`)
    },
    onCopyComplete: (providerId, pieceCid) => {
      console.log(`Secondary copy complete on provider ${providerId}`)
    },
    onCopyFailed: (providerId, pieceCid, error) => {
      console.warn(`Copy failed on provider ${providerId}:`, error.message)
    },
    onPullProgress: (providerId, pieceCid, status) => {
      console.log(`Pull to provider ${providerId}: ${status}`)
    },
    onPiecesAdded: (txHash, providerId, pieces) => {
      console.log(`On-chain commit submitted: ${txHash}`)
    },
    onPiecesConfirmed: (dataSetId, providerId, pieces) => {
      console.log(`Confirmed on-chain: dataSet=${dataSetId}, provider=${providerId}`)
    },
    onProgress: (bytesUploaded) => {
      console.log(`Uploaded ${bytesUploaded} bytes`)
    },
  },
})

Copy to clipboard

Callback lifecycle:

1. onProgress - fires during upload to primary provider
2. onStored - primary upload complete, piece parked on SP
3. onPullProgress - SP-to-SP transfer status for secondaries
4. onCopyComplete / onCopyFailed - secondary pull result
5. onPiecesAdded - commit transaction submitted
6. onPiecesConfirmed - commit confirmed on-chain

Understanding the Result

upload() is designed around partial success over atomicity: it commits whatever succeeded rather than throwing away successful work. This means the return value is the primary interface for understanding what happened.

When upload() throws

upload() only throws in these cases:

Error	What happened	What to do
StoreError	Primary upload failed	Retry the upload
CommitError	Data is stored on providers but all on-chain commits failed	Use split operations to retry commit() without re-uploading
Selection error	No endorsed provider available or reachable	Check provider health / network

When upload() returns

If upload() returns (no throw), at least one copy is committed on-chain. But the result may contain fewer copies than requested. Every copy in copies[] represents a committed on-chain data set that the user is now paying for.

import { Synapse } from "@filoz/synapse-sdk"
import { privateKeyToAccount } from "viem/accounts"

const synapse = Synapse.create({ account: privateKeyToAccount("0x..."), source: 'my-app' })

const data = new Uint8Array(256)

const result = await synapse.storage.upload(data, { copies: 2 })

// Check overall success: complete === true means all requested copies succeeded
if (!result.complete) {
  console.warn(`Only ${result.copies.length}/${result.requestedCopies} copies succeeded`)
  for (const attempt of result.failedAttempts) {
    console.warn(`  Provider ${attempt.providerId} (${attempt.role}): ${attempt.error}`)
  }
}

// Every copy is committed and being paid for
for (const copy of result.copies) {
  console.log(`Provider ${copy.providerId}, dataset ${copy.dataSetId}, piece ${copy.pieceId}`)
}

Copy to clipboard

Auto-retry behavior

For auto-selected providers (no explicit providerIds or dataSetIds), the SDK automatically retries failed secondaries with alternate providers up to 5 times. If you explicitly specify providers, the SDK respects your choice and does not retry.

Split Operations

When You Need This

The high-level upload() handles single-piece multi-copy uploads end-to-end. Use split operations when you need:

• Batch uploading many files to specific providers without repeated context creation
• Custom error handling at each phase, with the ability to retry store failures, skip failed secondaries, or recover from commit failures without re-uploading
• Signing control to avoid multiple wallet signature prompts during multi-copy uploads
• Greater provider/dataset targeting for uploading to known providers

Key Benefit

In the split operations pipeline, your client uploads data once to the primary provider. Secondary providers fetch directly from the primary via SP-to-SP transfer, so your upload bandwidth is used only once regardless of copy count.

	upload()	Split Operations
Control	Automatic	Manual per-phase
Error recovery	Re-upload on commit failure	Retry commit without re-upload
Batch files	One call per file	Store many, commit in batch
Wallet prompts	Managed internally	Control via presignForCommit()
Best for	Most use cases	Production pipelines, custom UX

The Pipeline

Every upload goes through three phases:

store --> pull --> commit
  |         |         |
  |         |         +-- On-chain: create dataset, add piece, start payments
  |         +-- SP-to-SP: secondary provider fetches from primary
  +-- Upload: bytes sent to one provider (no on-chain state yet)

Copy to clipboard

• store: Upload bytes to a single SP. Returns { pieceCid, size }. The piece is “parked” on the SP but not yet on-chain and subject to garbage collection if not committed.
• pull: SP-to-SP transfer. The destination SP fetches the piece from a source SP. No client bandwidth used.
• commit: Submit an on-chain transaction to add the piece to a data set. Creates the data set and payment rail if needed.

Store Phase

Upload data to a provider without committing on-chain:

const contexts = await synapse.storage.createContexts({
  copies: 2,
})
const [primary, secondary] = contexts

const { pieceCid, size } = await primary.store(data, {
  pieceCid: preCalculatedCid,       // skip expensive PieceCID (hash digest) calculation (optional)
  signal: abortController.signal,   // cancellation (optional)
  onProgress: (bytes) => {          // progress callback (optional)
    console.log(`Uploaded ${bytes} bytes`)
  },
})

console.log(`Stored: ${pieceCid}, ${size} bytes`)

Copy to clipboard

store() accepts Uint8Array or ReadableStream<Uint8Array>. Use streaming for large files to minimize memory.

After store completes, the piece is parked on the SP and can be:

• Retrieved via the context’s getPieceUrl(pieceCid)
• Pulled to other providers via pull()
• Committed on-chain via commit()

Pull Phase (SP-to-SP Transfer)

Request a secondary provider to fetch pieces from the primary:

// Pre-sign to avoid double wallet prompts during pull + commit
const extraData = await secondary.presignForCommit([{ pieceCid }])

const pullResult = await secondary.pull({
  pieces: [pieceCid],
  from: (cid) => primary.getPieceUrl(cid), // source URL builder (or URL string)
  extraData,                               // pre-signed auth (optional, reused for commit)
  signal: abortController.signal,          // cancellation (optional)
  onProgress: (cid, status) => {           // status callback (optional)
    console.log(`${cid}: ${status}`)
  },
})

if (pullResult.status !== "complete") {
  for (const piece of pullResult.pieces) {
    if (piece.status === "failed") {
      console.error(`Failed to pull ${piece.pieceCid}`)
    }
  }
}

Copy to clipboard

The from parameter accepts either a URL string (base service URL) or a function that returns a piece URL for a given PieceCID.

pullResult.pieces has one entry per input piece, in input order, and each entry’s index is its position in pieces. Set dedupe: true to send each PieceCID only once: repeated inputs share the first one’s status and are listed in pullResult.dropped. When you pass a pre-signed extraData with dedupe, sign it over the deduped pieces.

Pre-signing: presignForCommit() creates an EIP-712 signature that can be reused for both pull() and commit(). This avoids prompting the wallet twice. Pass the same extraData to both calls.

Commit Phase

Add pieces to an on-chain data set. Creates the data set and payment rail if one doesn’t exist:

// Commit on both providers
const [primaryCommit, secondaryCommit] = await Promise.allSettled([
  primary.commit({
    pieces: [{ pieceCid, pieceMetadata: { filename: "doc.pdf" } }],
    signal: abortController.signal, // cancellation (optional)
    onSubmitted: (txHash) => {
      console.log(`Transaction submitted: ${txHash}`)
    },
  }),
  secondary.commit({
    pieces: [{ pieceCid, pieceMetadata: { filename: "doc.pdf" } }],
    extraData,          // pre-signed auth from presignForCommit() (optional)
    signal: abortController.signal, // cancellation (optional)
    onSubmitted: (txHash) => {
      console.log(`Transaction submitted: ${txHash}`)
    },
  })
])

if (primaryCommit.status === "fulfilled") {
  console.log(`Primary: dataSet=${primaryCommit.value.dataSetId}`)
}
if (secondaryCommit.status === "fulfilled") {
  console.log(`Secondary: dataSet=${secondaryCommit.value.dataSetId}`)
}

Copy to clipboard

The result:

• txHash - transaction hash
• pieceIds - assigned piece IDs (one per input piece)
• dataSetId - data set ID (may be newly created)
• isNewDataSet - whether a new data set was created

Cancellation: aborting signal after onSubmitted only stops waiting for confirmation. The transaction can still land on chain. If the commit was creating a data set, the context does not learn the new data set ID, so calling commit() on it again creates another data set.

Multi-File Batch Example

Batch Strategy

The pattern below follows an optimal sequence: (1) store all files on the primary first so they’re available for pull, (2) pre-sign once for all pieces on the secondary, (3) pull all pieces in a single call, (4) commit on both providers in parallel. This minimizes wallet prompts and maximizes parallelism.

Upload multiple files to 2 providers with full error handling:

import { Synapse, type PieceCID } from "@filoz/synapse-sdk"
import { privateKeyToAccount } from "viem/accounts"

const synapse = Synapse.create({ account: privateKeyToAccount("0x.."), source: "my-app" })

const files = [
  new TextEncoder().encode("File 1 content..."),
  new TextEncoder().encode("File 2 content..."),
  new TextEncoder().encode("File 3 content..."),
]

// Create contexts for 2 providers
const [primary, secondary] = await synapse.storage.createContexts({
  copies: 2,
  metadata: { source: "batch-upload" },
})

// Store all files on primary (note: these could be done in parallel w/ Promise.all)
const stored: { pieceCid: PieceCID; size: number }[] = []
for (const file of files) {
  const result = await primary.store(file)
  stored.push(result)
  console.log(`Stored ${result.pieceCid}`)
}

// Pre-sign for all pieces on secondary
const pieceCids = stored.map(s => s.pieceCid)
const extraData = await secondary.presignForCommit(
  pieceCids.map(cid => ({ pieceCid: cid }))
)

// Pull all pieces to secondary
const pullResult = await secondary.pull({
  pieces: pieceCids,
  from: (cid) => primary.getPieceUrl(cid),
  extraData,
})

// Commit on both providers
const [primaryCommit, secondaryCommit] = await Promise.allSettled([
  primary.commit({ pieces: pieceCids.map(cid => ({ pieceCid: cid })) }),
  pullResult.status === "complete"
    ? secondary.commit({ pieces: pieceCids.map(cid => ({ pieceCid: cid })), extraData })
    : Promise.reject(new Error("Pull failed, skipping secondary commit")), // not advised!
])

if (primaryCommit.status === "fulfilled") {
  console.log(`Primary: dataSet=${primaryCommit.value.dataSetId}`)
}
if (secondaryCommit.status === "fulfilled") {
  console.log(`Secondary: dataSet=${secondaryCommit.value.dataSetId}`)
}

Copy to clipboard

Caution

The example above skips the secondary commit entirely when pull fails. In production, consider committing successfully-pulled pieces individually, or retrying the pull before giving up.

Error Handling

Each phase’s errors are independent. Failures don’t cascade, and you can retry at any level:

Phase	Failure	Data state	Recovery
store	Upload/network error	No data on SP	Retry store() with same or different context
pull	SP-to-SP transfer failed	Data on primary only	Retry pull(), try different secondary, or skip
commit	On-chain transaction failed	Data on SP but not on-chain	Retry commit() (no re-upload needed)

The key advantage of split operations: if commit fails, data is already stored on the SP. You can retry commit() without re-uploading the data. With the high-level upload(), a CommitError would require re-uploading.

Next Steps

• Storage Operations - Data set management, retrieval, downloads, and lifecycle operations.

• Storage Costs - Calculate your monthly costs and understand funding requirements.

• Synapse Core - Use the core library directly for maximum control over provider selection, uploads, and SP-to-SP transfers.