Skip to content

DEX-2183: warn once at startup and add a README deprecation banner - #347

Merged
mottymilshtein merged 4 commits into
masterfrom
DEX-2183-deprecation-notice
Oct 4, 2026
Merged

mottymilshtein merged 4 commits into
masterfrom
DEX-2183-deprecation-notice

Conversation

@mottymilshtein

@mottymilshtein mottymilshtein commented Oct 1, 2026 •

Copy link
Copy Markdown
Collaborator

What

  • Startup warning. The FireblocksSDK constructor prints a one-time console.warn: the SDK is deprecated, it reaches end-of-life on November 1, 2026, and users should migrate to @fireblocks/ts-sdk, with the migration guide link. It fires once per process however many clients are created. Setting FIREBLOCKS_SDK_SUPPRESS_DEPRECATION_WARNING to any value turns it off, for customers with strict log monitoring.
  • README banner at the top, covering the four points DEX-2183 requires: deprecated now · no updates or fixes after November 1, 2026 · existing installs keep working and the package will never be unpublished · migrate to @fireblocks/ts-sdk, with the guide link. It's a plain blockquote, not GitHub's > [!IMPORTANT] syntax, because npm doesn't render that syntax and would show the tag as literal text.

Not included: @deprecated tags

Tagging the SDK class @deprecated would cross it out in editors. I left it out on purpose. typescript-eslint's no-deprecated rule is an error in the strict-type-checked preset, so customers using that preset would have their lint fail after upgrading. DEX-2183 asks to signal deprecation "without breaking anyone", and it made the runtime warning switchable for the same reason. A lint error has no such switch.

After the release (DEX-2185)

Right after this release, a fireblocks-sdk maintainer deprecates the package on npm: npmjs.com → fireblocks-sdk → Settings → Deprecate package. That marks every version, including this one. Message to use:

fireblocks-sdk is deprecated and reaches end-of-life (no further updates or fixes) on Nov 1, 2026. Existing installs continue to work. Migrate to @fireblocks/ts-sdk — https://developers.fireblocks.com/reference/sdk-migration-guide

No further releases are planned, so this is a one-time step.

Tested

  • tsc and tslint pass.
  • I built the package, then created the client 3 times in one process. The warning appeared exactly once. With FIREBLOCKS_SDK_SUPPRESS_DEPRECATION_WARNING=1 it didn't appear.

🤖 Generated with Claude Code

…s deprecated

The SDK reaches end-of-life on November 1, 2026. The constructor now prints a
one-time console warning pointing at @fireblocks/ts-sdk, silenced by setting
FIREBLOCKS_SDK_SUPPRESS_DEPRECATION_WARNING, and the README opens with a
deprecation banner.
npm deprecate only marks versions that already exist, so a version published
after the package is deprecated installs without a warning. This repo publishes
through OIDC and deliberately holds no npm token, and OIDC cannot run npm
deprecate, so the step after publish raises a warning and puts the exact
npm deprecate command in the run summary for a fireblocks-sdk maintainer on npm
to run by hand.
@mottymilshtein mottymilshtein changed the title DEX-2183: warn once at startup and add a README deprecation banner DEX-2183, DEX-2185: deprecation warning, README banner, and npm deprecate reminder Oct 1, 2026
No further releases are planned after this one, and nobody reads the release
run's log for it. npm deprecate is run once by hand right after this release.
@mottymilshtein mottymilshtein changed the title DEX-2183, DEX-2185: deprecation warning, README banner, and npm deprecate reminder DEX-2183: warn once at startup and add a README deprecation banner Oct 1, 2026
@mottymilshtein
mottymilshtein merged commit a9ca97d into master Oct 4, 2026
12 checks passed
@mottymilshtein
mottymilshtein deleted the DEX-2183-deprecation-notice branch October 4, 2026 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants