@lombard.finance/sdk 2.5.2 → 3.2.0

package/src/bridge/lib/config.ts

@@ -0,0 +1,338 @@
+import { Abi } from 'viem';
+import { ChainId } from '../../common/chains';
+import CCIP_BRIDGE_ADAPTER_ABI from '../abi/CCIP_BRIDGE_ADAPTER_ABI.json';
+import OFT_BRIDGE_ADAPTER_ABI from '../abi/OFT_BRIDGE_ADAPTER_ABI.json';
+import { ContractInfo } from '../../common/contract-info';
+import BigNumber from 'bignumber.js';
+import { unique } from '../../utils/array';
+
+export const MIN_BRIDGE_AMOUNT = BigNumber(0.000001);
+
+export enum BridgeType {
+  /** CCIP - (Chainlink) Cross-Chain Interoperability Protocol */
+  CCIP = 'CCIP',
+
+  /** OFT - (LayerZero) Omnichain Fungible Token */
+  OFT = 'OFT',
+}
+
+export const BRIDGE_EXPLORER_URL_MAP = {
+  [BridgeType.CCIP]: 'https://ccip.chain.link/tx/{txHash}',
+  [BridgeType.OFT]: 'https://layerzeroscan.com/tx/{txHash}',
+};
+
+export const CCIP_BRIDGE_CHAINS = [
+  // Mainnets:
+  ChainId.ethereum,
+  ChainId.base,
+  ChainId.binanceSmartChain,
+  // Testnets:
+  ChainId.baseSepoliaTestnet,
+  ChainId.holesky,
+];
+export type CCIPBridgeChain = (typeof CCIP_BRIDGE_CHAINS)[number];
+
+export const OFT_BRIDGE_CHAINS = [
+  // Mainnets:
+  ChainId.ethereum,
+  ChainId.berachain,
+  ChainId.corn,
+  ChainId.etherlink,
+  ChainId.sonic,
+  ChainId.swell,
+  // Testnets:
+  ChainId.berachainBartioTestnet,
+  ChainId.sepolia,
+];
+
+export const BRIDGE_CHAINS = unique([
+  ...CCIP_BRIDGE_CHAINS,
+  ...OFT_BRIDGE_CHAINS,
+]);
+export type BridgeChain = CCIPBridgeChain | OFTBridgeChain;
+
+export const OFT_GAS_LIMIT = 90_000;
+export const OFT_HI_GAS_LIMIT = 200_000;
+export const OFT_HI_GAS_LIMIT_CHAINS = [
+  // Mainnets:
+  ChainId.berachain,
+  ChainId.sonic,
+  // Testnets:
+  ChainId.berachainBartioTestnet,
+];
+
+export type OFTBridgeChain = (typeof OFT_BRIDGE_CHAINS)[number];
+
+type BridgeIdentifier<Ch extends CCIPBridgeChain | OFTBridgeChain> =
+  `[from:${Ch}, to: ${Ch}]`;
+
+const bridgeIdentifier = <Ch extends CCIPBridgeChain | OFTBridgeChain>([
+  from,
+  to,
+]: [from: Ch, to: Ch]): BridgeIdentifier<Ch> => `[from:${from}, to: ${to}]`;
+
+type BridgeInfo = { type: BridgeType; contract: ContractInfo };
+
+type CCIPBridgesConfig = [
+  BridgeIdentifier<CCIPBridgeChain>,
+  { type: BridgeType.CCIP; contract: ContractInfo },
+];
+
+const CCIP_BRIDGES: CCIPBridgesConfig[] = [
+  // Mainnets:
+
+  [
+    bridgeIdentifier([ChainId.ethereum, ChainId.base]),
+    {
+      type: BridgeType.CCIP,
+      contract: {
+        address: '0xa869817b48b25eee986bdf4be04062e6fd2c418b',
+        abi: CCIP_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.ethereum,
+      },
+    },
+  ],
+  [
+    bridgeIdentifier([ChainId.ethereum, ChainId.binanceSmartChain]),
+    {
+      type: BridgeType.CCIP,
+      contract: {
+        address: '0xa869817b48b25eee986bdf4be04062e6fd2c418b',
+        abi: CCIP_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.ethereum,
+      },
+    },
+  ],
+
+  [
+    bridgeIdentifier([ChainId.base, ChainId.ethereum]),
+    {
+      type: BridgeType.CCIP,
+      contract: {
+        address: '0xa869817b48b25eee986bdf4be04062e6fd2c418b',
+        abi: CCIP_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.base,
+      },
+    },
+  ],
+  [
+    bridgeIdentifier([ChainId.base, ChainId.binanceSmartChain]),
+    {
+      type: BridgeType.CCIP,
+      contract: {
+        address: '0xa869817b48b25eee986bdf4be04062e6fd2c418b',
+        abi: CCIP_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.base,
+      },
+    },
+  ],
+
+  [
+    bridgeIdentifier([ChainId.binanceSmartChain, ChainId.ethereum]),
+    {
+      type: BridgeType.CCIP,
+      contract: {
+        address: '0xa869817b48b25eee986bdf4be04062e6fd2c418b',
+        abi: CCIP_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.binanceSmartChain,
+      },
+    },
+  ],
+  [
+    bridgeIdentifier([ChainId.binanceSmartChain, ChainId.base]),
+    {
+      type: BridgeType.CCIP,
+      contract: {
+        address: '0xa869817b48b25eee986bdf4be04062e6fd2c418b',
+        abi: CCIP_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.binanceSmartChain,
+      },
+    },
+  ],
+
+  // Testnets:
+
+  [
+    bridgeIdentifier([ChainId.baseSepoliaTestnet, ChainId.holesky]),
+    {
+      type: BridgeType.CCIP,
+      contract: {
+        address: '0x38247C4c846D549CAAd2C6c0b6fec0c402b77a0F',
+        abi: CCIP_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.baseSepoliaTestnet,
+      },
+    },
+  ],
+
+  [
+    bridgeIdentifier([ChainId.holesky, ChainId.baseSepoliaTestnet]),
+    {
+      type: BridgeType.CCIP,
+      contract: {
+        address: '0x38247C4c846D549CAAd2C6c0b6fec0c402b77a0F',
+        abi: CCIP_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.holesky,
+      },
+    },
+  ],
+];
+
+type OFTBridgeConfig = [
+  BridgeIdentifier<OFTBridgeChain>,
+  { type: BridgeType.OFT; contract: ContractInfo },
+];
+const OFT_BRIDGES: OFTBridgeConfig[] = [
+  // Mainnets:
+
+  [
+    bridgeIdentifier([ChainId.ethereum, ChainId.berachain]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0x1290A6b480f7eF14925229fdB66f5680aD8F44AD',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.ethereum,
+      },
+    },
+  ],
+  [
+    bridgeIdentifier([ChainId.ethereum, ChainId.corn]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0x6bc15d7930839ec18a57f6f7df72ae1b439d077f',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.ethereum,
+      },
+    },
+  ],
+  [
+    bridgeIdentifier([ChainId.ethereum, ChainId.etherlink]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0x3a7647c1323144a16e7D0D71A581E3FE5BD95299',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.ethereum,
+      },
+    },
+  ],
+  [
+    bridgeIdentifier([ChainId.ethereum, ChainId.sonic]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0xcFEAc622BC6464acC759ACd9741a6D78F8b0d3Cd',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.ethereum,
+      },
+    },
+  ],
+  [
+    bridgeIdentifier([ChainId.ethereum, ChainId.swell]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0x37E92d760a15231e652a2C502182a6b44c7510c0',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.ethereum,
+      },
+    },
+  ],
+
+  [
+    bridgeIdentifier([ChainId.berachain, ChainId.ethereum]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0x630e12D53D4E041b8C5451aD035Ea841E08391d7',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.berachain,
+      },
+    },
+  ],
+
+  [
+    bridgeIdentifier([ChainId.corn, ChainId.ethereum]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0xfc7B20D9B59A8A466f4fC3d34aA69a7D98e71d7A',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.corn,
+      },
+    },
+  ],
+
+  [
+    bridgeIdentifier([ChainId.etherlink, ChainId.ethereum]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0xC832183d4d5fc5831daaC892a93dBBfd798034E3',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.etherlink,
+      },
+    },
+  ],
+
+  [
+    bridgeIdentifier([ChainId.sonic, ChainId.ethereum]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0x630e12D53D4E041b8C5451aD035Ea841E08391d7',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.sonic,
+      },
+    },
+  ],
+
+  [
+    bridgeIdentifier([ChainId.swell, ChainId.ethereum]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0x7B3784AD646C10A8Ddf42b47a4f4bd9aFD351E54',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.swell,
+      },
+    },
+  ],
+
+  // Testnets:
+
+  [
+    bridgeIdentifier([ChainId.berachainBartioTestnet, ChainId.sepolia]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0x1977013acaf27856ac8048C42EE2ed0134d53895',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.berachainBartioTestnet,
+      },
+    },
+  ],
+
+  [
+    bridgeIdentifier([ChainId.sepolia, ChainId.berachainBartioTestnet]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0xe3748bF0Ec0A76767539eE28610B3367e35fe2C2',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.sepolia,
+      },
+    },
+  ],
+];
+
+export const BRIDGES = new Map<BridgeIdentifier<BridgeChain>, BridgeInfo>([
+  ...CCIP_BRIDGES,
+  ...OFT_BRIDGES,
+]);
+
+/** Gets the bridge information */
+export const getBridgeInfo = (from: BridgeChain, to: BridgeChain) => {
+  return BRIDGES.get(bridgeIdentifier([from, to]));
+};

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

