From e78dfd19519f34e2450f29042fba103fb1c938af Mon Sep 17 00:00:00 2001 From: Mohammad Al Faiyaz Date: Fri, 23 Oct 2026 14:44:01 -0400 Subject: [PATCH 1/3] build: require Node.js 22+ for UTXO packages Refs: WCN-3796 --- CLAUDE.md | 2 +- DEVELOPERS.md | 2 +- README.md | 10 +++++----- modules/utxo-bin/package.json | 3 +++ modules/utxo-core/package.json | 3 +++ modules/utxo-ord/package.json | 3 +++ scripts/sdk-coin-generator-v2/core/generator.ts | 2 +- scripts/sdk-coin-generator/template/base/package.json | 2 +- 8 files changed, 18 insertions(+), 9 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 8cfdbd2683c..037df89541b 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -130,4 +130,4 @@ This will generate the necessary boilerplate for a new coin implementation. ## Node.js Version Support -BitGoJS supports Node.js versions >=20, with NPM >=3.10.10. +BitGoJS supports Node.js versions >=22, with NPM >=3.10.10. diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 4a7f10002e6..ecdff2dae04 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -180,7 +180,7 @@ Engines should be set to the following: ```json { "engines": { - "node": ">=22 <25", + "node": ">=22", "npm": ">=3.10.10" } } diff --git a/README.md b/README.md index c3e9b423b7a..58d51e84829 100644 --- a/README.md +++ b/README.md @@ -47,24 +47,24 @@ Examples can be found in each of the modules specific to the module use cases. S # NodeJS Version Support Policy -BitGoJS currently provides support for the following Node versions per package.json engines policy: +BitGoJS packages declare a minimum supported Node version of 22; CI tests supported LTS versions and checks the Current release line non-blocking: ``` "engines": { - "node": ">=22 <25", + "node": ">=22", "npm": ">=3.10.10" } ``` -We specifically limit our support to these versions of Node, not because this package won't work on other versions, but because these versions tend to be the most widely used in practice. It's possible the packages in this repository will work correctly on newer or older versions of Node, but we typically don't run automated tests against non-specified versions of Node (including odd versions), with the possible exception of the latest odd numbered version for advanced awareness of upcoming breaks in version support. +The engines range sets a minimum Node version rather than an upper bound. The required CI matrix covers supported LTS versions; other versions may work but are not covered by required tests, except the Current release line as a non-blocking signal. -As each Node LTS version reaches its end-of-life we will exclude that version from the node engines property of our package's package.json file. Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package. We will not accept any requests to support an end-of-life version of Node, and any pull requests or issues regarding support for an end-of-life version of Node will be closed. We will accept code that allows this package to run on newer, non-LTS, versions of Node. Furthermore, we will attempt to ensure our own changes work on the latest version of Node. To help in that commitment, our continuous integration setup runs the full test suite on the latest release of the following versions of node: +As the oldest supported Node LTS reaches end-of-life, raise the minimum `node` engines version to the next supported LTS. Removing support for an LTS version is a breaking change and entails publishing a new major version. We will not accept requests to support an end-of-life version of Node. We will accept code that allows this package to run on newer, non-LTS versions and will attempt to ensure changes work on the latest Node release. - `22` (Maintenance LTS) — required to pass - `24` (Active LTS) — required to pass - `26` (Current) — run non-blocking; a failure posts a warning comment on the PR instead of blocking merge -When a new Node major becomes Active LTS, update the `node-version` matrix in `.github/workflows/ci.yml` (moving the outgoing Current version into the required set and adding the new Current release), and bump the `engines.node` range across all `modules/*/package.json` files accordingly. +When a new Node major becomes Active LTS, update the `node-version` matrix in `.github/workflows/ci.yml` (moving the outgoing Current version into the required set and adding the new Current release). When the minimum supported LTS changes, raise `engines.node` across package manifests accordingly. JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our node engines property. If you encounter issues installing this package on a supported version of Node, please report the issue to us. diff --git a/modules/utxo-bin/package.json b/modules/utxo-bin/package.json index 79d5048f306..af4efc5f4bc 100644 --- a/modules/utxo-bin/package.json +++ b/modules/utxo-bin/package.json @@ -19,6 +19,9 @@ "fmt": "prettier --write '{bin,src,test}/**/*.{ts,js}'", "precommit": "yarn lint-staged" }, + "engines": { + "node": ">=22" + }, "repository": { "type": "git", "url": "https://github.com/BitGo/BitGoJS.git", diff --git a/modules/utxo-core/package.json b/modules/utxo-core/package.json index 6fbc6289cf2..85316ce324d 100644 --- a/modules/utxo-core/package.json +++ b/modules/utxo-core/package.json @@ -58,6 +58,9 @@ }, "author": "BitGo SDK Team ", "license": "MIT", + "engines": { + "node": ">=22" + }, "repository": { "type": "git", "url": "https://github.com/BitGo/BitGoJS.git", diff --git a/modules/utxo-ord/package.json b/modules/utxo-ord/package.json index d8a49511a58..97002002e55 100644 --- a/modules/utxo-ord/package.json +++ b/modules/utxo-ord/package.json @@ -39,6 +39,9 @@ "fmt": "prettier --write '{src,test}/**/*.{ts,js}'", "precommit": "yarn lint-staged" }, + "engines": { + "node": ">=22" + }, "repository": { "type": "git", "url": "https://github.com/BitGo/BitGoJS.git", diff --git a/scripts/sdk-coin-generator-v2/core/generator.ts b/scripts/sdk-coin-generator-v2/core/generator.ts index dd0351f24e6..d758c3c1e36 100644 --- a/scripts/sdk-coin-generator-v2/core/generator.ts +++ b/scripts/sdk-coin-generator-v2/core/generator.ts @@ -214,7 +214,7 @@ export class Generator { author: 'BitGo SDK Team ', license: 'MIT', engines: { - node: '>=20 <23', + node: '>=22', }, repository: { type: 'git', diff --git a/scripts/sdk-coin-generator/template/base/package.json b/scripts/sdk-coin-generator/template/base/package.json index 99be6c2607c..c4bb419e28b 100644 --- a/scripts/sdk-coin-generator/template/base/package.json +++ b/scripts/sdk-coin-generator/template/base/package.json @@ -21,7 +21,7 @@ "author": "BitGo SDK Team ", "license": "MIT", "engines": { - "node": ">=20" + "node": ">=22" }, "repository": { "type": "git", From bb214b43cf7d744dda981c36cdb11223c0f5a8a8 Mon Sep 17 00:00:00 2001 From: Mohammad Al Faiyaz Date: Fri, 23 Oct 2026 15:02:23 -0400 Subject: [PATCH 2/3] docs: restore Node engines upper bound in DEVELOPERS Refs: WCN-3796 --- DEVELOPERS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVELOPERS.md b/DEVELOPERS.md index ecdff2dae04..4a7f10002e6 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -180,7 +180,7 @@ Engines should be set to the following: ```json { "engines": { - "node": ">=22", + "node": ">=22 <25", "npm": ">=3.10.10" } } From a2740a708efca849c3b82d2b293fc02ffe0693a3 Mon Sep 17 00:00:00 2001 From: Mohammad Al Faiyaz Date: Fri, 23 Oct 2026 15:03:25 -0400 Subject: [PATCH 3/3] docs: restore README Node policy text Refs: WCN-3796 --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 58d51e84829..c3e9b423b7a 100644 --- a/README.md +++ b/README.md @@ -47,24 +47,24 @@ Examples can be found in each of the modules specific to the module use cases. S # NodeJS Version Support Policy -BitGoJS packages declare a minimum supported Node version of 22; CI tests supported LTS versions and checks the Current release line non-blocking: +BitGoJS currently provides support for the following Node versions per package.json engines policy: ``` "engines": { - "node": ">=22", + "node": ">=22 <25", "npm": ">=3.10.10" } ``` -The engines range sets a minimum Node version rather than an upper bound. The required CI matrix covers supported LTS versions; other versions may work but are not covered by required tests, except the Current release line as a non-blocking signal. +We specifically limit our support to these versions of Node, not because this package won't work on other versions, but because these versions tend to be the most widely used in practice. It's possible the packages in this repository will work correctly on newer or older versions of Node, but we typically don't run automated tests against non-specified versions of Node (including odd versions), with the possible exception of the latest odd numbered version for advanced awareness of upcoming breaks in version support. -As the oldest supported Node LTS reaches end-of-life, raise the minimum `node` engines version to the next supported LTS. Removing support for an LTS version is a breaking change and entails publishing a new major version. We will not accept requests to support an end-of-life version of Node. We will accept code that allows this package to run on newer, non-LTS versions and will attempt to ensure changes work on the latest Node release. +As each Node LTS version reaches its end-of-life we will exclude that version from the node engines property of our package's package.json file. Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package. We will not accept any requests to support an end-of-life version of Node, and any pull requests or issues regarding support for an end-of-life version of Node will be closed. We will accept code that allows this package to run on newer, non-LTS, versions of Node. Furthermore, we will attempt to ensure our own changes work on the latest version of Node. To help in that commitment, our continuous integration setup runs the full test suite on the latest release of the following versions of node: - `22` (Maintenance LTS) — required to pass - `24` (Active LTS) — required to pass - `26` (Current) — run non-blocking; a failure posts a warning comment on the PR instead of blocking merge -When a new Node major becomes Active LTS, update the `node-version` matrix in `.github/workflows/ci.yml` (moving the outgoing Current version into the required set and adding the new Current release). When the minimum supported LTS changes, raise `engines.node` across package manifests accordingly. +When a new Node major becomes Active LTS, update the `node-version` matrix in `.github/workflows/ci.yml` (moving the outgoing Current version into the required set and adding the new Current release), and bump the `engines.node` range across all `modules/*/package.json` files accordingly. JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our node engines property. If you encounter issues installing this package on a supported version of Node, please report the issue to us.