@lombard.finance/sdk 2.0.12 → 2.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lombard.finance/sdk",
-  "version": "2.0.12",
+  "version": "2.0.15",
   "exports": {
     ".": {
       "import": "./dist/index.js",

package/src/sdk/getUserStakeAndBakeSignature/getUserStakeAndBakeSignature.stories.tsx

@@ -2,10 +2,11 @@ import type { Meta, StoryObj } from '@storybook/react';
 import { OChainId, OEnv } 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 {
-    IGetUserStakeAndBakeSignatureParams,
-    getUserStakeAndBakeSignature,
+  IGetUserStakeAndBakeSignatureParams,
+  getUserStakeAndBakeSignature,
 } from './getUserStakeAndBakeSignature';
 
 const meta = {
@@ -21,25 +22,41 @@ type Story = StoryObj<typeof meta>;
 export const WithParams: Story = {
   args: {
     env: OEnv.stage,
-    userDestinationAddress: '0x8C6bF4b04363910443cCc8F3B71B267EC3b96241',
   },
 };
 
 type GetUserStakeAndBakeSignatureProps = Pick<
   IGetUserStakeAndBakeSignatureParams,
-  'env' | 'userDestinationAddress'
+  'env'
 >;
 
 export function StoryView(props: GetUserStakeAndBakeSignatureProps) {
+  const {
+    data: connectData,
+    error: connectError,
+    isLoading: isConnectLoading,
+    connect,
+  } = useConnect();
+
   const request = async () => {
+    if (!connectData?.account) {
+      return;
+    }
+
     return getUserStakeAndBakeSignature({
       ...props,
+      userDestinationAddress: connectData.account,
       chainId: OChainId.holesky,
     });
   };
 
   const { data, error, isLoading, refetch } = useQuery(request, [], false);
 
+  const formattedConnectData = connectData && {
+    account: connectData.account,
+    chainId: connectData.chainId,
+  };
+
   return (
     <>
       <p>
@@ -47,6 +64,18 @@ export function StoryView(props: GetUserStakeAndBakeSignatureProps) {
         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>
+
       <Button onClick={refetch} disabled={isLoading} isLoading={isLoading}>
         Get User Stake and Bake Signature
       </Button>
@@ -54,4 +83,4 @@ export function StoryView(props: GetUserStakeAndBakeSignatureProps) {
       <CodeBlock text={error || data} />
     </>
   );
-}
+}

package/src/sdk/getUserStakeAndBakeSignature/getUserStakeAndBakeSignature.ts

@@ -21,9 +21,17 @@ export interface IGetUserStakeAndBakeSignatureResponse {
    */
   signature: string;
   /**
-   * The typed data used to generate the signature
+   * The expiration date
    */
-  typedData: string;
+  expirationDate: string;
+  /**
+   * The deposit amount
+   */
+  depositAmount: string;
+  /**
+   * The chain ID
+   */
+  chainId: string;
 }
 
 /**

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

@@ -1,13 +1,23 @@
-import { FormControl, InputLabel, MenuItem, Select, TextField } from '@mui/material';
+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 { OChainId, OEnv } 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 {
+  getStakeAndBakeSpenderContract,
+  SUPPORTED_STAKE_AND_BAKE_CHAINS,
+} from '../../web3Sdk/signStakeAndBake/contracts';
 import { signStakeAndBake } from '../../web3Sdk/signStakeAndBake/signStakeAndBake';
+import { storeStakeAndBakeSignature } from './storeStakeAndBakeSignature';
 
 const EXPIRY_OPTIONS = {
   '10 seconds': 10,
@@ -19,8 +29,6 @@ const EXPIRY_OPTIONS = {
 
 type ExpiryOption = keyof typeof EXPIRY_OPTIONS;
 
-const AVAILABLE_CHAINS = Object.keys(VAULT_CONTRACTS).map(Number);
-
 const meta = {
   title: 'SDK/storeStakeAndBakeSignature',
   component: StoryView,
@@ -33,11 +41,15 @@ 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 [spender, setSpender] = useState(
+    getStakeAndBakeSpenderContract(OChainId.holesky),
   );
 
+  useEffect(() => {
+    setSpender(getStakeAndBakeSpenderContract(selectedChain));
+  }, [selectedChain]);
+
   const {
     data: connectData,
     error: connectError,
@@ -45,12 +57,6 @@ export function StoryView() {
     connect,
   } = useConnect();
 
-  useEffect(() => {
-    const contracts = VAULT_CONTRACTS[selectedChain];
-    setSpender(contracts.SPENDER);
-    setVerifyingContract(contracts.VERIFYING_CONTRACT);
-  }, [selectedChain]);
-
   const request = async () => {
     if (!connectData || !connectData.provider) {
       return;
@@ -59,20 +65,32 @@ export function StoryView() {
     const expiry =
       Math.floor(Date.now() / 1000) + EXPIRY_OPTIONS[selectedExpiry];
 
-    return signStakeAndBake({
+    // First sign the authorization
+    const { signature, typedData } = await signStakeAndBake({
       provider: connectData.provider,
       address: connectData.account,
       chainId: selectedChain,
       value: '1999',
       expiry,
       spender,
-      verifyingContract,
     });
+
+    // Then store it
+    await storeStakeAndBakeSignature({
+      signature,
+      typedData,
+      env: OEnv.stage,
+    });
+
+    return {
+      signature,
+      typedData,
+    };
   };
 
   const { data, error, isLoading, refetch } = useQuery(
     request,
-    [selectedExpiry, selectedChain, spender, verifyingContract],
+    [selectedExpiry, selectedChain],
     false,
   );
 
@@ -84,8 +102,8 @@ export function StoryView() {
   return (
     <>
       <p>
-        This method stores the stake and bake signature in the backend. The
-        signature is used to approve spending of tokens.
+        This method signs and stores the stake and bake signature in the
+        backend. The signature is used to approve spending of tokens.
       </p>
 
       <div className="mb-4">
@@ -111,7 +129,7 @@ export function StoryView() {
               setSelectedChain(Number(e.target.value) as typeof selectedChain)
             }
           >
-            {AVAILABLE_CHAINS.map(chainId => (
+            {SUPPORTED_STAKE_AND_BAKE_CHAINS.map(chainId => (
               <MenuItem key={chainId} value={chainId}>
                 {chainId} Holesky
               </MenuItem>
@@ -120,28 +138,6 @@ export function StoryView() {
         </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>
@@ -160,6 +156,17 @@ export function StoryView() {
         </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>
+
       <Button
         onClick={refetch}
         disabled={
@@ -167,7 +174,7 @@ export function StoryView() {
         }
         isLoading={isLoading}
       >
-        Store Stake and Bake Signature
+        Sign and Store Stake and Bake Signature
       </Button>
 
       <CodeBlock

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

@@ -19,27 +19,23 @@ type Story = StoryObj<typeof meta>;
 export const Holesky: Story = {
   args: {
     chainId: OChainId.holesky,
-    bakeGasEstimate: 77,
   },
 };
 
 export const Ethereum: Story = {
   args: {
     chainId: OChainId.ethereum,
-    bakeGasEstimate: 77,
   },
 };
 
 type GetLBTCMintingFeeProps = {
   chainId: TChainId;
-  bakeGasEstimate: number;
 };
 
 export function StoryView(props: GetLBTCMintingFeeProps) {
   const request = async () => {
     return getLBTCMintingFee({
       chainId: props.chainId,
-      bakeGasEstimate: props.bakeGasEstimate,
     });
   };
 
@@ -57,7 +53,6 @@ export function StoryView(props: GetLBTCMintingFeeProps) {
         <div className="mt-4 p-4 border rounded">
           <h3 className="text-lg font-bold mb-2">Fee Details</h3>
           <p>Minting Fee: {data.toString()} BTC</p>
-          <p>Bake Gas Estimate: {props.bakeGasEstimate}</p>
         </div>
       )}
     </div>

package/src/web3Sdk/getLBTCMintingFee/getLBTCMintingFee.tsx

@@ -11,10 +11,6 @@ export interface IGetLBTCMintingFeeParams {
    * Chain ID
    */
   chainId: TChainId;
-  /**
-   * Bake gas estimate
-   */
-  bakeGasEstimate?: number;
   /**
    * RPC URL
    */
@@ -25,14 +21,12 @@ export interface IGetLBTCMintingFeeParams {
  * Get LBTC minting fee.
  *
  * @param chainId - Chain ID
- * @param bakeGasEstimate - Bake gas estimate
- * @param rpcUrl - RPC URL
+ * @param rpcUrl - RPC URL (optional)
  *
  * @returns LBTC minting fee
  */
 export async function getLBTCMintingFee({
   chainId,
-  bakeGasEstimate = 0,
   rpcUrl,
 }: IGetLBTCMintingFeeParams): Promise<BigNumber> {
   const rpcUrlConfig = getRpcUrlConfigFromChain(chainId, rpcUrl);
@@ -42,10 +36,6 @@ export async function getLBTCMintingFee({
 
   const fee: bigint = await tokenContract.methods.getMintFee().call();
   const feeBtc = new BigNumber(fromSatoshi(fee.toString(10)));
-  if (bakeGasEstimate) {
-    const total = feeBtc.plus(fromSatoshi(bakeGasEstimate));
-    return total;
-  }
 
   return feeBtc;
 }

package/src/web3Sdk/signStakeAndBake/config.ts

@@ -1,8 +1,8 @@
 import { TChainId } from '../../common/types/types';
-import { VAULT_CONTRACTS } from './contracts';
+import { STAKE_AND_BAKE_SPENDER_CONTRACTS } from './contracts';
 
 export const getStakeAndBakeSpenderAddress = (chainId: TChainId): string => {
-  const address = VAULT_CONTRACTS[chainId]?.SPENDER;
+  const address = STAKE_AND_BAKE_SPENDER_CONTRACTS[chainId];
   if (!address) {
     throw new Error(`No spender address configured for chain ID ${chainId}`);
   }

package/src/web3Sdk/signStakeAndBake/contracts.ts

@@ -1,13 +1,13 @@
-import { OChainId } from '../../common/types/types';
+import { OChainId, TChainId } 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',
-  },
+export const STAKE_AND_BAKE_SPENDER_CONTRACTS: Record<number, string> = {
+  [OChainId.holesky]: '0x52BD640617eeD47A00dA0da93351092D49208d1d',
 } as const;
+
+export const SUPPORTED_STAKE_AND_BAKE_CHAINS = Object.keys(
+  STAKE_AND_BAKE_SPENDER_CONTRACTS,
+).map(Number);
+
+export const getStakeAndBakeSpenderContract = (chainId: TChainId): string => {
+  return STAKE_AND_BAKE_SPENDER_CONTRACTS[chainId];
+};

package/src/web3Sdk/signStakeAndBake/index.ts

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

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

@@ -13,7 +13,10 @@ 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 {
+  getStakeAndBakeSpenderContract,
+  SUPPORTED_STAKE_AND_BAKE_CHAINS,
+} from './contracts';
 import { signStakeAndBake } from './signStakeAndBake';
 
 const { name } = signStakeAndBake;
@@ -29,8 +32,6 @@ const EXPIRY_OPTIONS = {
 
 type ExpiryOption = keyof typeof EXPIRY_OPTIONS;
 
-const AVAILABLE_CHAINS = Object.keys(VAULT_CONTRACTS).map(Number);
-
 const meta = {
   title: 'Web3SDK/signStakeAndBake',
   component: StoryView,
@@ -44,10 +45,7 @@ export function StoryView() {
     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,
+    getStakeAndBakeSpenderContract(OChainId.holesky),
   );
 
   const {
@@ -58,9 +56,7 @@ export function StoryView() {
   } = useConnect();
 
   useEffect(() => {
-    const contracts = VAULT_CONTRACTS[selectedChain];
-    setSpender(contracts.SPENDER);
-    setVerifyingContract(contracts.VERIFYING_CONTRACT);
+    setSpender(getStakeAndBakeSpenderContract(selectedChain));
   }, [selectedChain]);
 
   const request = async () => {
@@ -78,13 +74,12 @@ export function StoryView() {
       value: '1999',
       expiry,
       spender,
-      verifyingContract,
     });
   };
 
   const { data, error, isLoading, refetch } = useQuery(
     request,
-    [selectedExpiry, selectedChain, spender, verifyingContract],
+    [selectedExpiry, selectedChain, spender],
     false,
   );
 
@@ -123,7 +118,7 @@ export function StoryView() {
               setSelectedChain(Number(e.target.value) as typeof selectedChain)
             }
           >
-            {AVAILABLE_CHAINS.map(chainId => (
+            {SUPPORTED_STAKE_AND_BAKE_CHAINS.map(chainId => (
               <MenuItem key={chainId} value={chainId}>
                 {chainId}
               </MenuItem>
@@ -143,17 +138,6 @@ export function StoryView() {
         </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>

package/src/web3Sdk/signStakeAndBake/signStakeAndBake.ts

@@ -2,6 +2,7 @@ import { TChainId } from '../../common/types/types';
 import { Provider } from '../../provider';
 import { IProviderBasedParams } from '../types';
 import { getStakeAndBakeTypedData } from './getTypedData';
+import { getVerifyingContract } from './utils';
 
 const NO_SIGNATURE_ERROR =
   'Failed to obtain a valid signature. The response is undefined or invalid.';
@@ -32,10 +33,6 @@ export interface ISignStakeAndBakeParams
    * 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 {
@@ -63,7 +60,6 @@ export async function signStakeAndBake({
   expiry,
   rpcUrl,
   spender,
-  verifyingContract,
 }: ISignStakeAndBakeParams): Promise<ISignStakeAndBakeResult> {
   const providerInstance = new Provider({
     provider,
@@ -71,6 +67,8 @@ export async function signStakeAndBake({
     chainId,
   });
 
+  const verifyingContract = getVerifyingContract(chainId);
+
   const typedDataObject = await getStakeAndBakeTypedData({
     chainId,
     expiry,

package/src/web3Sdk/signStakeAndBake/utils.ts

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