@obolnetwork/obol-sdk 2.12.0 → 2.12.2

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.
Files changed (42) hide show
  1. package/README.md +6 -4
  2. package/dist/browser/src/index.js +374 -170
  3. package/dist/browser/src/index.js.map +1 -1
  4. package/dist/cjs/src/blsUtils.js +19 -2
  5. package/dist/cjs/src/blsUtils.js.map +1 -1
  6. package/dist/cjs/src/index.js +382 -170
  7. package/dist/cjs/src/index.js.map +1 -1
  8. package/dist/cjs/src/verification/clusterLockValidationWorker.js +14694 -0
  9. package/dist/cjs/src/verification/clusterLockValidationWorker.js.map +1 -0
  10. package/dist/cjs/src/verification/lockWorker.js +13 -1
  11. package/dist/cjs/src/verification/lockWorker.js.map +1 -1
  12. package/dist/cjs/src/verification/parallelPool.js +227 -35
  13. package/dist/cjs/src/verification/parallelPool.js.map +1 -1
  14. package/dist/esm/src/blsUtils.js +7 -3
  15. package/dist/esm/src/{chunk-267HIPEB.js → chunk-LOSYOJC3.js} +16 -1
  16. package/dist/esm/src/{chunk-267HIPEB.js.map → chunk-LOSYOJC3.js.map} +1 -1
  17. package/dist/esm/src/chunk-T74RX3N2.js +10240 -0
  18. package/dist/esm/src/chunk-T74RX3N2.js.map +1 -0
  19. package/dist/esm/src/chunk-YSXFCSVK.js +389 -0
  20. package/dist/esm/src/chunk-YSXFCSVK.js.map +1 -0
  21. package/dist/esm/src/index.js +234 -10339
  22. package/dist/esm/src/index.js.map +1 -1
  23. package/dist/esm/src/verification/clusterLockValidationWorker.js +18 -0
  24. package/dist/esm/src/verification/clusterLockValidationWorker.js.map +1 -0
  25. package/dist/esm/src/verification/lockWorker.js +7 -2
  26. package/dist/esm/src/verification/lockWorker.js.map +1 -1
  27. package/dist/esm/src/verification/parallelPool.js +8 -2
  28. package/dist/types/src/base.d.ts +5 -3
  29. package/dist/types/src/blsUtils.d.ts +3 -0
  30. package/dist/types/src/errors.d.ts +21 -0
  31. package/dist/types/src/index.d.ts +5 -6
  32. package/dist/types/src/services.d.ts +4 -1
  33. package/dist/types/src/types.d.ts +6 -0
  34. package/dist/types/src/verification/clusterLockValidationWorker.d.ts +1 -0
  35. package/dist/types/src/verification/common.d.ts +17 -7
  36. package/dist/types/src/verification/lockWorker.d.ts +7 -2
  37. package/dist/types/src/verification/parallelPool.d.ts +9 -0
  38. package/dist/types/test/client/baseUrl.spec.d.ts +1 -0
  39. package/dist/types/tsconfig.types.tsbuildinfo +1 -1
  40. package/package.json +2 -2
  41. package/dist/esm/src/chunk-OYZHSNKR.js +0 -186
  42. package/dist/esm/src/chunk-OYZHSNKR.js.map +0 -1
package/README.md CHANGED
@@ -39,11 +39,13 @@ Checkout our [docs](https://docs.obol.org/docs/advanced/quickstart-sdk), [exampl
39
39
  ## Terms and Conditions
40
40
  To use obol-sdk and in order to be able to create a cluster definition or accept an invite to join a cluster, you must accept the [latest Obol terms and conditions](https://obol.org/terms.pdf) by calling acceptObolLatestTermsAndConditions.
41
41
 
42
- ## ⚠️ Important Security Notice:
43
- If you're integrating this SDK with a **backend** (e.g., in Node.js), and you store a private key for executing splitter transactions, handle it with extreme caution. Ensure that:
42
+ ## Security
44
43
 
45
- - The private key is securely stored (e.g., in an `.env` file).
46
- - Never commit or push your `.env` file containing the private key to version control.
44
+ **API host:** `baseUrl` must be one of `https://api.obol.tech`, `https://obol-api-nonprod-dev.dev.obol.tech`, or `https://obol-api-nonprod-qa.dev.obol.tech` (no path suffix). Endpoints are still called as `/v1/...` as before. Any other value throws `InvalidBaseUrlError`.
45
+
46
+ **RPC URLs:** Set `RPC_MAINNET`, `RPC_HOODI`, etc. in your own app or pass an explicit provider/RPC to the client. The SDK does not load a `.env` file on import.
47
+
48
+ **Private keys:** If you use a backend signer, store keys securely (KMS, HSM, or env vars your app loads explicitly). Never commit secrets to version control.
47
49
 
48
50
  ## ⚡️ Integration with Safe Wallet
49
51