From 1b17d9c5a87814ab619865c59d9fb818a9abf66e Mon Sep 17 00:00:00 2001 From: Ryan Yang Date: Thu, 18 Jun 2026 15:56:10 -0700 Subject: [PATCH] add deprecation notice and remove stale warning about sodium-native --- README.md | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 505f357b4..3c969c137 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,8 @@ implementation in JavaScript that can be used on either Node.js or web browsers. - **[API Reference](https://stellar.github.io/js-stellar-base/)** -> **Warning!** The Node version of this package uses the [`sodium-native`](https://www.npmjs.com/package/sodium-native) package, a native implementation of [Ed25519](https://ed25519.cr.yp.to/) in Node.js, as an [optional dependency](https://docs.npmjs.com/files/package.json#optionaldependencies). -> This means that if for any reason installation of this package fails, `stellar-base` will fallback to the much slower implementation contained in [`tweetnacl`](https://www.npmjs.com/package/tweetnacl). -> -> If you'd explicitly prefer **not** to install the `sodium-native` package, pass the appropriate flag to skip optional dependencies when installing this package (e.g. `--no-optional` if using `npm install` or `--without-optional` using `yarn install`). -> -> If you are using `stellar-base` in a browser you can ignore this. However, for production backend deployments you should most likely be using `sodium-native`. -> If `sodium-native` is successfully installed and working, -> `StellarBase.FastSigning` variable will be equal `true`. Otherwise it will be -> `false`. +> ⚠️ **Deprecation Notice:** `@stellar/stellar-base` still works, but is no longer actively updated. Future updates, including protocol releases, ship only in [`@stellar/stellar-sdk`](https://www.npmjs.com/package/@stellar/stellar-sdk), which re-exports this package's full API. Switch your dependency to `@stellar/stellar-sdk` to keep receiving updates. ⚠️ + ## Quick start