add deprecation notice #978
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a prominent deprecation notice to the project README to direct users to @stellar/stellar-sdk for future updates.
Changes:
- Replaces the old Node crypto performance/optional dependency note with a deprecation notice pointing to
@stellar/stellar-sdk.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| > 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. ⚠️ |
|
Size Change: 0 B Total Size: 3.54 MB ℹ️ View Unchanged
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1b17d9c5a8
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| > 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. ⚠️ |
There was a problem hiding this comment.
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 👍 / 👎.
No description provided.