@lombard.finance/sdk 4.0.0 → 4.1.0

package/src/config/index.ts

@@ -1,12 +0,0 @@
-/**
- * Configuration module for the Lombard SDK
- *
- * This module provides:
- * - Provider type definitions and type guards
- * - SDK configuration types
- * - Configuration validation and defaults
- */
-
-export * from './providers';
-export * from './types';
-export * from './validation';

package/src/config/providers.ts

@@ -1,81 +0,0 @@
-export type {
-  AnyProvider,
-  BtcProvider,
-  EvmProvider,
-  ProviderKey,
-  ProviderMap,
-  SolanaProvider,
-  StarknetProvider,
-  SuiProvider,
-} from '@lombard.finance/sdk-common';
-import type {
-  BtcProvider,
-  EvmProvider,
-  SolanaProvider,
-  StarknetProvider,
-  SuiProvider,
-} from '@lombard.finance/sdk-common';
-
-/**
- * Type guard to check if a provider is an EVM provider
- */
-export function isEvmProvider(provider: unknown): provider is EvmProvider {
-  return (
-    typeof provider === 'object' &&
-    provider !== null &&
-    'request' in provider &&
-    typeof (provider as EvmProvider).request === 'function'
-  );
-}
-
-/**
- * Type guard to check if a provider is a Bitcoin provider
- */
-export function isBtcProvider(provider: unknown): provider is BtcProvider {
-  return (
-    typeof provider === 'object' &&
-    provider !== null &&
-    'getAddresses' in provider &&
-    typeof (provider as BtcProvider).getAddresses === 'function'
-  );
-}
-
-/**
- * Type guard to check if a provider is a Solana provider
- */
-export function isSolanaProvider(
-  provider: unknown,
-): provider is SolanaProvider {
-  return (
-    typeof provider === 'object' &&
-    provider !== null &&
-    'publicKey' in provider &&
-    'signAndSendTransaction' in provider
-  );
-}
-
-/**
- * Type guard to check if a provider is a Sui provider
- */
-export function isSuiProvider(provider: unknown): provider is SuiProvider {
-  return (
-    typeof provider === 'object' &&
-    provider !== null &&
-    'getAddress' in provider &&
-    'signAndExecuteTransactionBlock' in provider
-  );
-}
-
-/**
- * Type guard to check if a provider is a Starknet provider
- */
-export function isStarknetProvider(
-  provider: unknown,
-): provider is StarknetProvider {
-  return (
-    typeof provider === 'object' &&
-    provider !== null &&
-    'address' in provider &&
-    'execute' in provider
-  );
-}

package/src/config/types.ts

