@lombard.finance/sdk 3.7.4 → 4.1.0

package/src/common/contract-info.ts

@@ -1,9 +0,0 @@
-import { Abi, Address } from 'viem';
-
-import { ChainId } from './chains';
-
-export type ContractInfo = {
-  abi: Abi;
-  address: Address;
-  chainId: ChainId;
-};

package/src/common/feature-config.ts

@@ -1,18 +0,0 @@
-export interface FeatureConfig {
-  /**
-   * Enable/disable Monad blockchain support
-   * @default false - Currently disabled
-   */
-  isMonadEnabled: boolean;
-
-  /**
-   * Enable/disable Avalanche blockchain support
-   * @default false - Currently disabled
-   */
-  isAvalancheEnabled: boolean;
-}
-
-export const featureConfig: FeatureConfig = {
-  isMonadEnabled: true,
-  isAvalancheEnabled: false,
-};

package/src/common/parameters.ts

@@ -1,89 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import { Address, EIP1193Provider } from 'viem';
-
-import { SignerAdapter } from '../clients/evm-signer-adapter';
-import { ChainId } from './chains';
-
-export interface IEnvParam {
-  /**
-   * Optional environment identifier. If not provided, it defaults to `prod`.
-   *
-   * @default Env.prod
-   */
-  env?: Env;
-}
-
-export interface CommonParameters extends IEnvParam {
-  /**
-   * Chain ID for identifying the blockchain network (e.g., Ethereum, Binance Smart Chain, etc.)
-   */
-  chainId: ChainId;
-
-  /**
-   * Optional RPC URL to connect to the blockchain. If not provided, a default RPC URL might be used.
-   */
-  rpcUrl?: string;
-}
-
-export interface CommonReadParameters extends CommonParameters {
-  /**
-   * The account address.
-   */
-  account: Address;
-}
-
-export interface CommonOptionalWriteParameters extends CommonParameters {
-  /**
-   * The provider (required). An instance of the `EIP1193Provider` which adheres to the EIP-1193 standard for communication with Ethereum-compatible providers.
-   * @type {EIP1193Provider}
-   */
-  provider?: EIP1193Provider;
-}
-
-/**
- * Common write parameters using an EIP-1193 provider (legacy flow).
- */
-export interface CommonWriteParameters extends CommonParameters {
-  /**
-   * The account address.
-   */
-  account: Address;
-  /**
-   * An instance of the `EIP1193Provider` which adheres to the EIP-1193 standard for communication with Ethereum-compatible providers.
-   * @type {EIP1193Provider}
-   */
-  provider: EIP1193Provider;
-}
-
-/**
- * Common write parameters using a SignerAdapter (unified bridge flow).
- */
-export interface CommonSignerWriteParameters extends CommonParameters {
-  /**
-   * The account address.
-   */
-  account: Address;
-  /**
-   * A SignerAdapter instance for transaction signing (compatible with unified bridge EvmSigner).
-   * @type {SignerAdapter}
-   */
-  signer: SignerAdapter;
-}
-
-/**
- * Type guard to check if parameters use provider flow.
- */
-export function isProviderFlow(
-  params: CommonWriteParameters | CommonSignerWriteParameters,
-): params is CommonWriteParameters {
-  return 'provider' in params;
-}
-
-/**
- * Type guard to check if parameters use signer flow.
- */
-export function isSignerFlow(
-  params: CommonWriteParameters | CommonSignerWriteParameters,
-): params is CommonSignerWriteParameters {
-  return 'signer' in params;
-}

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