@@ -0,0 +1,89 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { Button } from '../../stories/components/Button';
+import { CodeBlock } from '../../stories/components/CodeBlock';
+import {
+  canPerformAction,
+  useConnection,
+} from '../../stories/hooks/useConnection';
+import useQuery from '../../stories/hooks/useQuery';
+import { ConnectButton } from '../../stories/components/ConnectButton';
+import {
+  functionType,
+  wagmiDecorator,
+} from '../../stories/components/decorators';
+import { ErrorBlock } from '../../stories/components/error-block';
+import { ChainId } from '../../common/chains';
+import { OFT_BRIDGE_CHAINS } from './config';
+import { bridgeOFT, BridgeOFTParameters } from './oft-bridge';
+
+const meta = {
+  title: 'bridge/bridgeOFT',
+  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: OFT_BRIDGE_CHAINS.map(
+        ch => Object.entries(ChainId).find(([k, v]) => v === ch)?.[0],
+      ),
+      control: { type: 'select' },
+    },
+  },
+};
+
+type Props = Omit<BridgeOFTParameters, 'account' | 'chainId' | 'provider'>;
+
+export function StoryView(props: Props) {
+  const connection = useConnection();
+
+  const request = async () => {
+    if (!canPerformAction(connection)) {
+      return;
+    }
+
+    return bridgeOFT({
+      ...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={bridgeOFT.name}
+      />
+
+      <ErrorBlock>{error}</ErrorBlock>
+
+      <CodeBlock text={data} />
+    </>
+  );
+}

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

@@ -0,0 +1,212 @@
+import BigNumber from 'bignumber.js';
+import { CommonWriteParameters } from '../../common/parameters';
+import {
+  BridgeType,
+  getBridgeInfo,
+  MIN_BRIDGE_AMOUNT,
+  OFT_BRIDGE_CHAINS,
+  OFT_GAS_LIMIT,
+  OFT_HI_GAS_LIMIT,
+  OFT_HI_GAS_LIMIT_CHAINS,
+  OFTBridgeChain,
+} from './config';
+import { makePublicClient } from '../../clients/public-client';
+import { makeWalletClient } from '../../clients/wallet-client';
+import {
+  fromBaseDenomination,
+  getTokenInfo,
+  toBaseDenomination,
+} from '../../tokens/tokens';
+import { getErrorMessage } from '../../utils/err';
+import toBigInt from '../../utils/numbers';
+import { Address, numberToHex, pad, parseEther, toBytes, toHex } from 'viem';
+import { approveLBTC } from '../../contract-functions';
+import { ChainId } from '../../common/chains';
+import { Options } from '@layerzerolabs/lz-v2-utilities';
+import { Token } from '../../tokens/token-addresses';
+
+const DESTINATION_ENDPOINT_ID_MAP: Record<OFTBridgeChain, number> = {
+  // Mainnets:
+  [ChainId.ethereum]: 30101,
+  [ChainId.berachain]: 30362,
+  [ChainId.corn]: 30331,
+  [ChainId.etherlink]: 30292,
+  [ChainId.sonic]: 30332,
+  [ChainId.swell]: 30335,
+  // Testnets:
+  [ChainId.sepolia]: 40161,
+  [ChainId.berachainBartioTestnet]: 40291,
+};
+
+export type BridgeOFTParameters = {
+  /** The destination chain id. */
+  to: OFTBridgeChain;
+  /** 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;
+export async function bridgeOFT({
+  to,
+  amount: amountRaw,
+  approve,
+  recipient: optionalRecipient,
+  account,
+  chainId: from,
+  provider,
+  env,
+  rpcUrl,
+}: BridgeOFTParameters) {
+  const amount = BigNumber(amountRaw);
+  const recipient = optionalRecipient || account;
+
+  const bridgeInfo = getBridgeInfo(from as OFTBridgeChain, to);
+  if (!bridgeInfo || bridgeInfo.type !== BridgeType.OFT) {
+    throw new Error(
+      `Unsupported bridge from ${from} to ${to}. Please switch to the supported chains: ${OFT_BRIDGE_CHAINS.join(', ')}`,
+    );
+  }
+
+  const bridgeContract = bridgeInfo.contract;
+
+  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, bridgeContract.address],
+  });
+  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
+    console.info(exceededMessage);
+    try {
+      const txHash = await approveLBTC({
+        account,
+        spender: bridgeContract.address,
+        amount,
+        chainId: from,
+        provider,
+        rpcUrl,
+        env,
+      });
+      console.info(`Approve tx hash: ${txHash}`);
+      console.info(`Approved ${amountBase} for ${bridgeContract.address}`);
+    } catch (err) {
+      const msg = getErrorMessage(err);
+      throw new Error(
+        `Could not approve ${amountBase} for ${bridgeContract.address}. \nReason: ${msg}`,
+      );
+    }
+  }
+
+  const extraOptions = Options.newOptions().addExecutorLzReceiveOption(
+    (OFT_HI_GAS_LIMIT_CHAINS as number[]).includes(to)
+      ? OFT_HI_GAS_LIMIT
+      : OFT_GAS_LIMIT,
+    0,
+  );
+
+  /** _sendParam */
+  const sendParam = [
+    /** dstEid - uint32 */
+    DESTINATION_ENDPOINT_ID_MAP[to],
+    /** to - bytes32 */
+    pad(recipient),
+    /** amountLD - uint256 */
+    amountBase,
+    /** minAmountLD - uint256 */
+    amountBase,
+    /** extraOptions - bytes */
+    extraOptions.toHex(),
+    /** composeMsg - bytes */
+    '0x',
+    /** oftCmd - bytes */
+    '0x',
+  ];
+
+  const { nativeFee, lzTokenFee } = (await publicClient.readContract({
+    abi: bridgeContract.abi,
+    address: bridgeContract.address,
+    account,
+    functionName: 'quoteSend',
+    args: [sendParam, false],
+  })) as { nativeFee: bigint; lzTokenFee: bigint };
+
+  const bridgeArgs = [
+    /** _sendParam */
+    sendParam,
+    /** _fee */
+    [
+      /** nativeFee - uint256 */
+      nativeFee,
+      /** lzTokenFee - uint256 */
+      lzTokenFee,
+    ],
+    /** address - address */
+    account,
+  ];
+
+  const { request } = await publicClient.simulateContract({
+    abi: bridgeContract.abi,
+    address: bridgeContract.address,
+    account,
+    functionName: 'send',
+    args: bridgeArgs,
+    value: nativeFee,
+  });
+
+  const txHash = await walletClient.writeContract(request);
+  return txHash;
+}

package/src/clients/public-client.ts

@@ -0,0 +1,32 @@
+import { rpcUrlConfig } from './rpc-url-config';
+import { CHAIN_ID_TO_VIEM_CHAIN_MAP, ChainId } from '../common/chains';
+import { createPublicClient, http, PublicClient } from 'viem';
+
+type MakePublicClientParameters = {
+  chainId: ChainId;
+  rpcUrl?: string;
+};
+
+/**
+ * Creates the public (read-only) client for specified `chainId`.
+ * @param chainId - The chain id
+ * @param rpcUrl - The overridden RPC url for specified chain id.
+ * @returns The public client instance
+ */
+export function makePublicClient({
+  chainId,
+  rpcUrl,
+}: MakePublicClientParameters): PublicClient {
+  const override = rpcUrl ? { [chainId]: rpcUrl } : undefined;
+  const rpcUrls = { ...rpcUrlConfig, ...override };
+
+  const chain = CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId];
+  const transport = http(rpcUrls[chainId]);
+
+  const publicClient = createPublicClient({
+    chain,
+    transport,
+  });
+
+  return publicClient as PublicClient<typeof transport>;
+}

package/src/clients/rpc-url-config.ts

@@ -0,0 +1,20 @@
+import { ChainId } from '../common/chains';
+
+export type TRpcUrlConfig = Record<number, string>;
+
+export const RPC_URL = 'https://bff.prod.lombard.finance/multi-rpc/proxy';
+
+export const rpcUrlConfig: TRpcUrlConfig = {
+  [ChainId.ethereum]: `${RPC_URL}/eth`,
+  [ChainId.base]: `${RPC_URL}/base`,
+  [ChainId.binanceSmartChain]: 'https://bsc-dataseed.bnbchain.org',
+  [ChainId.corn]: `${RPC_URL}/corn_maizenet`,
+  [ChainId.sonic]: `${RPC_URL}/sonic_mainnet`,
+  // Testnets:
+  [ChainId.baseSepoliaTestnet]: `${RPC_URL}/base_sepolia`,
+  [ChainId.binanceSmartChainTestnet]:
+    'https://bsc-testnet-dataseed.bnbchain.org',
+  [ChainId.holesky]: `${RPC_URL}/eth_holesky`,
+  [ChainId.sepolia]: `${RPC_URL}/eth_sepolia`,
+  [ChainId.sonicBlazeTestnet]: `${RPC_URL}/sonic_blaze_testnet`,
+};