@baseline-markets/sdk 0.0.1 → 1.0.0

package/README.md

@@ -18,22 +18,24 @@ npm install @baseline-markets/sdk viem
 ```ts
 import { BaselineSDK } from '@baseline-markets/sdk';
 import { createPublicClient, createWalletClient, http, custom } from 'viem';
-import { baseSepolia } from 'viem/chains';
+import { base } from 'viem/chains';
 
 const publicClient = createPublicClient({
-  chain: baseSepolia,
+  chain: base,
   transport: http(),
 });
 
 // Wallet client is optional — only needed for write actions
 const walletClient = createWalletClient({
-  chain: baseSepolia,
+  chain: base,
   transport: custom(window.ethereum),
 });
 
 const sdk = new BaselineSDK(publicClient, walletClient);
 ```
 
+Each SDK instance is **bound to a single chain** — the chain comes from `publicClient.chain`. To talk to a different chain, build a new `publicClient` (and `walletClient` if writing) for that chain and instantiate a new `BaselineSDK`. The SDK has no `chainId` parameter on its methods by design; chain selection lives in the clients you pass to the constructor. See [Switching chains](#switching-chains) below for the React + wagmi pattern.
+
 ### Read-only
 
 ```ts
@@ -93,6 +95,96 @@ try {
 
 The original viem error is preserved on `err.cause` if you need it.
 
+## React + wagmi
+
+wagmi's `usePublicClient` / `useWalletClient` return viem clients, so they plug straight into `BaselineSDK`. Wrap construction in a hook and memoize — re-creating the SDK on every render is fine but wasteful.
+
+```tsx
+import { useMemo } from 'react';
+import { useChainId, usePublicClient, useWalletClient } from 'wagmi';
+import { BaselineSDK } from '@baseline-markets/sdk';
+
+export function useBaselineSDK(chainId?: number) {
+  const walletChainId = useChainId();
+  const targetChainId = chainId ?? walletChainId;
+
+  const publicClient  = usePublicClient({ chainId: targetChainId });
+  const { data: walletClient } = useWalletClient({ chainId: targetChainId });
+
+  return useMemo(() => {
+    if (!publicClient) return null;
+    return new BaselineSDK(publicClient, walletClient ?? undefined);
+  }, [publicClient, walletClient]);
+}
+```
+
+`useWalletClient()` returns `undefined` until the user connects — the SDK still works for reads in that state, and `sdk.hasWallet` tells you whether write actions are available.
+
+### Switching chains
+
+The SDK is **single-chain**: the chain is baked into `publicClient`, so a `BaselineSDK` instance can only talk to one network. When the user switches network, you need new clients and a new SDK.
+
+With the hook above this is automatic — passing `chainId` to wagmi's `usePublicClient`/`useWalletClient` returns different client references per chain, the `useMemo` deps change, and a fresh `BaselineSDK` is constructed. You don't have to do anything special; just trust that:
+
+1. **Chain change → new clients → new SDK.** Construction is cheap (the SDK just holds client references and resolves a proxy address from the chain id), so don't try to skip the rebuild.
+2. **Don't mix chains in one SDK.** Never pass a `publicClient` for one chain and a `walletClient` for another — reads and writes will target different networks.
+3. **Read across chains?** Call the hook with an explicit `chainId` per component (e.g. `useBaselineSDK(mainnet.id)` and `useBaselineSDK(base.id)`) — you'll get two independent SDK instances, one per chain.
+
+### Reads with `useQuery`
+
+```tsx
+import { useQuery } from '@tanstack/react-query';
+
+function Price({ bToken }: { bToken: `0x${string}` }) {
+  const sdk = useBaselineSDK();
+
+  const { data: price } = useQuery({
+    queryKey: ['baseline', 'activePrice', sdk?.chainId, bToken],
+    queryFn: () => sdk!.activePrice(bToken),
+    enabled: !!sdk,
+  });
+
+  return <div>{price?.toString()}</div>;
+}
+```
+
+Include `sdk.chainId` in the query key so cached data is scoped per network.
+
+### Writes with `useMutation`
+
+```tsx
+import { useMutation } from '@tanstack/react-query';
+import { SDKError } from '@baseline-markets/sdk';
+
+function BuyButton({ bToken, amount, maxIn }: {
+  bToken: `0x${string}`;
+  amount: bigint;
+  maxIn: bigint;
+}) {
+  const sdk = useBaselineSDK();
+
+  const buy = useMutation({
+    mutationFn: () =>
+      sdk!.buyTokensExactOut(bToken, amount, maxIn, { wait: true }),
+    onError: (err) => {
+      if (err instanceof SDKError && err.kind === 'user_rejected') return;
+      // surface other kinds: insufficient_funds, reverted, network, ...
+    },
+  });
+
+  return (
+    <button
+      disabled={!sdk?.hasWallet || buy.isPending}
+      onClick={() => buy.mutate()}
+    >
+      {buy.isPending ? 'Confirming…' : 'Buy'}
+    </button>
+  );
+}
+```
+
+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.
+
 ## Configuration
 
 `BaselineSDK` takes an optional third argument:
@@ -115,11 +207,20 @@ await sdk.buyTokensExactOut(bToken, 100n, maxIn, {
 
 ## 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.
+- Ethereum mainnet (`mainnet`, chain id `1`)
+- Base (`base`, chain id `8453`)
 
-## Development
+The SDK reads the chain from your `publicClient` and throws if it isn't one of the supported chains — no separate chain config needed.
+
+```ts
+import { supportedChainIds } from '@baseline-markets/sdk';
 
-This package is part of the [baseline-mono](https://github.com/baseline-markets/baseline-mono) workspace.
+if (!supportedChainIds.includes(chainId)) {
+  // unsupported network — prompt user to switch
+}
+```
+
+## Development
 
 ```bash
 bun install

package/dist/index.cjs

@@ -4650,7 +4650,7 @@ var ContractFactory = class {
 };
 
 // ../contracts/index.ts
-Object.keys(addressBook_default).map(Number);
+var supportedChainIds = Object.keys(addressBook_default).map(Number);
 var SDKError = class extends Error {
   kind = "unknown";
   component;
@@ -4864,7 +4864,7 @@ var BaselineSDK = class _BaselineSDK {
     this.publicClient = publicClient;
     this.walletClient = walletClient;
     this.config = config;
-    this.readFactory = new ContractFactory(publicClient);
+    this.readFactory = new ContractFactory(this.publicClient);
   }
   get chainId() {
     return this.readFactory.chain;
@@ -5312,3 +5312,4 @@ var BaselineSDK = class _BaselineSDK {
 
 exports.BaselineSDK = BaselineSDK;
 exports.SDKError = SDKError;
+exports.supportedChainIds = supportedChainIds;

package/dist/index.d.cts

@@ -91,11 +91,11 @@ declare class BaselineSDK {
     private readonly readFactory;
     private getAccount;
     private requireWallet;
-    constructor(publicClient: PublicClient, walletClient?: WalletClient, config?: SDKConfig);
+    constructor(publicClient: PublicClient<any, any>, walletClient?: WalletClient<any, any, any>, config?: SDKConfig);
     get chainId(): number;
     get proxy(): Address;
     get hasWallet(): boolean;
-    withWallet(wallet: WalletClient): BaselineSDK;
+    withWallet(wallet: WalletClient<any, any, any>): BaselineSDK;
     createBToken(name: string, symbol: string, totalSupply: bigint, salt: Hex, opts?: TxOpts): Promise<{
         hash: Hex;
         bToken: Address;
@@ -218,4 +218,6 @@ declare class SDKError extends Error {
     constructor(message: string, params?: Partial<SDKError>);
 }
 
-export { type ApprovalOpts, type ApprovalPolicy, BaselineSDK, type CreateParams, type CreditAccount, type DeleverageResult, type LeverageResult, type NativeOpts, type PoolKey, type QuoteBuyBToken, type QuoteBuyReserves, type QuoteSellBToken, type QuoteSellReserves, type SDKConfig, SDKError, type StakedAccount, type SwapOpts, type TxOpts };
+declare const supportedChainIds: number[];
+
+export { type ApprovalOpts, type ApprovalPolicy, BaselineSDK, type CreateParams, type CreditAccount, type DeleverageResult, type LeverageResult, type NativeOpts, type PoolKey, type QuoteBuyBToken, type QuoteBuyReserves, type QuoteSellBToken, type QuoteSellReserves, type SDKConfig, SDKError, type StakedAccount, type SwapOpts, type TxOpts, supportedChainIds };

package/dist/index.d.ts

@@ -91,11 +91,11 @@ declare class BaselineSDK {
     private readonly readFactory;
     private getAccount;
     private requireWallet;
-    constructor(publicClient: PublicClient, walletClient?: WalletClient, config?: SDKConfig);
+    constructor(publicClient: PublicClient<any, any>, walletClient?: WalletClient<any, any, any>, config?: SDKConfig);
     get chainId(): number;
     get proxy(): Address;
     get hasWallet(): boolean;
-    withWallet(wallet: WalletClient): BaselineSDK;
+    withWallet(wallet: WalletClient<any, any, any>): BaselineSDK;
     createBToken(name: string, symbol: string, totalSupply: bigint, salt: Hex, opts?: TxOpts): Promise<{
         hash: Hex;
         bToken: Address;
@@ -218,4 +218,6 @@ declare class SDKError extends Error {
     constructor(message: string, params?: Partial<SDKError>);
 }
 
-export { type ApprovalOpts, type ApprovalPolicy, BaselineSDK, type CreateParams, type CreditAccount, type DeleverageResult, type LeverageResult, type NativeOpts, type PoolKey, type QuoteBuyBToken, type QuoteBuyReserves, type QuoteSellBToken, type QuoteSellReserves, type SDKConfig, SDKError, type StakedAccount, type SwapOpts, type TxOpts };
+declare const supportedChainIds: number[];
+
+export { type ApprovalOpts, type ApprovalPolicy, BaselineSDK, type CreateParams, type CreditAccount, type DeleverageResult, type LeverageResult, type NativeOpts, type PoolKey, type QuoteBuyBToken, type QuoteBuyReserves, type QuoteSellBToken, type QuoteSellReserves, type SDKConfig, SDKError, type StakedAccount, type SwapOpts, type TxOpts, supportedChainIds };

package/dist/index.js

@@ -4648,7 +4648,7 @@ var ContractFactory = class {
 };
 
 // ../contracts/index.ts
-Object.keys(addressBook_default).map(Number);
+var supportedChainIds = Object.keys(addressBook_default).map(Number);
 var SDKError = class extends Error {
   kind = "unknown";
   component;
@@ -4862,7 +4862,7 @@ var BaselineSDK = class _BaselineSDK {
     this.publicClient = publicClient;
     this.walletClient = walletClient;
     this.config = config;
-    this.readFactory = new ContractFactory(publicClient);
+    this.readFactory = new ContractFactory(this.publicClient);
   }
   get chainId() {
     return this.readFactory.chain;
@@ -5308,4 +5308,4 @@ var BaselineSDK = class _BaselineSDK {
   }
 };
 
-export { BaselineSDK, SDKError };
+export { BaselineSDK, SDKError, supportedChainIds };

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@baseline-markets/sdk",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "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",