@bestinslot/wallet-kit 0.9.1 → 0.11.0

package/dist/types/core/bis_swap.d.ts

@@ -1,3 +1,4 @@
+import { FeePolicy } from '../lib/fee-policy';
 import { SwapFees } from '../lib/swap-reporting';
 import { BISSwapWalletInfo } from './store';
 /**
@@ -100,13 +101,18 @@ export interface SwapInfo {
     factory_address: string;
     wbtc_address: string;
     wbtc_handler_address: string;
+    fee_policy: FeePolicy | null;
 }
 /**
- * Fetches the swap's deployment info — the factory, WBTC and WBTC handler addresses — for the current network, by making an API call to the swap backend. The result is fetched once per network and cached.
+ * Fetches the swap's deployment info (the factory, WBTC and WBTC handler addresses, and the
+ * backend-owned swap fee policy) for the current network, by making an API call to the swap
+ * backend. The result is cached per network for 60 seconds; a response without a fee policy (an
+ * older backend) is returned but not cached, so the policy is picked up once the backend is
+ * upgraded.
  *
  * This does not require a connected wallet or a smart wallet.
  *
- * @returns {Promise<SwapInfo>} A promise that resolves to a SwapInfo object containing the factory address, the WBTC token address, and the WBTC handler address.
+ * @returns {Promise<SwapInfo>} A promise that resolves to a SwapInfo object containing the factory address, the WBTC token address, the WBTC handler address, and the fee policy (`null` if the backend does not serve one).
  */
 export declare function getSwapInfo(): Promise<SwapInfo>;
 /**
@@ -122,11 +128,12 @@ export interface SwapBalance {
     ticker: string;
     decimals: number;
     is_lp: boolean;
-    price_sats: number;
+    price_sats: number | null;
     reserve_token_amt?: string;
     token_decimals?: number;
     reserve_btc_amt?: string;
     btc_decimals?: number;
+    quote_token?: string;
     lp_total_supply?: string;
 }
 /**
@@ -205,11 +212,13 @@ export interface PairInfo {
     price: number;
     price_change_24h: number;
     price_change_7d: number;
-    volume_24h: bigint;
-    volume_7d: bigint;
+    volume_24h: bigint | null;
+    volume_7d: bigint | null;
     lp_fee_tier: number;
-    tvl: bigint;
-    apr: number;
+    tvl: bigint | null;
+    apr: number | null;
+    price_quote_token: string;
+    exposure_sats: bigint;
 }
 export interface ListPairsResponse {
     page: number;
@@ -223,7 +232,7 @@ export interface ListPairsResponse {
  * This does not require a connected wallet or a smart wallet, so it can be used to populate a market table or pair selector before the user connects.
  *
  * @param params (Optional) An object containing the sort order (defaults to 'tvl_desc'), the page to fetch (defaults to 1), and the number of pairs per page (defaults to 20, max 100).
- * @returns {Promise<ListPairsResponse>} A promise that resolves to an object containing the current page, page size, total number of pairs, and an array of PairInfo objects. Each pair includes both token addresses and symbols, price, 24h/7d price change, 24h/7d volume, LP fee tier, TVL, and APR. The volumes and TVL are returned as strings from the API and converted to bigint in this function.
+ * @returns {Promise<ListPairsResponse>} A promise that resolves to an object containing the current page, page size, total number of pairs, and an array of PairInfo objects. Each pair includes both token addresses and symbols, price and the token it is quoted in, 24h/7d price change, 24h/7d volume, LP fee tier, TVL, APR, and BTC exposure. The volumes, TVL and exposure are returned as strings from the API and converted to bigint in this function; volume, TVL and APR are `null` for a token/token pair below the backend's BTC-exposure threshold.
  */
 export declare function listPairs(params?: ListPairsRequest): Promise<ListPairsResponse>;
 export interface GetPairVolumeRequest {
@@ -237,7 +246,7 @@ export interface GetPairVolumeResponse {
     token_b_address: string;
     token_b_symbol: string;
     period_days: number;
-    total_volume_wbtc: string;
+    total_volume_wbtc: string | null;
     total_trades: number;
     start_time: string;
     end_time: string;
@@ -246,7 +255,7 @@ export interface GetPairVolumeResponse {
  * Fetches the trading volume and number of trades for a specific token pair over a given number of days by making an API call to the swap backend.
  *
  * @param params An object containing the pair address and the number of days to look back for volume data.
- * @returns {Promise<GetPairVolumeResponse>} A promise that resolves to an object containing the pair address, token addresses and symbols, period in days, total volume in WBTC, total number of trades, and the start and end time of the period. The total volume is returned as a string from the API and can be converted to bigint if needed.
+ * @returns {Promise<GetPairVolumeResponse>} A promise that resolves to an object containing the pair address, token addresses and symbols, period in days, total volume in WBTC, total number of trades, and the start and end time of the period. The total volume is returned as a string from the API and can be converted to bigint if needed; it is `null` for a token/token pair below the backend's BTC-exposure threshold.
  */
 export declare function getPairVolumeOverDays(params: GetPairVolumeRequest): Promise<GetPairVolumeResponse>;
 export interface GetKlinesRequest {
@@ -272,6 +281,7 @@ export interface GetKlinesResponse {
     token_a_symbol: string;
     token_b_address: string;
     token_b_symbol: string;
+    price_quote_token: string | null;
     interval: string;
     klines: Kline[];
 }
@@ -279,7 +289,7 @@ export interface GetKlinesResponse {
  * Fetches the historical price and volume data (klines) for a specific token pair and time interval by making an API call to the swap backend.
  *
  * @param params An object containing the pair address, desired time interval for the klines, limit on the number of klines to fetch (max 1000), and optional start and end timestamps to filter the klines.
- * @returns {Promise<GetKlinesResponse>} A promise that resolves to an object containing the pair address, token addresses and symbols, interval, and an array of kline data. Each kline includes open time, close time, open price, high price, low price, close price, volume in WBTC, and number of trades. The volume is returned as a string from the API and can be converted to bigint if needed.
+ * @returns {Promise<GetKlinesResponse>} A promise that resolves to an object containing the pair address, token addresses and symbols, the token prices are quoted in (`price_quote_token`), interval, and an array of kline data. Each kline includes open time, close time, open price, high price, low price, close price, volume in WBTC, and number of trades. For a token/token pair the prices are the raw base/quote ratio (quote-token base units per whole base token), with no BTC conversion. The volume is returned as a string from the API and can be converted to bigint if needed.
  */
 export declare function getKlines(params: GetKlinesRequest): Promise<GetKlinesResponse>;
 export interface GetTvlHistoryRequest {
@@ -289,7 +299,7 @@ export interface GetTvlHistoryRequest {
 export interface TvlPoint {
     timestamp: number;
     block_height: number;
-    tvl: string;
+    tvl: string | null;
 }
 export interface GetTvlHistoryResponse {
     pair_address: string;
@@ -304,10 +314,10 @@ export interface GetTvlHistoryResponse {
 /**
  * Fetches a daily Total Value Locked (TVL) series for a token pair from the swap backend, for charting TVL over time.
  *
- * TVL is valued in WBTC sats (2 x the WBTC-side reserve). Points are one per day, oldest first, each carrying the pair's reserves as of that day (carried forward across days with no on-chain change). A pair with no WBTC side reports `wbtc_side: ''` and a zero series.
+ * TVL is valued in WBTC sats: 2 x the WBTC-side reserve for a WBTC pair. A token/token pair (`wbtc_side: ''`) is valued through each token's direct BTC pool as of that day, and its point is `tvl: null` on days its BTC exposure is below the backend's threshold. Points are one per day, oldest first, each carrying the pair's reserves as of that day (carried forward across days with no on-chain change).
  *
  * @param params An object with the pair address and the number of days to look back (max 365; the backend clamps out-of-range values).
- * @returns {Promise<GetTvlHistoryResponse>} A promise that resolves to the pair address, token addresses and symbols, which side is WBTC, the period in days, and the ascending array of `{ timestamp, block_height, tvl }` points. Each `tvl` is a string of sats and can be converted to bigint if needed.
+ * @returns {Promise<GetTvlHistoryResponse>} A promise that resolves to the pair address, token addresses and symbols, which side is WBTC, the period in days, and the ascending array of `{ timestamp, block_height, tvl }` points. Each `tvl` is a string of sats (or `null`, see above) and can be converted to bigint if needed.
  */
 export declare function getTvlHistory(params: GetTvlHistoryRequest): Promise<GetTvlHistoryResponse>;
 export interface GetActivityOfPairRequest {
@@ -517,6 +527,19 @@ interface RemoveLiquidityOrderResponse {
  * @returns A promise that resolves to an object indicating the success of the remove liquidity order request.
  */
 export declare function prepareAndSendRemoveLiquidityOrder(token1Addr: string, token2Addr: string, lpAmt: bigint, amt1: bigint, amt2: bigint, slippageBPS: bigint): Promise<RemoveLiquidityOrderResponse>;
+/**
+ * The protocol-fee split the swap backend requires for a swap, from its
+ * `fee_policy` (see `swapFeeBps`). Exported for tests; not part of the public API.
+ *
+ * @param token1Addr The input token address (for both exact-input and exact-output swaps).
+ * @param token2Addr The output token address.
+ * @returns The fee bps on the input (`token1FeeBps`) and output (`token2FeeBps`) legs.
+ * @throws {Error} `MISSING_FEE_POLICY_ERROR` if the backend does not serve a fee policy.
+ */
+export declare function getSwapFeesBps(token1Addr: string, token2Addr: string): Promise<{
+    token1FeeBps: bigint;
+    token2FeeBps: bigint;
+}>;
 /**
  * Calculates the expected output amount, quoted price, and price impact for a token swap operation. The function retrieves the necessary swap information and connected wallet details, then uses a proxy to check the current balances and reserves of the tokens in the liquidity pool. It also requests the miner fee for swapping and gets the fee basis points for the tokens involved in the swap. Finally, it calls the swapRequest function to get the expected results based on the input parameters.
  *
@@ -524,7 +547,7 @@ export declare function prepareAndSendRemoveLiquidityOrder(token1Addr: string, t
  * @param tokenOutAddr The address of the token being swapped to.
  * @param amtIn The amount of the input token to be swapped, represented as a bigint.
  *
- * @returns A promise that resolves to an object containing the expected output amount of the token being swapped to, the quoted price for the swap, the price impact in basis points, and the fee breakdown (see `SwapFees` — `amount_out` is net of the pool fee only, with the rest charged on top).
+ * @returns A promise that resolves to an object containing the expected output amount of the token being swapped to, the quoted price for the swap (sats per whole token when either side is WBTC; for a token/token swap, output-token base units per whole input token, see `quotedPrice`), the price impact in basis points, and the fee breakdown (see `SwapFees`: `amount_out` is net of the pool fee only, with the rest charged on top).
  */
 export declare function getSwapResult(tokenInAddr: string, tokenOutAddr: string, amtIn: bigint): Promise<{
     amount_out: bigint;
@@ -557,7 +580,7 @@ export declare function prepareAndSendSwapOrder(token1Addr: string, token2Addr:
  * @param tokenOutAddr The address of the token being swapped to.
  * @param amtOut The amount of the output token expected from the swap, represented as a bigint.
  *
- * @returns A promise that resolves to an object containing the expected input amount of the token being swapped from, the quoted price for the swap, the price impact in basis points, and the fee breakdown (see `SwapFees` — `amount_in` covers the pool fee only, with the rest charged on top).
+ * @returns A promise that resolves to an object containing the expected input amount of the token being swapped from, the quoted price for the swap (sats per whole token when either side is WBTC; for a token/token swap, output-token base units per whole input token, see `quotedPrice`), the price impact in basis points, and the fee breakdown (see `SwapFees`: `amount_in` covers the pool fee only, with the rest charged on top).
  */
 export declare function getSwap2Result(tokenInAddr: string, tokenOutAddr: string, amtOut: bigint): Promise<{
     amount_in: bigint;

package/dist/types/core/providers.d.ts

@@ -1,5 +1,29 @@
 import { BISProvider, SignFunction } from '../provider/api';
 import { BISSession, BISWallet, BISWalletProvider, BISWalletPurpose } from '../types/common';
+/**
+ * Thrown before signing when the account active in the wallet extension differs from the
+ * connected session (the user switched accounts inside the wallet after connecting). The stored
+ * session is cleared when this is thrown; the app should prompt the user to reconnect.
+ */
+export declare class WalletAccountChangedError extends Error {
+    readonly expectedAddress: string;
+    readonly accounts: string[];
+    readonly code = "WALLET_ACCOUNT_CHANGED";
+    /**
+     * @param expectedAddress The address of the connected session.
+     * @param accounts The addresses the wallet reports as active.
+     */
+    constructor(expectedAddress: string, accounts: string[]);
+}
+/**
+ * Emitted when the wallet's active account no longer matches the connected session. The stored
+ * session has already been cleared when listeners run.
+ */
+export interface AccountChangeEvent {
+    provider: BISWalletProvider;
+    previousAddresses: string[];
+    accounts: string[];
+}
 /**
  * Registry of wallet providers, populated per build via `registerProvider`. The
  * browser build registers the extension wallets; the server build registers only
@@ -24,6 +48,15 @@ export declare function registerProvider(name: BISWalletProvider, provider: BISP
  * @throws An error if the provider is not supported or if there is an error while fetching the wallets, with a message indicating the reason for the failure.
  */
 export declare function getWallets(provider: BISWalletProvider): Promise<BISSession>;
+/**
+ * Subscribes to account switches made inside the connected wallet extension (supported by
+ * Unisat and OKX). When the wallet's active account stops matching the session, the kit clears
+ * the stored session and calls the listener so the app can prompt a reconnect.
+ *
+ * @param listener Called with the provider, the session's previous addresses and the wallet's new accounts.
+ * @returns An unsubscribe function that removes the listener.
+ */
+export declare function subscribeToAccountChanges(listener: (event: AccountChangeEvent) => void): () => void;
 /**
  * Returns the currently connected ordinals wallet, or undefined if no ordinals wallet is connected. The function retrieves the wallet information from local storage and checks for a wallet with the purpose of 'ordinals'. If such a wallet is found, it is returned; otherwise, the function returns undefined.
  *

package/dist/types/lib/fee-policy.d.ts

@@ -0,0 +1,41 @@
+/**
+ * The swap protocol-fee policy served by the swap backend (`/get_swap_info` →
+ * `fee_policy`).
+ */
+export interface FeePolicy {
+    /** Total protocol fee on a swap, in basis points. */
+    swap_fee_bps: number;
+    /** Lowercased token addresses that take the whole fee, highest priority first. WBTC is always first. */
+    priority_tokens: string[];
+    /** Minimum BTC exposure (sats) for a token/token pair's volume/TVL to be reported. A decimal string. */
+    min_btc_exposure_sats: string;
+}
+export declare const MISSING_FEE_POLICY_ERROR: string;
+/**
+ * Validates and normalises the raw `fee_policy` object from `/get_swap_info`.
+ * Priority addresses are lowercased.
+ *
+ * @param raw The `fee_policy` value exactly as the backend returned it.
+ * @returns The validated policy.
+ * @throws {Error} `MISSING_FEE_POLICY_ERROR` when `raw` is null/undefined (backend too old),
+ * or an `Invalid fee_policy…` error when a field is malformed.
+ */
+export declare function parseFeePolicy(raw: unknown): FeePolicy;
+/**
+ * The protocol-fee split for a swap. `token1` is always the input token, for both
+ * exact-input and exact-output swaps.
+ *
+ * If either side is a priority token, the higher-priority side (lower index in
+ * `priority_tokens`) pays the full rate and the other side pays 0. Otherwise the
+ * rate is split, with the odd bp on the input side: input `ceil(rate/2)`, output
+ * `floor(rate/2)`. Addresses are compared lowercased.
+ *
+ * @param tokenIn The input token address.
+ * @param tokenOut The output token address.
+ * @param policy The backend's fee policy.
+ * @returns The fee bps on the input (`token1FeeBps`) and output (`token2FeeBps`) legs.
+ */
+export declare function swapFeeBps(tokenIn: string, tokenOut: string, policy: FeePolicy): {
+    token1FeeBps: bigint;
+    token2FeeBps: bigint;
+};

package/dist/types/lib/swap-reporting.d.ts

@@ -78,3 +78,25 @@ export interface SwapFees {
  * @returns The fee breakdown for the quote.
  */
 export declare function buildSwapFees(amountIn: bigint, amountOut: bigint, token1FeeBps: bigint, token2FeeBps: bigint, btcFee: bigint): SwapFees;
+/**
+ * The `quoted_price` that the swap quote functions report. The price is floored
+ * to hundredths in bigint arithmetic, then converted to a `number`; above
+ * `Number.MAX_SAFE_INTEGER` hundredths (common for token/token quotes) that
+ * conversion rounds to the nearest representable value. Its unit depends on the
+ * direction:
+ *
+ * - WBTC in: sats per whole output token.
+ * - Any other input, WBTC out included: output-token base units per whole input
+ *   token. With WBTC out that is sats per whole input token. For a token/token swap
+ *   the output is **not** scaled by its decimals, so 1 XYZ in for 2 ABC out (18
+ *   decimals) quotes `2e18`.
+ *
+ * @param tokenInAddress The input token address.
+ * @param wbtcAddress The WBTC token address.
+ * @param amountIn The input amount, in input-token base units.
+ * @param amountOut The output amount, in output-token base units.
+ * @param decimalsIn The input token's decimals.
+ * @param decimalsOut The output token's decimals.
+ * @returns The quoted price.
+ */
+export declare function quotedPrice(tokenInAddress: string, wbtcAddress: string, amountIn: bigint, amountOut: bigint, decimalsIn: number, decimalsOut: number): number;

package/dist/types/provider/api.d.ts

@@ -48,6 +48,22 @@ export interface BISProvider {
      * @returns A promise that resolves to an array of BISWallet objects, each representing a wallet associated with the provider. This allows developers to access the wallets available through the provider and perform various operations with them. If there is an error in retrieving the wallets, the promise will be rejected with an appropriate error message.
      */
     getWallets: () => Promise<BISWallet[]>;
+    /**
+     * Returns the addresses of the account currently active in the wallet, without prompting the
+     * user. Implemented only by providers that expose this silently; the kit compares the result
+     * with the stored session before signing to detect an account switch made inside the wallet.
+     *
+     * @returns The active account's addresses, or an empty array when the wallet cannot tell (e.g. it is locked).
+     */
+    getAccounts?: () => Promise<string[]>;
+    /**
+     * Subscribes to account switches made inside the wallet. Implemented only by providers that
+     * emit such an event.
+     *
+     * @param handler Called with the newly active account's addresses (empty when the wallet cannot tell).
+     * @returns An unsubscribe function.
+     */
+    onAccountsChanged?: (handler: (accounts: string[]) => void) => () => void;
     /**
      * Signs a message using the provider. The signMessage method takes a message as a string and returns a promise that resolves to the signature of the message as a hexadecimal string. This method allows developers to sign messages using the wallets associated with the provider, enabling functionalities such as authentication or transaction signing. If there is an error in signing the message, the promise will be rejected with an appropriate error message.
      *

package/dist/types/types/global.d.ts

@@ -14,6 +14,9 @@ declare global {
 
 interface UniSat {
   requestAccounts: () => Promise<string[]>
+  getAccounts: () => Promise<string[]>
+  on: (event: 'accountsChanged', handler: (accounts: string[]) => void) => void
+  removeListener: (event: 'accountsChanged', handler: (accounts: string[]) => void) => void
   getNetwork: () => Promise<'livenet' | 'testnet'>
   switchNetwork: (network: string) => Promise<void>
   signMessage: (message: string, type?: 'ecdsa' | 'bip322-simple') => Promise<string>

package/dist/vue.js

@@ -1,13 +1,13 @@
 import { ref as s, onScopeDispose as i, watch as u } from "vue";
-import { d as r, w as c, i as w } from "./mint-BXVHw4CQ.js";
-function n() {
+import { d as r, R as c, i as a } from "./mint-Dm67SjcM.js";
+function w() {
   const e = s(r()), t = c((o) => {
     e.value !== o && (e.value = o);
   });
   return i(t, !0), u(e, (o) => {
-    o !== r() && w(o);
+    o !== r() && a(o);
   }), e;
 }
 export {
-  n as useNetwork
+  w as useNetwork
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bestinslot/wallet-kit",
   "type": "module",
-  "version": "0.9.1",
+  "version": "0.11.0",
   "private": false,
   "description": "A lightweight JavaScript library for connecting Bitcoin wallets with a unified API.",
   "license": "MIT",
@@ -92,8 +92,10 @@
     "dotenv": "^17.3.1",
     "eslint": "^9.39.2",
     "eslint-plugin-jsdoc": "^62.6.1",
+    "husky": "9.1.7",
     "jsdom": "^29.1.1",
-    "prettier": "^3.8.1",
+    "lint-staged": "16.4.0",
+    "prettier": "3.9.9",
     "react": "^19.2.7",
     "react-dom": "^19.2.7",
     "solc": "^0.8.33",
@@ -113,13 +115,18 @@
   "publishConfig": {
     "access": "public"
   },
+  "lint-staged": {
+    "*": "prettier --write --ignore-unknown"
+  },
   "scripts": {
     "dev": "vite",
     "build": "vue-tsc -b && vite build",
     "build:debug": "vue-tsc -b && vite build --minify=false",
     "preview": "vite preview",
     "lint": "eslint",
-    "lint:fix": "prettier --write . && eslint --fix",
+    "lint:fix": "eslint --fix && prettier --write .",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
     "test": "vitest run",
     "release": "node scripts/release.mjs",
     "release:tag": "node scripts/release.mjs --tag",