@lombard.finance/sdk 4.0.0 → 4.1.2

package/src/tokens/tokens.ts

@@ -1,249 +0,0 @@
-/**
- * Token Contract Utilities
- *
- * @deprecated v4.1 Migration Target
- *
- * Functions like `getTokenContractInfo()` use hardcoded TOKEN_ADDRESSES.
- * For v4.1, migrate to use Asset Catalog with catalog injection.
- *
- * See: docs/ADDRESS_SYSTEM_UNIFICATION.md
- *
- * @module tokens/tokens
- */
-
-import { DEFAULT_ENV, Env } from '@lombard.finance/sdk-common';
-import BigNumber from 'bignumber.js';
-import { type Abi, Address, erc20Abi, PublicClient, zeroAddress } from 'viem';
-
-import { makePublicClient } from '../clients/public-client';
-import { ChainId } from '../common/chains';
-import { TokenContractAddressNotFoundError } from '../utils/err';
-import BRIDGE_TOKEN_ADAPTER_ABI from './abi/BRIDGE_TOKEN_ADAPTER_ABI';
-import BTCK_ABI from './abi/BTCK_ABI';
-import { LBTC_ABI } from './abi/LBTC_ABI';
-import NATIVE_LBTC_ABI from './abi/NATIVE_LBTC_ABI';
-import STLBTC_ABI from './abi/STLBTC_ABI';
-import { AddressKind, Token,TOKEN_ADDRESSES } from './token-addresses';
-
-export type TokenInfo = {
-  address: Address;
-  abi: Abi;
-  symbol: string;
-  decimals: number;
-};
-
-const MAYBE_UPGRADED_CONTRACT_ABI = [
-  {
-    inputs: [],
-    name: 'getAssetRouter',
-    outputs: [{ internalType: 'address', name: '', type: 'address' }],
-    stateMutability: 'view',
-    type: 'function',
-  },
-] as const;
-const UPGRADED_CONTRACT_POINTER = MAYBE_UPGRADED_CONTRACT_ABI[0].name;
-
-export async function isUpgradedContract(
-  token: Token.LBTC | Token.BTCK,
-  chainId: ChainId,
-  env?: Env,
-  rpcUrl?: string,
-) {
-  const environment = env || DEFAULT_ENV;
-  const address = TOKEN_ADDRESSES[token]?.[environment]?.[chainId];
-
-  if (!address) {
-    throw new TokenContractAddressNotFoundError(token, chainId, environment);
-  }
-
-  const publicClient = makePublicClient({ chainId, rpcUrl, env: environment });
-  try {
-    const assetRouter = await publicClient.readContract({
-      abi: MAYBE_UPGRADED_CONTRACT_ABI,
-      address: typeof address === 'string' ? address : address.adapter,
-      functionName: UPGRADED_CONTRACT_POINTER,
-    });
-    return assetRouter !== zeroAddress;
-  } catch {
-    return false;
-  }
-}
-
-type AbiForLBTC =
-  | typeof STLBTC_ABI // upgraded
-  | typeof LBTC_ABI; // legacy
-
-type AbiForBTCK =
-  | typeof NATIVE_LBTC_ABI // upgraded
-  | typeof BTCK_ABI; // legacy
-
-type AbiForNativeLBTC = typeof NATIVE_LBTC_ABI;
-export type AbiForBridgeTokenAdapter = typeof BRIDGE_TOKEN_ADAPTER_ABI;
-
-type AbiFor<
-  TToken extends Token,
-  chain = ChainId,
-  addressKind extends AddressKind = AddressKind.Token,
-> = TToken extends Token.LBTC
-  ? AbiForLBTC
-  : TToken extends Token.BTCK
-    ? AbiForBTCK
-    : TToken extends Token.BTCb
-      ? chain extends typeof ChainId.avalanche | typeof ChainId.avalancheFuji
-        ? addressKind extends AddressKind.Adapter
-          ? AbiForBridgeTokenAdapter
-          : typeof erc20Abi // <-- AddressKind.Token - ERC-20 Token Contract
-        : AbiForNativeLBTC
-      : typeof erc20Abi;
-
-type TokenContractInfo<
-  TToken extends Token,
-  chain extends ChainId,
-  TAddressKind extends AddressKind,
-> = {
-  abi: AbiFor<TToken, chain, TAddressKind>;
-  address: Address;
-  chainId: chain;
-};
-
-export const isUpgradedAbi = (
-  abi: unknown,
-): abi is typeof STLBTC_ABI | typeof NATIVE_LBTC_ABI => {
-  const redeemForBtcAbi = (abi as Abi).find(
-    a => a.type === 'function' && a.name === UPGRADED_CONTRACT_POINTER,
-  );
-  return redeemForBtcAbi != null;
-};
-
-export async function getTokenContractInfo<
-  TToken extends Token,
-  chain extends ChainId,
-  TAddressKind extends AddressKind = AddressKind.Token,
->(
-  token: TToken,
-  chainId: chain,
-  env?: Env,
-  _addressKind?: TAddressKind,
-): Promise<TokenContractInfo<TToken, chain, TAddressKind>> {
-  const environment = env || DEFAULT_ENV;
-  const addressKind = _addressKind || AddressKind.Token;
-
-  let abi: AbiFor<TToken, chain, TAddressKind> | undefined = undefined;
-
-  // nosemgrep: codacy.tools-configs.rules_lgpl_javascript_crypto_rule-node-timing-attack -- comparing Token enum values, not secrets
-  if (token === Token.LBTC) {
-    if (await isUpgradedContract(Token.LBTC, chainId, environment)) {
-      abi = STLBTC_ABI as AbiFor<TToken, chain, TAddressKind>;
-    } else {
-      abi = LBTC_ABI as AbiFor<TToken, chain, TAddressKind>;
-    }
-  } else if (token === Token.BTCK) {
-    abi = BTCK_ABI as AbiFor<TToken, chain, TAddressKind>;
-    if (await isUpgradedContract(Token.BTCK, chainId, environment)) {
-      abi = NATIVE_LBTC_ABI as AbiFor<TToken, chain, TAddressKind>;
-    }
-  } else if (token === Token.BTCb) {
-    if (chainId === ChainId.avalanche || chainId === ChainId.avalancheFuji) {
-      if (addressKind === AddressKind.Adapter) {
-        abi = BRIDGE_TOKEN_ADAPTER_ABI as AbiFor<TToken, chain, TAddressKind>;
-      } else {
-        abi = erc20Abi as AbiFor<TToken, chain, TAddressKind>;
-      }
-    } else {
-      abi = NATIVE_LBTC_ABI as AbiFor<TToken, chain, TAddressKind>;
-    }
-  } else {
-    abi = erc20Abi as AbiFor<TToken, chain, TAddressKind>;
-  }
-
-  const address = TOKEN_ADDRESSES[token]?.[environment]?.[chainId];
-  if (!address) {
-    throw new TokenContractAddressNotFoundError(token, chainId, environment);
-  }
-
-  return {
-    abi,
-    address: typeof address === 'string' ? address : address[addressKind],
-    chainId,
-  };
-}
-
-export const retrieveTokenProperties = async <
-  TToken extends Token,
-  chain extends ChainId,
->(
-  publicClient: PublicClient,
-  tokenContractInfo: TokenContractInfo<TToken, chain, AddressKind.Token>,
-) => {
-  const [symbolResult, decimalsResult] = await publicClient.multicall({
-    contracts: [
-      {
-        address: tokenContractInfo.address,
-        abi: tokenContractInfo.abi as Abi,
-        functionName: 'symbol',
-      },
-      {
-        address: tokenContractInfo.address,
-        abi: tokenContractInfo.abi as Abi,
-        functionName: 'decimals',
-      },
-    ],
-  });
-
-  if (
-    symbolResult.status === 'success' &&
-    decimalsResult.status === 'success'
-  ) {
-    return {
-      address: tokenContractInfo.address,
-      abi: tokenContractInfo.abi,
-      symbol: String(symbolResult.result),
-      decimals: Number(decimalsResult.result),
-    };
-  }
-};
-
-export async function getTokenInfo(
-  token: Token,
-  chainId: ChainId,
-  env?: Env,
-  rpcUrl?: string,
-) {
-  const tokenContractInfo = await getTokenContractInfo(token, chainId, env);
-  if (!tokenContractInfo) return;
-
-  const publicClient = makePublicClient({ chainId, rpcUrl });
-  return retrieveTokenProperties(publicClient, tokenContractInfo);
-}
-
-export async function getAssetInfo(
-  address: Address,
-  chainId: ChainId,
-  rpcUrl?: string,
-) {
-  const publicClient = makePublicClient({ chainId, rpcUrl });
-  return retrieveTokenProperties(publicClient, {
-    abi: erc20Abi,
-    address,
-    chainId,
-  });
-}
-
-// Utils:
-// TODO: Move to utils
-
-export function toBaseDenomination(
-  input: BigNumber.Value,
-  decimalPlaces: number,
-) {
-  return BigNumber(input)
-    .multipliedBy(BigNumber(10).pow(decimalPlaces))
-    .decimalPlaces(0, BigNumber.ROUND_HALF_UP);
-}
-
-export function fromBaseDenomination(
-  input: BigNumber.Value,
-  decimalPlaces: number,
-) {
-  return BigNumber(input).dividedBy(BigNumber(10).pow(decimalPlaces));
-}

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/chain.ts

