@babylonlabs-io/ts-sdk 0.20.1 → 0.22.0

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 (51) hide show
  1. package/README.md +14 -6
  2. package/dist/{errors-D_PI__IT.js → errors-CkkL1ztr.js} +338 -328
  3. package/dist/errors-CkkL1ztr.js.map +1 -0
  4. package/dist/errors-D2H46Yut.cjs +2 -0
  5. package/dist/errors-D2H46Yut.cjs.map +1 -0
  6. package/dist/index-BAECy2oz.cjs +2 -0
  7. package/dist/index-BAECy2oz.cjs.map +1 -0
  8. package/dist/{index-CFwoGJNQ.js → index-DLtpqdlu.js} +141 -115
  9. package/dist/index-DLtpqdlu.js.map +1 -0
  10. package/dist/index.cjs +1 -1
  11. package/dist/index.js +124 -117
  12. package/dist/index.js.map +1 -1
  13. package/dist/shared/wallets/index.d.ts +8 -0
  14. package/dist/shared/wallets/index.d.ts.map +1 -1
  15. package/dist/tbv/core/clients/index.cjs +1 -1
  16. package/dist/tbv/core/clients/index.d.ts +3 -2
  17. package/dist/tbv/core/clients/index.d.ts.map +1 -1
  18. package/dist/tbv/core/clients/index.js +16 -15
  19. package/dist/tbv/core/clients/mempool/mempoolApi.d.ts.map +1 -1
  20. package/dist/tbv/core/clients/vault-provider/index.d.ts +1 -1
  21. package/dist/tbv/core/clients/vault-provider/index.d.ts.map +1 -1
  22. package/dist/tbv/core/contracts/errors.d.ts.map +1 -1
  23. package/dist/tbv/core/index.cjs +1 -1
  24. package/dist/tbv/core/index.js +120 -113
  25. package/dist/tbv/core/index.js.map +1 -1
  26. package/dist/tbv/core/managers/PeginManager.d.ts.map +1 -1
  27. package/dist/tbv/core/managers/index.d.ts +15 -62
  28. package/dist/tbv/core/managers/index.d.ts.map +1 -1
  29. package/dist/tbv/core/services/index.d.ts +2 -4
  30. package/dist/tbv/core/services/index.d.ts.map +1 -1
  31. package/dist/tbv/core/utils/index.cjs +1 -1
  32. package/dist/tbv/core/utils/index.d.ts +2 -7
  33. package/dist/tbv/core/utils/index.d.ts.map +1 -1
  34. package/dist/tbv/core/utils/index.js +37 -31
  35. package/dist/tbv/core/utils/index.js.map +1 -1
  36. package/dist/tbv/core/utils/validation.d.ts +35 -0
  37. package/dist/tbv/core/utils/validation.d.ts.map +1 -0
  38. package/dist/tbv/index.cjs +1 -1
  39. package/dist/tbv/index.js +120 -113
  40. package/dist/tbv/index.js.map +1 -1
  41. package/dist/validation-CxqROCno.js +15 -0
  42. package/dist/validation-CxqROCno.js.map +1 -0
  43. package/dist/validation-u8W7Lp2x.cjs +2 -0
  44. package/dist/validation-u8W7Lp2x.cjs.map +1 -0
  45. package/package.json +1 -1
  46. package/dist/errors-D9EtjJoD.cjs +0 -2
  47. package/dist/errors-D9EtjJoD.cjs.map +0 -1
  48. package/dist/errors-D_PI__IT.js.map +0 -1
  49. package/dist/index-BpXpESWu.cjs +0 -2
  50. package/dist/index-BpXpESWu.cjs.map +0 -1
  51. package/dist/index-CFwoGJNQ.js.map +0 -1
package/README.md CHANGED
@@ -5,11 +5,9 @@
5
5
 
6
6
  TypeScript SDK for Trustless Bitcoin Vaults
7
7
 
8
- > **⚠️ Status**: Currently under active development.
9
-
10
8
  ## Overview
11
9
 
12
- The Babylon TypeScript SDK is a production-ready toolkit for integrating Trustless Bitcoin Vaults into your applications. Currently provides comprehensive support for Trustless Bitcoin Vaults (TBV) including vault management and supported application integrations.
10
+ The Babylon TypeScript SDK is the toolkit for integrating Trustless Bitcoin Vaults into your applications. It provides vault lifecycle management (peg-in, activation, refund, payout signing) and application integrations built on top, starting with Aave v4.
13
11
 
14
12
  ## What Are Trustless Bitcoin Vaults?
15
13
 
@@ -156,9 +154,9 @@ import {
156
154
  } from "@babylonlabs-io/ts-sdk/tbv/integrations/aave";
157
155
  ```
158
156
 
159
- ## Choose Your API Level
157
+ ## Where to start
160
158
 
161
- The SDK provides two integration approaches:
159
+ The SDK exposes several peer entry points — **managers**, **services**, **primitives**, **utils**, **clients**, and **integrations** — and you compose the pieces you need. The two most common starting points for a new integration are:
162
160
 
163
161
  ### Managers (High-Level)
164
162
 
@@ -174,7 +172,13 @@ The SDK provides two integration approaches:
174
172
  - **You provide**: Everything (signing logic, contract calls, broadcasting)
175
173
  - **SDK handles**: Only PSBT construction and utility functions
176
174
 
177
- ## Trustless Bitcoin Vaults (TBV) Documentation
175
+ For how `services`, `utils`, `clients`, and `integrations` fit in and which layer a given task belongs to, read the [Get Started](./docs/get-started/README.md) guide.
176
+
177
+ ## Documentation
178
+
179
+ ### 🏁 Start here
180
+
181
+ - **[Get Started](./docs/get-started/README.md)** — five-minute orientation: what TBV is, the SDK's layer layout, prerequisites, config sourcing, glossary, vault lifecycle, and a decision table routing you to the right quickstart. **Read this first if you're new.**
178
182
 
179
183
  ### 🚀 Quickstart
180
184
 
@@ -183,6 +187,10 @@ Step-by-step tutorials:
183
187
  - **[Managers Quickstart](./docs/quickstart/managers.md)** - Create a Bitcoin vault with wallet integration (step-by-step)
184
188
  - **[Primitives Quickstart](./docs/quickstart/primitives.md)** - Build vault PSBTs with custom signing logic (advanced)
185
189
 
190
+ ### 🔑 Guides
191
+
192
+ - **[Wallet Interfaces](./docs/guides/wallet-interfaces.md)** - Adapt any BTC/ETH wallet (browser, Node.js, KMS/HSM) to the SDK's interfaces
193
+
186
194
  ### 🔌 Application Integrations
187
195
 
188
196
  Use BTC vaults in DeFi protocols and applications: