@lombard.finance/sdk 2.0.7 → 2.0.9

package/src/sdk/storeStakeAndBakeSignature/storeStakeAndBakeSignature.stories.tsx

@@ -0,0 +1,185 @@
+import { FormControl, InputLabel, MenuItem, Select, TextField } from '@mui/material';
+import type { Meta } from '@storybook/react';
+import { useEffect, useState } from 'react';
+import { OChainId } 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 { VAULT_CONTRACTS } from '../../web3Sdk/signStakeAndBake/contracts';
+import { signStakeAndBake } from '../../web3Sdk/signStakeAndBake/signStakeAndBake';
+
+const EXPIRY_OPTIONS = {
+  '10 seconds': 10,
+  '1 minute': 60,
+  '1 hour': 3600,
+  '1 day': 86400,
+  '1 year': 31536000,
+} as const;
+
+type ExpiryOption = keyof typeof EXPIRY_OPTIONS;
+
+const AVAILABLE_CHAINS = Object.keys(VAULT_CONTRACTS).map(Number);
+
+const meta = {
+  title: 'SDK/storeStakeAndBakeSignature',
+  component: StoryView,
+  tags: ['autodocs'],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+export function StoryView() {
+  const [selectedExpiry, setSelectedExpiry] =
+    useState<ExpiryOption>('10 seconds');
+  const [selectedChain, setSelectedChain] = useState(OChainId.holesky);
+  const [spender, setSpender] = useState(VAULT_CONTRACTS[OChainId.holesky].SPENDER);
+  const [verifyingContract, setVerifyingContract] = useState(
+    VAULT_CONTRACTS[OChainId.holesky].VERIFYING_CONTRACT,
+  );
+
+  const {
+    data: connectData,
+    error: connectError,
+    isLoading: isConnectLoading,
+    connect,
+  } = useConnect();
+
+  useEffect(() => {
+    const contracts = VAULT_CONTRACTS[selectedChain];
+    setSpender(contracts.SPENDER);
+    setVerifyingContract(contracts.VERIFYING_CONTRACT);
+  }, [selectedChain]);
+
+  const request = async () => {
+    if (!connectData || !connectData.provider) {
+      return;
+    }
+
+    const expiry =
+      Math.floor(Date.now() / 1000) + EXPIRY_OPTIONS[selectedExpiry];
+
+    return signStakeAndBake({
+      provider: connectData.provider,
+      address: connectData.account,
+      chainId: selectedChain,
+      value: '1999',
+      expiry,
+      spender,
+      verifyingContract,
+    });
+  };
+
+  const { data, error, isLoading, refetch } = useQuery(
+    request,
+    [selectedExpiry, selectedChain, spender, verifyingContract],
+    false,
+  );
+
+  const formattedConnectData = connectData && {
+    account: connectData.account,
+    chainId: connectData.chainId,
+  };
+
+  return (
+    <>
+      <p>
+        This method stores the stake and bake signature in the backend. The
+        signature is used to approve spending of tokens.
+      </p>
+
+      <div className="mb-4">
+        <Button
+          onClick={connect}
+          disabled={isConnectLoading}
+          isLoading={isConnectLoading}
+        >
+          Connect
+        </Button>
+
+        <CodeBlock text={connectError || formattedConnectData} />
+      </div>
+
+      <div className="mb-4">
+        <FormControl fullWidth>
+          <InputLabel id="chain-select-label">Chain</InputLabel>
+          <Select
+            labelId="chain-select-label"
+            value={selectedChain}
+            label="Chain"
+            onChange={e =>
+              setSelectedChain(Number(e.target.value) as typeof selectedChain)
+            }
+          >
+            {AVAILABLE_CHAINS.map(chainId => (
+              <MenuItem key={chainId} value={chainId}>
+                {chainId} Holesky
+              </MenuItem>
+            ))}
+          </Select>
+        </FormControl>
+      </div>
+
+      <div className="mb-4">
+        <FormControl fullWidth>
+          <TextField
+            label="Spender Address"
+            value={spender}
+            onChange={e => setSpender(e.target.value)}
+            helperText="The address that will be authorized to spend tokens"
+          />
+        </FormControl>
+      </div>
+
+      <div className="mb-4">
+        <FormControl fullWidth>
+          <TextField
+            label="Verifying Contract"
+            value={verifyingContract}
+            onChange={e => setVerifyingContract(e.target.value)}
+            helperText="The contract that will verify the signature"
+          />
+        </FormControl>
+      </div>
+
+      <div className="mb-4">
+        <FormControl fullWidth>
+          <InputLabel id="expiry-select-label">Expiry Time</InputLabel>
+          <Select
+            labelId="expiry-select-label"
+            value={selectedExpiry}
+            label="Expiry Time"
+            onChange={e => setSelectedExpiry(e.target.value as ExpiryOption)}
+          >
+            {Object.keys(EXPIRY_OPTIONS).map(option => (
+              <MenuItem key={option} value={option}>
+                {option}
+              </MenuItem>
+            ))}
+          </Select>
+        </FormControl>
+      </div>
+
+      <Button
+        onClick={refetch}
+        disabled={
+          isLoading || !connectData || connectData.chainId !== selectedChain
+        }
+        isLoading={isLoading}
+      >
+        Store Stake and Bake Signature
+      </Button>
+
+      <CodeBlock
+        text={
+          error ||
+          (data && {
+            ...data,
+            signature: data.signature,
+            typedData: data.typedData ? JSON.parse(data.typedData) : '',
+          })
+        }
+      />
+    </>
+  );
+}

package/src/sdk/storeStakeAndBakeSignature/storeStakeAndBakeSignature.ts

@@ -0,0 +1,56 @@
+import axios from 'axios';
+import { IEnvParam } from '../../common/types/internalTypes';
+import { getErrorMessage } from '../../common/utils/getErrorMessage';
+import { getApiConfig } from '../apiConfig';
+
+export type IStoreStakeAndBakeSignatureStatus = 'success';
+
+interface IStoreStakeAndBakeSignatureResponse {
+  status: IStoreStakeAndBakeSignatureStatus;
+}
+
+export interface IStoreStakeAndBakeSignatureParams extends IEnvParam {
+  /**
+   * signature
+   */
+  signature: string;
+  /**
+   * JSON typed data used for the signature
+   */
+  typedData: string;
+}
+
+/**
+ * Store stake and bake signature
+ *
+ * @param {IStoreStakeAndBakeSignatureParams} params - The parameters for storing stake and bake signature
+ *
+ * @returns {Promise<IStoreStakeAndBakeSignatureStatus>} Response promise with status
+ *
+ */
+export async function storeStakeAndBakeSignature({
+  signature,
+  typedData,
+  env,
+}: IStoreStakeAndBakeSignatureParams): Promise<IStoreStakeAndBakeSignatureStatus> {
+  const { baseApiUrl } = getApiConfig(env);
+
+  try {
+    const { data } = await axios.post<IStoreStakeAndBakeSignatureResponse>(
+      `${baseApiUrl}/api/v1/claimer/save-stake-and-bake-signature`,
+      null,
+      {
+        params: {
+          typed_data: typedData,
+          signature,
+        },
+      },
+    );
+
+    return data.status;
+  } catch (error) {
+    const errorMsg = getErrorMessage(error);
+
+    throw new Error(errorMsg);
+  }
+}

package/src/web3Sdk/getLBTCMintingFee/getLBTCMintingFee.stories.tsx

@@ -16,9 +16,9 @@ export default meta;
 
 type Story = StoryObj<typeof meta>;
 
-export const Sepolia: Story = {
+export const Holesky: Story = {
   args: {
-    chainId: OChainId.sepolia,
+    chainId: OChainId.holesky,
     bakeGasEstimate: 77,
   },
 };

package/src/web3Sdk/index.ts

@@ -1,15 +1,6 @@
-export * from '../sdk/getNetworkFeeSignature';
-export * from '../sdk/storeNetworkFeeSignature';
-export * from './approveLBTC';
-export * from './claimLBTC';
-export * from './getBasculeDepositStatus';
 export * from './getLBTCMintingFee';
-export * from './getLBTCTotalSupply';
-export * from './getPermitNonce';
-export * from './lbtcAddressConfig';
-export * from './lbtcOFTAdapterAddressConfig';
 export * from './signLbtcDestionationAddr';
 export * from './signNetworkFee';
-export * from './types';
-export * from './unstakeLBTC';
+export * from './signStakeAndBake';
+export * from './signStakeAndBake/config';
 

package/src/web3Sdk/signStakeAndBake/config.ts

@@ -0,0 +1,13 @@
+import { OChainId, TChainId } from '../../common/types/types';
+
+export const STAKE_AND_BAKE_SPENDER_ADDRESSES: Record<number, string> = {
+  [OChainId.holesky]: '0x52BD640617eeD47A00dA0da93351092D49208d1d',
+};
+
+export const getStakeAndBakeSpenderAddress = (chainId: TChainId): string => {
+  const address = STAKE_AND_BAKE_SPENDER_ADDRESSES[chainId];
+  if (!address) {
+    throw new Error(`No spender address configured for chain ID ${chainId}`);
+  }
+  return address;
+};

package/src/web3Sdk/signStakeAndBake/contracts.ts

@@ -0,0 +1,13 @@
+import { OChainId } from '../../common/types/types';
+
+interface IVaultContracts {
+  SPENDER: string;
+  VERIFYING_CONTRACT: string;
+}
+
+export const VAULT_CONTRACTS: Record<number, IVaultContracts> = {
+  [OChainId.holesky]: {
+    SPENDER: '0x52BD640617eeD47A00dA0da93351092D49208d1d',
+    VERIFYING_CONTRACT: '0xED7bfd5C1790576105Af4649817f6d35A75CD818',
+  },
+} as const;

package/src/web3Sdk/signStakeAndBake/getTypedData.ts

@@ -0,0 +1,78 @@
+import { TChainId } from '../../common/types/types';
+import { getPermitNonce } from '../getPermitNonce';
+
+export interface IStakeAndBakeTypedData {
+  chainId: TChainId;
+  expiry: number;
+  owner: string;
+  spender: string;
+  value: string;
+  rpcUrl?: string;
+  verifyingContract: string;
+}
+
+/**
+ * Generates EIP-712 typed data for stake and bake signature
+ *
+ * @param {IStakeAndBakeTypedData} params - Parameters for generating typed data
+ * @returns {object} The typed data object conforming to EIP-712
+ */
+export async function getStakeAndBakeTypedData({
+  chainId,
+  expiry,
+  owner,
+  spender,
+  value,
+  rpcUrl,
+  verifyingContract,
+}: IStakeAndBakeTypedData) {
+  const nonce = await getPermitNonce({
+    owner,
+    chainId,
+    rpcUrl,
+  });
+
+  return {
+    domain: {
+      name: 'Lombard Staked Bitcoin',
+      version: '1',
+      chainId,
+      verifyingContract,
+    },
+    types: {
+      EIP712Domain: [
+        {
+          name: 'name',
+          type: 'string',
+        },
+        {
+          name: 'version',
+          type: 'string',
+        },
+        {
+          name: 'chainId',
+          type: 'uint256',
+        },
+        {
+          name: 'verifyingContract',
+          type: 'address',
+        },
+      ],
+      Permit: [
+        { name: 'owner', type: 'address' },
+        { name: 'spender', type: 'address' },
+        { name: 'value', type: 'uint256' },
+        { name: 'nonce', type: 'uint256' },
+        { name: 'deadline', type: 'uint256' },
+      ],
+    },
+    primaryType: 'Permit',
+    message: {
+      owner,
+      spender,
+      value,
+      nonce,
+      deadline: expiry.toString(),
+    },
+  };
+}

package/src/web3Sdk/signStakeAndBake/index.ts

@@ -0,0 +1,2 @@
+export * from './getTypedData';
+export * from './signStakeAndBake';

package/src/web3Sdk/signStakeAndBake/signStakeAndBake.stories.tsx

@@ -0,0 +1,197 @@
+import {
+  FormControl,
+  InputLabel,
+  MenuItem,
+  Select,
+  TextField,
+} from '@mui/material';
+import type { Meta } from '@storybook/react';
+import { useEffect, useState } from 'react';
+import { OChainId } 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 { VAULT_CONTRACTS } from './contracts';
+import { signStakeAndBake } from './signStakeAndBake';
+
+const { name } = signStakeAndBake;
+const nameWithWhitespaces = fromCamelCase(name);
+
+const EXPIRY_OPTIONS = {
+  '10 seconds': 10,
+  '1 minute': 60,
+  '1 hour': 3600,
+  '1 day': 86400,
+  '1 year': 31536000,
+} as const;
+
+type ExpiryOption = keyof typeof EXPIRY_OPTIONS;
+
+const AVAILABLE_CHAINS = Object.keys(VAULT_CONTRACTS).map(Number);
+
+const meta = {
+  title: 'Web3SDK/signStakeAndBake',
+  component: StoryView,
+  tags: ['autodocs'],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+export function StoryView() {
+  const [selectedExpiry, setSelectedExpiry] =
+    useState<ExpiryOption>('10 seconds');
+  const [selectedChain, setSelectedChain] = useState(OChainId.holesky);
+  const [spender, setSpender] = useState(
+    VAULT_CONTRACTS[OChainId.holesky].SPENDER,
+  );
+  const [verifyingContract, setVerifyingContract] = useState(
+    VAULT_CONTRACTS[OChainId.holesky].VERIFYING_CONTRACT,
+  );
+
+  const {
+    data: connectData,
+    error: connectError,
+    isLoading: isConnectLoading,
+    connect,
+  } = useConnect();
+
+  useEffect(() => {
+    const contracts = VAULT_CONTRACTS[selectedChain];
+    setSpender(contracts.SPENDER);
+    setVerifyingContract(contracts.VERIFYING_CONTRACT);
+  }, [selectedChain]);
+
+  const request = async () => {
+    if (!connectData || !connectData.provider) {
+      return;
+    }
+
+    const expiry =
+      Math.floor(Date.now() / 1000) + EXPIRY_OPTIONS[selectedExpiry];
+
+    return signStakeAndBake({
+      provider: connectData.provider,
+      address: connectData.account,
+      chainId: selectedChain,
+      value: '1999',
+      expiry,
+      spender,
+      verifyingContract,
+    });
+  };
+
+  const { data, error, isLoading, refetch } = useQuery(
+    request,
+    [selectedExpiry, selectedChain, spender, verifyingContract],
+    false,
+  );
+
+  const formattedConnectData = connectData && {
+    account: connectData.account,
+    chainId: connectData.chainId,
+  };
+
+  return (
+    <>
+      <p>
+        This method is used to sign a permit for stake and bake operations. The
+        signature is used to approve spending of tokens.
+      </p>
+
+      <div className="mb-4">
+        <Button
+          onClick={connect}
+          disabled={isConnectLoading}
+          isLoading={isConnectLoading}
+        >
+          Connect
+        </Button>
+
+        <CodeBlock text={connectError || formattedConnectData} />
+      </div>
+
+      <div className="mb-4">
+        <FormControl fullWidth>
+          <InputLabel id="chain-select-label">Chain</InputLabel>
+          <Select
+            labelId="chain-select-label"
+            value={selectedChain}
+            label="Chain"
+            onChange={e =>
+              setSelectedChain(Number(e.target.value) as typeof selectedChain)
+            }
+          >
+            {AVAILABLE_CHAINS.map(chainId => (
+              <MenuItem key={chainId} value={chainId}>
+                {chainId}
+              </MenuItem>
+            ))}
+          </Select>
+        </FormControl>
+      </div>
+
+      <div className="mb-4">
+        <FormControl fullWidth>
+          <TextField
+            label="Spender Address"
+            value={spender}
+            onChange={e => setSpender(e.target.value)}
+            helperText="The address that will be authorized to spend tokens"
+          />
+        </FormControl>
+      </div>
+
+      <div className="mb-4">
+        <FormControl fullWidth>
+          <TextField
+            label="Verifying Contract"
+            value={verifyingContract}
+            onChange={e => setVerifyingContract(e.target.value)}
+            helperText="The contract that will verify the signature"
+          />
+        </FormControl>
+      </div>
+
+      <div className="mb-4">
+        <FormControl fullWidth>
+          <InputLabel id="expiry-select-label">Expiry Time</InputLabel>
+          <Select
+            labelId="expiry-select-label"
+            value={selectedExpiry}
+            label="Expiry Time"
+            onChange={e => setSelectedExpiry(e.target.value as ExpiryOption)}
+          >
+            {Object.keys(EXPIRY_OPTIONS).map(option => (
+              <MenuItem key={option} value={option}>
+                {option}
+              </MenuItem>
+            ))}
+          </Select>
+        </FormControl>
+      </div>
+
+      <Button
+        onClick={refetch}
+        disabled={
+          isLoading || !connectData || connectData.chainId !== selectedChain
+        }
+        isLoading={isLoading}
+      >
+        {nameWithWhitespaces}
+      </Button>
+
+      <CodeBlock
+        text={
+          error ||
+          (data && {
+            ...data,
+            signature: data.signature,
+            typedData: data.typedData ? JSON.parse(data.typedData) : '',
+          })
+        }
+      />
+    </>
+  );
+}

package/src/web3Sdk/signStakeAndBake/signStakeAndBake.ts

@@ -0,0 +1,103 @@
+import { TChainId } from '../../common/types/types';
+import { Provider } from '../../provider';
+import { IProviderBasedParams } from '../types';
+import { getStakeAndBakeTypedData } from './getTypedData';
+
+const NO_SIGNATURE_ERROR =
+  'Failed to obtain a valid signature. The response is undefined or invalid.';
+
+export interface ISignStakeAndBakeParams
+  extends Pick<IProviderBasedParams, 'provider'> {
+  /**
+   * 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 spender address that will be authorized to spend tokens
+   */
+  spender: string;
+  /**
+   * The contract address that will verify the signature
+   */
+  verifyingContract: 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,
+  spender,
+  verifyingContract,
+}: ISignStakeAndBakeParams): Promise<ISignStakeAndBakeResult> {
+  const providerInstance = new Provider({
+    provider,
+    account: address,
+    chainId,
+  });
+
+  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 };
+}