@baseline-markets/sdk 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,221 @@
+import { Address, Hex, PublicClient, WalletClient } from 'viem';
+
+type CreateParams = {
+    bToken: Address;
+    initialPoolBTokens: bigint;
+    reserve: Address;
+    initialPoolReserves: bigint;
+    initialActivePrice: bigint;
+    initialBLV: bigint;
+    creator: Address;
+    feeRecipient: Address;
+    creatorFeePct: bigint;
+    swapFeePct: bigint;
+    createHook: boolean;
+    claimMerkleRoot: Hex;
+    initialCollateral: bigint;
+    initialDebt: bigint;
+};
+type PoolKey = {
+    currency0: Address;
+    currency1: Address;
+    fee: bigint;
+    tickSpacing: number;
+    hooks: Address;
+};
+type QuoteBuyBToken = {
+    reservesIn: bigint;
+    fee: bigint;
+    price: bigint;
+};
+type QuoteSellBToken = {
+    reservesOut: bigint;
+    fee: bigint;
+    price: bigint;
+};
+type QuoteBuyReserves = {
+    tokensIn: bigint;
+    fee: bigint;
+    price: bigint;
+};
+type QuoteSellReserves = {
+    tokensOut: bigint;
+    fee: bigint;
+    price: bigint;
+};
+type StakedAccount = {
+    amount: bigint;
+    locked: bigint;
+    earned: bigint;
+    userAccumulator: bigint;
+};
+type CreditAccount = {
+    collateral: bigint;
+    debt: bigint;
+};
+type TxOpts = {
+    account?: Address;
+    confirmations?: number;
+    onSimulateError?: (e: unknown) => void;
+};
+type ApprovalPolicy = 'infinite' | 'exact';
+type ApprovalOpts = {
+    approvals?: ApprovalPolicy;
+};
+type NativeOpts = {
+    useNative?: boolean;
+    outputNative?: boolean;
+};
+type SwapOpts = TxOpts & NativeOpts & ApprovalOpts & {
+    slippageBps?: number;
+};
+type LeverageResult = {
+    hash: Hex;
+    reservesIn: bigint;
+    refund: bigint;
+};
+type DeleverageResult = {
+    hash: Hex;
+    reservesOut: bigint;
+};
+type SDKConfig = {
+    approvals?: ApprovalPolicy;
+    defaultUseNative?: boolean;
+    wrappedNative?: Address;
+};
+
+declare class BaselineSDK {
+    readonly publicClient: PublicClient;
+    readonly walletClient?: WalletClient;
+    readonly config?: SDKConfig;
+    private readonly readFactory;
+    private getAccount;
+    private requireWallet;
+    constructor(publicClient: PublicClient, walletClient?: WalletClient, config?: SDKConfig);
+    get chainId(): number;
+    get proxy(): Address;
+    get hasWallet(): boolean;
+    withWallet(wallet: WalletClient): BaselineSDK;
+    createBToken(name: string, symbol: string, totalSupply: bigint, salt: Hex, opts?: TxOpts): Promise<{
+        hash: Hex;
+        bToken: Address;
+    }>;
+    createPool(params: CreateParams, opts?: TxOpts): Promise<{
+        hash: Hex;
+    }>;
+    quoteBuyExactIn(bToken: Address, reservesIn: bigint): Promise<{
+        tokensOut: bigint;
+        fee: bigint;
+        slippage: bigint;
+    }>;
+    quoteBuyExactOut(bToken: Address, amountOut: bigint): Promise<{
+        amountIn: bigint;
+        fee: bigint;
+        slippage: bigint;
+    }>;
+    quoteSellExactIn(bToken: Address, amountIn: bigint): Promise<{
+        amountOut: bigint;
+        fee: bigint;
+        slippage: bigint;
+    }>;
+    quoteSellExactOut(bToken: Address, reservesOut: bigint): Promise<{
+        tokensIn: bigint;
+        fee: bigint;
+        slippage: bigint;
+    }>;
+    buyTokensExactOut(bToken: Address, amountOut: bigint, limitAmount: bigint, opts?: SwapOpts): Promise<Hex>;
+    sellTokensExactIn(bToken: Address, amountIn: bigint, limitAmount: bigint, opts?: SwapOpts): Promise<Hex>;
+    sellTokensExactOut(bToken: Address, amountOut: bigint, limitAmount: bigint, opts?: SwapOpts): Promise<Hex>;
+    buyTokensExactIn(bToken: Address, amountIn: bigint, limitAmount: bigint, opts?: SwapOpts): Promise<Hex>;
+    deposit(bToken: Address, amount: bigint, opts?: TxOpts & {
+        user?: Address;
+    }): Promise<Hex>;
+    withdraw(bToken: Address, amount: bigint, opts?: TxOpts): Promise<Hex>;
+    claim(bToken: Address, opts?: TxOpts & {
+        user?: Address;
+        asNative?: boolean;
+    }): Promise<{
+        hash: Hex;
+        amount: bigint;
+    }>;
+    getBorrowForCollateral(bToken: Address, collateral: bigint): Promise<{
+        borrowAmount: bigint;
+        fee: bigint;
+    }>;
+    getMaxBorrow(bToken: Address, user: Address): Promise<bigint>;
+    previewBorrow(bToken: Address, user: Address, borrowAmount: bigint): Promise<{
+        collateral: bigint;
+        debt: bigint;
+        fee: bigint;
+    }>;
+    previewRepay(bToken: Address, recipient: Address, reservesIn: bigint): Promise<{
+        collateralRedeemed: bigint;
+        debtRepaid: bigint;
+    }>;
+    borrow(bToken: Address, amount: bigint, recipient: Address, opts?: TxOpts & {
+        outputNative?: boolean;
+    }): Promise<Hex>;
+    repay(bToken: Address, reservesIn: bigint, recipient: Address, opts?: TxOpts & {
+        useNative?: boolean;
+    }): Promise<Hex>;
+    simulateLeverage(bToken: Address, totalCollateral: bigint, collateralIn: bigint, maxSwapReservesIn: bigint, opts?: TxOpts): Promise<{
+        debtAdded: bigint;
+    }>;
+    leverage(bToken: Address, totalCollateral: bigint, collateralIn: bigint, maxSwapReservesIn: bigint, opts?: TxOpts): Promise<{
+        hash: `0x${string}`;
+        debtAdded: bigint;
+    }>;
+    simulateDeleverage(bToken: Address, collateralToSell: bigint, minSwapReservesOut: bigint, opts?: TxOpts & {
+        outputNative?: boolean;
+    }): Promise<{
+        collateralRedeemed: bigint;
+        debtRepaid: bigint;
+        refund: bigint;
+    }>;
+    deleverage(bToken: Address, collateralToSell: bigint, minSwapReservesOut: bigint, opts?: TxOpts & {
+        outputNative?: boolean;
+    }): Promise<{
+        hash: `0x${string}`;
+        collateralRedeemed: bigint;
+        debtRepaid: bigint;
+        refund: bigint;
+    }>;
+    getStakedAccount(bToken: Address, user: Address): Promise<StakedAccount>;
+    getCreditAccount(bToken: Address, user: Address): Promise<CreditAccount>;
+    getTokenBalance(token: Address, user: Address): Promise<bigint>;
+    approve(token: Address, spender: Address, amount: bigint, opts?: TxOpts): Promise<Hex>;
+    getAllowance(token: Address, owner: Address, spender: Address): Promise<bigint>;
+    ensureApproval(token: Address, spender: Address, required: bigint, opts?: TxOpts & {
+        policy?: 'infinite' | 'exact';
+    }): Promise<void>;
+    getReserve(bToken: Address): Promise<Address>;
+    activePrice(bToken: Address): Promise<bigint>;
+    quoteLeverage(bToken: Address, collateralIn: bigint, leverageFactor: bigint): Promise<{
+        targetCollateral: bigint;
+        maxSwapReservesIn: bigint;
+        expectedDebt: bigint;
+        slippage: bigint;
+    }>;
+}
+
+/**
+ * Coarse-grained category for an SDKError. Consumers should branch on this
+ * instead of sniffing the message string or unwrapping `cause`.
+ *
+ * - `user_rejected`:     user cancelled from their wallet UI
+ * - `reverted`:          contract reverted on-chain (message carries decoded reason)
+ * - `insufficient_funds`: not enough native balance for gas/value
+ * - `network`:           RPC/HTTP/socket/timeout — transient, retry-worthy
+ * - `wallet`:            SDK misuse (no wallet client, no account)
+ * - `unknown`:           anything we couldn't classify
+ */
+type SDKErrorKind = 'user_rejected' | 'reverted' | 'insufficient_funds' | 'network' | 'wallet' | 'unknown';
+declare class SDKError extends Error {
+    kind: SDKErrorKind;
+    component?: string;
+    args?: readonly unknown[];
+    cause?: unknown;
+    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 };

