Skip to content

docs: state Node 22 as the minimum for the SDK - #2024

Closed
dj-jarvis wants to merge 1 commit into
ProjectOpenSea:mainfrom
dj-jarvis:docs/node-22-minimum
Closed

dj-jarvis wants to merge 1 commit into
ProjectOpenSea:mainfrom
dj-jarvis:docs/node-22-minimum

Conversation

@dj-jarvis

Copy link
Copy Markdown

Problem

Three docs still require Node 20:

  • developerDocs/quick-start.md:14 — "Node.js version 20 or higher is required… run nvm use 20"
  • developerDocs/contributing.md:18 — "Node.js 20 or higher"
  • developerDocs/overview.md:32 — "Node.js 20 or higher"

Every other source in the repo says 22+: package.json sets engines.node: ">=22.0.0", README.md:287 says "Node 22 or newer", AGENTS.md says "Node 22+ is the floor", developerDocs/stream-migration.md:156 states "Node 22 is the minimum", CHANGELOG.md:505 records the bump, and .nvmrc (which CI reads) is 24.14.1.

Impact

A reader following the Quick Start runs nvm use 20, gets EBADENGINE from npm, and on that runtime @opensea/sdk/stream throws No WebSocket implementation found because Node 20 has no global WebSocket. Contributors also set up a Node version that differs from CI.

Fix

Update the three stale statements to 22, matching engines.node. Prose only — no TypeScript fences changed, so the doc-example check is unaffected and biome (which covers **/*.ts, **/*.js, **/*.json only) does not touch markdown.

@ryanio

ryanio commented Oct 6, 2026

Copy link
Copy Markdown
Collaborator

Thanks! All three guides now say Node 22, matching engines.node. Recreated in our internal monorepo in ProjectOpenSea/opensea-devtools#789 (now merged) with you credited, and it ships with the next SDK release.

This repo is a read-only mirror, so we can't merge here, but we review every PR. Appreciate you taking the time.

@ryanio ryanio closed this Oct 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants