feat(synapse-core): support paginated client dataset reads from FWSS by Chaitu-Tatipamula · Pull Request #698 · FilOzone/synapse-sdk

Chaitu-Tatipamula · 2026-03-26T11:50:32Z

Summary

Adds synapse-core actions for the paginated client dataset query overloads introduced in filecoin-services#444, addressing filecoin-pin#362. This is in support of #691

New actions

getClientDataSetsLength - returns total count of datasets for a client (getClientDataSetsLength(address))
getClientDataSetsIds - returns paginated dataset IDs (clientDataSets(address, offset, limit))

Updated actions

getClientDataSets - added optional offset/limit params. defaults to unpaginated.

Other changes

ABI regenerated with updated GIT_REF
Mock handler and presets updated for getClientDataSetsLength
Tests added for all new/updated actions (call + mocked RPC)

all new pagination params default to 0n (fetch all), so no breaking changes are introduced.

synapse-sdk changes will follow in a separate PR. but will just have exposing these actions in WarmStorageService but as per comment there should not be any new methods so i'll just add an updated call at getClientDataSetsWithDetails() to use paginated version of clientDataSets

BigLep · 2026-03-27T15:35:49Z

We can ignore the "add issues and PRs" CI check. That will get fixed in #700

Copilot

Pull request overview

Adds synapse-core support for FWSS’s new paginated client dataset read APIs by introducing new warm-storage actions (IDs + length) and extending the existing getClientDataSets action to optionally use the paginated overload, along with ABI/mocks/test updates.

Changes:

Extend getClientDataSets to accept optional offset/limit and select the correct contract overload.
Add new actions getClientDataSetsLength and getClientDataSetsIds for count + paginated ID enumeration.
Regenerate ABI and update JSON-RPC mocks/presets and tests to cover the new actions.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
packages/synapse-core/wagmi.config.ts	Bumps FWSS ABI source ref to pick up the new contract overloads/helpers.
packages/synapse-core/test/get-client-data-sets.test.ts	Adds call-shape tests for the new paginated args selection.
packages/synapse-core/test/get-client-data-sets-length.test.ts	New tests for the dataset-count action (call + mocked RPC).
packages/synapse-core/test/get-client-data-sets-ids.test.ts	New tests for the paginated dataset-IDs action (call + mocked RPC).
packages/synapse-core/src/warm-storage/index.ts	Exports the new warm-storage actions.
packages/synapse-core/src/warm-storage/get-client-data-sets.ts	Adds optional `offset`/`limit` and overload selection logic for `getClientDataSets`.
packages/synapse-core/src/warm-storage/get-client-data-sets-length.ts	Introduces `getClientDataSetsLength` action and call builder.
packages/synapse-core/src/warm-storage/get-client-data-sets-ids.ts	Introduces `getClientDataSetsIds` action and call builder for `clientDataSets`.
packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts	Adds mock handler support for `getClientDataSetsLength`.
packages/synapse-core/src/mocks/jsonrpc/index.ts	Extends mock presets with `getClientDataSetsLength` return value.
packages/synapse-core/src/abis/generated.ts	Regenerates ABI including new overloads/helpers needed by the actions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-31T21:35:40Z

packages/synapse-core/src/warm-storage/get-client-data-sets.ts

+    /** Starting index (0-based). Use 0 to start from beginning. Defaults to fetching all (unpaginated). */
+    offset?: bigint
+    /** Maximum number of data sets to return. Use 0 to get all remaining. Defaults to fetching all (unpaginated). */


The JSDoc for offset/limit says they default to “fetching all (unpaginated)”, but the implementation uses the unpaginated overload only when both params are omitted; providing either param (even 0n) switches to the paginated overload with 0n defaults. Please clarify the docs to match the actual behavior (e.g., “If omitted, uses legacy unpaginated overload; if provided, uses paginated overload with default 0n values”).

Suggested change

/** Starting index (0-based). Use 0 to start from beginning. Defaults to fetching all (unpaginated). */

offset?: bigint

/** Maximum number of data sets to return. Use 0 to get all remaining. Defaults to fetching all (unpaginated). */

