@lombard.finance/sdk 2.5.1 → 3.1.0

package/src/web3Sdk/signStakeAndBake/signStakeAndBake.ts

@@ -1,105 +0,0 @@
-import { IEnvParam } from '../../common/types/internalTypes';
-import { TChainId } from '../../common/types/types';
-import { Provider } from '../../provider';
-import { IProviderBasedParams } from '../types';
-import { getStakeAndBakeSpenderContract } from './contracts';
-import { getStakeAndBakeTypedData } from './getTypedData';
-import { getVerifyingContract } from './utils';
-
-const NO_SIGNATURE_ERROR =
-  'Failed to obtain a valid signature. The response is undefined or invalid.';
-
-export interface ISignStakeAndBakeParams
-  extends Pick<IProviderBasedParams, 'provider'>, IEnvParam {
-  /**
-   * The address to sign with (owner)
-   */
-  address: string;
-  /**
-   * Chain ID for the signature
-   */
-  chainId: TChainId;
-  /**
-   * The value to approve
-   */
-  value: string;
-  /**
-   * Expiry date as a unix timestamp
-   */
-  expiry: number;
-  /**
-   * Optional RPC URL for the network
-   */
-  rpcUrl?: string;
-  /**
-   * The key of the vault to authorize
-   */
-  vaultKey: string;
-}
-
-export interface ISignStakeAndBakeResult {
-  /**
-   * The signature
-   */
-  signature: string;
-  /**
-   * The typed data used to generate the signature
-   */
-  typedData: string;
-}
-
-/**
- * Signs stake and bake authorization with EIP-712
- *
- * @param {ISignStakeAndBakeParams} params - Parameters for signing
- * @returns {Promise<ISignStakeAndBakeResult>} The signature and typed data
- */
-export async function signStakeAndBake({
-  address,
-  provider,
-  chainId,
-  value,
-  expiry,
-  rpcUrl,
-  vaultKey,
-  env
-}: ISignStakeAndBakeParams): Promise<ISignStakeAndBakeResult> {
-  const providerInstance = new Provider({
-    provider,
-    account: address,
-    chainId,
-  });
-
-  const verifyingContract = getVerifyingContract(chainId, env);
-  const spender = getStakeAndBakeSpenderContract(chainId, vaultKey);
-
-  const typedDataObject = await getStakeAndBakeTypedData({
-    chainId,
-    expiry,
-    owner: address,
-    spender,
-    value,
-    rpcUrl,
-    verifyingContract,
-  });
-
-  const typedData = JSON.stringify(typedDataObject);
-
-  const signature = await providerInstance.web3?.currentProvider?.request<
-    'eth_signTypedData_v4',
-    string
-  >({
-    method: 'eth_signTypedData_v4',
-    params: [address, typedData],
-  });
-
-  if (typeof signature === 'string') {
-    return { signature, typedData };
-  }
-
-  if (!signature?.result) {
-    throw new Error(NO_SIGNATURE_ERROR);
-  }
-
-  return { signature: signature.result, typedData };
-}

package/src/web3Sdk/signStakeAndBake/utils.ts

@@ -1,23 +0,0 @@
-import { TChainId } from '../../common/types/types';
-import { getLbtcAddressConfig } from '../lbtcAddressConfig';
-import { Env } from '@lombard.finance/sdk-common';
-
-/**
- * Gets the LBTC contract address for a given chain ID
- * @param chainId The chain ID
- * @param env
- * @returns The LBTC contract address for the chain
- */
-export const getVerifyingContract = (
-  chainId: TChainId,
-  env: Env = Env.prod,
-): string => {
-  const lbtcAddressConfig = getLbtcAddressConfig(env);
-  const address = lbtcAddressConfig[chainId];
-  if (!address) {
-    throw new Error(
-      `No LBTC contract address configured for chain ID ${chainId}`,
-    );
-  }
-  return address;
-};

package/src/web3Sdk/types.ts

@@ -1,16 +0,0 @@
-import { IEIP1193Provider, TChainId } from '../common/types/types';
-
-export interface IProviderBasedParams {
-  /**
-   * The EIP-1193 provider instance.
-   */
-  provider: IEIP1193Provider;
-  /**
-   * Current chain ID
-   */
-  chainId: TChainId;
-  /**
-   * Current account address
-   */
-  account: string;
-}

