Skip to content
foc Filecoin Onchain Cloud Documentation

All versions since 0.0.0
All versions

0.0.0

Features

  • add ‘authorization’ option for auth header (ddb4bcd)
  • add blob creation helpers (848613c)
  • add commp calculation functionality (a87c4c9)
  • auth: modify ScheduleRemovals signing for UX improvements (fadcc8d)
  • commp: toZeroPaddedSize (18aa22b)
  • dist: publish as single-file bundles for web/cdn use (0a42daa)
  • docs: add post-deploy-setup.js script, more docs (ed002d7)
  • implement wallet & contract interactions; style, test, lint (689afdd)
  • implementation of initial design with mock backend (346b01f)
  • initial interface design proposal (53616f0)
  • make constructor private, simplify internals (2e23b4c)
  • minimal interface to align with M1 plan (c05319a)
  • more payments contract interaction features (c198f56)
  • payments: extract SynapsePayments class, access as synapse.payments (f7df69e)
  • pdp: EIP-712 signing support (a4513af)
  • rename SimplePDPServiceWithPayments to Pandora (942030c)
  • signing operations for PDP (ff08423)
  • sptool: Add StorageProviderTool for SP-focused utilities (e54b4ad)
  • streaming commp, PDP piece upload & download (d464589)

Bug Fixes

  • adjust signing to match current contract implementation (4a6668c)
  • auth signature needs [bytes] for CID, not bytes (87afdc1)
  • auth: also pack roots for ScheduleRemoval (8abfba5)
  • auth: deal with EIP-712 incompatibilities in contract (175c012)
  • auth: deeper EIP-712 support with internal metamask detection (4efc63d)
  • auth: fix compatibility with questionable results (8d87969)
  • auth: simplify auth setup inside Synapse, update docs (ed35266)
  • auth: use uint256[] for ScheduleRemovals signature (690c2aa)
  • lint and browser test compatibility (aac8569)
  • no Buffer (5a6de27)
  • pdp: more complete index (14f8abe)
  • test: dedupe test utils (831e745)
  • websockets first, document walletBalance vs balance differences (7a58b9e)