/**

* Starting index (0-based). Use 0 to start from the beginning.

*

* If both `offset` and `limit` are omitted, the legacy unpaginated

* overload is used and all data sets are fetched.

*

* If either `offset` or `limit` is provided, the paginated overload is

* used and any omitted `offset` defaults to `0n`.

*/

offset?: bigint

/**

* Maximum number of data sets to return. Use 0 to get all remaining.

*

* If both `offset` and `limit` are omitted, the legacy unpaginated

* overload is used and all data sets are fetched.

*

* If either `offset` or `limit` is provided, the paginated overload is

* used and any omitted `limit` defaults to `0n`.

*/

yeah copilot is right, i just dont like the suggestion with words like legacy and overload.

Copilot · 2026-03-31T21:35:41Z

packages/synapse-core/src/warm-storage/get-client-data-sets.ts

+  const base = {
    abi: chain.contracts.fwssView.abi,
    address: options.contractAddress ?? chain.contracts.fwssView.address,
    functionName: 'getClientDataSets',
+  } as const
+
+  if (options.offset != null || options.limit != null) {
+    return {
+      ...base,
+      args: [options.address, options.offset ?? 0n, options.limit ?? 0n],
+    } as getClientDataSetsCall.OutputType
+  }


In the paginated branch, the return value is forced with as getClientDataSetsCall.OutputType, which can mask ABI/args mismatches (especially with overloads). Prefer returning an object that satisfies getClientDataSetsCall.OutputType (or otherwise typing base/args so both branches are checked) to keep compile-time verification.

can args be just [options.address, options.offset ?? 0n, options.limit ?? 0n] ?

Copilot · 2026-03-31T21:35:41Z

packages/synapse-core/test/get-client-data-sets.test.ts

+    it('should use paginated args when offset is provided', () => {
+      const call = getClientDataSetsCall({
+        chain: calibration,
+        address: ADDRESSES.client1,
+        offset: 10n,
+        limit: 50n,
+      })
+
+      assert.equal(call.functionName, 'getClientDataSets')
+      assert.deepEqual(call.args, [ADDRESSES.client1, 10n, 50n])
+    })
+
+    it('should use unpaginated args when no offset/limit provided', () => {
+      const call = getClientDataSetsCall({
+        chain: calibration,
+        address: ADDRESSES.client1,
+      })
+
+      assert.equal(call.functionName, 'getClientDataSets')
+      assert.deepEqual(call.args, [ADDRESSES.client1])
+    })


There’s mocked-RPC coverage for the legacy unpaginated getClientDataSets call, but no test that exercises the new offset/limit path end-to-end against the MSW JSON-RPC handler. Please add a mocked RPC test that calls getClientDataSets(client, { address, offset, limit }) to ensure the ABI overload resolution + mock handler decoding/encoding work for the paginated overload.

hugomrdias · 2026-04-01T11:11:13Z

packages/synapse-core/wagmi.config.ts


 // GIT_REF can be one of: '<branch name>', '<commit>' or 'tags/<tag>'
-const GIT_REF = '44ef7165f7db93e5491a27ce14460143ff9a7d13'
+const GIT_REF = 'd08214e1b3d200e0bc80f0d4f2e5ea3e1e4d603e'


can you change it to 'ed85348ebad54196b5bfefc5cb0dbe7e8bfd6f7c' should have what you need here

https://github.com/FilOzone/filecoin-services/blob/c04be93aa680082e359481f0776e41ed157a2ac2/service_contracts/deployments.json#L4

hugomrdias · 2026-04-01T11:12:09Z

packages/synapse-core/src/warm-storage/get-client-data-sets.ts

+  const base = {
    abi: chain.contracts.fwssView.abi,
    address: options.contractAddress ?? chain.contracts.fwssView.address,
    functionName: 'getClientDataSets',
+  } as const
+
+  if (options.offset != null || options.limit != null) {
+    return {
+      ...base,
+      args: [options.address, options.offset ?? 0n, options.limit ?? 0n],
+    } as getClientDataSetsCall.OutputType
+  }


can args be just [options.address, options.offset ?? 0n, options.limit ?? 0n] ?

hugomrdias · 2026-04-01T11:13:23Z

packages/synapse-core/src/warm-storage/get-client-data-sets.ts