package/src/web3Sdk/unstakeLBTC/unstakeLBTC.stories.tsx

@@ -1,77 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { defaultEnv } from '@lombard.finance/sdk-common';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { useConnect } from '../../stories/hooks/useConnect';
-import useQuery from '../../stories/hooks/useQuery';
-import { IUnstakeLBTCParams, unstakeLBTC } from './unstakeLBTC';
-
-const meta = {
-  title: 'Web3SDK/unstakeLBTC',
-  component: StoryView,
-  tags: ['autodocs'],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    amount: 0.00001,
-    btcAddress: '',
-    env: defaultEnv,
-  },
-};
-
-type ClaimLBTCProps = Pick<IUnstakeLBTCParams, 'btcAddress' | 'env' | 'amount'>;
-
-export function StoryView(props: ClaimLBTCProps) {
-  const {
-    data: connectData,
-    error: connectError,
-    isLoading: isConnectLoading,
-    connect,
-  } = useConnect();
-
-  const request = async () => {
-    if (!connectData) {
-      return;
-    }
-
-    return unstakeLBTC({ ...connectData, ...props });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  const formattedConnectData = connectData && {
-    account: connectData.account,
-    chainId: connectData.chainId,
-  };
-
-  return (
-    <>
-      <div className="mb-4">
-        <Button
-          onClick={connect}
-          disabled={isConnectLoading}
-          isLoading={isConnectLoading}
-        >
-          Connect
-        </Button>
-
-        <CodeBlock text={connectError || formattedConnectData} />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !connectData}
-        isLoading={isLoading}
-      >
-        Unstake LBTC
-      </Button>
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/web3Sdk/unstakeLBTC/unstakeLBTC.ts

@@ -1,51 +0,0 @@
-import { getOutputScript } from '@lombard.finance/sdk-common';
-import { IEnvParam } from '../../common/types/internalTypes';
-import { toSatoshi } from '../../common/utils/convertSatoshi';
-import { IWeb3SendResult, Provider } from '../../provider';
-import { IProviderBasedParams } from '../types';
-import { getGasMultiplier } from '../utils/getGasMultiplier';
-import { getLbtcTokenContract } from '../utils/getLbtcTokenContract';
-
-export interface IUnstakeLBTCParams extends IProviderBasedParams, IEnvParam {
-  /**
-   * The BTC address to send the unstaked BTC to.
-   */
-  btcAddress: string;
-  /**
-   * The amount of LBTC to unstake.
-   */
-  amount: number;
-}
-
-/**
- * Unstakes LBTC to the specified BTC address.
- *
- * @param {IUnstakeLBTCParams} params
- *
- * @returns {Promise<IWeb3SendResult>} transaction promise
- */
-export function unstakeLBTC({
-  btcAddress,
-  amount,
-  env,
-  ...providerParams
-}: IUnstakeLBTCParams): Promise<IWeb3SendResult> {
-  const provider = new Provider(providerParams);
-  const tokenContract = getLbtcTokenContract(provider, env);
-  const outputScript = getOutputScript(btcAddress, env);
-
-  const amountSat = toSatoshi(amount).toNumber();
-
-  const tx = tokenContract.methods.redeem(outputScript, amountSat);
-
-  return provider.sendTransactionAsync(
-    provider.account,
-    tokenContract.options.address,
-    {
-      data: tx.encodeABI(),
-      estimate: true,
-      estimateFee: true,
-      gasLimitMultiplier: getGasMultiplier(provider.chainId),
-    },
-  );
-}

package/src/web3Sdk/utils/chainIdToEnv.ts

@@ -1,12 +0,0 @@
-import { OChainId, TChainId } from '../../common/types/types';
-import { Env } from '@lombard.finance/sdk-common';
-
-const PROD_NATIVE_MINT_CHAINS = [
-  OChainId.ethereum,
-  OChainId.base,
-  OChainId.binanceSmartChain,
-] as TChainId[];
-
-export const chainIdToEnv = (chainId: TChainId): Env => {
-  return PROD_NATIVE_MINT_CHAINS.includes(chainId) ? Env.prod : Env.stage;
-};

package/src/web3Sdk/utils/getBasculeTokenContract.ts

@@ -1,21 +0,0 @@
-import { Provider } from '../../provider';
-import { BASCULE_ABI } from '../abi';
-
-export function getBasculeTokenContract(
-  provider: Provider,
-  contractAddress: string,
-) {
-  if (!contractAddress) {
-    throw new Error('The address for bascule module is not defined');
-  }
-
-  const contract = provider.createContract(BASCULE_ABI, contractAddress);
-
-  if (!contract.options.address) {
-    contract.options.address = contractAddress;
-  }
-
-  return contract as typeof contract & {
-    options: typeof contract.options & { address: string };
-  };
-}

package/src/web3Sdk/utils/getGasMultiplier.ts

@@ -1,20 +0,0 @@
-import { OChainId } from '../../common/types/types';
-
-/**
- * Returns the gas multiplier for the given chain ID.
- *
- * @param chainId - Chain ID.
- *
- * @returns Gas multiplier.
- */
-export function getGasMultiplier(chainId: number): number {
-  switch (chainId) {
-    case OChainId.ethereum:
-      return 1.3;
-    case OChainId.holesky:
-    case OChainId.sepolia:
-      return 1.5;
-    default:
-      return 1.3;
-  }
-}

package/src/web3Sdk/utils/getLbtcTokenContract.ts

@@ -1,36 +0,0 @@
-import { ReadProvider } from '../../provider/ReadProvider';
-import { Env } from '@lombard.finance/sdk-common';
-import { isValidChain } from '../../common/utils/isValidChain';
-import { Provider } from '../../provider';
-import { getLbtcAddressConfig } from '../lbtcAddressConfig';
-import { getTokenABI } from './getTokenABI';
-
-export function getLbtcTokenContract(
-  provider: Provider | ReadProvider,
-  env?: Env,
-) {
-  const lbtcAddressConfig = getLbtcAddressConfig(env);
-  const { chainId } = provider;
-
-  if (!isValidChain(chainId)) {
-    throw new Error(`This chain ${chainId} is not supported`);
-  }
-
-  const tokenAddress = lbtcAddressConfig[chainId];
-
-  if (!tokenAddress) {
-    throw new Error(`Token address for chain ${chainId} is not defined`);
-  }
-
-  const abi = getTokenABI('LBTC');
-
-  const contract = provider.createContract(abi, tokenAddress);
-
-  if (!contract.options.address) {
-    contract.options.address = tokenAddress;
-  }
-
-  return contract as typeof contract & {
-    options: typeof contract.options & { address: string };
-  };
-}

package/src/web3Sdk/utils/getRpcUrlConfigFromChain.ts

@@ -1,34 +0,0 @@
-import { TChainId } from '../../common/types/types';
-import { isValidChain } from '../../common/utils/isValidChain';
-import {
-  rpcUrlConfig as defaultRpcUrlConfig,
-  TRpcUrlConfig,
-} from '../../provider/rpcUrlConfig';
-
-/**
- * Get RPC URL configuration for a specific chain.
- * Validates chain support and RPC URL availability.
- *
- * @param {TChainId} chainId - Chain ID to get RPC config for
- * @param {string} [rpcUrl] - Optional custom RPC URL
- * @returns {TRpcUrlConfig} RPC URL configuration for the chain
- * @throws {Error} If chain is not supported or RPC URL is not found
- */
-export function getRpcUrlConfigFromChain(
-  chainId: TChainId,
-  rpcUrl?: string,
-): TRpcUrlConfig {
-  if (!isValidChain(chainId)) {
-    throw new Error(`This chain ${chainId} is not supported`);
-  }
-
-  const rpcUrlConfig: TRpcUrlConfig = rpcUrl
-    ? { [chainId]: rpcUrl }
-    : defaultRpcUrlConfig;
-
-  if (!rpcUrlConfig[chainId]) {
-    throw new Error(`RPC URL for chainId ${chainId} not found`);
-  }
-
-  return rpcUrlConfig;
-}

package/src/web3Sdk/utils/getTokenABI.ts

@@ -1,12 +0,0 @@
-import { IERC20, LBTCABI } from '../abi';
-
-type Token = 'LBTC' | 'ERC20';
-
-export function getTokenABI(token: Token) {
-  switch (token) {
-    case 'LBTC':
-      return LBTCABI;
-    default:
-      return IERC20;
-  }
-}