@lombard.finance/sdk 3.7.4 → 4.1.0

package/src/tokens/types.ts

@@ -1,80 +0,0 @@
-import { Address } from 'viem';
-
-/**
- * Address kinds for tokens that have multiple contract addresses.
- *
- * **BTC.b Integration Architecture:**
- *
- * BTC.b on Avalanche uses a dual-contract architecture with both a token contract
- * and an adapter contract serving different purposes:
- *
- * **When to use Token vs Adapter:**
- *
- * - **Token** (`AddressKind.Token`):
- *   - Use for EIP-2612 `permit()` signatures (Stake and Bake)
- *   - Use for querying token balance, symbol, decimals
- *   - Use for standard ERC20 operations (allowance checks, balance queries)
- *   - This is the actual BTC.b ERC20 token contract
- *
- * - **Adapter** (`AddressKind.Adapter`):
- *   - Use for burn/mint/transfer operations via BridgeTokenAdapter
- *   - Use for bridge deposit/withdrawal operations
- *   - Use as spender address when approving tokens for bridge operations
- *   - This adapter serves as an intermediary between BridgeToken and both AssetRouter and Bridge
- *
- * **Important Notes:**
- *
- * 1. **Permit Signatures**: Always use `AddressKind.Token` as the `verifyingContract` in
- *    EIP-2612 permit signatures. The token contract implements the `permit()` function,
- *    not the adapter.
- *
- * 2. **Approvals**: For bridge and redemption operations, users must grant allowance to
- *    the **BridgeTokenAdapter** address, not the vault or bridge contract.
- *
- * 3. **Deposit Address**: For Ledger integration, the token address includes the adapter
- *    address when tweaking deposit addresses.
- *
- * @example
- * ```typescript
- * // For permit signatures (Stake and Bake):
- * const tokenContract = await getTokenContractInfo(
- *   Token.BTCb,
- *   ChainId.avalancheFuji,
- *   env,
- *   AddressKind.Token  // ✅ Use token address for permit
- * );
- *
- * // For bridge operations:
- * const adapterContract = await getTokenContractInfo(
- *   Token.BTCb,
- *   ChainId.avalancheFuji,
- *   env,
- *   AddressKind.Adapter  // ✅ Use adapter address for bridge
- * );
- * ```
- */
-export enum AddressKind {
-  /**
-   * The bridge adapter contract address (BridgeTokenAdapter).
-   * Used for burn/mint/transfer operations and as the spender for bridge approvals.
-   */
-  Adapter = 'adapter',
-
-  /**
-   * The token contract address (standard ERC20).
-   * Used for permit signatures, balance queries, and standard ERC20 operations.
-   */
-  Token = 'token',
-}
-
-/**
- * Address structure for tokens with both token and adapter addresses.
- *
- * Currently only used by `Token.BTCb` on Avalanche chains.
- */
-export type BridgeTokenAddresses = {
-  /** The bridge adapter contract address (BridgeTokenAdapter) */
-  [AddressKind.Adapter]: Address;
-  /** The token contract address (standard ERC20) */
-  [AddressKind.Token]: Address;
-};

package/src/utils/array.ts

@@ -1,31 +0,0 @@
-export function unique<T>(arr: T[]): T[] {
-  return arr.filter((v, i, a) => a.indexOf(v) === i);
-}
-
-export function orderBy<T>(
-  arr: T[],
-  property: (arrEntry: T) => string | number,
-  direction: 'asc' | 'desc' = 'asc',
-): T[] {
-  const array = [...arr];
-  array.sort((a, b) => {
-    const propA = property(a);
-    const propB = property(b);
-
-    if (typeof propA === 'number') {
-      return propA - (propB as number);
-    }
-
-    if (typeof propA === 'string') {
-      return propA.localeCompare(propB as string);
-    }
-
-    return 0;
-  });
-
-  if (direction === 'desc') {
-    array.reverse();
-  }
-
-  return array;
-}

package/src/utils/block.ts

@@ -1,23 +0,0 @@
-import axios from 'axios';
-
-import { ChainId, getLlamaChainName } from '../common/chains';
-
-type Response = {
-  height: number;
-  timestamp: number;
-};
-
-export async function getBlockHeight(
-  chainId: ChainId,
-  timestamp: number | bigint,
-) {
-  const chainName = getLlamaChainName(chainId);
-
-  if (!chainName) return;
-
-  const { data } = await axios.get<Response>(
-    `https://coins.llama.fi/block/${chainName}/${String(timestamp)}`,
-  );
-
-  return data.height;
-}