@@ -1,216 +0,0 @@
-/**
- * Configuration types for the Lombard SDK
- *
- * This module defines the types for SDK configuration, including
- * provider getters, partner configuration, and custom asset registration.
- */
-
-import type { AnyModule, Env } from '@lombard.finance/sdk-common';
-
-import type { AssetId, Chain } from '../core';
-import type { Logger } from '../shared/context/types';
-import type {
-  BtcProvider,
-  EvmProvider,
-  SolanaProvider,
-  StarknetProvider,
-  SuiProvider,
-} from './providers';
-
-/**
- * Provider getter function
- *
- * A function that returns a provider instance for a specific chain.
- * This allows lazy loading of providers only when needed.
- *
- * @param chain - Optional chain identifier (for multi-chain providers like EVM)
- * @returns Provider instance or promise of provider instance
- */
-export type ProviderGetter<TProvider> = (
-  chain?: Chain,
-) => TProvider | Promise<TProvider>;
-
-export interface ProviderGetters {
-  evm?: ProviderGetter<EvmProvider>;
-  bitcoin?: ProviderGetter<BtcProvider>;
-  solana?: ProviderGetter<SolanaProvider>;
-  sui?: ProviderGetter<SuiProvider>;
-  starknet?: ProviderGetter<StarknetProvider>;
-}
-
-/**
- * Get provider getter from config by key
- *
- * Uses explicit property access to avoid security concerns with dynamic keys.
- * This pattern is required by static analysis tools (Codacy/Semgrep) to prevent
- * potential object injection vulnerabilities.
- *
- * @param providers - Provider getters configuration
- * @param key - Provider key to retrieve
- * @returns Provider getter function or undefined if not configured
- */
-export function getProviderGetter<T = unknown>(
-  providers: ProviderGetters,
-  key: string,
-): ProviderGetter<T> | undefined {
-  let getter: ProviderGetter<unknown> | undefined;
-  switch (key) {
-    case 'evm':
-      getter = providers.evm;
-      break;
-    case 'bitcoin':
-      getter = providers.bitcoin;
-      break;
-    case 'solana':
-      getter = providers.solana;
-      break;
-    case 'sui':
-      getter = providers.sui;
-      break;
-    case 'starknet':
-      getter = providers.starknet;
-      break;
-    default:
-      getter = undefined;
-  }
-  return getter as ProviderGetter<T> | undefined;
-}
-
-/**
- * SDK configuration options
- *
- * Options passed to createConfig(). `modules` is optional; built-ins are
- * registered automatically if not provided.
- *
- * @example
- * ```typescript
- * // Config is synchronous - can be exported directly
- * export const config = createConfig({
- *   env: Env.prod,
- *   providers: { evm: () => window.ethereum },
- *   debug: true,  // Enable console logging
- * });
- *
- * // SDK creation is async (fetches catalog)
- * const sdk = await createLombardSDK(config);
- * ```
- */
-export interface CreateConfigOptions {
-  /** Environment (prod, testnet, stage, dev) */
-  env: Env;
-
-  /** Wallet provider getters for each chain */
-  providers?: ProviderGetters;
-
-  /** Optional modules to register */
-  modules?: readonly AnyModule[];
-
-  /** Partner configuration */
-  partner?: PartnerConfig;
-
-  /**
-   * Optional logger for SDK operations
-   *
-   * Provide your own logger to integrate with your logging infrastructure
-   * (e.g., Sentry, DataDog, custom logging).
-   *
-   * @example
-   * ```typescript
-   * logger: {
-   *   error: (msg, meta) => Sentry.captureMessage(msg, { extra: meta }),
-   *   warn: console.warn,
-   *   info: console.info,
-   *   debug: () => {},  // Suppress debug logs
-   * }
-   * ```
-   */
-  logger?: Logger;
-
-  /**
-   * Enable debug mode
-   *
-   * When true, creates a console logger that outputs all SDK operations.
-   * Useful for development and debugging.
-   *
-   * Note: If both `logger` and `debug` are provided, `logger` takes precedence.
-   *
-   * @default false
-   */
-  debug?: boolean;
-}
-
-/**
- * Validated SDK configuration
- *
- * Configuration object returned by createConfig(). This is a plain,
- * synchronous object that can be exported from a module and passed around.
- *
- * The asset catalog is NOT included here - it's fetched asynchronously
- * when createLombardSDK() is called.
- */
-export interface LombardConfig {
-  env: Env;
-  providers: ProviderGetters;
-  modules: readonly AnyModule[];
-  partner?: PartnerConfig;
-  logger?: Logger;
-}
-
-/**
- * Resolved SDK configuration (internal)
- *
- * Extended config with the asset catalog, used internally by LombardSDK.
- * Users don't interact with this type directly.
- *
- * @internal
- */
-export interface ResolvedLombardConfig extends LombardConfig {
-  /**
-   * Asset catalog (fetched during SDK initialization)
-   *
-   * Contains all asset deployments, chain configs, and addresses.
-   * This is fetched asynchronously during createLombardSDK() to allow
-   * for dynamic updates without SDK releases.
-   */
-  catalog: import('../core/assets/types').AssetCatalog;
-}
-
-export type LombardSDKOptions = CreateConfigOptions;
-
-/**
- * Partner configuration
- *
- * Configuration for partners integrating the SDK.
- */
-export interface PartnerConfig {
-  /** Unique partner identifier */
-  partnerId: string;
-}
-
-/**
- * Custom asset registration
- *
- * Allows partners to register custom assets (e.g., SPL tokens).
- */
-export interface CustomAsset {
-  /** Asset type */
-  type: 'spl' | 'erc20' | 'native';
-
-  /** Contract address (for token assets) */
-  address?: string;
-
-  /** Asset symbol */
-  symbol: string;
-
-  /** Number of decimals */
-  decimals: number;
-
-  /** L-Asset symbol (how it will be named in Lombard) */
-  lAssetSymbol: string;
-
-  /** Chain where the asset exists */
-  chain?: Chain;
-
-  /** Optional: Asset ID mapping */
-  assetId?: AssetId;
-}

package/src/config/validation.ts

