@lombard.finance/sdk 0.1.0

package/src/web3Sdk/abi/index.ts

@@ -0,0 +1,4 @@
+import IERC20 from './IERC20.json';
+import LBTCABI from './LBTC.json';
+
+export { IERC20, LBTCABI };

package/src/web3Sdk/approveLBTC/approveLBTC.stories.tsx

@@ -0,0 +1,77 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { defaultEnv } from '../../common/const';
+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 { approveLBTC, IApproveLBTCParams } from './approveLBTC';
+
+const meta = {
+  title: 'Web3SDK/approveLBTC',
+  component: StoryView,
+  tags: ['autodocs'],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const WithParams: Story = {
+  args: {
+    amount: 0.00001,
+    spender: '',
+    env: defaultEnv,
+  },
+};
+
+type ClaimLBTCProps = Pick<IApproveLBTCParams, 'spender' | 'amount' | 'env'>;
+
+export function StoryView(props: ClaimLBTCProps) {
+  const {
+    data: connectData,
+    error: connectError,
+    isLoading: isConnectLoading,
+    connect,
+  } = useConnect();
+
+  const request = async () => {
+    if (!connectData) {
+      return;
+    }
+
+    return approveLBTC({ ...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}
+      >
+        Approve LBTC
+      </Button>
+
+      <CodeBlock text={error || data} />
+    </>
+  );
+}

package/src/web3Sdk/approveLBTC/approveLBTC.ts

@@ -0,0 +1,48 @@
+import { IEnvParam } from '../../common/types/internalTypes';
+import { toSatoshi } from '../../common/utils/convertSatoshi';
+import { IWeb3SendResult, Provider } from '../../provider';
+import { IProviderBasedParams } from '../internalTypes';
+import { getGasMultiplier } from '../utils/getGasMultiplier';
+import { getLbtcTokenContract } from '../utils/getLbtcTokenContract';
+
+export interface IApproveLBTCParams extends IProviderBasedParams, IEnvParam {
+  /**
+   * Spender address
+   */
+  spender: string;
+  /**
+   * The amount of LBTC to approve
+   */
+  amount: number;
+}
+
+/**
+ * Approves the transfer of a specified amount of LBTC tokens.
+ *
+ * @param {IApproveLBTCParams} params
+ *
+ * @returns {Promise<IWeb3SendResult>} transaction promise
+ */
+export function approveLBTC({
+  spender,
+  amount,
+  env,
+  ...providerParams
+}: IApproveLBTCParams): Promise<IWeb3SendResult> {
+  const provider = new Provider(providerParams);
+  const tokenContract = getLbtcTokenContract(provider, env);
+  const amountSat = toSatoshi(amount);
+
+  const tx = tokenContract.methods.approve(spender, amountSat);
+
+  return provider.sendTransactionAsync(
+    provider.account,
+    tokenContract.options.address,
+    {
+      data: tx.encodeABI(),
+      estimate: true,
+      estimateFee: true,
+      gasLimitMultiplier: getGasMultiplier(provider.chainId),
+    },
+  );
+}

package/src/web3Sdk/approveLBTC/index.ts

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

package/src/web3Sdk/claimLBTC/claimLBTC.stories.tsx

@@ -0,0 +1,77 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { defaultEnv } from '../../common/const';
+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 { claimLBTC, IClaimLBTCParams } from './claimLBTC';
+
+const meta = {
+  title: 'Web3SDK/claimLBTC',
+  component: StoryView,
+  tags: ['autodocs'],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const WithParams: Story = {
+  args: {
+    proofSignature: '',
+    data: '',
+    env: defaultEnv,
+  },
+};
+
+type ClaimLBTCProps = Pick<IClaimLBTCParams, 'data' | 'env' | 'proofSignature'>;
+
+export function StoryView(props: ClaimLBTCProps) {
+  const {
+    data: connectData,
+    error: connectError,
+    isLoading: isConnectLoading,
+    connect,
+  } = useConnect();
+
+  const request = async () => {
+    if (!connectData) {
+      return;
+    }
+
+    return claimLBTC({ ...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}
+      >
+        Claim LBTC
+      </Button>
+
+      <CodeBlock text={error || data} />
+    </>
+  );
+}

package/src/web3Sdk/claimLBTC/claimLBTC.ts

@@ -0,0 +1,62 @@
+import { IEnvParam } from '../../common/types/internalTypes';
+import { getErrorMessage } from '../../common/utils/getErrorMessage';
+import { IWeb3SendResult, Provider } from '../../provider';
+import { IProviderBasedParams } from '../internalTypes';
+import { getGasMultiplier } from '../utils/getGasMultiplier';
+import { getLbtcTokenContract } from '../utils/getLbtcTokenContract';
+
+const INSUFFICIENT_FUNDS_PARTIAL_ERROR = 'insufficient funds';
+const INSUFFICIENT_FUNDS_ERROR = 'Insufficient funds for transfer';
+
+export interface IClaimLBTCParams extends IProviderBasedParams, IEnvParam {
+  /**
+   * Raw payload from deposit notarization.
+   */
+  data: string;
+  /**
+   * Signature from deposit notarization.
+   */
+  proofSignature: string;
+}
+
+/**
+ * Claims LBTC.
+ *
+ * @param {IClaimLBTCParams} params - The parameters for claiming LBTC.
+ *
+ * @returns {Promise<IWeb3SendResult>} transaction promise
+ */
+export async function claimLBTC({
+  data,
+  proofSignature,
+  env,
+  ...providerParams
+}: IClaimLBTCParams): Promise<IWeb3SendResult> {
+  const provider = new Provider(providerParams);
+  const tokenContract = getLbtcTokenContract(provider, env);
+
+  const tx = tokenContract.methods.mint(data, proofSignature);
+
+  try {
+    const result = await provider.sendTransactionAsync(
+      provider.account,
+      tokenContract.options.address,
+      {
+        data: tx.encodeABI(),
+        estimate: true,
+        estimateFee: true,
+        gasLimitMultiplier: getGasMultiplier(provider.chainId),
+      },
+    );
+
+    return result;
+  } catch (error) {
+    const errorMessage = getErrorMessage(error);
+
+    if (errorMessage.includes(INSUFFICIENT_FUNDS_PARTIAL_ERROR)) {
+      throw new Error(INSUFFICIENT_FUNDS_ERROR);
+    }
+
+    throw new Error(errorMessage);
+  }
+}

package/src/web3Sdk/claimLBTC/index.ts

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

package/src/web3Sdk/index.ts

@@ -0,0 +1,4 @@
+export * from './approveLBTC';
+export * from './claimLBTC';
+export * from './signLbtcDestionationAddr';
+export * from './unstakeLBTC';

package/src/web3Sdk/internalTypes.ts

@@ -0,0 +1,19 @@
+import Web3 from 'web3';
+import { TChainId } from '../common/types/types';
+
+export interface IProviderBasedParams {
+  /**
+   * The web3 instance with write access.
+   *
+   * {@inheritDoc Web3}
+   */
+  web3: Web3;
+  /**
+   * Current chain ID
+   */
+  chainId: TChainId;
+  /**
+   * Current account address
+   */
+  account: string;
+}

package/src/web3Sdk/lbtcAddressConfig.ts

@@ -0,0 +1,16 @@
+import { defaultEnv } from '../common/const';
+import { OChainId, TChainId, TEnv } from '../common/types/types';
+
+type LbtcTokenConfig = Partial<Record<TChainId, string>>;
+
+const testnetConfig: LbtcTokenConfig = {
+  [OChainId.holesky]: '0xED7bfd5C1790576105Af4649817f6d35A75CD818',
+};
+
+const mainnetConfig: LbtcTokenConfig = {
+  [OChainId.ethereum]: '0x8236a87084f8b84306f72007f36f2618a5634494',
+};
+
+export function getLbtcAddressConfig(env: TEnv = defaultEnv): LbtcTokenConfig {
+  return env === 'prod' ? mainnetConfig : testnetConfig;
+}

package/src/web3Sdk/signLbtcDestionationAddr/index.ts

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

package/src/web3Sdk/signLbtcDestionationAddr/signLbtcDestionationAddr.stories.tsx

@@ -0,0 +1,97 @@
+import type { Meta } from '@storybook/react';
+import Web3, { FMT_BYTES, FMT_NUMBER } from 'web3';
+import { OChainId, TChainId } from '../../common/types/types';
+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 { fromCamelCase } from '../../stories/utils/fromCamelCase';
+import { signLbtcDestionationAddr } from './signLbtcDestionationAddr';
+
+const { name } = signLbtcDestionationAddr;
+const nameWithWhitespaces = fromCamelCase(name);
+
+const meta = {
+  title: 'Web3SDK/signLbtcDestionationAddr',
+  component: StoryView,
+  tags: ['autodocs'],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+export function StoryView() {
+  const {
+    data: connectData,
+    error: connectError,
+    isLoading: isConnectLoading,
+    connect,
+  } = useConnect();
+
+  const request = async () => {
+    if (!connectData) {
+      return;
+    }
+
+    return signLbtcDestionationAddr(connectData);
+  };
+
+  const { data, error, isLoading, refetch } = useQuery(request, [], false);
+
+  const formattedConnectData = connectData && {
+    account: connectData.account,
+    chainId: connectData.chainId,
+  };
+
+  return (
+    <>
+      <p>
+        This method is used to get the signature of the Liquid BTC destination
+        address. The signature is used for generating the deposit address.
+      </p>
+
+      <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}
+      >
+        {nameWithWhitespaces}
+      </Button>
+
+      <CodeBlock text={error || data} />
+    </>
+  );
+}
+
+async function getWalletInfo(web3: Web3) {
+  const [account] = await web3.eth.getAccounts();
+
+  if (!account) {
+    throw new Error('No account found');
+  }
+
+  const chainId = await web3.eth.getChainId({
+    bytes: FMT_BYTES.HEX,
+    number: FMT_NUMBER.NUMBER,
+  });
+
+  return {
+    account,
+    chainId,
+  };
+}
+
+function isValidChain(chainId: number): chainId is TChainId {
+  return Object.values(OChainId).includes(chainId as TChainId);
+}

package/src/web3Sdk/signLbtcDestionationAddr/signLbtcDestionationAddr.ts

@@ -0,0 +1,25 @@
+import { Provider } from '../../provider';
+import { IProviderBasedParams } from '../internalTypes';
+
+export type SignLbtcDestionationAddrParams = IProviderBasedParams;
+
+/**
+ * Signs the destination address for the LBTC in active chain
+ * in the current account. Signing is necessary for the
+ * generation of the deposit address.
+ *
+ * @param {SignLbtcDestionationAddrParams} params - The parameters for signing the destination address.
+ *
+ * @returns {Promise<string>} The signature of the message.
+ */
+export async function signLbtcDestionationAddr({
+  web3,
+  chainId,
+  account,
+}: SignLbtcDestionationAddrParams): Promise<string> {
+  const provider = new Provider({ web3, chainId, account });
+
+  const message = `destination chain id is ${chainId}`;
+
+  return provider.signMessage(message);
+}

package/src/web3Sdk/unstakeLBTC/index.ts

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

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

@@ -0,0 +1,77 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { defaultEnv } from '../../common/const';
+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

@@ -0,0 +1,51 @@
+import { getOutputScript } from '../../btcSdk/utils/getOutputScript';
+import { IEnvParam } from '../../common/types/internalTypes';
+import { toSatoshi } from '../../common/utils/convertSatoshi';
+import { IWeb3SendResult, Provider } from '../../provider';
+import { IProviderBasedParams } from '../internalTypes';
+import { getGasMultiplier } from '../utils/getGasMultiplier';
+import { getLbtcTokenContract } from '../utils/getLbtcTokenContract';
+
+export interface IUnstakeLBTCParams extends IProviderBasedParams, IEnvParam {
+  /**
+   * The BTC address to send the 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);
+
+  const tx = tokenContract.methods.burn(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/getGasMultiplier.ts

@@ -0,0 +1,19 @@
+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:
+      return 1.5;
+    default:
+      return 1.3;
+  }
+}

package/src/web3Sdk/utils/getLbtcTokenContract.ts

@@ -0,0 +1,28 @@
+import { TChainId, TEnv } from '../../common/types/types';
+import { Provider } from '../../provider';
+import { getLbtcAddressConfig } from '../lbtcAddressConfig';
+import { getTokenABI } from './getTokenABI';
+
+export function getLbtcTokenContract(provider: Provider, env?: TEnv) {
+  const lbtcAddressConfig = getLbtcAddressConfig(env);
+
+  const tokenAddress = lbtcAddressConfig[provider.chainId as TChainId];
+
+  if (!tokenAddress) {
+    throw new Error(
+      `Token address for chain ${provider.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/getTokenABI.ts

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