@baseline-markets/sdk 0.0.1

package/README.md

@@ -0,0 +1,132 @@
+# @baseline-markets/sdk
+
+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.
+
+## Install
+
+```bash
+npm install @baseline-markets/sdk viem
+# or: bun add @baseline-markets/sdk viem
+```
+
+`viem` is a peer dependency — bring your own.
+
+## Quickstart
+
+```ts
+import { BaselineSDK } from '@baseline-markets/sdk';
+import { createPublicClient, createWalletClient, http, custom } from 'viem';
+import { baseSepolia } from 'viem/chains';
+
+const publicClient = createPublicClient({
+  chain: baseSepolia,
+  transport: http(),
+});
+
+// Wallet client is optional — only needed for write actions
+const walletClient = createWalletClient({
+  chain: baseSepolia,
+  transport: custom(window.ethereum),
+});
+
+const sdk = new BaselineSDK(publicClient, walletClient);
+```
+
+### Read-only
+
+```ts
+const bToken = '0x...' as const;
+
+const price   = await sdk.activePrice(bToken);
+const reserve = await sdk.getReserve(bToken);
+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,
+});
+
+// Sell 100 bTokens, accept at least `minOut` reserve out
+const hash2 = await sdk.sellTokensExactIn(bToken, 100n, minOut);
+```
+
+### Borrow / leverage / stake
+
+```ts
+await sdk.deposit(bToken, collateral);
+await sdk.borrow(bToken, debtAmount);
+await sdk.leverage(bToken, collateral, targetLTV);
+await sdk.repay(bToken, debtAmount);
+await sdk.claim(bToken);
+```
+
+See `src/baseline-sdk.ts` for the full method list.
+
+## Error handling
+
+All write methods throw `SDKError`, a single error type with a `.kind` discriminator so you don't have to sniff messages:
+
+```ts
+import { SDKError } from '@baseline-markets/sdk';
+
+try {
+  await sdk.buyTokensExactOut(bToken, 100n, maxIn);
+} catch (err) {
+  if (err instanceof SDKError) {
+    switch (err.kind) {
+      case 'user_rejected':     // user cancelled in their wallet
+      case 'insufficient_funds': // not enough native balance for gas
+      case 'reverted':          // contract reverted (decoded reason in .message)
+      case 'network':           // RPC/socket/timeout — retry-worthy
+      case 'wallet':            // SDK misuse: no wallet, no account
+      case 'unknown':           // anything else
+    }
+  }
+}
+```
+
+The original viem error is preserved on `err.cause` if you need it.
+
+## Configuration
+
+`BaselineSDK` takes an optional third argument:
+
+```ts
+new BaselineSDK(publicClient, walletClient, {
+  defaultUseNative: true,  // wrap/unwrap ETH automatically for native-reserve pools
+});
+```
+
+Per-call options live on `TxOpts`:
+
+```ts
+await sdk.buyTokensExactOut(bToken, 100n, maxIn, {
+  account: '0x...',           // override which address sends the tx
+  confirmations: 2,           // wait for N confirmations before returning
+  onSimulateError: (e) => {}, // hook for pre-simulation failures
+});
+```
+
+## Supported networks
+
+Whatever your `publicClient` is connected to, as long as Baseline contracts are deployed there. The SDK reads the chain from your client — no separate chain config needed.
+
+## 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
+bun test
+```
+
+## License
+
+MIT