Sam/ws transport #12

samholmes · 2026-01-17T00:14:34Z

CHANGELOG

Does this branch warrant an entry to the CHANGELOG?

Yes
No

Dependencies

none

Description

none

Note

Modernizes logging and configuration, expands transport support, and simplifies plugin coverage.

Logging: Replace ad-hoc console logging with Pino (src/util/logger.ts), add scoped child loggers, and document usage/output (docs/logging.md). Refactor hub, blockbook, evmRpc, and index to emit structured JSON logs with connection/IP and plugin metadata.
Service key templating: Introduce serviceKeys cleaner/matcher and URL templating (authenticateUrl, replaceUrlParams, serviceKeysFromUrl) to inject API keys by host/subdomain; update scan adapters to pull keys per-URL.
Transports: Add WebSocket support to EVM RPC via viem (auto-select http/ws per URL); improve error handling and tracing; add address prefix helpers for concise logs.
Plugins: Use templated NowNodes URLs for Blockbook chains; reduce EVM plugin list to core networks (BSC, Botanix, Ethereum, Optimism, Polygon, zkSync) plus fakePlugin.
Config/Tests: Remove nowNodesApiKey in favor of serviceKeys; update serverConfig, Jest setup, and tests accordingly; add pino dependency.

^{Written by Cursor Bugbot for commit b270b9f. This will update automatically on new commits. Configure here.}

To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1212754123530595

- Use Pino for performant logging - Use Pino's .child() pattern for efficient scoped logging - Add pino-pretty support for human-readable development output - Disable logging in tests via NODE_ENV check - Automatically rename conflicting fields (time → time_, scope → scope_)

Remove the following plugins to reduce load: - abstract, amoy, arbitrum, avalanche, base - bobevm, celo, ethereumclassic, ethereumpow, fantom - filecoinfevm, filecoinfevmcalibration, holesky, hyperevm - pulsechain, rsk, sepolia, sonic

Add serviceKeysFromUrl utility that matches API keys to URLs by hostname with subdomain fallback support (e.g., api.example.com → example.com). Keys can be configured with or without ports. - Add src/util/serviceKeys.ts with ServiceKeys type and matching logic - Add src/util/replaceUrlParams.ts for {{param}} placeholder substitution - Add src/util/authenticateUrl.ts to combine key lookup with URL templating - Add comprehensive tests for serviceKeysFromUrl Refactor RPC and scan adapter configuration: - Switch to authenticated RPC endpoints using {{apiKey}} templates - Make scanAdapters required in EvmRpcOptions - Update EtherscanV1/V2 adapters to use serviceKeysFromUrl - Fix pickRandom return type to T | undefined for empty arrays - Improve error handling when no URLs or API keys are configured

This reduces complexity and re-uses the new infrastructure. The only trade-off is to remove the logging of the URL without the key, which we can accept since these logs should be treated as company sensitive.

src/util/scanAdapters/EtherscanV1ScanAdapter.ts

swansontec

Found a few small things.

src/plugins/blockbook.ts

swansontec · 2026-01-22T00:20:50Z

