@lombard.finance/sdk 3.7.4 → 4.1.0

package/src/defi/defi-registry.ts

@@ -1,179 +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 { Token } from '../tokens/token-addresses';
-import { SILO_VAULT_SPENDER_ABI } from '../vaults/abi';
-import {
-  VEDA_VAULT_SPENDER_CONTRACTS,
-  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[];
-
-const VEDA_STAKE_AND_BAKE_CHAINS = [
-  ChainId.ethereum,
-  ChainId.binanceSmartChain,
-  ChainId.binanceSmartChainTestnet,
-  ChainId.holesky,
-] as const satisfies readonly ChainId[];
-
-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;
-}
-
-export const DefiRegistryTokens = {
-  LBTC: Token.LBTC,
-  BTCb: Token.BTCb,
-  BTC: 'BTC',
-} as const;
-
-export type DefiRegistryToken =
-  (typeof DefiRegistryTokens)[keyof typeof DefiRegistryTokens];
-
-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.
- */
-export const DEFI_REGISTRY: StakeAndBakeRegistry = {
-  [DefiProtocol.Veda]: {
-    [Token.LBTC]: mapEnvs(ALL_ENVS, () =>
-      mapChains(VEDA_STAKE_AND_BAKE_CHAINS, chain => ({
-        amountStrategy: 'identity',
-        approval: { ...VEDA_LBTC_PERMIT_APPROVAL },
-        spenderContract: getVedaSpenderContract(chain),
-      })),
-    ),
-    BTC: mapEnvs(ALL_ENVS, () =>
-      mapChains(VEDA_STAKE_AND_BAKE_CHAINS, chain => ({
-        amountStrategy: 'btcToLbtc',
-        approval: { ...VEDA_LBTC_PERMIT_APPROVAL },
-        spenderContract: getVedaSpenderContract(chain),
-      })),
-    ),
-  },
-  [DefiProtocol.Silo]: {
-    [Token.BTCb]: {
-      [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;

package/src/defi/index.ts

@@ -1,5 +0,0 @@
-export {
-  DefiProtocol,
-  type DefiRegistryToken,
-  type StakeAndBakeToken,
-} from './defi-registry';

package/src/index.ts

@@ -1,84 +0,0 @@
-// API functions:
-export * from './api-functions';
-
-// READ and WRITE functions:
-export * from './contract-functions';
-
-// Vault:
-export * from './vaults';
-
-// DeFi:
-export * from './defi';
-
-// Utils:
-export * from './common/api-config';
-export * from './common/blockchain-identifier';
-export * from './common/chains';
-export {
-  SOLANA_DEVNET_CHAIN,
-  SOLANA_MAINNET_CHAIN,
-  SOLANA_TESTNET_CHAIN,
-  SUI_DEVNET_CHAIN,
-  SUI_MAINNET_CHAIN,
-  SUI_TESTNET_CHAIN,
-} from './common/chains';
-export * from './tokens/lbtc-addresses';
-export * from './tokens/token-addresses';
-export * from './utils/satoshi';
-
-// 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';
-
-// Tokens:
-export * from './tokens/lbtc-addresses';
-export * from './tokens/tokens';
-
-// Re-exports:
-export { Env } from '@lombard.finance/sdk-common';
-export type { Address, EIP1193Provider } from 'viem';
-
-// Signer support (custom transaction signing):
-export {
-  createAccountFromSigner,
-  createWalletClientFromSigner,
-  type DispatchCallback,
-  type EvmTransactionRequest,
-  type SignerAdapter,
-  SignerError,
-  validateTransactionRequest,
-} from './clients/evm-signer-adapter';
-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';

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

package/src/metrics/get-lbtc-apy.ts

@@ -1,74 +0,0 @@
-import axios from 'axios';
-import BigNumber from 'bignumber.js';
-import { Address, zeroAddress } from 'viem';
-
-import { getApiConfig } from '../common/api-config';
-import { IEnvParam } from '../common/parameters';
-
-type Response = {
-  lbtc_base_apy: number;
-  lbtc_effective_apy: number;
-};
-
-export type LbtcApy = {
-  /**
-   * The base APY for LBTC, representing the nominal yield without any bonuses
-   * or adjustments.
-   */
-  baseApy: BigNumber;
-  /**
-   * The effective APY for LBTC, including any additional rewards,
-   * compounding effects, or protocol-specific incentives.
-   */
-  effectiveApy: BigNumber;
-};
-
-/** Returns the current APY (annual percentage yield) for LBTC. */
-export async function getApy({
-  account,
-  env,
-}: {
-  /** The optional account address. Pass it for more accurate APY data. */
-  account?: Address;
-} & IEnvParam) {
-  const { baseApiUrl } = getApiConfig(env);
-
-  const url = `${baseApiUrl}/api/v1/analytics/${account || zeroAddress}/apy`;
-  const { data } = await axios.get<Response>(url);
-
-  const apy: LbtcApy = {
-    baseApy: BigNumber(data.lbtc_base_apy),
-    effectiveApy: BigNumber(data.lbtc_effective_apy),
-  };
-
-  return apy;
-}
-
-type EstimatedApyResponse = { lbtc_estimated_apy: number };
-export type LbtcEstimatedApy = {
-  /**
-   * The estimated APY for LBTC based on the specified partner context.
-   *
-   * This value reflects a projected annual percentage yield that may vary
-   * depending on the `partnerId`, taking into account potential partner-specific
-   * incentives, compounding assumptions, or estimated future rewards.
-   */
-  estimatedApy: BigNumber;
-};
-
-/** Returns the estimated APY for LBTC. */
-export async function getEstimatedApy({
-  partnerId,
-  env,
-}: { partnerId?: string } & IEnvParam) {
-  const { baseApiUrl } = getApiConfig(env);
-
-  const url = `${baseApiUrl}/api/v1/analytics/estimated-apy?partner_id=${partnerId || ''}`;
-  const { data } = await axios.get<EstimatedApyResponse>(url);
-
-  const apy: LbtcEstimatedApy = {
-    estimatedApy: BigNumber(data.lbtc_estimated_apy),
-  };
-
-  return apy;
-}

package/src/metrics/get-lbtc-stats.stories.tsx

@@ -1,56 +0,0 @@
-import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-import { envSelector } from '../stories/arg-types';
-import { Button } from '../stories/components/Button';
-import { CodeBlock } from '../stories/components/CodeBlock';
-import { functionType, wagmiDecorator } from '../stories/components/decorators';
-import { ErrorBlock } from '../stories/components/error-block';
-import useQuery from '../stories/hooks/useQuery';
-import { getLBTCStats } from './get-lbtc-stats';
-
-const meta = {
-  title: 'metrics/getLBTCStats',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [wagmiDecorator, functionType('api-get')],
-  argTypes: { ...envSelector },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    env: DEFAULT_ENV,
-  },
-};
-
-type SignNetworkFeeProps = Parameters<typeof getLBTCStats>[0];
-
-export function StoryView(props: SignNetworkFeeProps) {
-  const request = async () => {
-    return getLBTCStats({
-      ...props,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <p>This function returns the total supply of the LBTC.</p>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getLBTCStats.name}
-      />
-
-      <ErrorBlock>{error}</ErrorBlock>
-
-      <CodeBlock text={data} />
-    </>
-  );
-}

package/src/metrics/get-lbtc-stats.ts

@@ -1,59 +0,0 @@
-import axios from 'axios';
-import BigNumber from 'bignumber.js';
-
-import { getApiConfig } from '../common/api-config';
-import { IEnvParam } from '../common/parameters';
-
-type LBTCStatsResponse = { price: number; supply: number; tvl: number }[];
-
-type LBTCHoldersResponse = number;
-
-type Stats = {
-  /** The BTC price  */
-  price: BigNumber;
-  /** The LBTC supply */
-  supply: BigNumber;
-  /** The LBTC TVL (supply * price) */
-  tvl: BigNumber;
-  /** The number of LBTC holders */
-  holders: BigNumber;
-  /** The total (historical) number of LBTC holders */
-  historicalHolders: BigNumber;
-};
-
-/** Gets the Lombard's TVL. */
-export async function getLBTCStats(
-  parameters?: { partnerId?: string; accountAddress?: string } & IEnvParam,
-) {
-  const env = parameters?.env;
-  const partnerId = parameters?.partnerId;
-
-  const { bffApiUrl } = getApiConfig(env);
-  if (!bffApiUrl) {
-    throw new Error(
-      `Could not determine API endpoint for provided environment: ${env}`,
-    );
-  }
-
-  const { data } = await axios.get<LBTCStatsResponse>(
-    `${bffApiUrl}/dune-api/query/getLBTCStats?partnerId=${partnerId || ''}`,
-  );
-
-  const { data: holders } = await axios.get<LBTCHoldersResponse>(
-    `${bffApiUrl}/dune-api/query/lbtc-holders?partnerId=${partnerId || ''}`,
-  );
-
-  const { data: historicalHolders } = await axios.get<LBTCHoldersResponse>(
-    `${bffApiUrl}/dune-api/query/getTotalLBTCUsers?partnerId=${partnerId || ''}`,
-  );
-
-  const stats: Stats = {
-    price: BigNumber(data[0].price),
-    supply: BigNumber(data[0].supply),
-    tvl: BigNumber(data[0].tvl),
-    holders: BigNumber(holders),
-    historicalHolders: BigNumber(historicalHolders),
-  };
-
-  return stats;
-}

package/src/metrics/get-positions-summary.stories.tsx

@@ -1,57 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-import { envSelector } from '../stories/arg-types';
-import { Button } from '../stories/components/Button';
-import { CodeBlock } from '../stories/components/CodeBlock';
-import { functionType, wagmiDecorator } from '../stories/components/decorators';
-import { ErrorBlock } from '../stories/components/error-block';
-import { EXAMPLE_EVM_ADDRESS } from '../stories/constants';
-import useQuery from '../stories/hooks/useQuery';
-import { getPositionsSummary } from './get-positions-summary';
-
-const meta = {
-  title: 'metrics/getPositionsSummary',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [wagmiDecorator, functionType('api-get')],
-  argTypes: { ...envSelector },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: { account: EXAMPLE_EVM_ADDRESS, env: Env.stage },
-};
-
-type SignNetworkFeeProps = Parameters<typeof getPositionsSummary>[0];
-
-export function StoryView(props: SignNetworkFeeProps) {
-  const request = async () => {
-    return getPositionsSummary({
-      ...props,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <p>
-        This function returns the rewards info for provided account address.
-      </p>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getPositionsSummary.name}
-      />
-
-      <ErrorBlock>{error}</ErrorBlock>
-
-      <CodeBlock text={data} />
-    </>
-  );
-}