@lombard.finance/sdk 4.0.0 → 4.1.0

package/src/contract-functions/claimLBTC/claimLBTC.stories.tsx

@@ -1,82 +0,0 @@
-import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { makeTokenSelector } from '../../stories/arg-types';
-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 {
-  canPerformAction,
-  useConnection,
-} from '../../stories/hooks/useConnection';
-import useQuery from '../../stories/hooks/useQuery';
-import { Token } from '../../tokens/token-addresses';
-import { mintToken } from './claimLBTC';
-
-const meta = {
-  title: 'write/claimLBTC',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [wagmiDecorator, functionType('write')],
-  argTypes: {
-    ...makeTokenSelector([Token.LBTC, Token.BTCK, Token.BTCb]),
-  },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    proofSignature: '',
-    data: '',
-    env: DEFAULT_ENV,
-    token: Token.LBTC,
-  },
-};
-
-type ClaimLBTCProps = Omit<
-  Parameters<typeof mintToken>[0],
-  'account' | 'chainId' | 'provider'
->;
-
-export function StoryView(props: ClaimLBTCProps) {
-  const connection = useConnection();
-
-  const request = async () => {
-    if (!canPerformAction(connection)) {
-      return;
-    }
-
-    return mintToken({
-      ...props,
-      account: connection.account.address,
-      chainId: connection.account.chainId,
-      provider: connection.provider,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <div className="mb-4">
-        <ConnectButton />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !connection.account.address}
-        isLoading={isLoading}
-        actionName={mintToken.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/contract-functions/claimLBTC/claimLBTC.ts

@@ -1,159 +0,0 @@
-import { Hash, parseGwei } from 'viem';
-
-import { makePublicClient } from '../../clients/public-client';
-import { makeWalletClient } from '../../clients/wallet-client';
-import { CHAIN_ID_TO_VIEM_CHAIN_MAP, isKatanaChain } from '../../common/chains';
-import { CommonWriteParameters } from '../../common/parameters';
-import { AddressKind, Token } from '../../tokens/token-addresses';
-import { getTokenContractInfo } from '../../tokens/tokens';
-import { estimateGasFees } from '../../utils/gas';
-import { ensureHex } from '../../utils/hex';
-import {
-  BasculeDepositStatus,
-  getBasculeDepositStatus,
-} from '../getBasculeDepositStatus';
-
-export interface IClaimLBTCParams extends CommonWriteParameters {
-  /**
-   * The raw payload from deposit notarization, see `Deposit.rawPayload`.
-   */
-  data: string;
-  /**
-   * The proof signature from deposit notarization, see `Deposit.proof`.
-   */
-  proofSignature: string;
-}
-
-/**
- * Mints a specified token (LBTC or NativeLBTC) from a notarized deposit.
- *
- * This is the primary function for claiming tokens from a deposit notarization.
- *
- * It performs the following steps:
- * 1. Validates that the token is supported.
- * 2. Checks chain restrictions.
- * 3. Fetches the token contract information.
- * 4. Checks the deposit status via Bascule.
- * 5. Prepares the transaction call data and estimates gas fees if on Katana.
- * 6. Simulates the contract call and executes the transaction via the provided wallet.
- *
- * @param {Object} params - The parameters.
- * @param {string} params.data - Raw payload from the deposit notarization (`Deposit.rawPayload`).
- * @param {string} params.proofSignature - Signature from the deposit notarization (`Deposit.proof`).
- * @param {Address} params.account - The EVM account address that will receive the tokens.
- * @param {ChainId} params.chainId - The chain ID of the target blockchain network.
- * @param {EIP1193Provider} params.provider - The connected wallet provider.
- * @param {string} [params.rpcUrl] - Optional RPC URL for the blockchain network.
- * @param {Env} [params.env] - Optional environment identifier (e.g., `prod`, `staging`).
- * @param {Token} [params.token=Token.LBTC] - The token to mint. Defaults to LBTC.
- *
- * @returns {Promise<Hash>} Resolves with the transaction hash of the mint operation.
- *
- * @throws Will throw an error if:
- * - The token is unsupported.
- * - BTCK minting is attempted on a non-Katana chain.
- * - The deposit is unreported, withdrawn, or blocked by bridge security.
- */
-export async function mintToken({
-  data,
-  proofSignature,
-  account,
-  chainId,
-  provider,
-  rpcUrl,
-  env,
-  token = Token.LBTC,
-}: IClaimLBTCParams & { token?: Token }) {
-  if (![Token.LBTC, Token.BTCK, Token.BTCb].includes(token)) {
-    throw new Error('Unsupported token');
-  }
-
-  if (token === Token.BTCK && !isKatanaChain(chainId)) {
-    throw new Error('Operation not permitted');
-  }
-
-  const tokenContract = await getTokenContractInfo(
-    token,
-    chainId,
-    env,
-    AddressKind.Adapter,
-  );
-  const basculeStatus = await getBasculeDepositStatus({
-    chainId,
-    rawPayload: data,
-    env,
-    token,
-  });
-
-  if (basculeStatus !== BasculeDepositStatus.REPORTED) {
-    switch (basculeStatus) {
-      case BasculeDepositStatus.UNREPORTED:
-        throw new Error(
-          'The deposit cannot be claimed because it is unreported or potentially still pending, please try again later.',
-        );
-      case BasculeDepositStatus.WITHDRAWN:
-        throw new Error(
-          'The deposit cannot be claimed because it is withdrawn already.',
-        );
-      default: // unknown bascule deposit status
-        throw new Error(
-          'The deposit cannot be claimed because it is blocked by bridge security.',
-        );
-    }
-  }
-
-  const publicClient = makePublicClient({ chainId, rpcUrl, env });
-  const walletClient = makeWalletClient({ chainId, provider });
-
-  const callData = {
-    address: tokenContract.address,
-    account,
-    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    abi: tokenContract.abi,
-    functionName:
-      token === Token.BTCK || token === Token.BTCb ? 'mintV1' : 'mint',
-    args: [ensureHex(data), ensureHex(proofSignature)],
-  } as const;
-
-  const gasEstimationData = isKatanaChain(chainId)
-    ? await estimateGasFees(publicClient, callData, parseGwei('1'))
-    : {};
-
-  const { request } = await publicClient.simulateContract({
-    ...callData,
-    ...gasEstimationData,
-  });
-
-  const txHash = await walletClient.writeContract(request);
-
-  return txHash;
-}
-
-/**
- * Convenience wrapper for minting LBTC from a deposit notarization.
- *
- * Internally calls `mintToken` with the `Token.LBTC` argument.
- *
- * @param {IClaimLBTCParams} params - The parameters for claiming LBTC.
- * @returns {Promise<Hash>} Resolves with the transaction hash of the LBTC mint operation.
- */
-export async function claimLBTC({
-  data,
-  proofSignature,
-  account,
-  chainId,
-  provider,
-  rpcUrl,
-  env,
-}: IClaimLBTCParams): Promise<Hash> {
-  return mintToken({
-    data,
-    proofSignature,
-    account,
-    chainId,
-    provider,
-    rpcUrl,
-    env,
-    token: Token.LBTC,
-  });
-}

package/src/contract-functions/claimLBTC/index.ts

@@ -1 +0,0 @@
-export * from './claimLBTC';

package/src/contract-functions/claimUnstakeRedeem/claimUnstakeRedeem.ts

@@ -1,95 +0,0 @@
-import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
-import { Hash, parseGwei, zeroAddress } from 'viem';
-
-import { makePublicClient } from '../../clients/public-client';
-import { makeWalletClient } from '../../clients/wallet-client';
-import { CHAIN_ID_TO_VIEM_CHAIN_MAP, isKatanaChain } from '../../common/chains';
-import { CommonWriteParameters } from '../../common/parameters';
-import ASSET_ROUTER_ABI from '../../tokens/abi/ASSET_ROUTER_ABI';
-import { AddressKind, Token } from '../../tokens/token-addresses';
-import { getTokenContractInfo } from '../../tokens/tokens';
-import { estimateGasFees } from '../../utils/gas';
-import { ensureHex } from '../../utils/hex';
-
-/**
- * Parameters for claiming BTC.b from unstake redemptions
- */
-export interface IClaimUnstakeRedeemParams extends CommonWriteParameters {
-  /** Raw payload from the unstake redemption (`Unstake.rawPayload`) */
-  data: string;
-
-  /** Signature/proof from the unstake redemption (`Unstake.proof`) */
-  proofSignature: string;
-}
-
-/**
- * Claims BTC.b tokens from an unstake redemption (LBTC → BTC.b)
- *
- * This function is specifically for claiming native chain redemptions after the 7-day unstaking period.
- * Unlike deposits which use `adapter.mintV1`, unstake redemptions use `assetRouter.mint`.
- *
- * Business Rules:
- * - Only works for native chain redemptions (LBTC → BTC.b)
- * - Requires notarization status = SESSION_APPROVED
- * - Requires session state = COMPLETED
- * - Must be called after 7 days from unstake
- *
- * @param params - Parameters for claiming
- * @returns Transaction hash of the claim operation
- *
- * @throws Error if claiming fails or if action selector doesn't match
- */
-export async function claimUnstakeRedeem({
-  data,
-  proofSignature,
-  account,
-  chainId,
-  provider,
-  rpcUrl,
-  env = DEFAULT_ENV,
-}: IClaimUnstakeRedeemParams): Promise<Hash> {
-  const publicClient = makePublicClient({ chainId, rpcUrl, env });
-  const walletClient = makeWalletClient({ chainId, provider });
-
-  // Get AssetRouter address from BTCb token adapter
-  const btcbTokenContract = await getTokenContractInfo(
-    Token.BTCb,
-    chainId,
-    env,
-    AddressKind.Adapter,
-  );
-
-  // Read AssetRouter address from token adapter
-  const assetRouterAddress = await publicClient.readContract({
-    address: btcbTokenContract.address,
-    abi: btcbTokenContract.abi,
-    functionName: 'getAssetRouter',
-  });
-
-  if (!assetRouterAddress || assetRouterAddress === zeroAddress) {
-    throw new Error('AssetRouter address not found in token adapter');
-  }
-
-  // Call AssetRouter.mint function
-  const callData = {
-    address: assetRouterAddress,
-    account,
-    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    abi: ASSET_ROUTER_ABI,
-    functionName: 'mint',
-    args: [ensureHex(data), ensureHex(proofSignature)],
-  } as const;
-
-  const gasEstimationData = isKatanaChain(chainId)
-    ? await estimateGasFees(publicClient, callData, parseGwei('1'))
-    : {};
-
-  const { request } = await publicClient.simulateContract({
-    ...callData,
-    ...gasEstimationData,
-  });
-
-  const txHash = await walletClient.writeContract(request);
-
-  return txHash;
-}

package/src/contract-functions/claimUnstakeRedeem/index.ts

@@ -1 +0,0 @@
-export * from './claimUnstakeRedeem';

package/src/contract-functions/deposit/depositToken.stories.tsx

@@ -1,83 +0,0 @@
-import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { makeTokenSelector } from '../../stories/arg-types';
-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 {
-  canPerformAction,
-  useConnection,
-} from '../../stories/hooks/useConnection';
-import useQuery from '../../stories/hooks/useQuery';
-import { Token } from '../../tokens/token-addresses';
-import { depositToken } from './depositToken';
-
-const meta = {
-  title: 'write/depositToken',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [wagmiDecorator, functionType('write')],
-  argTypes: {
-    ...makeTokenSelector([Token.BTCK, Token.BTCb], 'tokenIn'),
-    ...makeTokenSelector([Token.LBTC], 'tokenOut'),
-  },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    env: DEFAULT_ENV,
-    amount: 0,
-    tokenIn: Token.BTCb,
-    tokenOut: Token.LBTC,
-  },
-};
-
-type StoryProps = Omit<
-  Parameters<typeof depositToken>[0],
-  'account' | 'chainId' | 'provider'
->;
-
-export function StoryView(props: StoryProps) {
-  const connection = useConnection();
-
-  const request = async () => {
-    if (!canPerformAction(connection)) {
-      return;
-    }
-
-    return depositToken({
-      ...props,
-      account: connection.account.address,
-      chainId: connection.account.chainId,
-      provider: connection.provider,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <div className="mb-4">
-        <ConnectButton />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !connection.account.address}
-        isLoading={isLoading}
-        actionName={depositToken.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/contract-functions/deposit/depositToken.ts

@@ -1,214 +0,0 @@
-/**
- * Asset Router deposit functionality for token swaps
- */
-import BigNumber from 'bignumber.js';
-import { Address } from 'viem';
-
-import { makePublicClient } from '../../clients/public-client';
-import { makeWalletClient } from '../../clients/wallet-client';
-import { CHAIN_ID_TO_VIEM_CHAIN_MAP } from '../../common/chains';
-import { CommonWriteParameters, IEnvParam } from '../../common/parameters';
-import ASSET_ROUTER_ABI from '../../tokens/abi/ASSET_ROUTER_ABI';
-import { AddressKind, Token } from '../../tokens/token-addresses';
-import {
-  fromBaseDenomination,
-  getTokenContractInfo,
-  retrieveTokenProperties,
-  toBaseDenomination,
-} from '../../tokens/tokens';
-import { UnsupportedTokenFlow } from '../../utils/err';
-import toBigInt from '../../utils/numbers';
-
-const AVAILABLE_FLOWS: Array<{
-  tokenIn: Token;
-  tokenOut: Token;
-}> = [
-  {
-    tokenIn: Token.BTCb,
-    tokenOut: Token.LBTC,
-  },
-];
-
-/* -------------------------------------------------------------------------- */
-/*                                   Types                                    */
-/* -------------------------------------------------------------------------- */
-
-/**
- * Parameters for depositing tokens into a supported token contract.
- *
- * Extends {@link CommonWriteParameters} and {@link IEnvParam}.
- */
-type DepositTokenParameters = {
-  /**
-   * The amount of tokens to deposit in human-readable format
-   * (e.g., `1.23` for 1.23 XBTC).
-   */
-  amount: BigNumber.Value;
-  /**
-   * The input token that will be deposited.
-   * Defaults to {@link Token.BTCb}.
-   */
-  tokenIn: Token;
-  /**
-   * The output token to be minted after deposit.
-   * Defaults to {@link Token.LBTC}.
-   */
-  tokenOut: Token;
-} & CommonWriteParameters &
-  IEnvParam;
-
-/* -------------------------------------------------------------------------- */
-/*                               Public API                                   */
-/* -------------------------------------------------------------------------- */
-
-/**
- * Gets the AssetRouter address for a given token.
- *
- * This is useful for approving tokens before calling the deposit function.
- *
- * @param tokenIn - The input token (e.g., Token.BTCb)
- * @param chainId - The chain ID
- * @param env - The environment
- * @param rpcUrl - Optional RPC URL
- * @returns The AssetRouter address
- */
-export async function getAssetRouterAddress({
-  tokenIn,
-  chainId,
-  env,
-  rpcUrl,
-}: {
-  tokenIn: Token;
-  chainId: CommonWriteParameters['chainId'];
-  env?: IEnvParam['env'];
-  rpcUrl?: string;
-}): Promise<Address> {
-  const publicClient = makePublicClient({ chainId, rpcUrl, env });
-
-  const adapterContractInfo = await getTokenContractInfo(
-    tokenIn,
-    chainId,
-    env,
-    AddressKind.Adapter,
-  );
-
-  const assetRouterAddress = (await publicClient.readContract({
-    address: adapterContractInfo.address,
-    abi: adapterContractInfo.abi,
-    functionName: 'getAssetRouter',
-  })) as Address;
-
-  return assetRouterAddress;
-}
-
-/**
- * Deposits tokens using the Asset Router contract to mint the corresponding output token.
- *
- * This function validates the deposit flow (input → output token), retrieves token and adapter contract
- * information, obtains the AssetRouter address, and submits a `deposit` transaction to the AssetRouter contract.
- *
- * **Note:** This function does NOT handle token approval. You must approve tokens for the AssetRouter
- * before calling this function. Use {@link getAssetRouterAddress} to get the spender address for approval.
- *
- * ---
- * **Supported flows:**
- * - BTC.b → LBTC
- *
- * ---
- * **Errors thrown:**
- * - `UnsupportedTokenDepositFlow` if the (tokenIn, tokenOut) pair is not supported
- * - `Error` if token contract properties cannot be retrieved
- * - `Error` if the deposit amount exceeds the account balance
- * - `Error` if insufficient allowance (tokens not approved)
- */
-export async function depositToken({
-  account: accountAddress,
-  amount: amountRaw,
-  chainId,
-  env,
-  provider,
-  rpcUrl,
-  tokenIn = Token.BTCb,
-  tokenOut = Token.LBTC,
-}: DepositTokenParameters) {
-  const flow = AVAILABLE_FLOWS.find(
-    af => af.tokenIn === tokenIn && af.tokenOut === tokenOut,
-  );
-  if (!flow) {
-    throw new UnsupportedTokenFlow(tokenIn, tokenOut, chainId, env);
-  }
-
-  const publicClient = makePublicClient({ chainId, rpcUrl, env });
-  const walletClient = makeWalletClient({ provider, chainId });
-
-  // Get adapter contract for tokenIn (BTC.b)
-  const adapterContractInfo = await getTokenContractInfo(
-    tokenIn,
-    chainId,
-    env,
-    AddressKind.Adapter,
-  );
-
-  // Get token contract for tokenIn to check balance and approve
-  const tokenInContractInfo = await getTokenContractInfo(
-    tokenIn,
-    chainId,
-    env,
-    AddressKind.Token,
-  );
-
-  // Get token contract for tokenOut to pass to AssetRouter
-  const tokenOutContractInfo = await getTokenContractInfo(
-    tokenOut,
-    chainId,
-    env,
-    AddressKind.Token,
-  );
-
-  const IN = await retrieveTokenProperties(publicClient, tokenInContractInfo);
-  if (!IN) {
-    throw new Error(
-      `Could not retrieve the properties of ${tokenIn} on ${chainId}`,
-    );
-  }
-
-  // Get AssetRouter address from adapter contract
-  const assetRouterAddress = (await publicClient.readContract({
-    address: adapterContractInfo.address,
-    abi: adapterContractInfo.abi,
-    functionName: 'getAssetRouter',
-  })) as Address;
-
-  const amount = BigNumber(amountRaw);
-  const amountBigInt = toBigInt(toBaseDenomination(amount, IN.decimals));
-
-  // Check token balance
-  const tokenInBalanceRaw = await publicClient.readContract({
-    address: IN.address,
-    abi: IN.abi,
-    functionName: 'balanceOf',
-    args: [accountAddress],
-  });
-  const tokenInBalance = fromBaseDenomination(tokenInBalanceRaw, IN.decimals);
-
-  if (amount.isGreaterThan(tokenInBalance)) {
-    throw new Error(
-      `Unable to deposit ${amount.toString()} ${IN.symbol} because the amount exceeds the account's balance of ${tokenInBalance.toString()} ${IN.symbol}`,
-    );
-  }
-
-  // const isAvalanche =
-  //   chainId === ChainId.avalanche || chainId === ChainId.avalancheFuji;
-
-  // Call deposit on AssetRouter
-  const hash = await walletClient.writeContract({
-    address: assetRouterAddress,
-    abi: ASSET_ROUTER_ABI,
-    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    functionName: 'deposit',
-    args: [accountAddress, tokenOutContractInfo.address, amountBigInt],
-    account: accountAddress,
-  });
-
-  return hash;
-}

package/src/contract-functions/deposit/index.ts

@@ -1 +0,0 @@
-export * from './depositToken';