src/plugins/blockbook.ts

            .then(() => initBlockConnection())
            .catch(err => {
-              console.error('Failed to re-initialize block connection:', err)
+              logger.error({ err }, 'Failed to re-initialize block connection')


Below we did ${String(error}. Here we log the object. Should we standardize on one of the other?

Yes, standardize on logging the object. We get full stack traces this way.

swansontec · 2026-01-22T00:21:26Z

src/plugins/blockbook.ts

    pluginErrorCounter.inc({ pluginId, url: logUrl })

-    logger.warn('WebSocket error:', error)
+    logger.warn(`WebSocket error: ${String(error)}`)


Above we did { err }. Here we log the stringified version. Should we standardize on one of the other?

swansontec · 2026-01-22T00:36:39Z

docs/logging.md

+pluginLogger.error('message')
+
+// Pass an object with extra fields:
+pluginLogger.info({ ip: '1.2.3.4' }, 'connected')


You pass an object with a msg field in a ton of places, but your own docs suggest that this is the wrong approach. Should you be passing the msg field as a second string parameter? If so, that applies to a bunch of places.

src/util/scanAdapters/EtherscanV1ScanAdapter.ts

swansontec · 2026-01-22T00:49:10Z

src/util/scanAdapters/EtherscanV2ScanAdapter.ts

-      logger.warn({ host, msg: 'No API key found' })
+    if (url == null) {
+      logger.error({ msg: 'No URLs for EtherscanV2ScanAdapter provided' })
+      return false


swansontec · 2026-01-22T00:53:07Z

src/plugins/blockbook.ts

    const socketReady = new Promise<void>(resolve => {
      ws.on('open', () => {
-        pluginConnectionCounter.inc({ pluginId, url: logUrl })
+        pluginConnectionCounter.inc({ pluginId, url: url })


url: url could be just url. There are a bunch of other places where this happens in this same commit.

"Standardize on `{ msg: ... }` and `{ err }`" - Pass msg as second string parameter to logger methods instead of in the object. Use `{ err: error }` for error logging instead of String(error). Also removes debug `{ scope: 'foo' }`, uses shorthand `url` instead of `url: url`, and returns true when no URLs available (fail-safe).

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

cursor · 2026-01-24T01:17:36Z

src/plugins/blockbook.ts

    const socketReady = new Promise<void>(resolve => {
      ws.on('open', () => {
-        pluginConnectionCounter.inc({ pluginId, url: logUrl })
+        pluginConnectionCounter.inc({ pluginId, url })


API keys exposed in Prometheus metric labels

High Severity

The url parameter now contains the actual API key (substituted by authenticateUrl in allPlugins.ts) and is used directly in Prometheus metric labels via pluginConnectionCounter.inc({ pluginId, url }) and similar calls. The old code maintained a separate logUrl with the template placeholder {nowNodesApiKey} for metrics, while using connectionUrl with the actual key only for connections. This change exposes API keys to anyone with access to the Prometheus metrics endpoint.

Additional Locations (2)

src/plugins/blockbook.ts#L108-L109

src/plugins/blockbook.ts#L203-L204

samholmes · 2026-01-26T22:21:01Z

Closing this PR since we've dropped the commit that is the main reason for it (the WSS url support).

All the other commits will be in #13

samholmes force-pushed the sam/ws-transport branch from 5bf8600 to d4fde3b Compare January 17, 2026 00:18

This comment was marked as outdated.

Sign in to view

samholmes force-pushed the sam/ws-transport branch from d4fde3b to 0003e4a Compare January 19, 2026 23:41

samholmes added 5 commits January 19, 2026 17:02

Disable some chains

a4043d8

Remove the following plugins to reduce load: - abstract, amoy, arbitrum, avalanche, base - bobevm, celo, ethereumclassic, ethereumpow, fantom - filecoinfevm, filecoinfevmcalibration, holesky, hyperevm - pulsechain, rsk, sepolia, sonic

refactor: use service key URL matching for nownodes

c54808e

This reduces complexity and re-uses the new infrastructure. The only trade-off is to remove the logging of the URL without the key, which we can accept since these logs should be treated as company sensitive.

feat: add websocket RPC transport support for evmRpc plugin

d9c897f

samholmes force-pushed the sam/ws-transport branch from 0003e4a to d9c897f Compare January 20, 2026 01:02

cursor bot reviewed Jan 20, 2026

View reviewed changes

src/util/scanAdapters/EtherscanV1ScanAdapter.ts Outdated Show resolved Hide resolved

This was referenced Jan 21, 2026

Alchemy Plugin #14

Draft

Sam/correctness issues #13

Open

swansontec requested changes Jan 22, 2026

View reviewed changes

samholmes added 2 commits January 23, 2026 17:07

fixup! feat: Add flexible service key matching with URL templating

b270b9f

samholmes force-pushed the sam/ws-transport branch from b4b7b8c to b270b9f Compare January 24, 2026 01:07

cursor bot reviewed Jan 24, 2026

View reviewed changes

samholmes closed this Jan 26, 2026

Sam/ws transport #12

Sam/ws transport #12

Uh oh!

Conversation

samholmes commented Jan 17, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CHANGELOG

Dependencies

Description

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

swansontec left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

swansontec Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

samholmes Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

swansontec Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

swansontec Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

swansontec Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

swansontec Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot Jan 24, 2026

Choose a reason for hiding this comment

API keys exposed in Prometheus metric labels

Uh oh!

samholmes commented Jan 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

samholmes commented Jan 17, 2026 •

edited by cursor bot

Loading