@@ -1,78 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-import { ChainId } from '../../common/chains';
-import { chainSelector } 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 { VAULTS, Vault } from '../../vaults/lib/config';
-import { IApproveLBTCParams, approveLBTC } from './approveLBTC';
-
-const meta = {
-  title: 'write/approveLBTC',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [wagmiDecorator, functionType('write')],
-  argTypes: { ...chainSelector },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    chainId: ChainId.holesky,
-    spender: VAULTS[Vault.Veda].spenderContracts[ChainId.holesky]?.address,
-    amount: 0.00001,
-    env: Env.stage,
-  },
-};
-
-type Props = Omit<IApproveLBTCParams, 'account' | 'provider'>;
-
-export function StoryView(props: Props) {
-  const connection = useConnection();
-
-  const request = async () => {
-    if (!canPerformAction(connection)) {
-      return;
-    }
-
-    return approveLBTC({
-      ...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={approveLBTC.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

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

@@ -1,66 +0,0 @@
-import BigNumber from 'bignumber.js';
-import { Address, Hash } 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 } from '../../common/parameters';
-import { Token } from '../../tokens/token-addresses';
-import { getTokenContractInfo } from '../../tokens/tokens';
-import { toSatoshi } from '../../utils/satoshi';
-
-export interface IApproveLBTCParams extends CommonWriteParameters {
-  /**
-   * The spender account address.
-   */
-  spender: Address;
-  /**
-   * The approved amount of LBTC.
-   */
-  amount: BigNumber.Value;
-}
-
-/**
- * Approves the provided spender to withdraw a specified amount of LBTC from
- * your account.
- *
- * @param {IApproveLBTCParams} parameters - The parameters.
- * @param {Address} spender - The spender account address.
- * @param {BigNumber.Value} - The amount of LBTC.
- * @param {Address} parameters.account - The EVM account address.
- * @param {ChainId} parameters.chainId - The chain id.
- * @param {EIP1193Provider} parameters.provider - The EIP1193 provider.
- * @param {string} parameters.rpcUrl - The optional rpc url.
- * @param {Env} parameters.env - The optional environment identifier.
- *
- * @returns {Promise<Hash>}
- */
-export async function approveLBTC({
-  account,
-  spender,
-  amount,
-  chainId,
-  provider,
-  rpcUrl,
-  env,
-}: IApproveLBTCParams): Promise<Hash> {
-  const publicClient = makePublicClient({ chainId, rpcUrl });
-  const walletClient = makeWalletClient({ chainId, provider });
-
-  const lbtcContract = await getTokenContractInfo(Token.LBTC, chainId, env);
-
-  const amountSat = toSatoshi(amount).toNumber();
-
-  const { request } = await publicClient.simulateContract({
-    address: lbtcContract.address,
-    account,
-    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    abi: lbtcContract.abi,
-    functionName: 'approve',
-    args: [spender, BigInt(amountSat)],
-  });
-
-  const txHash = await walletClient.writeContract(request);
-
-  return txHash;
-}

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

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

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

@@ -1,126 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import BigNumber from 'bignumber.js';
-import { Address, Hash } from 'viem';
-
-import { makePublicClient } from '../../clients/public-client';
-import { makeWalletClient } from '../../clients/wallet-client';
-import { CHAIN_ID_TO_VIEM_CHAIN_MAP, ChainId } from '../../common/chains';
-import { CommonWriteParameters, IEnvParam } from '../../common/parameters';
-import { Token } from '../../tokens/token-addresses';
-import {
-  fromBaseDenomination,
-  getTokenInfo,
-  toBaseDenomination,
-} from '../../tokens/tokens';
-import toBigInt from '../../utils/numbers';
-
-export interface IApproveTokenParams extends CommonWriteParameters, IEnvParam {
-  /**
-   * The token to approve.
-   */
-  token: Token;
-  /**
-   * The spender account address.
-   */
-  spender: Address;
-  /**
-   * The approved amount of the token.
-   */
-  amount: BigNumber.Value;
-}
-
-/**
- * Approves the provided spender to withdraw a specified amount of a token from
- * your account.
- *
- * @param {IApproveTokenParams} parameters - The parameters.
- * @param {Token} parameters.token - The token to approve.
- * @param {Address} parameters.spender - The spender account address.
- * @param {BigNumber.Value} parameters.amount - The amount of the token.
- * @param {Address} parameters.account - The EVM account address.
- * @param {ChainId} parameters.chainId - The chain id.
- * @param {EIP1193Provider} parameters.provider - The EIP1193 provider.
- * @param {string} parameters.rpcUrl - The optional rpc url.
- * @param {Env} parameters.env - The optional environment identifier.
- *
- * @returns {Promise<Hash>}
- */
-export async function approveToken({
-  account,
-  token,
-  spender,
-  amount,
-  chainId,
-  provider,
-  rpcUrl,
-  env,
-}: IApproveTokenParams): Promise<Hash> {
-  const publicClient = makePublicClient({ chainId, rpcUrl, env });
-  const walletClient = makeWalletClient({ chainId, provider });
-
-  const tokenInfo = await getTokenInfo(token, chainId, env, rpcUrl);
-  if (!tokenInfo) {
-    throw new Error(`Token info not found for ${token} on chain ${chainId}`);
-  }
-
-  const amountBase = toBigInt(
-    toBaseDenomination(BigNumber(amount), tokenInfo.decimals),
-  );
-
-  const { request } = await publicClient.simulateContract({
-    address: tokenInfo.address,
-    account,
-    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    abi: tokenInfo.abi,
-    functionName: 'approve',
-    args: [spender, amountBase],
-  });
-
-  const txHash = await walletClient.writeContract(request);
-
-  return txHash;
-}
-
-/**
- * Gets the allowance of a token for a spender.
- *
- * @param {Object} parameters - The parameters.
- * @param {Token} parameters.token - The token.
- * @param {Address} parameters.owner - The owner account address.
- * @param {Address} parameters.spender - The spender account address.
- * @param {ChainId} parameters.chainId - The chain id.
- * @param {string} parameters.rpcUrl - The optional rpc url.
- * @param {Env} parameters.env - The optional environment identifier.
- *
- * @returns {Promise<BigNumber>}
- */
-export async function getTokenAllowance({
-  token,
-  owner,
-  spender,
-  chainId,
-  rpcUrl,
-  env,
-}: {
-  token: Token;
-  owner: Address;
-  spender: Address;
-  chainId: ChainId;
-  rpcUrl?: string;
-  env?: Env;
-}): Promise<BigNumber> {
-  const publicClient = makePublicClient({ chainId, rpcUrl, env });
-  const tokenInfo = await getTokenInfo(token, chainId, env, rpcUrl);
-  if (!tokenInfo) {
-    throw new Error(`Token info not found for ${token} on chain ${chainId}`);
-  }
-
-  const allowanceRaw = (await publicClient.readContract({
-    address: tokenInfo.address,
-    abi: tokenInfo.abi,
-    functionName: 'allowance',
-    args: [owner, spender],
-  })) as bigint;
-
-  return fromBaseDenomination(allowanceRaw.toString(), tokenInfo.decimals);
-}

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

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

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

@@ -1,81 +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';