Skip to content

add deprecation notice #978

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
Ryang-21 merged 1 commit into from
Jun 22, 2026
Merged

add deprecation notice #978

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 2 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. ⚠️

@chatgpt-codex-connector chatgpt-codex-connector Bot Jun 18, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Clarify that migration must update import specifiers

The notice tells users to “Switch your dependency” to @stellar/stellar-sdk, but the Quick start/Install snippets immediately below still install and import @stellar/stellar-base. In projects that remove the base package and keep require("@stellar/stellar-base")/imports unchanged, the SDK re-export is not used and the app fails at module resolution instead of receiving updates. Please make the migration wording or examples explicitly change the import/install target to @stellar/stellar-sdk.

Useful? React with 👍 / 👎.



## Quick start

Expand Down
Loading