package/src/utils/env.ts

@@ -1,20 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-
-import { ChainId } from '../common/chains';
-
-const PROD_NATIVE_MINT_CHAINS = [
-  ChainId.ethereum,
-  ChainId.base,
-  ChainId.berachain,
-  ChainId.binanceSmartChain,
-  ChainId.corn,
-  ChainId.etherlink,
-  ChainId.katana,
-  ChainId.morph,
-  ChainId.sonic,
-  ChainId.swell,
-] as ChainId[];
-
-export const determineEnv = (chainId: ChainId): Env => {
-  return PROD_NATIVE_MINT_CHAINS.includes(chainId) ? Env.prod : Env.stage;
-};

package/src/utils/err.ts

@@ -1,83 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import { AxiosError } from 'axios';
-
-import { ChainId } from '../common/chains';
-import { Token } from '../tokens/token-addresses';
-
-/**
- * Retrieves the error message from the given error object.
- *
- * @param error - The error object.
- * @returns The error message as a string.
- */
-export function getErrorMessage(error: unknown): string {
-  if (typeof error === 'string') {
-    return error;
-  }
-
-  const hasDataMessage = (err: unknown): err is { data: { message: string } } =>
-    Boolean(
-      err &&
-        typeof err === 'object' &&
-        'data' in err &&
-        err.data &&
-        typeof err.data === 'object' &&
-        'message' in err.data &&
-        err?.data?.message &&
-        typeof err.data.message === 'string',
-    );
-
-  if (hasDataMessage(error)) {
-    return error.data.message;
-  }
-
-  if (error instanceof Error) {
-    return getAxiosErrorMessage(error as AxiosError);
-  }
-
-  return getErrorMessageFromObject(error);
-}
-
-function getAxiosErrorMessage(error: AxiosError): string {
-  if (error.response) {
-    return (error.response.data as { message: string }).message;
-  }
-
-  return error.message;
-}
-
-function getErrorMessageFromObject(error: unknown): string {
-  if (
-    error &&
-    typeof error === 'object' &&
-    'message' in error &&
-    typeof error.message === 'string'
-  ) {
-    return error.message;
-  }
-
-  return 'Unknown error';
-}
-
-export class TokenContractAddressNotFoundError extends Error {
-  constructor(
-    public readonly token: Token,
-    public readonly chainId: ChainId,
-    env?: Env,
-  ) {
-    const message = `Could not determine the ${token} contract address for given chain id: ${chainId} (env: ${env || 'undefined'})`;
-    super(message);
-  }
-}
-
-export class UnsupportedTokenFlow extends Error {
-  constructor(
-    public readonly tokenIn: Token,
-    public readonly tokenOut: Token | string,
-    public readonly chainId: ChainId,
-    env?: Env,
-  ) {
-    const message = `The flow of ${tokenIn} to ${tokenOut} on ${chainId} (env: ${env || 'undefined'}) is not supported`;
-    super(message);
-  }
-}

package/src/utils/gas.ts

@@ -1,36 +0,0 @@
-import BigNumber from 'bignumber.js';
-import { PublicClient } from 'viem';
-
-export const estimateGasFees = async (
-  publicClient: PublicClient,
-  callData: Parameters<PublicClient['estimateContractGas']>[0],
-  overwriteMaxPriorityFeePerGas?: bigint,
-) => {
-  const fees = await publicClient.estimateFeesPerGas();
-
-  const multiplier = BigNumber(String(fees.maxFeePerGas)).dividedBy(
-    String(fees.maxPriorityFeePerGas),
-  );
-
-  const maxPriorityFeePerGas = overwriteMaxPriorityFeePerGas
-    ? overwriteMaxPriorityFeePerGas
-    : fees.maxPriorityFeePerGas;
-
-  const maxFeePerGas = overwriteMaxPriorityFeePerGas
-    ? BigInt(
-        BigNumber(String(maxPriorityFeePerGas))
-          .multipliedBy(multiplier)
-          .toFixed(0),
-      )
-    : fees.maxFeePerGas;
-
-  const gas = await publicClient.estimateContractGas(callData);
-
-  const gasEstimationData = {
-    gas,
-    maxFeePerGas,
-    maxPriorityFeePerGas,
-  };
-
-  return gasEstimationData;
-};

