@lombard.finance/sdk 3.7.4 → 4.1.0

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

@@ -1,211 +0,0 @@
-import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
-import {
-  Address,
-  ByteArray,
-  Client,
-  getContract,
-  keccak256,
-  PublicClient,
-  zeroAddress,
-} from 'viem';
-
-import { Deposit } from '../../api-functions/getDepositsByAddress/getDepositsByAddress';
-import { makePublicClient } from '../../clients/public-client';
-import { makeWalletClient } from '../../clients/wallet-client';
-import {
-  isEthereumChain,
-  isKatanaChain,
-  isMegaethChain,
-  isMonadChain,
-  isStableChain,
-} from '../../common/chains';
-import { CommonOptionalWriteParameters } from '../../common/parameters';
-import ASSET_ROUTER_ABI from '../../tokens/abi/ASSET_ROUTER_ABI';
-import KATANA_BASCULE_ABI from '../../tokens/abi/KATANA_BASCULE_ABI';
-import LBTC_BASCULE_ABI from '../../tokens/abi/LBTC_BASCULE_ABI.json';
-import { AddressKind, Token } from '../../tokens/token-addresses';
-import { getTokenContractInfo, isUpgradedAbi } from '../../tokens/tokens';
-import { getErrorMessage } from '../../utils/err';
-import {
-  calcMintIDFromDecoded,
-  decodeGmpMintPayload,
-} from './decodeBasculeDepositStatus';
-
-/**
- * The bascule drawbridge deposit status.
- */
-export enum BasculeDepositStatus {
-  /**
-   * The value representing that the deposit is unreported or potentially
-   * still pending.
-   */
-  UNREPORTED = 0,
-  /**
-   * The value representing that the deposit is reported.
-   */
-  REPORTED = 1,
-  /**
-   * The value representing that the deposit has already been withdrawn.
-   */
-  WITHDRAWN = 2,
-}
-
-export interface IGetBasculeDepositStatusParameters
-  extends CommonOptionalWriteParameters {
-  /**
-   * The deposit for which the bascule status will be checked.
-   * You can omit `rawPayload` parameter if `deposit` is provided.
-   */
-  deposit?: Deposit;
-  /**
-   * The `rawPayload` of the deposit for which the bascule status
-   * will be checked.
-   * You can omit `deposit` parameter if `rawPayload` is provided.
-   */
-  rawPayload?: string;
-  token?: Token;
-}
-
-/**
- * Gets the Bascule drawbridge deposit status for given deposit.
- *
- * **Multiple Bascule Interfaces:**
- * This function supports two different bascule contract interfaces:
- * - **Asset Router (upgraded)**: Uses `bascule()` getter - for StakedLBTC and upgraded contracts
- * - **Bridge Token Adapter**: Uses `getBascule()` getter - for BTCb on Avalanche
- * - **Legacy NativeLBTC**: Uses `Bascule()` getter - for old LBTC contracts
- *
- * **MintID Calculation:**
- * For Katana chains, this function uses proper GMP payload decoding to calculate
- * the mintID, which matches the Solidity implementation. For other chains, it uses
- * a simplified method.
- *
- * @param {IGetBasculeDepositStatusParameters} parameters - The parameters.
- * @param {Deposit} parameters.deposit - The deposit for which the bascule status will be checked. You can omit `rawPayload` parameter if `deposit` is provided.
- * @param {string} parameters.rawPayload - The `rawPayload` of the deposit for which the bascule status will be checked. You can omit `deposit` parameter if `rawPayload` is provided.
- * @param {ChainId} parameters.chainId - The chain id. For Katana chains (Katana mainnet or Katana Tatara testnet), GMP payload decoding is used.
- * @param {Token} parameters.token - The token for which to check bascule status. Defaults to Token.LBTC.
- * @param {EIP1193Provider} parameters.provider - The optional EIP1193 provider.
- * @param {string} parameters.rpcUrl - The optional rpc url.
- * @param {Env} parameters.env - The optional environment identifier.
- *
- * @returns {Promise<BasculeDepositStatus>}
- */
-export async function getBasculeDepositStatus({
-  deposit,
-  rawPayload,
-  provider,
-  chainId,
-  rpcUrl,
-  env = DEFAULT_ENV,
-  token = Token.LBTC,
-}: IGetBasculeDepositStatusParameters) {
-  const payload = deposit?.rawPayload || rawPayload;
-
-  if (!payload) {
-    throw new Error(
-      "No 'rawPayload' or 'deposit' data provided. Please provide 'rawPayload' or 'deposit' parameter.",
-    );
-  }
-
-  const publicClient = makePublicClient({ chainId, rpcUrl, env });
-  const tokenContractInfo = await getTokenContractInfo(
-    token,
-    chainId,
-    env,
-    AddressKind.Adapter,
-  );
-
-  // Determine which bascule getter function to use based on the contract type
-  // There are two different approaches:
-  // 1. Upgraded contracts (Asset Router): token.getAssetRouter() -> assetRouter.bascule()
-  // 2. Legacy contracts (NativeLBTC): Bascule()
-
-  let basculeContractAddress: Address;
-
-  if (isUpgradedAbi(tokenContractInfo.abi) && token === Token.LBTC) {
-    // Upgraded contract - get bascule from Asset Router
-    const assetRouterAddress = (await publicClient.readContract({
-      abi: tokenContractInfo.abi,
-      address: tokenContractInfo.address,
-      functionName: 'getAssetRouter',
-    })) as Address;
-
-    basculeContractAddress = (await publicClient.readContract({
-      abi: ASSET_ROUTER_ABI,
-      address: assetRouterAddress,
-      functionName: 'bascule',
-    })) as Address;
-  } else {
-    basculeContractAddress = (await publicClient.readContract({
-      abi: tokenContractInfo.abi,
-      address: tokenContractInfo.address,
-      functionName: 'Bascule',
-    })) as Address;
-  }
-
-  // If there's no bascule contract address on the LBTC contract then return
-  // the the deposit is ok (REPORTED).
-  if (basculeContractAddress === zeroAddress) {
-    return BasculeDepositStatus.REPORTED;
-  }
-
-  let client: PublicClient | Client | undefined = undefined;
-  if (!provider) {
-    client = makePublicClient({ chainId, rpcUrl });
-  } else {
-    client = makeWalletClient({ provider, chainId });
-  }
-
-  if (!client) {
-    throw new Error(
-      "Could not determine the client for the contract interactions. Please provide the 'provider' and 'chainId' parameters or 'chainId' and optionally the 'rpcUrl' parameter.",
-    );
-  }
-
-  const shouldCheckMintHistory =
-    (isKatanaChain(chainId) ||
-      isMonadChain(chainId) ||
-      isEthereumChain(chainId) ||
-      isStableChain(chainId) ||
-      isMegaethChain(chainId)) &&
-    token === Token.LBTC;
-
-  try {
-    // For Katana chains, use proper GMP payload decoding to calculate mintID
-    if (shouldCheckMintHistory) {
-      const prefixedPayload = payload.startsWith('0x')
-        ? payload
-        : `0x${payload}`;
-      const decoded = decodeGmpMintPayload(prefixedPayload);
-      const mintId = calcMintIDFromDecoded(decoded, chainId);
-
-      const [, status] = (await publicClient.readContract({
-        abi: KATANA_BASCULE_ABI,
-        address: basculeContractAddress,
-        functionName: 'mintHistory',
-        args: [mintId],
-      })) as [unknown, BasculeDepositStatus];
-
-      return status;
-    }
-
-    // For non-Katana chains, use the simple method
-    const basculeDepositId = keccak256(
-      Buffer.from(payload.slice(8), 'hex') as unknown as ByteArray,
-    );
-
-    const basculeContract = getContract({
-      abi: LBTC_BASCULE_ABI,
-      address: basculeContractAddress,
-      client: publicClient,
-    });
-
-    const status = await basculeContract.read.depositHistory([
-      basculeDepositId,
-    ]);
-    return status as BasculeDepositStatus;
-  } catch (err) {
-    throw new Error(getErrorMessage(err));
-  }
-}

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

