@lombard.finance/sdk 4.0.0 → 4.1.2

package/src/defi/defi-registry.ts

@@ -1,295 +0,0 @@
-/**
- * DeFi Stake & Bake Registry
- *
- * Provides a strongly typed registry of staking integrations so that
- * protocol/token/env/chain support is declarative and composable.
- */
-
-import { Env } from '@lombard.finance/sdk-common';
-import { Abi } from 'viem';
-
-import { ChainId } from '../common/chains';
-import { ContractInfo } from '../common/contract-info';
-import { AssetId } from '../core/assets';
-import { Token } from '../tokens/token-addresses';
-import { SILO_VAULT_SPENDER_ABI } from '../vaults/abi';
-import {
-  VEDA_VAULT_SPENDER_CONTRACTS,
-  VEDA_VAULT_STAKE_AND_BAKE_CHAINS,
-  VedaVaultStakeAndBakeChain,
-} from '../vaults/lib/config';
-
-/**
- * Approval mode for stake and bake operations.
- * - `permit`: Off-chain EIP-2612 signature (gasless for user, backend pays gas)
- * - `approve`: On-chain ERC-20 approval transaction (user pays gas)
- */
-export type ApprovalMode = 'permit' | 'approve';
-
-export type StakeAndBakeAmountStrategy = 'identity' | 'btcToLbtc';
-export type StakeAndBakeDeadlineStrategy = 'expiry' | 'zero';
-export type StakeAndBakeNonceStrategy = 'chain' | 'skip';
-
-export interface StakeAndBakeStrategyConfig {
-  amountStrategy: StakeAndBakeAmountStrategy;
-  approval: {
-    mode: ApprovalMode;
-    domainName: string;
-    domainVersion: string;
-    deadlineStrategy: StakeAndBakeDeadlineStrategy;
-    nonceStrategy: StakeAndBakeNonceStrategy;
-  };
-  spenderContract: ContractInfo;
-}
-
-export interface StakeAndBakeStrategy extends StakeAndBakeStrategyConfig {
-  protocol: DefiProtocol;
-  token: StakeAndBakeToken;
-  env: Env;
-  chainId: ChainId;
-}
-
-type ChainStrategyMap = Partial<Record<ChainId, StakeAndBakeStrategyConfig>>;
-type EnvStrategyMap = Partial<Record<Env, ChainStrategyMap>>;
-type TokenStrategyMap = Partial<Record<StakeAndBakeToken, EnvStrategyMap>>;
-export type StakeAndBakeRegistry = Record<DefiProtocol, TokenStrategyMap>;
-
-const ALL_ENVS = Object.values(Env) as Env[];
-
-// Use single source of truth from vaults/lib/config.ts
-// VEDA_VAULT_STAKE_AND_BAKE_CHAINS is imported and used directly below
-
-export const SILO_VAULT_SPENDER_CONTRACT_GASTALD_FUJI: `0x${string}` =
-  '0xFe1e76D9e065e879A9D1914482f0F13d85F39877';
-
-function mapChains<const C extends readonly ChainId[]>(
-  chains: C,
-  factory: (chain: C[number]) => StakeAndBakeStrategyConfig,
-): ChainStrategyMap {
-  return chains.reduce<ChainStrategyMap>((acc, chain) => {
-    acc[chain] = factory(chain);
-    return acc;
-  }, {} as ChainStrategyMap);
-}
-
-function mapEnvs<const E extends readonly Env[]>(
-  envs: E,
-  factory: (env: E[number]) => ChainStrategyMap,
-): EnvStrategyMap {
-  return envs.reduce<EnvStrategyMap>((acc, env) => {
-    acc[env] = factory(env);
-    return acc;
-  }, {} as EnvStrategyMap);
-}
-
-function getVedaSpenderContract(
-  chainId: VedaVaultStakeAndBakeChain,
-): ContractInfo {
-  const contract = VEDA_VAULT_SPENDER_CONTRACTS[chainId];
-  if (!contract) {
-    throw new Error(`Missing Veda spender contract for chain ${chainId}`);
-  }
-  return contract;
-}
-
-const _DefiRegistryTokens = {
-  LBTC: Token.LBTC,
-  BTCb: Token.BTCb,
-  BTC: 'BTC',
-} as const;
-
-export type DefiRegistryToken =
-  (typeof _DefiRegistryTokens)[keyof typeof _DefiRegistryTokens];
-
-/**
- * DeFi Protocol identifiers - SINGLE SOURCE OF TRUTH
- *
- * These are the canonical protocol identifiers used throughout the SDK.
- * All other protocol references should use these values.
- */
-export const DefiProtocol = {
-  Veda: 'veda',
-  Silo: 'silo',
-} as const;
-
-export type DefiProtocol = (typeof DefiProtocol)[keyof typeof DefiProtocol];
-
-export const DefiProtocols = {
-  [DefiProtocol.Veda]: {
-    name: 'Lombard DeFi Vault',
-    url: 'https://lombard.finance',
-  },
-  [DefiProtocol.Silo]: {
-    name: 'Silo Finance Vault',
-    url: 'https://silo.finance',
-  },
-} as const;
-
-const VEDA_LBTC_PERMIT_APPROVAL: StakeAndBakeStrategyConfig['approval'] = {
-  mode: 'permit',
-  domainName: 'Lombard Staked Bitcoin',
-  domainVersion: '1',
-  deadlineStrategy: 'expiry',
-  nonceStrategy: 'chain',
-};
-
-const SILO_BTCB_APPROVE_APPROVAL: StakeAndBakeStrategyConfig['approval'] = {
-  mode: 'approve',
-  domainName: 'Bitcoin',
-  domainVersion: '1',
-  deadlineStrategy: 'zero',
-  nonceStrategy: 'skip',
-};
-
-/**
- * DeFi Registry: Token approval configurations by vault, token, env, and chain.
- * 
- * TODO: Update the format of this registry to match asset catalog and chain catalog
- */
-export const DEFI_REGISTRY: StakeAndBakeRegistry = {
-  [DefiProtocol.Veda]: {
-    [Token.LBTC]: mapEnvs(ALL_ENVS, () =>
-      mapChains(VEDA_VAULT_STAKE_AND_BAKE_CHAINS, chain => ({
-        amountStrategy: 'identity',
-        approval: { ...VEDA_LBTC_PERMIT_APPROVAL },
-        spenderContract: getVedaSpenderContract(chain),
-      })),
-    ),
-    BTC: mapEnvs(ALL_ENVS, () =>
-      mapChains(VEDA_VAULT_STAKE_AND_BAKE_CHAINS, chain => ({
-        amountStrategy: 'btcToLbtc',
-        approval: { ...VEDA_LBTC_PERMIT_APPROVAL },
-        spenderContract: getVedaSpenderContract(chain),
-      })),
-    ),
-  },
-  [DefiProtocol.Silo]: {
-    [Token.BTCb]: {
-      // Silo on Avalanche Fuji is only available on testnet (Gastald backend)
-      // Stage environment does not support Avalanche Fuji
-      [Env.testnet]: mapChains([ChainId.avalancheFuji], chain => ({
-        amountStrategy: 'identity',
-        approval: { ...SILO_BTCB_APPROVE_APPROVAL },
-        spenderContract: {
-          abi: SILO_VAULT_SPENDER_ABI as Abi,
-          address: SILO_VAULT_SPENDER_CONTRACT_GASTALD_FUJI,
-          chainId: chain,
-        },
-      })),
-    },
-  },
-};
-
-/**
- * Type for a token that can be used with stake and bake.
- * Includes both Token enum values and virtual tokens like 'BTC'.
- */
-export type StakeAndBakeToken = DefiRegistryToken;
-
-/**
- * Get supported chains for a protocol/token/env combination.
- *
- * @example
- * ```typescript
- * // Get chains supporting Veda with BTC token on testnet
- * const chains = getStakeAndBakeSupportedChains(DefiProtocol.Veda, 'BTC', Env.testnet);
- * // Returns: [ChainId.binanceSmartChainTestnet, ChainId.holesky]
- * ```
- */
-export function getStakeAndBakeSupportedChains(
-  protocol: DefiProtocol,
-  token: StakeAndBakeToken,
-  env: Env,
-): ChainId[] {
-  const protocolRegistry = DEFI_REGISTRY[protocol];
-  if (!protocolRegistry) return [];
-
-  const tokenRegistry =
-    protocolRegistry[token as keyof typeof protocolRegistry];
-  if (!tokenRegistry) return [];
-
-  const envRegistry = tokenRegistry[env];
-  if (!envRegistry) return [];
-
-  return Object.keys(envRegistry).map(Number) as ChainId[];
-}
-
-/**
- * Get all supported protocols for stake and bake (regardless of environment).
- */
-export function getSupportedProtocols(assetId: AssetId): DefiProtocol[] {
-  return Object.entries(DEFI_REGISTRY)
-    .filter(([_, tokenMap]) => assetId in tokenMap)
-    .map(([protocol]) => protocol as DefiProtocol);
-}
-
-/**
- * Get available protocols for a specific environment and token.
- *
- * This filters protocols based on what is actually configured in the DEFI_REGISTRY
- * for the given environment. Use this to determine which protocol options should
- * be shown in the UI.
- *
- * @example
- * ```typescript
- * // Get protocols available for LBTC in production
- * const prodProtocols = getAvailableProtocols(AssetId.LBTC, Env.prod);
- * // Returns: ['veda'] - Silo is only on Avalanche which has no mainnet prod config
- *
- * // Get protocols available for BTCb in testnet
- * const testnetProtocols = getAvailableProtocols(AssetId.BTCb, Env.testnet);
- * // Returns: ['silo'] - Silo is available on Avalanche Fuji in testnet
- * ```
- */
-export function getAvailableProtocols(
-  assetId: AssetId,
-  env: Env,
-): DefiProtocol[] {
-  // Map asset IDs to registry tokens
-  const tokenMap: Partial<Record<AssetId, StakeAndBakeToken[]>> = {
-    [AssetId.LBTC]: [Token.LBTC, 'BTC'],
-    [AssetId.BTCb]: [Token.BTCb],
-    [AssetId.BTC]: ['BTC'],
-  };
-
-  const tokens = tokenMap[assetId];
-  if (!tokens) return [];
-
-  const availableProtocols: Set<DefiProtocol> = new Set();
-
-  for (const [protocol, tokenStrategyMap] of Object.entries(DEFI_REGISTRY)) {
-    for (const token of tokens) {
-      const tokenRegistry = tokenStrategyMap[token as keyof typeof tokenStrategyMap];
-      if (!tokenRegistry) continue;
-
-      const envRegistry = tokenRegistry[env];
-      if (!envRegistry || Object.keys(envRegistry).length === 0) continue;
-
-      availableProtocols.add(protocol as DefiProtocol);
-    }
-  }
-
-  return Array.from(availableProtocols);
-}
-
-/**
- * Get available protocols with their metadata for UI display.
- *
- * @example
- * ```typescript
- * const protocols = getAvailableProtocolsWithMetadata(AssetId.LBTC, Env.prod);
- * // Returns: [{ value: 'veda', label: 'Lombard DeFi Vault', url: '...' }]
- * ```
- */
-export function getAvailableProtocolsWithMetadata(
-  assetId: AssetId,
-  env: Env,
-): Array<{ value: DefiProtocol; label: string; url: string }> {
-  const protocols = getAvailableProtocols(assetId, env);
-  
-  return protocols.map(protocol => ({
-    value: protocol,
-    label: DefiProtocols[protocol]?.name ?? protocol,
-    url: DefiProtocols[protocol]?.url ?? '',
-  }));
-}