@@ -1,69 +0,0 @@
-/**
- * Configuration validation and defaults
- *
- * This module provides validation and default application for SDK configuration.
- */
-
-import { LombardError } from '../shared/errors';
-import type { CreateConfigOptions, LombardConfig } from './types';
-
-/**
- * Normalized options after validation (before modules/logger are added)
- * @internal
- */
-export type NormalizedOptions = Omit<LombardConfig, 'modules' | 'logger'>;
-
-/**
- * Validate and apply defaults to SDK options
- *
- * @param options - User-provided SDK options
- * @returns Validated and normalized options (catalog added separately)
- * @throws LombardError if configuration is invalid
- * @internal
- */
-export function validateAndApplyDefaults(
-  options: CreateConfigOptions,
-): NormalizedOptions {
-  // Validate environment
-  if (!options.env) {
-    throw LombardError.missingParameter('env');
-  }
-
-  // Build normalized options with defaults
-  const normalized: NormalizedOptions = {
-    env: options.env,
-    providers: options.providers || {},
-  };
-
-  // Add partner config if provided
-  if (options.partner) {
-    validatePartnerConfig(options.partner);
-    normalized.partner = options.partner;
-  }
-
-  return normalized;
-}
-
-/**
- * Validate partner configuration
- *
- * @param partner - Partner configuration to validate
- * @throws LombardError if configuration is invalid
- */
-function validatePartnerConfig(partner: unknown): void {
-  if (typeof partner !== 'object' || partner === null) {
-    throw LombardError.invalidConfiguration(
-      'Partner configuration must be an object',
-    );
-  }
-
-  const config = partner as { partnerId?: string };
-
-  if (!config.partnerId || typeof config.partnerId !== 'string') {
-    throw LombardError.missingParameter('partner.partnerId');
-  }
-
-  if (config.partnerId.trim().length === 0) {
-    throw LombardError.invalidConfiguration('Partner ID cannot be empty');
-  }
-}

package/src/contract-functions/approveLBTC/approveLBTC.stories.tsx

