@baseline-markets/sdk 0.0.3 → 1.0.1

package/README.md

@@ -2,7 +2,7 @@
 
 A typed TypeScript SDK for interacting with [Baseline Protocol](https://baseline.markets) contracts via [viem](https://viem.sh).
 
-Baseline is an onchain AMM for leveraged tokens — `@baseline-markets/sdk` exposes a single `BaselineSDK` class covering token launches, swaps, borrowing, leverage, staking, and rewards.
+Baseline is an onchain AMM for tokens with built-in liquidity — `@baseline-markets/sdk` exposes a single `BaselineSDK` class covering token launches, swaps, borrowing, leverage, staking, and rewards.
 
 ## Install
 
@@ -49,9 +49,9 @@ const quote   = await sdk.quoteBuyExactOut(bToken, 100n);
 ### Swaps
 
 ```ts
-// Buy exactly 100 bTokens, capped at `quote.reservesIn` reserve in
-const hash = await sdk.buyTokensExactOut(bToken, 100n, quote.reservesIn, {
-  wait: true,
+// Buy exactly 100 bTokens, capped at `quote.amountIn` reserve in
+const hash = await sdk.buyTokensExactOut(bToken, 100n, quote.amountIn, {
+  confirmations: 1,
 });
 
 // Sell 100 bTokens, accept at least `minOut` reserve out
@@ -62,9 +62,17 @@ const hash2 = await sdk.sellTokensExactIn(bToken, 100n, minOut);
 
 ```ts
 await sdk.deposit(bToken, collateral);
-await sdk.borrow(bToken, debtAmount);
-await sdk.leverage(bToken, collateral, targetLTV);
-await sdk.repay(bToken, debtAmount);
+await sdk.borrow(bToken, debtAmount, recipient);
+
+const leverageQuote = await sdk.quoteLeverage(bToken, collateralIn, leverageFactor);
+await sdk.leverage(
+  bToken,
+  leverageQuote.targetCollateral,
+  collateralIn,
+  leverageQuote.maxSwapReservesIn,
+);
+
+await sdk.repay(bToken, reservesIn, recipient);
 await sdk.claim(bToken);
 ```
 
@@ -165,7 +173,7 @@ function BuyButton({ bToken, amount, maxIn }: {
 
   const buy = useMutation({
     mutationFn: () =>
-      sdk!.buyTokensExactOut(bToken, amount, maxIn, { wait: true }),
+      sdk!.buyTokensExactOut(bToken, amount, maxIn, { confirmations: 1 }),
     onError: (err) => {
       if (err instanceof SDKError && err.kind === 'user_rejected') return;
       // surface other kinds: insufficient_funds, reverted, network, ...
@@ -183,7 +191,7 @@ function BuyButton({ bToken, amount, maxIn }: {
 }
 ```
 
-The `wait: true` option resolves the promise only after the receipt is mined, so `buy.isPending` covers both the wallet-prompt and the on-chain confirmation.
+The `confirmations` option resolves the promise only after the receipt reaches the requested confirmation count, so `buy.isPending` covers both the wallet prompt and the on-chain confirmation.
 
 ## Configuration
 
@@ -191,7 +199,7 @@ The `wait: true` option resolves the promise only after the receipt is mined, so
 
 ```ts
 new BaselineSDK(publicClient, walletClient, {
-  defaultUseNative: true,  // wrap/unwrap ETH automatically for native-reserve pools
+  defaultUseNative: true,  // use native ETH paths by default where supported
 });
 ```
 
@@ -222,8 +230,6 @@ if (!supportedChainIds.includes(chainId)) {
 
 ## Development
 
-This package is part of the [baseline-mono](https://github.com/baseline-markets/baseline-mono) workspace.
-
 ```bash
 bun install
 bun run build     # bundle ESM + CJS + .d.ts via tsup

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@baseline-markets/sdk",
-  "version": "0.0.3",
+  "version": "1.0.1",
   "description": "TypeScript SDK for Baseline — the end-to-end asset issuance protocol where tokens own their liquidity.",
+  "license": "MIT",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",