Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mottymilshtein merged 4 commits into from
Oct 4, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
276bc14
DEX-2183: warn once at startup and add a README banner that the SDK i…
mottymilshtein Oct 1, 2026
f4b1f30
DEX-2185: remind the releaser to mark each new version deprecated on npm
mottymilshtein Oct 1, 2026
59fcf34
DEX-2183: drop the npm deprecate reminder from the publish workflow
mottymilshtein Oct 1, 2026
28d3a3f
DEX-2183: document how to silence the startup warning in the README b…
mottymilshtein Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
## The Official Javascript & Typescript SDK for Fireblocks API
[![npm version](https://badge.fury.io/js/fireblocks-sdk.svg)](https://badge.fury.io/js/fireblocks-sdk)

> **⚠️ This package is deprecated.**
>
> `fireblocks-sdk` is deprecated and reaches **end-of-life on November 1, 2026** — no further updates or fixes will be released after that date.
>
> Existing installs continue to work, and this package will never be unpublished.
>
> Migrate to [`@fireblocks/ts-sdk`](https://www.npmjs.com/package/@fireblocks/ts-sdk) — see the [SDK Migration Guide](https://developers.fireblocks.com/reference/sdk-migration-guide).
>
> To silence the startup warning, set `FIREBLOCKS_SDK_SUPPRESS_DEPRECATION_WARNING=1`.

> The current version of the SDK has changed the minimum supported Node.js version from v12 to v16.
>
> Versions older than v16 are no longer maintained by the Node.js community and are considered EOL.
Expand Down
10 changes: 10 additions & 0 deletions src/fireblocks-sdk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,11 @@ export interface SDKOptions {

const DEFAULT_MAX_PAGE_SIZE = 100;

const DEPRECATION_WARNING = "fireblocks-sdk is deprecated and reaches end-of-life on November 1, 2026: no further updates or fixes after that date. " +
"Existing installs continue to work. Migrate to @fireblocks/ts-sdk: https://developers.fireblocks.com/reference/sdk-migration-guide " +
"(set FIREBLOCKS_SDK_SUPPRESS_DEPRECATION_WARNING=1 to silence this warning)";
let deprecationWarningShown = false;

export class FireblocksSDK {
private readonly authProvider: IAuthProvider;
private readonly apiBaseUrl: string;
Expand All @@ -243,6 +248,11 @@ export class FireblocksSDK {
* @param sdkOptions
*/
constructor(privateKey: string, apiKey: string, apiBaseUrl: string = "https://api.fireblocks.io", authProvider: IAuthProvider = undefined, sdkOptions?: SDKOptions) {
if (!deprecationWarningShown && !process.env.FIREBLOCKS_SDK_SUPPRESS_DEPRECATION_WARNING) {
deprecationWarningShown = true;
console.warn(DEPRECATION_WARNING);
}

this.authProvider = !!authProvider ? authProvider : new ApiTokenProvider(privateKey, apiKey);

if (!!apiBaseUrl) {
Expand Down
Loading