@@ -1,152 +0,0 @@
-/**
- * Chain Utility Functions
- *
- * Provides type-safe utilities for working with Chain enum values.
- * Handles parsing and validation of CAIP-2 chain identifiers.
- *
- * @module utils/chain
- */
-
-import { CAIP2_SEPARATOR, Chain,CHAIN_PREFIXES } from '../core';
-import { LombardError, ValidationErrorCode } from '../shared/errors';
-
-/** Helper to get prefix with separator */
-const withSeparator = (prefix: string) => `${prefix}${CAIP2_SEPARATOR}`;
-
-/**
- * Parse EVM chain ID from Chain enum
- *
- * Extracts the numeric chain ID from an EVM chain identifier.
- *
- * @param chain - Chain enum value
- * @returns Numeric EVM chain ID
- * @throws {ValidationError} If chain is not an EVM chain
- *
- * @example
- * ```typescript
- * parseEvmChainId(Chain.ETHEREUM) // 1
- * parseEvmChainId(Chain.BASE) // 8453
- * parseEvmChainId(Chain.BITCOIN_MAINNET) // throws ValidationError
- * ```
- */
-export function parseEvmChainId(chain: Chain): number {
-  const chainStr = String(chain);
-  const evmPrefix = withSeparator(CHAIN_PREFIXES.EIP155);
-  const isEvm = chainStr.startsWith(evmPrefix);
-
-  if (!isEvm) {
-    throw new LombardError(
-      ValidationErrorCode.INVALID_PARAMETER,
-      `Not an EVM chain: ${chainStr}`,
-    );
-  }
-
-  const chainId = Number.parseInt(chainStr.slice(evmPrefix.length), 10);
-
-  if (Number.isNaN(chainId)) {
-    throw new LombardError(
-      ValidationErrorCode.INVALID_PARAMETER,
-      `Invalid EVM chain ID: ${chainStr}`,
-    );
-  }
-
-  return chainId;
-}
-
-/**
- * Check if chain is an EVM chain
- *
- * @param chain - Chain enum value
- * @returns True if chain is an EVM chain
- *
- * @example
- * ```typescript
- * isEvmChain(Chain.ETHEREUM) // true
- * isEvmChain(Chain.BITCOIN_MAINNET) // false
- * ```
- */
-export function isEvmChain(chain: Chain): boolean {
-  return String(chain).startsWith(withSeparator(CHAIN_PREFIXES.EIP155));
-}
-
-/**
- * Check if chain is a Bitcoin chain
- *
- * @param chain - Chain enum value
- * @returns True if chain is a Bitcoin chain
- *
- * @example
- * ```typescript
- * isBitcoinChain(Chain.BITCOIN_MAINNET) // true
- * isBitcoinChain(Chain.ETHEREUM) // false
- * ```
- */
-export function isBitcoinChain(chain: Chain): boolean {
-  return String(chain).startsWith(withSeparator(CHAIN_PREFIXES.BIP122));
-}
-
-/**
- * Check if chain is a Solana chain
- *
- * @param chain - Chain enum value
- * @returns True if chain is a Solana chain
- *
- * @example
- * ```typescript
- * isSolanaChain(Chain.SOLANA_MAINNET) // true
- * isSolanaChain(Chain.ETHEREUM) // false
- * ```
- */
-export function isSolanaChain(chain: Chain): boolean {
-  return String(chain).startsWith(withSeparator(CHAIN_PREFIXES.SOLANA));
-}
-
-/**
- * Check if chain is a Sui chain
- *
- * @param chain - Chain enum value
- * @returns True if chain is a Sui chain
- *
- * @example
- * ```typescript
- * isSuiChain(Chain.SUI_MAINNET) // true
- * isSuiChain(Chain.ETHEREUM) // false
- * ```
- */
-export function isSuiChain(chain: Chain): boolean {
-  return String(chain).startsWith(withSeparator(CHAIN_PREFIXES.SUI));
-}
-
-/**
- * Check if chain is a Starknet chain
- *
- * @param chain - Chain enum value
- * @returns True if chain is a Starknet chain
- *
- * @example
- * ```typescript
- * isStarknetChain(Chain.STARKNET_MAINNET) // true
- * isStarknetChain(Chain.ETHEREUM) // false
- * ```
- */
-export function isStarknetChain(chain: Chain): boolean {
-  return String(chain).startsWith(withSeparator(CHAIN_PREFIXES.STARKNET));
-}
-
-/**
- * Get chain namespace from Chain enum
- *
- * Returns the CAIP-2 namespace prefix (eip155, bip122, solana, etc.)
- *
- * @param chain - Chain enum value
- * @returns CAIP-2 namespace string
- *
- * @example
- * ```typescript
- * getChainNamespace(Chain.ETHEREUM) // 'eip155'
- * getChainNamespace(Chain.BITCOIN_MAINNET) // 'bip122'
- * ```
- */
-export function getChainNamespace(chain: Chain): string {
-  return String(chain).split(CAIP2_SEPARATOR)[0];
-}

