@utexo/rgb-sdk 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Readme.md +8 -4
- package/package.json +1 -2
package/Readme.md
CHANGED
|
@@ -1,11 +1,15 @@
|
|
|
1
|
-
|
|
2
|
-
# RGB SDK v2 Overview
|
|
1
|
+
# @utexo/rgb-sdk Overview
|
|
3
2
|
|
|
4
3
|
This is the underlying SDK used by RGB client applications. It provides a complete set of TypeScript/Node.js bindings for managing RGB-based transfers using **rgb-protocol libraries**
|
|
5
4
|
|
|
5
|
+
⚠️ **Security Notice**
|
|
6
|
+
If you're migrating from the legacy `rgb-sdk` (which relied on a remote RGB Node server), be aware that wallet metadata such as xpubs may have been exposed and this cannot be undone.
|
|
7
|
+
|
|
8
|
+
If you're upgrading from `rgb-sdk` to `@utexo/rgb-sdk`, see the **[Migration Guide](./README.md#migration-guide-rgb-sdk--utexorgb-sdk)** for step-by-step instructions on moving your wallet state to local storage.
|
|
9
|
+
|
|
10
|
+
For full details on security implications and recommended actions, please read **[SECURITY.md](./SECURITY.md)**.
|
|
11
|
+
|
|
6
12
|
> **RGB Protocol**: This SDK uses the [`rgb-lib`](https://github.com/RGB-Tools/rgb-lib) binding library to interact with the RGB protocol. All operations are performed locally, providing full control over wallet data and operations.
|
|
7
|
-
>
|
|
8
|
-
> **Migrating from v1?** If you're upgrading from RGB SDK v1 (using RGB Node server), see the [Migration Guide](./MIGRATION.md) for step-by-step instructions on moving your wallet state to local storage.
|
|
9
13
|
|
|
10
14
|
---
|
|
11
15
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@utexo/rgb-sdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.4",
|
|
4
4
|
"devDependencies": {
|
|
5
5
|
"@types/jest": "^30.0.0",
|
|
6
6
|
"@types/node": "^22.17.2",
|
|
@@ -13,7 +13,6 @@
|
|
|
13
13
|
"scripts": {
|
|
14
14
|
"dev": "tsc -w",
|
|
15
15
|
"build": "tsup",
|
|
16
|
-
"prepare": "npm run build",
|
|
17
16
|
"test": "npm run build && NODE_OPTIONS='--experimental-vm-modules' jest",
|
|
18
17
|
"test:watch": "npm run build && NODE_OPTIONS='--experimental-vm-modules' jest --watch",
|
|
19
18
|
"test:coverage": "npm run build && NODE_OPTIONS='--experimental-vm-modules' jest --coverage",
|