@@ -1,2 +0,0 @@
-export * from './decodeBasculeDepositStatus';
-export * from './getBasculeDepositStatus';

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

@@ -1,60 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { ChainId } from '../../common/chains';
-import { chainSelector, envSelector } from '../../stories/arg-types';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { functionType } from '../../stories/components/decorators';
-import useQuery from '../../stories/hooks/useQuery';
-import { getLBTCMintingFee } from './getLBTCMintingFee';
-
-const meta = {
-  title: 'read/getLBTCMintingFee',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-  argTypes: { ...chainSelector, ...envSelector },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Holesky: Story = {
-  args: {
-    chainId: ChainId.holesky,
-    env: undefined,
-  },
-};
-
-type Params = Parameters<typeof getLBTCMintingFee>[0];
-
-export function StoryView(props: Params) {
-  const request = async () => {
-    return getLBTCMintingFee({
-      chainId: props.chainId,
-      env: props.env,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <div>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getLBTCMintingFee.name}
-      />
-
-      <CodeBlock text={error || data?.toFormat()} />
-
-      {data && (
-        <div className="mt-4 p-4 border rounded">
-          <h3 className="text-lg font-bold mb-2">Fee Details</h3>
-          <p>Minting Fee: {data.toFormat()} BTC</p>
-        </div>
-      )}
-    </div>
-  );
-}

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

@@ -1,193 +0,0 @@
-import BigNumber from 'bignumber.js';
-
-import { makePublicClient } from '../../clients/public-client';
-import { CommonParameters } from '../../common/parameters';
-import ASSET_ROUTER_ABI from '../../tokens/abi/ASSET_ROUTER_ABI';
-import { AddressKind, Token } from '../../tokens/token-addresses';
-import { getTokenContractInfo, isUpgradedAbi } from '../../tokens/tokens';
-import { determineEnv } from '../../utils/env';
-import { fromSatoshi } from '../../utils/satoshi';
-
-/**
- * Gets LBTC minting fee amount.
- *
- * @param {CommonParameters} parameters - The parameters.
- * @param {ChainId} parameters.chainId - The chain id.
- * @param {string} parameters.rpcUrl - The optional rpc url.
- * @param {Env} parameters.env - The optional environment identifier.
- *
- * @return {Promise<BigNumber>}
- */
-export async function getLBTCMintingFee(
-  props: CommonParameters,
-): Promise<BigNumber> {
-  return getMintingFee({ token: Token.LBTC, ...props });
-}
-
-/** Gets LBTC burn commission (fee) amount. */
-export async function getLBTCBurningFee(props: CommonParameters) {
-  return getRedeemFee({ token: Token.LBTC, ...props });
-}
-
-export async function getMintingFee({
-  token,
-  chainId,
-  rpcUrl,
-  env,
-}: { token: Token } & CommonParameters) {
-  if (![Token.LBTC, Token.BTCK, Token.BTCb].includes(token)) {
-    throw new Error(`Unsupported token: ${token}`);
-  }
-
-  const environment = env || determineEnv(chainId);
-
-  const publicClient = makePublicClient({ chainId, rpcUrl, env: environment });
-  const tokenContract = await getTokenContractInfo(
-    token,
-    chainId,
-    environment,
-    AddressKind.Adapter,
-  );
-  const tokenContractAbi = tokenContract.abi;
-
-  let rawFeeValue = 0n;
-
-  if (isUpgradedAbi(tokenContractAbi) || token === Token.BTCb) {
-    const assetRouterAddress = await publicClient.readContract({
-      abi: tokenContractAbi,
-      address: tokenContract.address,
-      functionName: 'getAssetRouter',
-    });
-
-    const assetRouter = {
-      abi: ASSET_ROUTER_ABI,
-      address: assetRouterAddress,
-    };
-
-    rawFeeValue = (await publicClient.readContract({
-      abi: assetRouter.abi,
-      address: assetRouter.address,
-      functionName: 'maxMintCommission',
-      args: [tokenContract.address],
-    })) as bigint;
-  } else {
-    rawFeeValue = await publicClient.readContract({
-      abi: tokenContract.abi,
-      address: tokenContract.address,
-      functionName: 'getMintFee',
-    });
-  }
-
-  return fromSatoshi(String(rawFeeValue));
-}
-
-export async function getRedeemFee({
-  token,
-  chainId,
-  rpcUrl,
-  env,
-}: { token: Token } & CommonParameters) {
-  if (![Token.LBTC, Token.BTCK, Token.BTCb].includes(token)) {
-    throw new Error(`Unsupported token: ${token}`);
-  }
-  const environment = env || determineEnv(chainId);
-
-  const publicClient = makePublicClient({ chainId, rpcUrl, env: environment });
-  const tokenContract = await getTokenContractInfo(
-    token,
-    chainId,
-    environment,
-    AddressKind.Adapter,
-  );
-
-  let rawFeeValue = 0n;
-  if (isUpgradedAbi(tokenContract.abi) || token === Token.BTCb) {
-    const assetRouterAddress = await publicClient.readContract({
-      abi: tokenContract.abi,
-      address: tokenContract.address,
-      functionName: 'getAssetRouter',
-    });
-
-    const assetRouter = {
-      abi: ASSET_ROUTER_ABI,
-      address: assetRouterAddress,
-    };
-
-    // 1.
-    const toNativeCommissionValue = (await publicClient.readContract({
-      abi: assetRouter.abi,
-      address: assetRouter.address,
-      functionName: 'toNativeCommission',
-      args: [tokenContract.address],
-    })) as bigint;
-
-    // 2.
-    const [redeemFeeValue /* redeemForBtcMinAmountValue, isRedeemEnabled */] =
-      (await publicClient.readContract({
-        abi: assetRouter.abi,
-        address: assetRouter.address,
-        functionName: 'tokenConfig',
-        args: [tokenContract.address],
-      })) as [bigint];
-
-    rawFeeValue = toNativeCommissionValue + redeemFeeValue;
-  } else {
-    // legacy (and BTCK v1)
-    rawFeeValue = await publicClient.readContract({
-      abi: tokenContract.abi,
-      address: tokenContract.address,
-      functionName: 'getBurnCommission',
-    });
-  }
-
-  return fromSatoshi(String(rawFeeValue));
-}
-
-export async function getMinRedeemAmount({
-  token,
-  chainId,
-  rpcUrl,
-  env,
-}: { token: Token } & CommonParameters) {
-  if (![Token.LBTC, Token.BTCK, Token.BTCb].includes(token)) {
-    throw new Error(`Unsupported token: ${token}`);
-  }
-
-  const environment = env || determineEnv(chainId);
-
-  const publicClient = makePublicClient({ chainId, rpcUrl, env: environment });
-  const tokenContract = await getTokenContractInfo(
-    token,
-    chainId,
-    environment,
-    AddressKind.Adapter,
-  );
-
-  let value = 0n;
-  if (isUpgradedAbi(tokenContract.abi) || token === Token.BTCb) {
-    const assetRouterAddress = await publicClient.readContract({
-      abi: tokenContract.abi,
-      address: tokenContract.address,
-      functionName: 'getAssetRouter',
-    });
-
-    const assetRouter = {
-      abi: ASSET_ROUTER_ABI,
-      address: assetRouterAddress,
-    };
-
-    const [, redeemForBtcMinAmountValue] = (await publicClient.readContract({
-      abi: assetRouter.abi,
-      address: assetRouter.address,
-      functionName: 'tokenConfig',
-      args: [tokenContract.address],
-    })) as [undefined, bigint];
-
-    value = redeemForBtcMinAmountValue;
-  } else {
-    // legacy (and BTCK v1)
-    value = 2000n; // 0.00002
-  }
-
-  return fromSatoshi(String(value));
-}

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

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

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

@@ -1,50 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { ChainId } from '../../common/chains';
-import { chainSelector, envSelector } from '../../stories/arg-types';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { functionType } from '../../stories/components/decorators';
-import useQuery from '../../stories/hooks/useQuery';
-import { getLBTCTotalSupply } from './getLBTCTotalSupply';
-
-const meta = {
-  title: 'read/getLBTCTotalSupply',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-  argTypes: { ...chainSelector, ...envSelector },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    chainId: ChainId.ethereum,
-    env: undefined,
-  },
-};
-
-type TotalSupplyLBTCProps = Parameters<typeof getLBTCTotalSupply>[0];
-
-export function StoryView(props: TotalSupplyLBTCProps) {
-  const request = async () => {
-    return getLBTCTotalSupply(props);
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getLBTCTotalSupply.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

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

@@ -1,40 +0,0 @@
-import BigNumber from 'bignumber.js';
-
-import { makePublicClient } from '../../clients/public-client';
-import { CommonParameters } from '../../common/parameters';
-import { Token } from '../../tokens/token-addresses';
-import { getTokenContractInfo } from '../../tokens/tokens';
-import { determineEnv } from '../../utils/env';
-import { fromSatoshi } from '../../utils/satoshi';
-
-/**
- * Get the total supply of LBTC tokens.
- *
- * @param {CommonParameters} parameters - The parameters.
- * @param {ChainId} parameters.chainId - The chain id.
- * @param {string} parameters.rpcUrl - The optional rpc url.
- * @param {Env} parameters.env - The optional environment identifier.
- *
- * @return {Promise<BigNumber>}
- */
-export async function getLBTCTotalSupply({
-  chainId,
-  rpcUrl,
-  env,
-}: CommonParameters): Promise<BigNumber> {
-  const environment = env || determineEnv(chainId);
-  const publicClient = makePublicClient({ chainId, rpcUrl, env: environment });
-  const lbtcContract = await getTokenContractInfo(
-    Token.LBTC,
-    chainId,
-    environment,
-  );
-
-  const totalSupplyRaw = await publicClient.readContract({
-    abi: lbtcContract.abi,
-    address: lbtcContract.address,
-    functionName: 'totalSupply',
-  });
-
-  return fromSatoshi(String(totalSupplyRaw));
-}

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

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

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

@@ -1,55 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { functionType } from '../../stories/components/decorators';
-import useQuery from '../../stories/hooks/useQuery';
-import { IGetPermitNonceParams, getPermitNonce } from './getPermitNonce';
-
-const meta = {
-  title: 'read/getPermitNonce',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    owner: '0x1234567890123456789012345678901234567890',
-    chainId: 1,
-  },
-};
-
-type GetPermitNonceProps = Parameters<typeof getPermitNonce>[0];
-
-export function StoryView(props: GetPermitNonceProps) {
-  const request = async () => {
-    return getPermitNonce(props);
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getPermitNonce.name}
-      />
-
-      <CodeBlock text={error || data} />
-
-      {data && (
-        <div className="mt-4 p-4 border rounded">
-          <h3 className="text-lg font-bold mb-2">Permit Nonce Details</h3>
-          <p>Owner: {props.owner}</p>
-          <p>Nonce: {data}</p>
-        </div>
-      )}
-    </>
-  );
-}

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

@@ -1,50 +0,0 @@
-import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
-import { Address } from 'viem';
-
-import { makePublicClient } from '../../clients/public-client';
-import { CommonParameters } from '../../common/parameters';
-import { Token } from '../../tokens/token-addresses';
-import { getTokenContractInfo } from '../../tokens/tokens';
-import { determineEnv } from '../../utils/env';
-
-export interface IGetPermitNonceParams extends CommonParameters {
-  /**
-   * Owner address to check permit nonce for
-   */
-  owner: Address;
-}
-
-/**
- * Get permit nonce for a specific owner address from LBTC contract.
- * This nonce is used in EIP-2612 permit operations.
- *
- * @param {IGetPermitNonceParams} parameters - The parameters.
- * @param {Address} parameters.owner - The 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.
- */
-export async function getPermitNonce({
-  owner,
-  chainId,
-  rpcUrl,
-  env = DEFAULT_ENV,
-}: IGetPermitNonceParams): Promise<string> {
-  const environment = env || determineEnv(chainId);
-
-  const publicClient = makePublicClient({ chainId, rpcUrl });
-  const lbtcContract = await getTokenContractInfo(
-    Token.LBTC,
-    chainId,
-    environment,
-  );
-
-  const nonce = await publicClient.readContract({
-    abi: lbtcContract.abi,
-    address: lbtcContract.address,
-    functionName: 'nonces',
-    args: [owner],
-  });
-
-  return String(nonce);
-}

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

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