package/src/defi/index.ts

@@ -1,17 +0,0 @@
-export {
-  isVedaVaultStakeAndBakeChain,
-  VEDA_VAULT_STAKE_AND_BAKE_CHAINS,
-  type VedaVaultStakeAndBakeChain,
-} from '../vaults/lib/config';
-export {
-  DEFI_REGISTRY,
-  DefiProtocol,
-  DefiProtocols,
-  type DefiRegistryToken,
-  getAvailableProtocols,
-  getAvailableProtocolsWithMetadata,
-  getStakeAndBakeSupportedChains,
-  getSupportedProtocols,
-  type StakeAndBakeRegistry,
-  type StakeAndBakeToken,
-} from './defi-registry';

package/src/index.ts

@@ -1,336 +0,0 @@
-/**
- * Lombard SDK - Public API
- *
- * Main entry point for the Lombard SDK.
- */
-
-// SDK Version (injected at build time)
-export { SDK_NAME, SDK_RUNTIME, SDK_VERSION } from './version';
-
-// Logging utilities
-export {
-type ConsoleLoggerOptions,   createConsoleLogger,
-  createSilentLogger, type LogLevel
-} from './utils/consoleLogger';
-
-// HTTP utilities (for advanced users)
-export { getSdkHeaders } from './utils/http';
-
-// Main SDK exports
-export type {
-  ApiVersion,
-  DepositAddressOptions,
-  DestinationChain,
-  ExchangeRateOptions,
-  UnstakeOptions
-} from './client/ApiNamespace';
-export { ApiNamespace } from './client/ApiNamespace';
-export { createConfig } from './client/createConfig';
-export { createLombardSDK } from './client/createLombardSDK';
-export { LombardSDK } from './client/LombardSDK';
-export { PartnerConfiguration } from './client/PartnerConfiguration';
-
-// Chain Actions (user-facing API)
-export { BtcActions, btcActions } from './chains/btc/BtcActions';
-export { EvmActions, evmActions } from './chains/evm/EvmActions';
-export { SolanaActions, solanaActions } from './chains/solana/SolanaActions';
-export {
-  StarknetActions,
-  starknetActions
-} from './chains/starknet/StarknetActions';
-export { SuiActions, suiActions } from './chains/sui/SuiActions';
-
-// Shared EVM utilities (fee authorization)
-export type { FeeAuthState } from './chains/evm/shared/feeAuth';
-
-// Status constants (single export to avoid duplicates)
-export {
-  BtcActionStatus,
-  EvmOperationStatus,
-  NonEvmUnstakeStatus
-} from './shared/constants/statusConstants';
-
-// Module exports
-export { btcModule, type BtcService } from './modules/btcModule';
-export type {
-  FeeAuthorizationResult,
-  StoredFeeSignature
-} from './modules/evmModule';
-export { evmModule, type EvmService } from './modules/evmModule';
-
-// Context types
-export type {
-  BtcCoreContext,
-  CoreContext,
-  EvmCoreContext,
-  EvmDestination,
-  Logger,
-  ProviderKey,
-  ProviderResolver,
-  SolanaDestination,
-  StarknetDestination,
-  SuiDestination
-} from './shared/context';
-
-// Configuration types
-export type {
-  CreateConfigOptions,
-  CustomAsset,
-  LombardConfig,
-  LombardSDKOptions,
-  PartnerConfig,
-  ProviderGetter,
-  ProviderGetters
-} from './config/types';
-
-// Provider types
-export type {
-  AnyProvider,
-  BtcProvider,
-  EvmProvider,
-  SolanaProvider,
-  StarknetProvider,
-  SuiProvider
-} from './config/providers';
-export {
-  isBtcProvider,
-  isEvmProvider,
-  isSolanaProvider,
-  isStarknetProvider,
-  isSuiProvider
-} from './config/providers';
-
-// Shared types
-export type { ChainMetadata, DeployConfig, RouteParams, StrategyProgress } from './core';
-export {
-  AssetId,
-  assetValueToKey, Chain,
-  // Chain utility functions
-  CHAIN_CATALOG, chainValueToKey, DeployProtocol,
-  Env, evmChainIdToChain,
-  getAllAssetChains,
-  getAssetAddress,
-  // Asset utility functions for dynamic chain discovery
-  getAssetChains,
-  getAssetChainsForEnvs,
-  getChainMetadata,
-  getChainName,
-  isAssetDeployed,
-  isAssetId,
-  isChain,
-  isEvmChain,
-  isMainnet,
-  isTestnet,
-  StepStatus,
-  StrategyStatus
-} from './core';
-
-// Event types
-export type {
-  BridgeEventMap,
-  DeployEventMap,
-  DepositEventMap,
-  RedeemEventMap,
-  StakeEventMap,
-  StrategyEvent,
-  StrategyEventMap,
-  UnstakeEventMap
-} from './shared/events';
-export {
-  BridgeEvent,
-  DeployEvent,
-  DepositEvent,
-  RedeemEvent,
-  StakeEvent,
-  UnstakeEvent
-} from './shared/events';
-
-// Error handling
-export {
-  ContractErrorCode,
-  ErrorCode, isLombardError, LombardError,
-  ProviderErrorCode,
-  RegistryErrorCode,
-  ValidationErrorCode, wrapError
-} from './shared/errors';
-
-// Action interfaces
-export type { LogMeta, MonitorableAction } from './shared/actions/BaseAction';
-
-// BTC types and direct actions
-export type {
-  BtcDepositAndDeployParams,
-  BtcDepositAndDeployPrepareParams,
-  BtcDepositAndDeployProgress,
-  BtcDepositParams,
-  BtcDepositPrepareParams,
-  BtcDepositProgress,
-  BtcStakeAndDeployParams,
-  BtcStakeAndDeployPrepareParams,
-  BtcStakeAndDeployProgress,
-  BtcStakeParams,
-  BtcStakeProgress,
-  IBtcDeposit,
-  IBtcDepositAndDeploy,
-  IBtcStake,
-  IBtcStakeAndDeploy
-} from './chains/btc';
-export {
-  BtcDeposit,
-  BtcDepositAndDeploy,
-  BtcStake,
-  BtcStakeAndDeploy
-} from './chains/btc';
-
-// Note: Sync factory functions (btcStake, btcDeposit, etc.) are intentionally
-// not exported. Use createLombardSDK() instead:
-//
-//   const sdk = await createLombardSDK({ env: Env.prod, ... });
-//   const stake = sdk.chain.btc.stake({ ... });
-//
-// This ensures consistent behavior when remote catalog fetching is added in v4.1.
-
-// EVM types and direct actions
-export type {
-  EvmDeployParams,
-  EvmDeployPrepareParams,
-  EvmDeployProgress,
-  EvmDepositParams,
-  EvmDepositPrepareParams,
-  EvmDepositProgress,
-  EvmRedeemParams,
-  EvmRedeemPrepareParams,
-  EvmRedeemProgress,
-  EvmStakeParams,
-  EvmStakePrepareParams,
-  EvmStakeProgress,
-  EvmUnstakeParams,
-  EvmUnstakePrepareParams,
-  EvmUnstakeProgress,
-  IEvmDeploy,
-  IEvmDeposit,
-  IEvmRedeem,
-  IEvmStake,
-  IEvmUnstake
-} from './chains/evm';
-export {
-  EvmDeployStatus,
-  EvmDepositStatus,
-  EvmRedeemStatus,
-  EvmStakeStatus,
-  EvmUnstakeStatus
-} from './chains/evm';
-
-// Note: Sync factory functions (evmStake, evmUnstake, etc.) are intentionally
-// not exported. Use createLombardSDK() instead:
-//
-//   const sdk = await createLombardSDK({ env: Env.prod, ... });
-//   const unstake = sdk.chain.evm.unstake({ ... });
-
-// Utils:
-export * from './common/api-config';
-export * from './common/blockchain-identifier';
-export * from './common/chains';
-export * from './common/fee-requirements';
-
-// Token utilities
-export * from './tokens/lbtc-addresses';
-export * from './tokens/token-addresses';
-export * from './tokens/tokens';
-export * from './utils/satoshi';
-
-// DeFi registry
-export * from './defi';
-
-// Metrics:
-export {
-  getAdditionalRewards,
-  type RewardsDistribution
-} from './metrics/get-additional-rewards';
-export {
-  getApy,
-  getEstimatedApy,
-  type LbtcApy,
-  type LbtcEstimatedApy
-} from './metrics/get-lbtc-apy';
-export { getLBTCStats } from './metrics/get-lbtc-stats';
-export {
-  getPositionsSummary,
-  type PositionsSummary
-} from './metrics/get-positions-summary';
-
-// Referrals
-export { ReferralsClient } from './referrals';
-export type {
-  ReferralLookupParams,
-  ReferralLookupResult
-} from './referrals/ReferralsClient';
-
-// API response types
-export type { Deposit } from './api-functions/getDepositsByAddress/getDepositsByAddress';
-export type { Unstake } from './api-functions/getUnstakesByAddress/getUnstakesByAddress';
-export { PayoutTxStatus } from './api-functions/getUnstakesByAddress/getUnstakesByAddress';
-
-// Deposit status utilities
-export {
-  calcConfirmations, type ConfirmationProgress, depositRequiresAction, type DepositStatus,
-  type DepositStatusDisplay, getConfirmationProgress,
-  getDepositStatus,
-  getDepositStatusDisplay,
-  isDepositClaimable,
-  isDepositPending,
-  isDepositTerminal, MIN_CLAIM_AMOUNT_BTC,
-  REQUIRED_CONFIRMATIONS, type StatusSeverity
-} from './shared/deposits';
-
-// External types
-export type { Address, EIP1193Provider } from 'viem';
-
-// Contract/API functions
-export * from './api-functions';
-export * from './contract-functions';
-
-// Vault:
-export * from './vaults';
-
-// Signer support (custom transaction signing):
-export {
-  createAccountFromSigner,
-  createWalletClientFromSigner, type DispatchCallback,
-  type EvmTransactionRequest,
-  type SignerAdapter,
-SignerError, validateTransactionRequest} from './clients/evm-signer-adapter';
-
-// RPC URL configuration (for wagmi/viem setup):
-export {
-  getRpcUrlConfig,
-  RPC_URL,
-  rpcUrlConfig,
-  type TRpcUrlConfig
-} from './clients/rpc-url-config';
-export {
-type CommonSignerWriteParameters,
-  isProviderFlow,
-  isSignerFlow} from './common/parameters';
-
-// Bridge:
-export {
-  bridge,
-  bridgeCCIP, type BridgeCCIPParameters, bridgeOFT, type BridgeParameters,
-getBridgeInfo, OFT_GAS_LIMIT,
-  OFT_HI_GAS_LIMIT,
-  OFT_HI_GAS_LIMIT_CHAINS} from './bridge';
-
-// Debug:
-export * from './debug-api';
-
-// Internal utilities (used by apps/main):
-export { makePublicClient } from './clients/public-client';
-export {
-  getErrorMessage,
-  TokenContractAddressNotFoundError,
-  UnsupportedTokenFlow
-} from './utils/err';
-export { ensureHex, isHex } from './utils/hex';
-export { DAY, HOUR, MINUTE, now, SECOND, toUnix } from './utils/time';
-

