@lombard.finance/sdk 3.1.0 → 3.2.0

package/src/bridge/index.ts

@@ -0,0 +1,11 @@
+/** 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 } from './lib/config';

package/src/bridge/lib/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 { BRIDGE_CHAINS, OFT_BRIDGE_CHAINS } from './config';
+import { bridge, BridgeParameters } from './bridge';
+
+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

@@ -0,0 +1,101 @@
+import BigNumber from 'bignumber.js';
+import { bridgeCCIP } from './ccip-bridge';
+import {
+  BRIDGE_CHAINS,
+  BRIDGE_EXPLORER_URL_MAP,
+  BridgeChain,
+  BridgeType,
+  CCIPBridgeChain,
+  getBridgeInfo,
+  OFTBridgeChain,
+} from './config';
+import { bridgeOFT } from './oft-bridge';
+import { Address } from 'viem';
+import { CommonWriteParameters } from '../../common/parameters';
+
+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;
+
+/**
+ * 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,
+}: BridgeParameters) {
+  const bridgeInfo = getBridgeInfo(chainId as BridgeChain, to);
+
+  if (!bridgeInfo) {
+    throw new Error(
+      `Unsupported bridge from ${chainId} to ${to}. Please switch to the supported chains: ${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

@@ -0,0 +1,90 @@
+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 { bridgeCCIP, BridgeCCIPParameters } from './ccip-bridge';
+import { ChainId } from '../../common/chains';
+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

@@ -0,0 +1,163 @@
+import BigNumber from 'bignumber.js';
+import { CommonWriteParameters } from '../../common/parameters';
+import {
+  BridgeType,
+  CCIP_BRIDGE_CHAINS,
+  CCIPBridgeChain,
+  getBridgeInfo,
+  MIN_BRIDGE_AMOUNT,
+} 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, pad, parseEther, toBytes, toHex } from 'viem';
+import { approveLBTC } from '../../contract-functions';
+import { Token } from '../../tokens/token-addresses';
+
+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;
+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(', ')}`,
+    );
+  }
+
+  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 bridgeArgs = [
+    /** toChain - bytes32 */
+    toHex(to, { size: 32 }),
+    /** toAddress - bytes32 */
+    pad(recipient),
+    /** amount - uint64 */
+    amountBase,
+  ];
+
+  const adapterFee = (await publicClient.readContract({
+    abi: bridgeContract.abi,
+    address: bridgeContract.address,
+    functionName: 'getAdapterFee',
+    args: bridgeArgs,
+  })) as bigint;
+
+  const { request } = await publicClient.simulateContract({
+    abi: bridgeContract.abi,
+    address: bridgeContract.address,
+    account,
+    functionName: 'deposit',
+    args: bridgeArgs,
+    value: adapterFee,
+  });
+
+  const txHash = await walletClient.writeContract(request);
+  return txHash;
+}