feat: add synapse-core and change sdk to viem client #289

hugomrdias · 2025-10-08T17:58:18Z

this will probably fix the metamask problems but need to confirm.

cloudflare-workers-and-pages · 2025-10-08T17:58:26Z

Deploying with Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status	Name	Latest Commit	Preview URL	Updated (UTC)
✅ Deployment successful! View logs	synapse-dev	`16f7b12`	Commit Preview URL Branch Preview URL	Oct 10 2025, 01:51 PM

socket-security · 2025-10-09T11:49:11Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	type-fest@5.0.1
	viem@2.38.0

View full report

…ve deprecated files - Updated package.json to use wireit for build, lint, and test scripts. - Added references to synapse-core in tsconfig.json. - Removed wagmi.config.ts and related ABI generation files. - Refactored Synapse class to utilize viem's Client for wallet and public client management. - Updated PaymentsService to remove ERC20Permit ABI usage and replace it with ERC20 ABI. - Enhanced test cases to align with new client structure and removed deprecated authentication methods. - Added new methods to access wallet and public clients in Synapse class.

- Added .wireit/ to .gitignore to exclude Wireit configuration files. - Updated biome.json to ignore packages/synapse-core/src/gen.ts for better build management. - Added wireit as a dependency in package.json for improved build, lint, and test scripts.

- Removed the line setting the script shell to bash in the GitHub Actions workflow for the Synapse SDK, streamlining the test execution process.

- Modified test commands in package.json to use a consistent pattern for test file matching in both node and browser environments.

…rkflow - Set the script shell to bash in the GitHub Actions workflow for the Synapse SDK to ensure compatibility during test runs.

- Modified test commands in package.json to use a more inclusive pattern for test file matching in both node and browser environments, ensuring all relevant tests are executed.

- Refactored the test command in package.json to utilize wireit for streamlined execution, while ensuring that both node and browser tests are run sequentially. This change enhances the consistency and efficiency of the testing process.

- Updated the GitHub Actions workflow for the Synapse SDK to set the script shell to bash directly in the test command, enhancing compatibility and simplifying the execution process.

- Modified test commands in package.json to use double quotes for file patterns, ensuring consistency and compatibility across different environments.

- Rearranged peerDependencies in synapse-core's package.json for clarity. - Removed unnecessary dependencies from synapse-sdk's package.json while maintaining required ones.

- Temporarily disabled the test execution step in the GitHub Actions workflow for the Synapse SDK to prevent tests from running during CI builds.

rvagg · 2025-10-13T02:51:55Z

.github/release-please-config.json

        }
      ]
