This repository was archived by the owner on Aug 14, 2026. It is now read-only.
docs: point readers at @opensea/sdk/stream - #528
Merged
Merged
Conversation
The Stream client now ships inside @opensea/sdk at the @opensea/sdk/stream subpath, and @opensea/stream-js is deprecated at 0.4.0. Anyone landing here should be sent to the maintained code rather than following install instructions for a package that will not be updated again. Adds a notice at the top with the uninstall/install commands, the two-line import diff, and the breaking changes, each linked to the migration guide. Also repoints the Documentation link from /reference/stream-js to /reference/stream-api. The old slug redirects, but this is the last thing a reader here will see, so it may as well be the live URL. Left as is: the rest of the README still describes the 0.4.0 API, which is what the last published version actually does. Rewriting it would misrepresent the package that is still on npm. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Stream client now ships inside
@opensea/sdkat the@opensea/sdk/streamsubpath.@opensea/stream-jsis deprecated, with0.4.0as its last published version.Anyone landing on this repo today gets install instructions for a package that will not be updated again, including
npm install ws node-localstorage, which is not needed on Node 22 or newer. This adds a notice at the top of the README with:It also repoints the Documentation link from
/reference/stream-jsto/reference/stream-api. The old slug redirects, but this is the last thing a reader here will see, so it may as well be the live URL.What I deliberately left alone
The rest of the README still describes the 0.4.0 API, because that is what the last published version actually does. Rewriting it to describe
@opensea/sdk/streamwould misrepresent the package still on npm for anyone pinned to it.The notice says "deprecated and no longer maintained" rather than "archived", so it reads correctly both now and after this repo is archived.
Context
@opensea/sdk11.9.0 is on npm with the client at@opensea/sdk/stream, verified by streaming live events from the published tarball.packages/streamfrom the monorepo, so this mirror will not be synced again.npm deprecate @opensea/stream-jsis the remaining step.🤖 Generated with Claude Code