package/dist/index.d.ts

@@ -0,0 +1,221 @@
+import { Address, Hex, PublicClient, WalletClient } from 'viem';
+
+type CreateParams = {
+    bToken: Address;
+    initialPoolBTokens: bigint;
+    reserve: Address;
+    initialPoolReserves: bigint;
+    initialActivePrice: bigint;
+    initialBLV: bigint;
+    creator: Address;
+    feeRecipient: Address;
+    creatorFeePct: bigint;
+    swapFeePct: bigint;
+    createHook: boolean;
+    claimMerkleRoot: Hex;
+    initialCollateral: bigint;
+    initialDebt: bigint;
+};
+type PoolKey = {
+    currency0: Address;
+    currency1: Address;
+    fee: bigint;
+    tickSpacing: number;
+    hooks: Address;
+};
+type QuoteBuyBToken = {
+    reservesIn: bigint;
+    fee: bigint;
+    price: bigint;
+};
+type QuoteSellBToken = {
+    reservesOut: bigint;
+    fee: bigint;
+    price: bigint;
+};
+type QuoteBuyReserves = {
+    tokensIn: bigint;
+    fee: bigint;
+    price: bigint;
+};
+type QuoteSellReserves = {
+    tokensOut: bigint;
+    fee: bigint;
+    price: bigint;
+};
+type StakedAccount = {
+    amount: bigint;
+    locked: bigint;
+    earned: bigint;
+    userAccumulator: bigint;
+};
+type CreditAccount = {
+    collateral: bigint;
+    debt: bigint;
+};
+type TxOpts = {
+    account?: Address;
+    confirmations?: number;
+    onSimulateError?: (e: unknown) => void;
+};
+type ApprovalPolicy = 'infinite' | 'exact';
+type ApprovalOpts = {
+    approvals?: ApprovalPolicy;
+};
+type NativeOpts = {
+    useNative?: boolean;
+    outputNative?: boolean;
+};
+type SwapOpts = TxOpts & NativeOpts & ApprovalOpts & {
+    slippageBps?: number;
+};
+type LeverageResult = {
+    hash: Hex;
+    reservesIn: bigint;
+    refund: bigint;
+};
+type DeleverageResult = {
+    hash: Hex;
+    reservesOut: bigint;
+};
+type SDKConfig = {
+    approvals?: ApprovalPolicy;
+    defaultUseNative?: boolean;
+    wrappedNative?: Address;
+};
+
+declare class BaselineSDK {
+    readonly publicClient: PublicClient;
+    readonly walletClient?: WalletClient;
+    readonly config?: SDKConfig;
+    private readonly readFactory;
+    private getAccount;
+    private requireWallet;
+    constructor(publicClient: PublicClient, walletClient?: WalletClient, config?: SDKConfig);
+    get chainId(): number;
+    get proxy(): Address;
+    get hasWallet(): boolean;
+    withWallet(wallet: WalletClient): BaselineSDK;
+    createBToken(name: string, symbol: string, totalSupply: bigint, salt: Hex, opts?: TxOpts): Promise<{
+        hash: Hex;
+        bToken: Address;
+    }>;
+    createPool(params: CreateParams, opts?: TxOpts): Promise<{
+        hash: Hex;
+    }>;
+    quoteBuyExactIn(bToken: Address, reservesIn: bigint): Promise<{
+        tokensOut: bigint;
+        fee: bigint;
+        slippage: bigint;
+    }>;
+    quoteBuyExactOut(bToken: Address, amountOut: bigint): Promise<{
+        amountIn: bigint;
+        fee: bigint;
+        slippage: bigint;
+    }>;
+    quoteSellExactIn(bToken: Address, amountIn: bigint): Promise<{
+        amountOut: bigint;
+        fee: bigint;
+        slippage: bigint;
+    }>;
+    quoteSellExactOut(bToken: Address, reservesOut: bigint): Promise<{
+        tokensIn: bigint;
+        fee: bigint;
+        slippage: bigint;
+    }>;
+    buyTokensExactOut(bToken: Address, amountOut: bigint, limitAmount: bigint, opts?: SwapOpts): Promise<Hex>;
+    sellTokensExactIn(bToken: Address, amountIn: bigint, limitAmount: bigint, opts?: SwapOpts): Promise<Hex>;
+    sellTokensExactOut(bToken: Address, amountOut: bigint, limitAmount: bigint, opts?: SwapOpts): Promise<Hex>;
+    buyTokensExactIn(bToken: Address, amountIn: bigint, limitAmount: bigint, opts?: SwapOpts): Promise<Hex>;
+    deposit(bToken: Address, amount: bigint, opts?: TxOpts & {
+        user?: Address;
+    }): Promise<Hex>;
+    withdraw(bToken: Address, amount: bigint, opts?: TxOpts): Promise<Hex>;
+    claim(bToken: Address, opts?: TxOpts & {
+        user?: Address;
+        asNative?: boolean;
+    }): Promise<{
+        hash: Hex;
+        amount: bigint;
+    }>;
+    getBorrowForCollateral(bToken: Address, collateral: bigint): Promise<{
+        borrowAmount: bigint;
+        fee: bigint;
+    }>;
+    getMaxBorrow(bToken: Address, user: Address): Promise<bigint>;
+    previewBorrow(bToken: Address, user: Address, borrowAmount: bigint): Promise<{
+        collateral: bigint;
+        debt: bigint;
+        fee: bigint;
+    }>;
+    previewRepay(bToken: Address, recipient: Address, reservesIn: bigint): Promise<{
+        collateralRedeemed: bigint;
+        debtRepaid: bigint;
+    }>;
+    borrow(bToken: Address, amount: bigint, recipient: Address, opts?: TxOpts & {
+        outputNative?: boolean;
+    }): Promise<Hex>;
+    repay(bToken: Address, reservesIn: bigint, recipient: Address, opts?: TxOpts & {
+        useNative?: boolean;
+    }): Promise<Hex>;
+    simulateLeverage(bToken: Address, totalCollateral: bigint, collateralIn: bigint, maxSwapReservesIn: bigint, opts?: TxOpts): Promise<{
+        debtAdded: bigint;
+    }>;
+    leverage(bToken: Address, totalCollateral: bigint, collateralIn: bigint, maxSwapReservesIn: bigint, opts?: TxOpts): Promise<{
+        hash: `0x${string}`;
+        debtAdded: bigint;
+    }>;
+    simulateDeleverage(bToken: Address, collateralToSell: bigint, minSwapReservesOut: bigint, opts?: TxOpts & {
+        outputNative?: boolean;
+    }): Promise<{
+        collateralRedeemed: bigint;
+        debtRepaid: bigint;
+        refund: bigint;
+    }>;
+    deleverage(bToken: Address, collateralToSell: bigint, minSwapReservesOut: bigint, opts?: TxOpts & {
+        outputNative?: boolean;
+    }): Promise<{
+        hash: `0x${string}`;
+        collateralRedeemed: bigint;
+        debtRepaid: bigint;
+        refund: bigint;
+    }>;
+    getStakedAccount(bToken: Address, user: Address): Promise<StakedAccount>;
+    getCreditAccount(bToken: Address, user: Address): Promise<CreditAccount>;
+    getTokenBalance(token: Address, user: Address): Promise<bigint>;
+    approve(token: Address, spender: Address, amount: bigint, opts?: TxOpts): Promise<Hex>;
+    getAllowance(token: Address, owner: Address, spender: Address): Promise<bigint>;
+    ensureApproval(token: Address, spender: Address, required: bigint, opts?: TxOpts & {
+        policy?: 'infinite' | 'exact';
+    }): Promise<void>;
+    getReserve(bToken: Address): Promise<Address>;
+    activePrice(bToken: Address): Promise<bigint>;
+    quoteLeverage(bToken: Address, collateralIn: bigint, leverageFactor: bigint): Promise<{
+        targetCollateral: bigint;
+        maxSwapReservesIn: bigint;
+        expectedDebt: bigint;
+        slippage: bigint;
+    }>;
+}
+
+/**
+ * Coarse-grained category for an SDKError. Consumers should branch on this
+ * instead of sniffing the message string or unwrapping `cause`.
+ *
+ * - `user_rejected`:     user cancelled from their wallet UI
+ * - `reverted`:          contract reverted on-chain (message carries decoded reason)
+ * - `insufficient_funds`: not enough native balance for gas/value
+ * - `network`:           RPC/HTTP/socket/timeout — transient, retry-worthy
+ * - `wallet`:            SDK misuse (no wallet client, no account)
+ * - `unknown`:           anything we couldn't classify
+ */
+type SDKErrorKind = 'user_rejected' | 'reverted' | 'insufficient_funds' | 'network' | 'wallet' | 'unknown';
+declare class SDKError extends Error {
+    kind: SDKErrorKind;
+    component?: string;
+    args?: readonly unknown[];
+    cause?: unknown;
+    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 };