Trivial Changes

  • add CLAUDE.md symlink (4c5b9e5)
  • add dependabot (c87963c)
  • add GHA test & release w/ release temporarily disabled (00e1fae)
  • deps-dev: bump webpack-cli from 5.1.4 to 6.0.1 (03df52f)
  • deps: bump actions/checkout from 4.1.7 to 4.2.2 (#45) (9fff4f5)
  • deps: bump actions/setup-node from 4.0.4 to 4.4.0 (711ad66)
  • doc: pdp-auth-demo page (0811d95)
  • docs,ai: compress and organise LLM file (3b192f9)
  • docs,ai: PDP architecture & contract details + flows (2e5091b)
  • docs,ai: update knowledge (7e21908)
  • docs,ai: update knowledge about dev repos (29b13e7)
  • docs: “base units” instead of “smallest unit” for tokens (8b97c60)
  • enable auto-publishing (ce08315)
  • move pdp-auth-demo.html into utils (ec60268)
  • publishConfig & dry-run for now (a198ddc)
  • remove example auth (17440a2)
  • remove reexport from top-level index (3ace19a)
  • rename @filoz/synapse-sdk for now (b588fda)
  • rename CLAUDE.md to AGENTS.md (d8c5d3a)
  • reorg auth components into pdp subpackage, remove from main interface (d0fc739)
  • test: extend timeout for windows browser tests (0dadc4f)
  • tmp: add example-auth-simple.js (f329d09)
  • update GHA release permissions (f07628f)

0.0.1

Bug Fixes

  • auth: no need for digest check (cac3b71)
  • use full bytes of commp in auth signing blob (2901305)

Trivial Changes

  • ci: no more dry-run publishes (7b0da83)
  • docs: add CHANGELOG with 0.0.0 notes (61193f9)
  • test: update addRoots auth blob fixtures (2897f2b)

0.1.0

Features

Trivial Changes

  • docs: fix CHANGELOG format [skip ci] (d89be6c)

0.2.0

Features

  • payments: add enhanced payment APIs and update Pandora contract integration (b6ff598)

Bug Fixes

  • payments: no fallback to known pricing, only from chain (e43def6)
  • use my latest deployed pandora contract (1b6b198)

Trivial Changes

  • doc: add payments-demo.html (e85bb18)
  • test: merge payments tests into single file (6166615)

0.3.0

Features

  • pandora: implement getClientProofSets for client (bef0053)
  • pdp: add comprehensive proof set discovery and status utilities (6f1da3e)
  • pdp: add findPiece method to check piece existence on PDP server (cd7f3cd)

Trivial Changes

  • docs: add proof-sets-viewer.html example (bdb995e)
  • remove unnecessary cruft and improve error handling (f04c0e0)

0.4.0

Features

  • refactor SDK architecture for separation of concerns (9e0867b)

0.5.0

Features

  • add minimum upload size validation and improve storage reliability (4270590)
  • storage: add creation callbacks and remove out-of-scope methods (2de7f91)
  • storage: implement download method and simplify DownloadOptions (05c1b79)
  • storage: implement preflight checks and refactor allowance API (2746cba)
  • storage: implement provider selection and proof set management (9faf04f)
  • storage: implement upload method with UploadCallbacks (e289ae9)

Bug Fixes

  • add hack to skip 60s delay in upload during tests (f4ade39)
  • docs: update README examples for latest signatures (b574a90)
  • pdp: restore correct upload protocol with check object (18618b2)
  • semantic-release bug (bf340d8)

Trivial Changes

  • remove example-usage.js in favour of new examples in utils/ (72dbe23)
  • remove unused getters (1bed0db)
  • use ethers.js utilities instead of hardcoded decimals (8895422)

0.6.0

Features

  • utils: add Pandora storage provider admin portal [skip ci] (#79) (e6a79bc)

Bug Fixes

  • remove 60s delay after createproofset and associated testing hack (353551a)

Trivial Changes

  • docs: move ADMIN_SAFE_INTEGRATION_PLAN.md to utils (4167234)

0.6.1

Trivial Changes

  • deps-dev: bump @types/node from 22.15.31 to 24.0.0 (fecfaa5)

0.7.0

Features

  • storage: implement smart provider selection to prefer existing relationships (8433899)

0.8.0

Features

  • return TransactionResponse objects from payment methods (23d1d9d)

Bug Fixes

  • storage: retry logic around proofset creation tx lookup (454c721)

Trivial Changes

0.8.1

Bug Fixes

  • addroots: report full padded piece size to contract to match Curio (277e015)

0.9.0

Features

  • pdp: add transaction tracking for root additions with server verification (00de2b2)

Trivial Changes

  • add conventional commits guidelines (bc68d04)

0.9.1

Trivial Changes

  • transactions: increase default wait confidence to 1 (f6e42cb)

0.10.0

Features

  • admin: expose addServiceProvider on PandoraService (0270e7b)

Trivial Changes

  • admin: remove pandora-admin html in preference of gh-pages branch (1708857)

0.11.0

Features

  • retriever: implement PieceRetriever pattern for flexible piece downloads (16d9a84)

Bug Fixes

  • retriever: use Promise.any instead of Promise.race for provider selection (c291821)

Trivial Changes

  • pdp: use extracted utility functions for url building (7e96345)

0.12.0

Features

  • cdn: add complete FilCDN retriever implementation (#106) (e2ff94b)

0.13.0

Features

  • enhance checkAllowanceForStorage with customizable lockup periods (52c3204)

Bug Fixes

  • correct depositAmountNeeded assignment in PandoraService (bdc1827)

Tests

  • add checks for depositAmountNeeded in PandoraService tests (e07ae2d)

0.14.0

Features

  • pdp: always validate and return CommP (CID) objects from server (d3b30da)

Trivial Changes

  • pdp: validate server responses (d2e135b)

0.15.0

Features

  • pdp: add ping method to check connectivity with SP (46a3223)

0.16.0

Features

  • pdp: implement ping validation for storage providers in selection process (#119) (12a5bf7)

0.16.1

0.17.0

Features

  • add provider info and storage info APIs (#124) (af8afb1)

0.18.0

Features

  • add SDK methods to fetch proofset roots and metadata (#111) (a6ec128)

0.19.0

Features

Trivial Changes

  • Update .github/workflows/add-issues-and-prs-to-fs-project-board.yml [skip ci] (579ef07)

0.19.1

Trivial Changes

  • add Claude Code GitHub Workflow [skip-ci] (#128) (3878254)

0.19.2

Bug Fixes

  • pdp: handle Curio’s “proofsetCreated” casing (#130) (594c4ae)

0.19.3

Trivial Changes

0.19.4

Trivial Changes

  • update docs for add-issues-and-prs-to-fs-project-board.yml (#133) (20ea7f3)

0.20.0

Features

  • doc: dual license as Apache 2.0 & MIT (#134) (5170b19)

0.20.1

Trivial Changes

1.0.0

⚠ BREAKING CHANGES

  • add pdpVerifierAddress option to SynapseOptions (#138)

Features

  • add pdpVerifierAddress option to SynapseOptions (#138) (d35b40d)

0.21.0

Features

  • add pdpVerifierAddress option to SynapseOptions (#138) (965592e)
  • reset versioning to continue 0.x development (ce58d21)

Trivial Changes

  • release: 1.0.0 [skip ci] (9d998b5), closes #138
  • reset version to 0.20.1 after accidental major release (1cfe165)

0.22.0

Features

  • add batching for parallel uploads (48b46b0)
  • upload batch size, add simple debounce for uploads (c54f36b)

0.23.0

Features

  • use Performance API, update docs with additional timing input (b4fe5f0)

Trivial Changes

  • add comprehensive performance and timing analysis documentation (d9eb5f1), closes #125

0.23.1

Trivial Changes

  • ci: delete Claude Code PR review workflow (#152) (ec26b4b)

0.23.2

Trivial Changes

  • deps: bump actions/checkout from 4 to 5 (#150) (efc8018)

0.24.0

Features

  • add synapse.storage and StorageContext (#153) (7485b84)
  • commp: transition to CommPv2 (c0c39a4)
  • commp: use “PieceCID” terminology, use v2 exclusively (81f9ea8)
  • commpv2: Curio CommPv2 compatibility (#156) (d529e0b)
  • EIP712 signing support for metadata in CreateDataSet and AddPices (#173) (f396e0d)
  • major rename - pandora->warm storage, proof sets->data sets, roots->pieces (6e1a743)
  • sp registry (e680f82)
  • utils: split client and provider functionality to make setup easier (66c9d02)
  • warmstorage: discover dependent contract addresses from WarmStorage (984966b)

Bug Fixes

  • ignore deleted providers when searching for retrieval options (#159) (2b8c427)
  • pdp: encode the metadata correctly in extraData (c4aea98)
  • pdp: isComplete on data set creation should include server status (#158) (5cf3dc1)
  • trim trailing slash from serviceURL (cf8be53)
  • warmstorage: adapt to view contract using extsload (f56f00e)

Trivial Changes

0.24.1

Trivial Changes

  • deps-dev: bump typescript from 5.8.3 to 5.9.2 (#193) (8892319)

0.24.2

Bug Fixes

  • pdp: select provider on ID, allow graceful fallback when no match (#195) (30d32af)

0.24.3

Trivial Changes

0.24.4

Trivial Changes

  • update testing setup and dependencies (#171) (eb3e590)

0.24.5

Trivial Changes

0.24.6

0.24.7

Trivial Changes

0.24.8

Trivial Changes

  • docs: initialize documentation site with Astro and Starlight (#180) (770efcb)

0.24.9

Trivial Changes

  • docs: add GitHub Pages deployment workflow and enable GitHub Pages in Astro config (#210) (4158abf)

0.24.10

Bug Fixes

  • select data set using providerId, not payee (#211) (6382e81)

Trivial Changes

  • no-release: fix docs (70d2c43)
  • no-release: fix docs base path (11ed22d)
  • no-release: fix docs index urls for github pages (d31669b)
  • no-release: github urls again (1c1aee5)
  • no-release: make docs run only on master (04a6f2b)

0.24.11

Trivial Changes

  • deps-dev: bump @biomejs/biome from 2.2.3 to 2.2.4 (#213) (d79ba37)
  • deps: bump actions/setup-node from 4 to 5 (#212) (32ec07a)

0.25.0

Features

Trivial Changes

  • deps-dev: bump type-fest from 4.41.0 to 5.0.0 (#217) (d3a3608)
  • no-release: disable eslint and prettier in VSCode settings (#214) (0631dbf)

0.25.1

Bug Fixes

0.26.0

Features

  • add mainnet address, add —network flag to sp-tool (#231) (d0b5242)

0.27.0

Features

  • allow custom metadata for data sets & roots (fe41931), closes #201
  • expose metadata as Record<string,string>; check constraints (68ed29b)
  • match data set for auto-selection based on all metadata (unordered) (50eb97a)

Bug Fixes

  • exact match of metadata, ignoring order, when selecting data set to reuse (5f80a64)
  • pass metadata to context create, match cached contexts on metadata (967f272)

0.29.0

Features

Bug Fixes

Chores

  • ci: switch from semantic-release to release-please (#233) (9f84cc6)

0.29.1

Bug Fixes

  • import constants (#246) (53e0c97)
  • resolve data sets in getClientDataSetsWithDetails without rail indirection (#235) (d0e8fb9)

0.29.2

Bug Fixes

  • clean up synapse-sdk readme (8a7f949)

0.29.3

Bug Fixes

  • update package.json paths to use ‘dist/src’ directory (625b269)

0.30.0

Features

Bug Fixes

  • generate-abi from correct contracts git tag (#279) (742c041)

Chores

  • update mock service worker package version to 2.10.5 (e201a48)

0.30.1

Bug Fixes

  • more careful checks for EIP-1193 provider (#290) (bfeee48)

0.31.0

Features

  • sp-tool: add full PDP offering updates and capabilities (#294) (e71fb8c)

0.31.1

Bug Fixes

  • resolves bug of using client address instead of signer for datsetId lookup (7320c2b)
  • Use clientAddress for next dataset ID (#299) (7320c2b)

0.32.0

Features

0.33.0

Features

  • getSizeFromPieceCID(cid) to extract size from PieceCIDv2 (#283) (5fac7a6)
  • PDPServer#getPieceStatus(pieceCid) (#315) (fb45df4)

Bug Fixes

  • multi-uploads, smarter batching, handle multiple files in example (#301) (3d41d21)
  • use providerId or providerAddress if provided with forceCreateDataSet (#314) (9d717d3)

0.34.0

Features

  • allowing deposits to secondary addresses (4629f1f)
  • deposit to any address (#316) (4629f1f)

Bug Fixes

  • getPDPService always returns a pdpOffering (#324) (42389da)

Chores

0.35.0

⚠ BREAKING CHANGES

  • create dataset and add pieces (#357)

Features

Bug Fixes

  • mocks: mock BatchJsonrpc errors with their request id (#338) (1167900)
  • resolves bug of using client address instead of signer for datsetId lookup (328ae43)
  • update lockup period from 10 to 30 days (34362fa)
  • use bigint in PDP auth, clientDataSetId now needs to be large (620b32e)

Chores

  • update ABIs for next contracts (6f1ebda)
  • update for M3 contracts (52f841c)
  • update for M3 contracts (52f841c)
  • update to M3 calibnet contracts in next-branch (#319) (52f841c)
  • v0.35.0-dev.1 (next) (1e43029)

0.35.1

Features

Bug Fixes

  • get pieces from contract instead of pdpServer (#249) (dc4aac2)
  • timing: increase transaction propagation timeout to 180s (#370) (63e749f), closes #359

0.35.2

Bug Fixes

  • core abis in sdk (#372) (2b70909)
  • sp-registry: no double-lookup to get provider by address (#367) (efd3dc2)
  • storage: forward the isApproved and use that in storage info (#377) (fa9d4cf)

Chores

  • convert fwss tests to jsonrpc mocks (#384) (947c25e)
  • deps-dev: bump @biomejs/biome from 2.2.7 to 2.3.1 (#352) (ed8cee6)
  • telemetry fixups based off learnings from filecoin-pin integration (#378) (e607834)

0.35.3

Features

Bug Fixes

  • default dev to false in selectProviderWithPing (a5c428c)
  • maxLockupPeriod should be a bigint (#383) (2fdf629)
  • normalize telemetry http call wrapping (#398) (c9a2f95)
  • remove debug logs from provider filtering (#395) (f86e085)
  • use serviceStatus=dev for dev provider filtering (#376) (a5c428c)

Chores

  • simplify linting and make sure git hook works (#394) (ee8a83d)
  • update Sentry DSN in telemetry service (#399) (44af935)

0.36.0

⚠ BREAKING CHANGES

  • revert golden path upload() API + minor fixes (#446)

Features

  • streaming upload support (9510752)

Bug Fixes

  • error outputs out of lotus are weird (#411) (341eeff)
  • revert golden path upload() API + minor fixes (#446) (12d11e9)

Chores

0.36.1

Bug Fixes

Chores

  • deps-dev: bump @biomejs/biome from 2.3.5 to 2.3.6 (#448) (ebcab4e)
  • deps-dev: bump @biomejs/biome from 2.3.6 to 2.3.7 (#459) (d3c65a8)
  • deps-dev: bump @biomejs/biome from 2.3.7 to 2.3.8 (#476) (d95f812)
  • export StorageManagerUploadOptions (#462) (c5897f2)

0.37.0 Latest

⚠ BREAKING CHANGES

  • change to only export Synapse from the main entrypoint

Features

  • Add API for querying remaining egress (#430) (c40d6b8)
  • change to only export Synapse from the main entrypoint (4c0cc47), closes #232
  • move ethers to peer dependencies (242a2c1)
  • storage: rename “pieces” callbacks, add piece info & dataSetId (#439) (f1bd585)

Bug Fixes

  • cache clientDataSetId in StorageContext (#489) (ec1345a)
  • createStorageContext without getClientDataSetsWithDetails (#438) (76e2439)
  • expose getScheduledRemovals on storageContext (#490) (6a3b5cc)
  • remove settlement fee (#502) (8c7537e), closes #243
  • treat status code 202 for findPiece as a retry (6b9e03f)
  • warm-storage: check metadata withCDN key in addition to cdnRailId for CDN status (#505) (db234e5)

Chores