package/src/utils/hex.ts

@@ -1,9 +0,0 @@
-import { Hex } from 'viem';
-
-export function isHex(input: string): input is Hex {
-  return input.startsWith('0x');
-}
-
-export function ensureHex(input: string): Hex {
-  return isHex(input) ? input : `0x${input}`;
-}

package/src/utils/numbers.ts

@@ -1,8 +0,0 @@
-import BigNumber from 'bignumber.js';
-
-export const ZERO = BigNumber(0);
-export const ONE = BigNumber(1);
-
-export default function toBigInt(input: BigNumber.Value) {
-  return BigInt(BigNumber(input).toFixed());
-}

package/src/utils/pagination.ts

@@ -1,70 +0,0 @@
-import axios from 'axios';
-
-/* -------------------------------------------------------------------------- */
-/*                                   Types                                    */
-/* -------------------------------------------------------------------------- */
-
-type FetchAllPaginatedParameters<T> = {
-  /** The API endpoint. */
-  endpoint: string | URL;
-  /** Function to extract items array from API response. */
-  extractItems: (data: unknown) => T[];
-  /** The additional query parameters. */
-  query?: Record<string, string | undefined>;
-  /** The page size, default: 1000 */
-  pageSize?: number;
-  /** The maximum amount of expected records. */
-  maxRecords?: number;
-};
-
-/* -------------------------------------------------------------------------- */
-/*                                  Helpers                                   */
-/* -------------------------------------------------------------------------- */
-
-/**
- * Generic helper to fetch all paginated items from an API endpoint.
- * Automatically handles `limit`, `offset` and the `has_more` flag.
- * If `has_more` is missing, pagination stops.
- *
- * @template T - Type of individual item
- * @param {FetchAllPaginatedParameters<T>} params - Parameters for fetching all items
-
- *
- * @returns {Promise<T[]>} - All items fetched across pages
- */
-export async function fetchAllPaginated<T>({
-  endpoint,
-  extractItems,
-  query = {},
-  pageSize = 1_000,
-  maxRecords,
-}: FetchAllPaginatedParameters<T>): Promise<T[]> {
-  let allItems: T[] = [];
-  let offset = 0;
-  let hasMore = true;
-
-  while (hasMore) {
-    const url = new URL(endpoint);
-
-    url.searchParams.set('limit', pageSize.toString());
-    url.searchParams.set('offset', offset.toString());
-    for (const [key, value] of Object.entries(query)) {
-      if (value !== undefined) url.searchParams.set(key, String(value));
-    }
-
-    const { data } = await axios.get(url.toString());
-    const items = extractItems(data);
-
-    allItems = allItems.concat(items);
-    offset += items.length;
-
-    if (maxRecords && allItems.length >= maxRecords) {
-      allItems = allItems.slice(0, maxRecords);
-      break;
-    }
-
-    hasMore = items.length > 0 && (data.has_more ?? false);
-  }
-
-  return allItems;
-}

package/src/utils/satoshi.ts

@@ -1,25 +0,0 @@
-import BigNumber from 'bignumber.js';
-
-export const BTC_DECIMALS = 8;
-export const SATOSHI_SCALE = BigNumber(10).pow(BTC_DECIMALS);
-
-/**
- * Converts Satoshi to BTC
- * @param amount - Satoshi amount
- * @returns BTC amount
- */
-export function fromSatoshi(amount: BigNumber.Value) {
-  return BigNumber(amount).dividedBy(SATOSHI_SCALE);
-}
-
-/**
- * Converts BTC to Satoshi
- *
- * @param amount - BTC amount
- * @returns Satoshi amount
- */
-export function toSatoshi(amount: BigNumber.Value) {
-  return BigNumber(amount)
-    .multipliedBy(SATOSHI_SCALE)
-    .decimalPlaces(0, BigNumber.ROUND_HALF_UP);
-}

package/src/utils/time.ts

@@ -1,12 +0,0 @@
-export const SECOND = 1000;
-export const MINUTE = 60 * SECOND;
-export const HOUR = 60 * MINUTE;
-export const DAY = 24 * HOUR;
-
-export function now() {
-  return Date.now();
-}
-
-export function toUnix(ms: number) {
-  return Math.round(ms / 1000);
-}