@@ -1,79 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../../common/chains';
-import { chainSelector } from '../../stories/arg-types';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { ConnectButton } from '../../stories/components/ConnectButton';
-import {
-  functionType,
-  wagmiDecorator,
-} from '../../stories/components/decorators';
-import {
-  canPerformAction,
-  useConnection,
-} from '../../stories/hooks/useConnection';
-import useQuery from '../../stories/hooks/useQuery';
-import { Vault,VAULTS } from '../../vaults/lib/config';
-import { approveLBTC,IApproveLBTCParams } from './approveLBTC';
-
-const meta = {
-  title: 'write/approveLBTC',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [wagmiDecorator, functionType('write')],
-  argTypes: { ...chainSelector },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    chainId: ChainId.sepolia,
-    spender: VAULTS[Vault.Veda].spenderContracts[ChainId.sepolia]?.address,
-    amount: 0.00001,
-    env: Env.stage,
-  },
-};
-
-type Props = Omit<IApproveLBTCParams, 'account' | 'provider'>;
-
-export function StoryView(props: Props) {
-  const connection = useConnection();
-
-  const request = async () => {
-    if (!canPerformAction(connection)) {
-      return;
-    }
-
-    return approveLBTC({
-      ...props,
-
-      account: connection.account.address,
-      // chainId: connection.account.chainId,
-      provider: connection.provider,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <div className="mb-4">
-        <ConnectButton />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !connection.account.address}
-        isLoading={isLoading}
-        actionName={approveLBTC.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/contract-functions/approveLBTC/approveLBTC.ts

@@ -1,66 +0,0 @@
-import BigNumber from 'bignumber.js';
-import { Address, Hash } from 'viem';
-
-import { makePublicClient } from '../../clients/public-client';
-import { makeWalletClient } from '../../clients/wallet-client';
-import { CHAIN_ID_TO_VIEM_CHAIN_MAP } from '../../common/chains';
-import { CommonWriteParameters } from '../../common/parameters';
-import { Token } from '../../tokens/token-addresses';
-import { getTokenContractInfo } from '../../tokens/tokens';
-import { toSatoshi } from '../../utils/satoshi';
-
-export interface IApproveLBTCParams extends CommonWriteParameters {
-  /**
-   * The spender account address.
-   */
-  spender: Address;
-  /**
-   * The approved amount of LBTC.
-   */
-  amount: BigNumber.Value;
-}
-
-/**
- * Approves the provided spender to withdraw a specified amount of LBTC from
- * your account.
- *
- * @param {IApproveLBTCParams} parameters - The parameters.
- * @param {Address} spender - The spender account address.
- * @param {BigNumber.Value} - The amount of LBTC.
- * @param {Address} parameters.account - The EVM account address.
- * @param {ChainId} parameters.chainId - The chain id.
- * @param {EIP1193Provider} parameters.provider - The EIP1193 provider.
- * @param {string} parameters.rpcUrl - The optional rpc url.
- * @param {Env} parameters.env - The optional environment identifier.
- *
- * @returns {Promise<Hash>}
- */
-export async function approveLBTC({
-  account,
-  spender,
-  amount,
-  chainId,
-  provider,
-  rpcUrl,
-  env,
-}: IApproveLBTCParams): Promise<Hash> {
-  const publicClient = makePublicClient({ chainId, rpcUrl });
-  const walletClient = makeWalletClient({ chainId, provider });
-
-  const lbtcContract = await getTokenContractInfo(Token.LBTC, chainId, env);
-
-  const amountSat = toSatoshi(amount).toNumber();
-
-  const { request } = await publicClient.simulateContract({
-    address: lbtcContract.address,
-    account,
-    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    abi: lbtcContract.abi,
-    functionName: 'approve',
-    args: [spender, BigInt(amountSat)],
-  });
-
-  const txHash = await walletClient.writeContract(request);
-
-  return txHash;
-}

package/src/contract-functions/approveLBTC/index.ts

@@ -1 +0,0 @@
-export * from './approveLBTC';

package/src/contract-functions/approveToken/approveToken.ts

@@ -1,126 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import BigNumber from 'bignumber.js';
-import { Address, Hash } from 'viem';
-
-import { makePublicClient } from '../../clients/public-client';
-import { makeWalletClient } from '../../clients/wallet-client';
-import { CHAIN_ID_TO_VIEM_CHAIN_MAP, ChainId } from '../../common/chains';
-import { CommonWriteParameters, IEnvParam } from '../../common/parameters';
-import { Token } from '../../tokens/token-addresses';
-import {
-  fromBaseDenomination,
-  getTokenInfo,
-  toBaseDenomination,
-} from '../../tokens/tokens';
-import toBigInt from '../../utils/numbers';
-
-export interface IApproveTokenParams extends CommonWriteParameters, IEnvParam {
-  /**
-   * The token to approve.
-   */
-  token: Token;
-  /**
-   * The spender account address.
-   */
-  spender: Address;
-  /**
-   * The approved amount of the token.
-   */
-  amount: BigNumber.Value;
-}
-
-/**
- * Approves the provided spender to withdraw a specified amount of a token from
- * your account.
- *
- * @param {IApproveTokenParams} parameters - The parameters.
- * @param {Token} parameters.token - The token to approve.
- * @param {Address} parameters.spender - The spender account address.
- * @param {BigNumber.Value} parameters.amount - The amount of the token.
- * @param {Address} parameters.account - The EVM account address.
- * @param {ChainId} parameters.chainId - The chain id.
- * @param {EIP1193Provider} parameters.provider - The EIP1193 provider.
- * @param {string} parameters.rpcUrl - The optional rpc url.
- * @param {Env} parameters.env - The optional environment identifier.
- *
- * @returns {Promise<Hash>}
- */
-export async function approveToken({
-  account,
-  token,
-  spender,
-  amount,
-  chainId,
-  provider,
-  rpcUrl,
-  env,
-}: IApproveTokenParams): Promise<Hash> {
-  const publicClient = makePublicClient({ chainId, rpcUrl, env });
-  const walletClient = makeWalletClient({ chainId, provider });
-
-  const tokenInfo = await getTokenInfo(token, chainId, env, rpcUrl);
-  if (!tokenInfo) {
-    throw new Error(`Token info not found for ${token} on chain ${chainId}`);
-  }
-
-  const amountBase = toBigInt(
-    toBaseDenomination(BigNumber(amount), tokenInfo.decimals),
-  );
-
-  const { request } = await publicClient.simulateContract({
-    address: tokenInfo.address,
-    account,
-    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    abi: tokenInfo.abi,
-    functionName: 'approve',
-    args: [spender, amountBase],
-  });
-
-  const txHash = await walletClient.writeContract(request);
-
-  return txHash;
-}
-
-/**
- * Gets the allowance of a token for a spender.
- *
- * @param {Object} parameters - The parameters.
- * @param {Token} parameters.token - The token.
- * @param {Address} parameters.owner - The owner account address.
- * @param {Address} parameters.spender - The spender account address.
- * @param {ChainId} parameters.chainId - The chain id.
- * @param {string} parameters.rpcUrl - The optional rpc url.
- * @param {Env} parameters.env - The optional environment identifier.
- *
- * @returns {Promise<BigNumber>}
- */
-export async function getTokenAllowance({
-  token,
-  owner,
-  spender,
-  chainId,
-  rpcUrl,
-  env,
-}: {
-  token: Token;
-  owner: Address;
-  spender: Address;
-  chainId: ChainId;
-  rpcUrl?: string;
-  env?: Env;
-}): Promise<BigNumber> {
-  const publicClient = makePublicClient({ chainId, rpcUrl, env });
-  const tokenInfo = await getTokenInfo(token, chainId, env, rpcUrl);
-  if (!tokenInfo) {
-    throw new Error(`Token info not found for ${token} on chain ${chainId}`);
-  }
-
-  const allowanceRaw = (await publicClient.readContract({
-    address: tokenInfo.address,
-    abi: tokenInfo.abi,
-    functionName: 'allowance',
-    args: [owner, spender],
-  })) as bigint;
-
-  return fromBaseDenomination(allowanceRaw.toString(), tokenInfo.decimals);
-}

package/src/contract-functions/approveToken/index.ts

@@ -1 +0,0 @@
-export * from './approveToken';