+    },
+    "packages/synapse-core": {


needs the rest of the config copied down

rvagg · 2025-10-13T02:52:46Z

.github/workflows/synapse-core.yml

+      - name: Install Dependencies
+        run: pnpm install
+      # - name: Run tests
+      #   run: pnpm -r --filter @filoz/synapse-core run test


? not ready yet?

no tests in core yet

rvagg · 2025-10-13T02:57:58Z

packages/synapse-core/src/chains.ts

+    },
+    Glif: {
+      name: 'Glif',
+      url: 'https://www.glif.io/en',


this is not a block explorer, or did I miss a memo?

it still is and imo one of the best for pending txs

rvagg · 2025-10-13T03:01:00Z

packages/synapse-core/src/index.ts

+ */
+
+/**
+ * Synapse SDK main entry point


maybe we should not do this but just use named exports exclusively here? we fell into a trap in current Synapse by making the main export a bucket-of-all-things which is terrible and I'd like to undo that, I don't think there's a good reason to do the same here is there?

what i normally do is namespace export in index.ts all the logical groups and teach users in docs theres named entrypoints if they want to cherrypick.

In the SDK case is different cause if you use the Synapse class you already pulling most of the other modules but yes we need to improve.

Here i think you right it we should only have named exports for logical groups.

Would you remove the default entrypoint completely ? if not what would you put there ?

rvagg · 2025-10-13T03:28:35Z

packages/synapse-core/src/utils.ts

+    return new FallbackProvider(providers)
+  }
+
+  return new JsonRpcProvider(transport.url, network)


shouldn't we support websocket urls here?

rvagg · 2025-10-13T03:31:42Z

packages/synapse-core/src/chains.ts

+      abi: ERC20_WITH_PERMIT_ABI,
+    },
+    payments: {
+      address: generated.paymentsAddress['314'],


What are the implications of exporting this here? what if I want to run the stack with my custom suite of contracts for deployment?
I'm not against baking in official addresses, I just don't want to make it even more onerous to test against new deployments for some subset of these contracts.

I think that since we still pull the dependency contract addresses off warmstorage that it still works by supplying the option; why why do the addresses help us in here? is there some adjacent functionality that viem gives us that makes this a good thing to do?

this gives us simplicity, you just need chainId and with getChain below you get everything you need addresses, abi, etc

its not onerous to test against any deployment:

open wagmi.config.ts

change address and git tag/commit to the specific contract

save and pnpm run generate-abi

rvagg · 2025-10-13T03:32:53Z

pnpm-workspace.yaml

  - workerd
+
+patchedDependencies:
+  viem: patches/viem.patch


funky, do we really need this? is there an attempt to upstream this so we're not stuck with jank?

this only works locally, we cant have this, only here to validate that everything works.
we will need a custom privateKeyToAccount function and i will remove this

rvagg · 2025-10-13T03:38:30Z

packages/synapse-sdk/src/pdp/auth.ts

-      // If it's a JsonRpcProvider or WebSocketProvider, it's not a browser provider
-      // These can sign locally with a wallet
-      if (provider instanceof ethers.JsonRpcProvider || provider instanceof ethers.WebSocketProvider) {
+      if (actualSigner.provider instanceof JsonRpcProvider) {


needs websocket check too?

I think I also might need some more help being convinced that this new logic is enough to get the answe we need in here

i need help understanding the special case for metamask.

BrowserProvider is always a eip1193 provider and always has a request function, the problem here may be old school interfaces from ethers before eip1193 existed.

rvagg · 2025-10-13T03:40:22Z

packages/synapse-sdk/src/synapse.ts

-      throw new Error(`Invalid network: ${String(network)}. Only 'mainnet' and 'calibration' are supported.`)
-    }
+    const chain = getChain(options.client.chain.id)
+    const network = chain.id === mainnet.id ? 'mainnet' : 'calibration'


we no longer do a getFilecoinNetworkType check here, do we have any confidence other than the config that we've been passed that we are actually talking to that network type? or are we choosing to not care and it's caveat emptor?

devs must define the chains first and should use our chain definitions or viem's if they try to customize and mess up rpc urls its there problem, anyway viem/wagmi already checks the chain definition against the RPC so devs really need to work hard and customize chain definition and RPC url to have problems.

hugomrdias · 2025-10-13T10:18:52Z

@rvagg any way after many attempts to convert ethers to viem theres no clean way at least for the local private key account to do it.

The conversion methods in this PR are already going into internals and for PKs we would need a custom privateKeyToAccount to expose the PK and convert to ethers. Also internal local sign methods for ether are sync and viems are async its a mess.

i think its best to park this for this week to avoid disruption.

github-project-automation bot added this to FS Oct 8, 2025

github-project-automation bot moved this to 📌 Triage in FS Oct 8, 2025

hugomrdias changed the title ~~Hugomrdias/core~~ feat: add synapse-core and change sdk to viem client Oct 8, 2025

hugomrdias requested a review from rvagg October 8, 2025 17:58

hugomrdias force-pushed the hugomrdias/core branch 2 times, most recently from 34def1c to 34b117f Compare October 9, 2025 11:39

hugomrdias marked this pull request as ready for review October 9, 2025 18:07

hugomrdias added 16 commits October 10, 2025 14:48

docs: fix navigation

b902a8a

feat: synapse core initial commit with chains, errors and abis

20bc9f2

chore: remove unnecessary shell configuration from CI workflow

534f5a1

- Removed the line setting the script shell to bash in the GitHub Actions workflow for the Synapse SDK, streamlining the test execution process.

chore: update test commands in package.json for consistency

ec20463

- Modified test commands in package.json to use a consistent pattern for test file matching in both node and browser environments.

fix: patch viem to exposes private key and fix session key tests

3afa0a2

chore: configure bash as the script shell for test execution in CI wo…

5c9df0f

…rkflow - Set the script shell to bash in the GitHub Actions workflow for the Synapse SDK to ensure compatibility during test runs.

chore: update test file matching patterns in package.json

e74d1eb

- Modified test commands in package.json to use a more inclusive pattern for test file matching in both node and browser environments, ensuring all relevant tests are executed.

chore: streamline test execution in CI workflow

afba7bf

- Updated the GitHub Actions workflow for the Synapse SDK to set the script shell to bash directly in the test command, enhancing compatibility and simplifying the execution process.

chore: update test command quotes in package.json

a3b7a8b

- Modified test commands in package.json to use double quotes for file patterns, ensuring consistency and compatibility across different environments.

chore: update package.json dependencies for synapse-core and synapse-sdk

4a8773e

- Rearranged peerDependencies in synapse-core's package.json for clarity. - Removed unnecessary dependencies from synapse-sdk's package.json while maintaining required ones.

chore: setup core ci

496cc21

docs: update README.md to enhance SDK description

950ac9c

chore: comment out test execution in CI workflow

16f7b12

- Temporarily disabled the test execution step in the GitHub Actions workflow for the Synapse SDK to prevent tests from running during CI builds.

hugomrdias force-pushed the hugomrdias/core branch from d93d285 to 16f7b12 Compare October 10, 2025 13:49

rvagg reviewed Oct 13, 2025

View reviewed changes

.github/release-please-config.json

}

]

},

"packages/synapse-core": {

Copy link

Collaborator

rvagg Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs the rest of the config copied down

rvagg reviewed Oct 13, 2025

View reviewed changes

rjan90 moved this from 📌 Triage to 🔎 Awaiting review in FS Oct 14, 2025

rjan90 added this to the M3: Preview Launch of SDK + Filecoin Pin milestone Oct 14, 2025

rjan90 assigned hugomrdias Oct 14, 2025

feat: add synapse-core and change sdk to viem client #289

Are you sure you want to change the base?

feat: add synapse-core and change sdk to viem client #289

Uh oh!

Conversation

hugomrdias commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cloudflare-workers-and-pages bot commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying with Cloudflare Workers

Uh oh!

socket-security bot commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hugomrdias commented Oct 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hugomrdias commented Oct 8, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented Oct 8, 2025 •

edited

Loading

socket-security bot commented Oct 9, 2025 •

edited

Loading