+    /** Starting index (0-based). Use 0 to start from beginning. Defaults to fetching all (unpaginated). */
+    offset?: bigint
+    /** Maximum number of data sets to return. Use 0 to get all remaining. Defaults to fetching all (unpaginated). */


yeah copilot is right, i just dont like the suggestion with words like legacy and overload.

…s, update GIT_REF, add paginated RPC test

Chaitu-Tatipamula requested review from hugomrdias and rvagg as code owners March 26, 2026 11:50

github-project-automation bot added this to FOC Mar 26, 2026

github-project-automation bot moved this to 📌 Triage in FOC Mar 26, 2026

BigLep assigned Chaitu-Tatipamula Mar 27, 2026

BigLep moved this from 📌 Triage to 🔎 Awaiting review in FOC Mar 27, 2026

Chaitu-Tatipamula force-pushed the paginated-fwss-reads branch from 2f5b70a to 956e6da Compare March 27, 2026 18:35

rjan90 added this to the M4.2: mainnet GA milestone Mar 30, 2026

Chaitu-Tatipamula force-pushed the paginated-fwss-reads branch from 956e6da to d14c1a1 Compare March 30, 2026 20:11

BigLep requested a review from Copilot March 31, 2026 21:31

Copilot started reviewing on behalf of BigLep March 31, 2026 21:31 View session

Copilot AI reviewed Mar 31, 2026

View reviewed changes

BigLep mentioned this pull request Mar 31, 2026

Investigate staging Dealbot startup failure FilOzone/dealbot#411

Closed

hugomrdias reviewed Apr 1, 2026

View reviewed changes

Chaitu-Tatipamula added 2 commits April 2, 2026 03:06

feat(synapse-core): support paginated client dataset reads from FWSS

d10caa6

fix(synapse-core): address PR review — simplify getClientDataSets arg…

ed66393

…s, update GIT_REF, add paginated RPC test

Chaitu-Tatipamula force-pushed the paginated-fwss-reads branch from d112a7e to ed66393 Compare April 1, 2026 21:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(synapse-core): support paginated client dataset reads from FWSS#698

feat(synapse-core): support paginated client dataset reads from FWSS#698
Chaitu-Tatipamula wants to merge 2 commits intoFilOzone:masterfrom
Chaitu-Tatipamula:paginated-fwss-reads

Chaitu-Tatipamula commented Mar 26, 2026 •

edited by BigLep

Loading

Uh oh!

BigLep commented Mar 27, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 31, 2026

Uh oh!

hugomrdias Apr 1, 2026

Uh oh!

Copilot AI Mar 31, 2026

Uh oh!

hugomrdias Apr 1, 2026

Uh oh!

Copilot AI Mar 31, 2026

Uh oh!

hugomrdias Apr 1, 2026

Uh oh!

Chaitu-Tatipamula Apr 1, 2026

Uh oh!

hugomrdias Apr 1, 2026

Uh oh!

hugomrdias Apr 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

-    /** Starting index (0-based). Use 0 to start from beginning. Defaults to fetching all (unpaginated). */
-    offset?: bigint
-    /** Maximum number of data sets to return. Use 0 to get all remaining. Defaults to fetching all (unpaginated). */
+    /**
+     * Starting index (0-based). Use 0 to start from the beginning.
+     *
+     * If both `offset` and `limit` are omitted, the legacy unpaginated
+     * overload is used and all data sets are fetched.
+     *
+     * If either `offset` or `limit` is provided, the paginated overload is
+     * used and any omitted `offset` defaults to `0n`.
+     */
+    offset?: bigint
+    /**
+     * Maximum number of data sets to return. Use 0 to get all remaining.
+     *
+     * If both `offset` and `limit` are omitted, the legacy unpaginated
+     * overload is used and all data sets are fetched.
+     *
+     * If either `offset` or `limit` is provided, the paginated overload is
+     * used and any omitted `limit` defaults to `0n`.
+     */

Conversation

Chaitu-Tatipamula commented Mar 26, 2026 • edited by BigLep Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

New actions

Updated actions

Other changes

Uh oh!

BigLep commented Mar 27, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

hugomrdias Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

hugomrdias Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

hugomrdias Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Chaitu-Tatipamula Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

hugomrdias Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

hugomrdias Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Chaitu-Tatipamula commented Mar 26, 2026 •

edited by BigLep

Loading