@lombard.finance/sdk 4.0.0 → 4.1.0

package/src/bridge/index.ts

@@ -1,16 +0,0 @@
-/** Generic bridge func */
-export { bridge, type BridgeParameters } from './lib/bridge';
-
-/** CCIP bridge func */
-export { bridgeCCIP, type BridgeCCIPParameters } from './lib/ccip-bridge';
-
-/** OFT bridge func */
-export { bridgeOFT, type BridgeOFTParameters } from './lib/oft-bridge';
-
-/** Utils */
-export {
-  getBridgeInfo,
-  OFT_GAS_LIMIT,
-  OFT_HI_GAS_LIMIT,
-  OFT_HI_GAS_LIMIT_CHAINS,
-} from './lib/config';

package/src/bridge/lib/bridge.stories.tsx

@@ -1,90 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../../common/chains';
-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 { ErrorBlock } from '../../stories/components/error-block';
-import {
-  canPerformAction,
-  useConnection,
-} from '../../stories/hooks/useConnection';
-import useQuery from '../../stories/hooks/useQuery';
-import { bridge,BridgeParameters } from './bridge';
-import { BRIDGE_CHAINS } from './config';
-
-const meta = {
-  title: 'bridge/bridge',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [wagmiDecorator, functionType('write')],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    to: ChainId.sonic,
-    amount: '0.0001',
-    approve: true,
-    env: 'prod',
-  },
-  argTypes: {
-    to: {
-      mapping: ChainId,
-      options: BRIDGE_CHAINS.map(
-        ch => Object.entries(ChainId).find(([_k, v]) => v === ch)?.[0],
-      ),
-      control: { type: 'select' },
-    },
-  },
-};
-
-type Props = Omit<BridgeParameters, 'account' | 'chainId' | 'provider'>;
-
-export function StoryView(props: Props) {
-  const connection = useConnection();
-
-  const request = async () => {
-    if (!canPerformAction(connection)) {
-      return;
-    }
-
-    return bridge({
-      ...props,
-
-      account: connection.account.address,
-      chainId: connection.account.chainId,
-      provider: connection.provider,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <p>This method bridges funds between chains.</p>
-
-      <div className="mb-4">
-        <ConnectButton />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !canPerformAction(connection)}
-        isLoading={isLoading}
-        actionName={bridge.name}
-      />
-
-      <ErrorBlock>{error}</ErrorBlock>
-
-      <CodeBlock text={data} />
-    </>
-  );
-}

package/src/bridge/lib/bridge.ts

@@ -1,115 +0,0 @@
-import BigNumber from 'bignumber.js';
-import { Address } from 'viem';
-
-import { CommonWriteParameters } from '../../common/parameters';
-import { bridgeCCIP } from './ccip-bridge';
-import {
-  BRIDGE_EXPLORER_URL_MAP,
-  BridgeChain,
-  BridgeType,
-  CCIP_BRIDGE_CHAINS,
-  CCIPBridgeChain,
-  getBridgeInfo,
-  OFTBridgeChain,
-} from './config';
-import { bridgeOFT } from './oft-bridge';
-
-export type BridgeParameters = {
-  /** The destination chain id. */
-  to: BridgeChain;
-  /** The LBTC amount. */
-  amount: BigNumber.Value;
-  /**
-   * A flag determining whether the amount should be approved within
-   * the execution of this function. If set to `false` it will
-   * throw an error when the deposit amount exceeds allowance.
-   */
-  approve?: boolean;
-  /** The destination address. If omitted the same as the account address. */
-  recipient?: Address;
-} & CommonWriteParameters & {
-    /**
-     * A flag indicating whether the OFT bridge should be allowed.
-     * Use at your onw risk!
-     */
-    experimentalAllowOFT?: boolean;
-  };
-
-/**
- * Bridges funds (`amount`) from the connected chain (`chainId`) to the provided
- * destination chain (`to`)
- */
-export async function bridge({
-  to,
-  amount,
-  approve,
-  account,
-  chainId,
-  provider,
-  recipient,
-  rpcUrl,
-  env,
-  experimentalAllowOFT = false,
-}: BridgeParameters) {
-  const bridgeInfo = getBridgeInfo(chainId as BridgeChain, to);
-
-  if (
-    !bridgeInfo ||
-    (!experimentalAllowOFT && bridgeInfo.type === BridgeType.OFT)
-  ) {
-    // The OFT bridges are disabled for now in this generic function as we're
-    // working on moving all bridges to the CCIP method. OFT bridging shouldn't
-    // be exposed.
-    throw new Error(
-      `Unsupported bridge from ${chainId} to ${to}. Please switch to the supported chains: ${CCIP_BRIDGE_CHAINS.join(', ')}`,
-    );
-  }
-
-  switch (bridgeInfo.type) {
-    case BridgeType.CCIP: {
-      const txHash = await bridgeCCIP({
-        to: to as CCIPBridgeChain,
-        amount,
-        approve,
-        recipient,
-        account,
-        chainId,
-        provider,
-        env,
-        rpcUrl,
-      });
-
-      return {
-        txHash,
-        explorerUrl: BRIDGE_EXPLORER_URL_MAP[BridgeType.CCIP].replace(
-          '{txHash}',
-          txHash,
-        ),
-        type: BridgeType.CCIP,
-      };
-    }
-
-    case BridgeType.OFT: {
-      const txHash = await bridgeOFT({
-        to: to as OFTBridgeChain,
-        amount,
-        approve,
-        recipient,
-        account,
-        chainId,
-        provider,
-        env,
-        rpcUrl,
-      });
-
-      return {
-        txHash,
-        explorerUrl: BRIDGE_EXPLORER_URL_MAP[BridgeType.OFT].replace(
-          '{txHash}',
-          txHash,
-        ),
-        type: BridgeType.OFT,
-      };
-    }
-  }
-}

package/src/bridge/lib/ccip-bridge.stories.tsx

@@ -1,91 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../../common/chains';
-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 { ErrorBlock } from '../../stories/components/error-block';
-import {
-  canPerformAction,
-  useConnection,
-} from '../../stories/hooks/useConnection';
-import useQuery from '../../stories/hooks/useQuery';
-import { bridgeCCIP,BridgeCCIPParameters } from './ccip-bridge';
-import { CCIP_BRIDGE_CHAINS } from './config';
-
-const meta = {
-  title: 'bridge/bridgeCCIP',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [wagmiDecorator, functionType('write')],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    to: ChainId.holesky,
-    amount: '0.0001',
-    approve: true,
-    env: 'stage',
-  },
-  argTypes: {
-    to: {
-      mapping: ChainId,
-      options: CCIP_BRIDGE_CHAINS.map(
-        ch => Object.entries(ChainId).find(([_k, v]) => v === ch)?.[0],
-      ),
-      defaultValue: 'holesky',
-      control: { type: 'select' },
-    },
-  },
-};
-
-type Props = Omit<BridgeCCIPParameters, 'account' | 'chainId' | 'provider'>;
-
-export function StoryView(props: Props) {
-  const connection = useConnection();
-
-  const request = async () => {
-    if (!canPerformAction(connection)) {
-      return;
-    }
-
-    return bridgeCCIP({
-      ...props,
-
-      account: connection.account.address,
-      chainId: connection.account.chainId,
-      provider: connection.provider,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <p>This method bridges funds between chains.</p>
-
-      <div className="mb-4">
-        <ConnectButton />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !canPerformAction(connection)}
-        isLoading={isLoading}
-        actionName={bridgeCCIP.name}
-      />
-
-      <ErrorBlock>{error}</ErrorBlock>
-
-      <CodeBlock text={data} />
-    </>
-  );
-}

package/src/bridge/lib/ccip-bridge.ts

@@ -1,214 +0,0 @@
-import BigNumber from 'bignumber.js';
-import {
-  Address,
-  encodeAbiParameters,
-  encodePacked,
-  parseAbiParameters,
-} from 'viem';
-
-import { makePublicClient } from '../../clients/public-client';
-import { makeWalletClient } from '../../clients/wallet-client';
-import { CommonWriteParameters } from '../../common/parameters';
-import { approveLBTC } from '../../contract-functions';
-import { Token } from '../../tokens/token-addresses';
-import {
-  fromBaseDenomination,
-  getTokenInfo,
-  toBaseDenomination,
-} from '../../tokens/tokens';
-import { getErrorMessage } from '../../utils/err';
-import toBigInt from '../../utils/numbers';
-import CCIP_ROUTER_ABI from '../abi/CCIP_ROUTER_ABI.json';
-import { getCCIPConfig } from './ccip-config';
-import {
-  BridgeType,
-  CCIP_BRIDGE_CHAINS,
-  CCIPBridgeChain,
-  getBridgeInfo,
-  MIN_BRIDGE_AMOUNT,
-} from './config';
-
-export type BridgeCCIPParameters = {
-  /** The destination chain id. */
-  to: CCIPBridgeChain;
-  /** The LBTC amount. */
-  amount: BigNumber.Value;
-  /**
-   * A flag determining whether the amount should be approved within
-   * the execution of this function. If set to `false` it will
-   * throw an error when the deposit amount exceeds allowance.
-   */
-  approve?: boolean;
-  /** The destination address. If omitted the same as the account address. */
-  recipient?: Address;
-} & CommonWriteParameters;
-
-/**
- * Encodes extraArgs for CCIP according to version 1
- * Format: EVMExtraArgsV1 { gasLimit: uint256 }
- *
- * @see https://github.com/smartcontractkit/smart-contract-examples/blob/main/ccip/offchain/javascript/src/transfer-tokens.js
- */
-function encodeExtraArgs(gasLimit: bigint): `0x${string}` {
-  // Tag for EVMExtraArgsV1
-  const tag = '0x97a657c9';
-
-  // Encode gasLimit as uint256
-  const encodedGasLimit = encodePacked(['uint256'], [gasLimit]);
-
-  return `${tag}${encodedGasLimit.slice(2)}` as `0x${string}`;
-}
-
-/**
- * Transfers tokens via CCIP using direct Router contract calls
- * Based on Chainlink example:
- * @see https://github.com/smartcontractkit/smart-contract-examples/blob/main/ccip/offchain/javascript/src/transfer-tokens.js
- */
-export async function bridgeCCIP({
-  to,
-  amount: amountRaw,
-  approve,
-  recipient: optionalRecipient,
-  account,
-  chainId: from,
-  provider,
-  env,
-  rpcUrl,
-}: BridgeCCIPParameters) {
-  const amount = BigNumber(amountRaw);
-  const recipient = optionalRecipient || account;
-
-  const bridgeInfo = getBridgeInfo(from as CCIPBridgeChain, to);
-  if (!bridgeInfo || bridgeInfo.type !== BridgeType.CCIP) {
-    throw new Error(
-      `Unsupported bridge from ${from} to ${to}. Please switch to the supported chains: ${CCIP_BRIDGE_CHAINS.join(', ')}`,
-    );
-  }
-
-  // Get CCIP Router configuration
-  const sourceChainConfig = getCCIPConfig(from);
-  const destinationChainConfig = getCCIPConfig(to);
-
-  if (!sourceChainConfig || !destinationChainConfig) {
-    throw new Error(`CCIP configuration not found for chains ${from} -> ${to}`);
-  }
-
-  const routerAddress = sourceChainConfig.routerAddress;
-
-  const lbtcContract = await getTokenInfo(Token.LBTC, from, env, rpcUrl);
-  if (!lbtcContract) {
-    throw new Error('Could not retrieve LBTC contract info.');
-  }
-
-  const publicClient = makePublicClient({ chainId: from, rpcUrl });
-  const walletClient = makeWalletClient({ provider, chainId: from });
-
-  const amountBase = toBigInt(
-    toBaseDenomination(amount, lbtcContract.decimals),
-  );
-
-  if (amount.isLessThan(MIN_BRIDGE_AMOUNT)) {
-    throw new Error(
-      `The amount is smaller than the minimum amount allowed: ${MIN_BRIDGE_AMOUNT.toFixed()}`,
-    );
-  }
-
-  const balanceRaw = await publicClient.readContract({
-    address: lbtcContract.address,
-    abi: lbtcContract.abi,
-    functionName: 'balanceOf',
-    args: [account],
-  });
-  const balance = fromBaseDenomination(
-    String(balanceRaw),
-    lbtcContract.decimals,
-  );
-
-  // check if amount exceeds balance
-  if (amount.isGreaterThan(balance)) {
-    throw new Error(
-      `The amount exceeds the account's balance. \nAmount: ${amount.toFixed()} \nBalance: ${balance.toFixed()}`,
-    );
-  }
-
-  const allowanceRaw = await publicClient.readContract({
-    address: lbtcContract.address,
-    abi: lbtcContract.abi,
-    functionName: 'allowance',
-    args: [account, routerAddress],
-  });
-  const allowance = fromBaseDenomination(
-    String(allowanceRaw),
-    lbtcContract.decimals,
-  );
-
-  // check if amount exceeds allowance
-  if (amount.isGreaterThan(allowance)) {
-    const exceededMessage = `The amount exceeds allowance. \nAmount: ${amount.toFixed()} \nAllowance: ${allowance.toFixed()}`;
-    if (!approve) {
-      throw new Error(exceededMessage);
-    }
-
-    // try to approve new amount for Router
-    console.info(exceededMessage);
-    try {
-      const txHash = await approveLBTC({
-        account,
-        spender: routerAddress,
-        amount,
-        chainId: from,
-        provider,
-        rpcUrl,
-        env,
-      });
-      console.info(`Approve tx hash: ${txHash}`);
-      console.info(`Approved ${amountBase} for ${routerAddress}`);
-    } catch (err) {
-      const msg = getErrorMessage(err);
-      throw new Error(
-        `Could not approve ${amountBase} for ${routerAddress}. \nReason: ${msg}`,
-      );
-    }
-  }
-
-  // Build CCIP message (EVM2AnyMessage)
-  // IMPORTANT: receiver must be abi.encode(address) for EVM chains, not encodePacked
-  const receiverBytes = encodeAbiParameters(parseAbiParameters('address'), [
-    recipient,
-  ]);
-  const extraArgs = encodeExtraArgs(0n);
-
-  const message = {
-    receiver: receiverBytes,
-    data: '0x' as `0x${string}`,
-    tokenAmounts: [
-      {
-        token: lbtcContract.address,
-        amount: amountBase,
-      },
-    ],
-    feeToken: '0x0000000000000000000000000000000000000000' as Address, // address(0) means payment in native currency
-    extraArgs, // 0 = automatic gas limit calculation
-  };
-
-  // Get fee for sending the message
-  const fee = (await publicClient.readContract({
-    address: routerAddress,
-    abi: CCIP_ROUTER_ABI,
-    functionName: 'getFee',
-    args: [BigInt(destinationChainConfig.chainSelector), message],
-  })) as bigint;
-
-  // Send CCIP message
-  const { request } = await publicClient.simulateContract({
-    address: routerAddress,
-    abi: CCIP_ROUTER_ABI,
-    account,
-    functionName: 'ccipSend',
-    args: [BigInt(destinationChainConfig.chainSelector), message],
-    value: fee,
-  });
-
-  const txHash = await walletClient.writeContract(request);
-  return txHash;
-}

package/src/bridge/lib/ccip-config.ts

@@ -1,54 +0,0 @@
-import { Address } from 'viem';
-
-import { ChainId } from '../../common/chains';
-
-export type CCIPChainConfig = {
-  routerAddress: Address;
-  chainSelector: string;
-};
-
-type CCIPConfig = Record<number, CCIPChainConfig>;
-
-export const CCIP_CONFIG: CCIPConfig = {
-  [ChainId.ethereum]: {
-    routerAddress: '0x80226fc0Ee2b096224EeAc085Bb9a8cba1146f7D',
-    chainSelector: '5009297550715157269',
-  },
-  [ChainId.base]: {
-    routerAddress: '0x881e3A65B4d4a04dD529061dd0071cf975F58bCD',
-    chainSelector: '15971525489660198786',
-  },
-  [ChainId.binanceSmartChain]: {
-    routerAddress: '0x34B03Cb9086d7D758AC55af71584F81A598759FE',
-    chainSelector: '11344663589394136015',
-  },
-  [ChainId.sonic]: {
-    routerAddress: '0xB4e1Ff7882474BB93042be9AD5E1fA387949B860',
-    chainSelector: '1673871237479749969',
-  },
-  [ChainId.katana]: {
-    routerAddress: '0x7c19b79D2a054114Ab36ad758A36e92376e267DA',
-    chainSelector: '2459028469735686113',
-  },
-  // Testnets
-  [ChainId.holesky]: {
-    routerAddress: '0xb9531b46fE8808fB3659e39704953c2B1112DD43',
-    chainSelector: '7717148896336251131',
-  },
-  [ChainId.baseSepoliaTestnet]: {
-    routerAddress: '0xD3b06cEbF099CE7DA4AcCf578aaebFDBd6e88a93',
-    chainSelector: '10344971235874465080',
-  },
-  [ChainId.binanceSmartChainTestnet]: {
-    routerAddress: '0xE1053aE1857476f36A3C62580FF9b016E8EE8F6f',
-    chainSelector: '13264668187771770619',
-  },
-  [ChainId.katanaTatara]: {
-    routerAddress: '0x1dF1fe714A376f248d51AAB826C3feeC379e80fC',
-    chainSelector: '9090863410735740267',
-  },
-};
-
-export function getCCIPConfig(chainId: ChainId): CCIPChainConfig | undefined {
-  return CCIP_CONFIG[chainId];
-}