package/src/metrics/get-additional-rewards.ts

@@ -1,69 +0,0 @@
-import axios from 'axios';
-import BigNumber from 'bignumber.js';
-import { Address } from 'viem';
-
-import { getApiConfig } from '../common/api-config';
-import { IEnvParam } from '../common/parameters';
-
-type Response = {
-  btc_distributed: { name: string; amount: number }[];
-  btc_undistributed: { name: string; amount: number }[];
-};
-
-export type RewardsDistribution = {
-  /**
-   * List of campaigns where rewards have been successfully distributed.
-   */
-  distributed: {
-    /** Name of the reward campaign. */
-    name: string;
-    /** Amount of BTC distributed for this campaign. */
-    amount: BigNumber;
-  }[];
-
-  /**
-   * List of campaigns where rewards are pending or not yet distributed.
-   */
-  undistributed: {
-    /** Name of the reward campaign. */
-    name: string;
-    /** Amount of BTC yet to be distributed. */
-    amount: BigNumber;
-  }[];
-};
-
-/**
- * Retrieves additional rewards that have been distributed or are pending
- * for a specific account.
- */
-export async function getAdditionalRewards({
-  account,
-  env,
-}: {
-  account: Address;
-} & IEnvParam) {
-  if (!account) {
-    throw new Error('Missing account address');
-  }
-
-  const { baseApiUrl } = getApiConfig(env);
-
-  const url = `${baseApiUrl}/api/v1/analytics/${account}/additional-rewards`;
-  const { data } = await axios.get<Response>(url);
-
-  const distribution: RewardsDistribution = {
-    distributed: data.btc_distributed.map(d => ({
-      amount: BigNumber(d.amount),
-      name: d.name,
-    })),
-    undistributed: data.btc_undistributed.map(u => ({
-      amount: BigNumber(u.amount),
-      name: u.name,
-    })),
-  };
-
-  return distribution;
-}
-
-// url: https://bft-dev.stage.lombard-fi.com/api/v1/analytics/0x2513196b4fD01Ed5888d1dB49AB9a42208E9fF90/additional-rewards
-// {"btc_distributed":[{"name":"ledger", "amount":0.7691864317643695}], "btc_undistributed":[{"name":"ledger", "amount":0.5699985451505658}]}