package/src/utils/consoleLogger.ts

@@ -1,140 +0,0 @@
-/**
- * Console Logger Factory
- *
- * Creates a logger that outputs to the console with configurable log levels.
- * Used when `debug: true` is set in SDK configuration.
- *
- * @module utils/consoleLogger
- */
-
-import type { Logger } from '../shared/context/types';
-
-/**
- * Log level hierarchy (from most to least verbose)
- */
-export type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';
-
-/**
- * Options for creating a console logger
- */
-export interface ConsoleLoggerOptions {
-  /**
-   * Minimum log level to output
-   *
-   * - 'debug': All logs (most verbose)
-   * - 'info': Info, warnings, and errors
-   * - 'warn': Warnings and errors only
-   * - 'error': Errors only
-   * - 'none': No logs (silent)
-   *
-   * @default 'debug'
-   */
-  level?: LogLevel;
-
-  /**
-   * Prefix for all log messages
-   *
-   * @default '[Lombard SDK]'
-   */
-  prefix?: string;
-
-  /**
-   * Include timestamp in log messages
-   *
-   * @default false
-   */
-  timestamp?: boolean;
-}
-
-const LOG_LEVELS: LogLevel[] = ['debug', 'info', 'warn', 'error', 'none'];
-
-/**
- * Create a console logger with configurable options
- *
- * @param options - Logger configuration options
- * @returns Logger instance that outputs to console
- *
- * @example
- * ```typescript
- * // Basic usage - log everything
- * const logger = createConsoleLogger();
- *
- * // Only warnings and errors
- * const logger = createConsoleLogger({ level: 'warn' });
- *
- * // Custom prefix with timestamp
- * const logger = createConsoleLogger({
- *   prefix: '[MyApp SDK]',
- *   timestamp: true,
- * });
- * ```
- */
-export function createConsoleLogger(
-  options: ConsoleLoggerOptions = {},
-): Logger {
-  const { level = 'debug', prefix = '[Lombard SDK]', timestamp = false } = options;
-
-  const minLevelIndex = LOG_LEVELS.indexOf(level);
-
-  const shouldLog = (logLevel: LogLevel): boolean => {
-    const levelIndex = LOG_LEVELS.indexOf(logLevel);
-    return levelIndex >= minLevelIndex && level !== 'none';
-  };
-
-  const formatMessage = (msg: string): string => {
-    if (timestamp) {
-      const ts = new Date().toISOString();
-      return `${prefix} ${ts} ${msg}`;
-    }
-    return `${prefix} ${msg}`;
-  };
-
-  const formatMeta = (meta?: Record<string, unknown>): unknown[] => {
-    if (!meta || Object.keys(meta).length === 0) {
-      return [];
-    }
-    return [meta];
-  };
-
-  return {
-    debug(message: string, meta?: Record<string, unknown>): void {
-      if (shouldLog('debug')) {
-        console.debug(formatMessage(message), ...formatMeta(meta));
-      }
-    },
-
-    info(message: string, meta?: Record<string, unknown>): void {
-      if (shouldLog('info')) {
-        console.info(formatMessage(message), ...formatMeta(meta));
-      }
-    },
-
-    warn(message: string, meta?: Record<string, unknown>): void {
-      if (shouldLog('warn')) {
-        console.warn(formatMessage(message), ...formatMeta(meta));
-      }
-    },
-
-    error(message: string, meta?: Record<string, unknown>): void {
-      if (shouldLog('error')) {
-        console.error(formatMessage(message), ...formatMeta(meta));
-      }
-    },
-  };
-}
-
-/**
- * Create a silent logger (no-op)
- *
- * Useful for testing or when you want to suppress all logs.
- */
-export function createSilentLogger(): Logger {
-  return {
-    debug: () => {},
-    info: () => {},
-    warn: () => {},
-    error: () => {},
-  };
-}
-
-

package/src/utils/ensureNotSanctionedAddress.ts

@@ -1,11 +0,0 @@
-import { SANCTIONED_ADDRESS } from '../api-functions/generateDepositBtcAddress/generateDepositBtcAddress';
-import { LombardError, ValidationErrorCode } from '../shared/errors';
-
-export function ensureNotSanctionedAddress(address: string): void {
-  if (address === SANCTIONED_ADDRESS) {
-    throw new LombardError(
-      ValidationErrorCode.INVALID_PARAMETER,
-      'Destination address is under sanctions',
-    );
-  }
-}

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;
-};