@lombard.finance/sdk 2.1.2 → 2.2.0

package/src/sdk/setReferral/setReferral.ts

@@ -0,0 +1,61 @@
+import axios from 'axios';
+import { IEnvParam } from '../../common/types/internalTypes';
+import { getErrorMessage } from '../../common/utils/getErrorMessage';
+import { getApiConfig } from '../apiConfig';
+
+const URL = 'api/v1/referral-system/referrer/';
+
+interface ISetReferrerResponse {}
+
+export interface ISetReferralParams extends IEnvParam {
+  /**
+   * The destination EVM user address where LBTC will be claimed.
+   */
+  address: string;
+  /**
+   * The signature of the address. The signature is generated by signing the address using EVM wallet.
+   */
+  signature: string;
+  /**
+   * The typed data object used to generate the signature if using a network fee authorization signature.
+   */
+  eip712Data: string;
+  /**
+   * The captcha token.
+   */
+  referrerCode: string;
+}
+
+/**
+ * Set a referral code.
+ *
+ * @param {ISetReferralParams} The parameters for set referral.
+ * @returns {Promise<void>} Nothing.
+ * @exception {Error}
+ */
+export async function setReferral({
+  address,
+  signature,
+  eip712Data,
+  referrerCode,
+  env,
+}: ISetReferralParams): Promise<void> {
+  const { baseApiUrl } = getApiConfig(env);
+
+  const requestParams = {
+    referrer_code: referrerCode,
+    signature,
+    signature_typed_data: eip712Data,
+  };
+
+  try {
+    await axios.post<ISetReferrerResponse>(`${URL}${address}`, requestParams, {
+      baseURL: baseApiUrl,
+    });
+
+    return undefined;
+  } catch (error) {
+    const errorMsg = getErrorMessage(error);
+    throw new Error(errorMsg);
+  }
+}

package/src/sdk/storeNetworkFeeSignature/storeNetworkFeeSignature.stories.tsx

@@ -1,5 +1,4 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { OEnv } from '../../common/types/types';
 import { Button } from '../../stories/components/Button';
 import { CodeBlock } from '../../stories/components/CodeBlock';
 import { useConnect } from '../../stories/hooks/useConnect';
@@ -8,6 +7,7 @@ import {
   IStoreNetworkFeeSignatureParams,
   storeNetworkFeeSignature,
 } from './storeNetworkFeeSignature';
+import { defaultEnv } from '../../common/const';
 
 const meta = {
   title: 'SDK/storeNetworkFeeSignature',
@@ -21,7 +21,7 @@ type Story = StoryObj<typeof meta>;
 
 export const WithParams: Story = {
   args: {
-    env: OEnv.stage,
+    env: defaultEnv,
   },
 };
 

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

@@ -1,5 +1,4 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { OEnv } from '../../common/types/types';
 import { Button } from '../../stories/components/Button';
 import { CodeBlock } from '../../stories/components/CodeBlock';
 import { useConnect } from '../../stories/hooks/useConnect';
@@ -10,6 +9,7 @@ import {
   signStakeAndBake,
 } from '../../web3Sdk/signStakeAndBake/signStakeAndBake';
 import { storeStakeAndBakeSignature } from './storeStakeAndBakeSignature';
+import { defaultEnv } from '../../common/const';
 
 const meta = {
   title: 'SDK/storeStakeAndBakeSignature',
@@ -61,7 +61,7 @@ export function StoryView(props: SignStakeAndBakeParams) {
     await storeStakeAndBakeSignature({
       signature,
       typedData,
-      env: OEnv.stage,
+      env: defaultEnv,
     });
 
     return { signature, typedData };

package/src/web3Sdk/abi/STAKE_AND_BAKE.json

@@ -0,0 +1,15 @@
+[
+  {
+    "inputs": [],
+    "name": "getStakeAndBakeFee",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  }
+]

package/src/web3Sdk/abi/index.ts

@@ -1,5 +1,6 @@
 import IERC20 from './IERC20.json';
 import LBTCABI from './LBTC.json';
 import BASCULE_ABI from './BASCULE.json';
+import STAKE_AND_BAKE from './STAKE_AND_BAKE.json';
 
-export { IERC20, LBTCABI, BASCULE_ABI };
+export { IERC20, LBTCABI, BASCULE_ABI, STAKE_AND_BAKE };

package/src/web3Sdk/basculeAddressConfig.ts

@@ -7,53 +7,72 @@ import { OChainId, OEnv, TChainId, TEnv } from '../common/types/types';
 type BasculeTokenConfig = Record<TChainId, string>;
 
 const stageConfig: BasculeTokenConfig = {
-  [OChainId.holesky]: '0x3a0c40c84b5034ed9a98a9a47a02af2b0885246f',
   [OChainId.ethereum]: PLACEHOLDER_ADDRESS,
+  [OChainId.holesky]: '0x3a0c40c84b5034ed9a98a9a47a02af2b0885246f',
+  [OChainId.sepolia]: PLACEHOLDER_ADDRESS,
 
-  [OChainId.binanceSmartChainTestnet]: PLACEHOLDER_ADDRESS,
   [OChainId.binanceSmartChain]: PLACEHOLDER_ADDRESS,
+  [OChainId.binanceSmartChainTestnet]: PLACEHOLDER_ADDRESS,
 
   [OChainId.base]: PLACEHOLDER_ADDRESS,
   [OChainId.baseSepoliaTestnet]: PLACEHOLDER_ADDRESS,
 
+  [OChainId.berachain]: PLACEHOLDER_ADDRESS,
   [OChainId.berachainBartioTestnet]: PLACEHOLDER_ADDRESS,
-  [OChainId.sepolia]: PLACEHOLDER_ADDRESS,
+
   [OChainId.corn]: PLACEHOLDER_ADDRESS,
 
   [OChainId.swell]: PLACEHOLDER_ADDRESS,
+
+  [OChainId.sonic]: PLACEHOLDER_ADDRESS,
+  [OChainId.morph]: PLACEHOLDER_ADDRESS,
+  [OChainId.morphHolesky]: PLACEHOLDER_ADDRESS,
 };
 
 const testnetConfig: BasculeTokenConfig = {
-  [OChainId.holesky]: '0x3a0c40c84b5034ed9a98a9a47a02af2b0885246f',
   [OChainId.ethereum]: PLACEHOLDER_ADDRESS,
+  [OChainId.holesky]: '0x3a0c40c84b5034ed9a98a9a47a02af2b0885246f',
+  [OChainId.sepolia]: PLACEHOLDER_ADDRESS,
 
-  [OChainId.binanceSmartChainTestnet]: PLACEHOLDER_ADDRESS,
   [OChainId.binanceSmartChain]: PLACEHOLDER_ADDRESS,
+  [OChainId.binanceSmartChainTestnet]: PLACEHOLDER_ADDRESS,
 
   [OChainId.base]: PLACEHOLDER_ADDRESS,
   [OChainId.baseSepoliaTestnet]: PLACEHOLDER_ADDRESS,
 
+  [OChainId.berachain]: PLACEHOLDER_ADDRESS,
   [OChainId.berachainBartioTestnet]: PLACEHOLDER_ADDRESS,
-  [OChainId.sepolia]: PLACEHOLDER_ADDRESS,
+
   [OChainId.corn]: PLACEHOLDER_ADDRESS,
 
   [OChainId.swell]: PLACEHOLDER_ADDRESS,
+
+  [OChainId.sonic]: PLACEHOLDER_ADDRESS,
+  [OChainId.morph]: PLACEHOLDER_ADDRESS,
+  [OChainId.morphHolesky]: PLACEHOLDER_ADDRESS,
 };
 
 const prodConfig: BasculeTokenConfig = {
-  [OChainId.holesky]: PLACEHOLDER_ADDRESS,
   [OChainId.ethereum]: '0xc750eCAC7250E0D18ecE2C7a5F130E3A765dc260',
+  [OChainId.holesky]: PLACEHOLDER_ADDRESS,
+  [OChainId.sepolia]: PLACEHOLDER_ADDRESS,
 
-  [OChainId.binanceSmartChainTestnet]: PLACEHOLDER_ADDRESS,
   [OChainId.binanceSmartChain]: PLACEHOLDER_ADDRESS,
+  [OChainId.binanceSmartChainTestnet]: PLACEHOLDER_ADDRESS,
 
   [OChainId.base]: PLACEHOLDER_ADDRESS,
   [OChainId.baseSepoliaTestnet]: PLACEHOLDER_ADDRESS,
 
+  [OChainId.berachain]: PLACEHOLDER_ADDRESS,
   [OChainId.berachainBartioTestnet]: PLACEHOLDER_ADDRESS,
-  [OChainId.sepolia]: PLACEHOLDER_ADDRESS,
+
   [OChainId.corn]: PLACEHOLDER_ADDRESS,
+
   [OChainId.swell]: PLACEHOLDER_ADDRESS,
+
+  [OChainId.sonic]: PLACEHOLDER_ADDRESS,
+  [OChainId.morph]: PLACEHOLDER_ADDRESS,
+  [OChainId.morphHolesky]: PLACEHOLDER_ADDRESS,
 };
 
 export function getBasculeAddressConfig(

package/src/web3Sdk/getStakeAndBakeFee/getStakeAndBakeFee.stories.tsx

@@ -0,0 +1,64 @@
+import type { Meta, StoryObj } from '@storybook/react';
+
+import { OChainId } from '../../common/types/types';
+import { Button } from '../../stories/components/Button';
+import { CodeBlock } from '../../stories/components/CodeBlock';
+import useQuery from '../../stories/hooks/useQuery';
+import {
+  getStakeAndBakeFee,
+  IGetStakeAndBakeFeeParams,
+} from './getStakeAndBakeFee';
+import BigNumber from 'bignumber.js';
+import { fromSatoshi } from '../../common/utils/convertSatoshi';
+
+const meta = {
+  title: 'Web3SDK/getStakeAndBakeFee',
+  component: StoryView,
+  tags: ['autodocs'],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const WithParams: Story = {
+  args: {
+    chainId: OChainId.binanceSmartChain,
+    rpcUrl: 'https://rpc.ankr.com/bsc',
+    vaultAddress: '0xC8bbF6153D7Ba105f1399D992ebd32B0541996ef',
+  },
+};
+
+type GetStakeAndBakeFeeProps = Pick<
+  IGetStakeAndBakeFeeParams,
+  'chainId' | 'rpcUrl' | 'vaultAddress'
+>;
+
+export function StoryView(props: GetStakeAndBakeFeeProps) {
+  const request = async () => {
+    return getStakeAndBakeFee({
+      ...props,
+    });
+  };
+
+  const { data, error, isLoading, refetch } = useQuery(request, [], false);
+
+  const value = new BigNumber(fromSatoshi(data || 0)).toString();
+
+  return (
+    <div>
+      <Button onClick={refetch} disabled={isLoading} isLoading={isLoading}>
+        Get Stake and Bake Fee
+      </Button>
+
+      <CodeBlock text={error || data?.toString()} />
+
+      {data && (
+        <div className="mt-4 p-4 border rounded">
+          <h3 className="text-lg font-bold mb-2">Fee Details</h3>
+          <p>Stake and Bak Fee: {value} LBTC</p>
+        </div>
+      )}
+    </div>
+  );
+}

package/src/web3Sdk/getStakeAndBakeFee/getStakeAndBakeFee.tsx

@@ -0,0 +1,48 @@
+import { TChainId } from '../../common/types/types';
+import { ReadProvider } from '../../provider/ReadProvider';
+import { getRpcUrlConfigFromChain } from '../utils/getRpcUrlConfigFromChain';
+import { STAKE_AND_BAKE } from '../abi';
+import { getErrorMessage } from '../../common/utils/getErrorMessage';
+
+export interface IGetStakeAndBakeFeeParams {
+  /**
+   * Chain ID
+   */
+  chainId: TChainId;
+  /**
+   * RPC URL
+   */
+  rpcUrl?: string;
+  /**
+   * Vault Address
+   */
+  vaultAddress: string;
+}
+
+/**
+ * Get Stake and bake fee.
+ *
+ * @param chainId - Chain ID
+ * @param rpcUrl - RPC URL (optional)
+ * @param vaultAddress - Vault Address
+ *
+ * @returns Stake and bake fee in satoshis
+ */
+export async function getStakeAndBakeFee({
+  chainId,
+  rpcUrl,
+  vaultAddress,
+}: IGetStakeAndBakeFeeParams): Promise<string> {
+  const rpcUrlConfig = getRpcUrlConfigFromChain(chainId, rpcUrl);
+  const provider = new ReadProvider({ chainId, rpcUrlConfig });
+
+  try {
+    const contract = provider.createContract(STAKE_AND_BAKE, vaultAddress);
+
+    const fee: bigint = await contract.methods.getStakeAndBakeFee().call();
+    return fee.toString();
+  } catch (error) {
+    const errorMessage = getErrorMessage(error);
+    throw new Error(errorMessage);
+  }
+}

package/src/web3Sdk/getStakeAndBakeFee/index.ts

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

package/src/web3Sdk/index.ts

@@ -12,3 +12,4 @@ export * from './types';
 export * from './unstakeLBTC';
 export * from './getBasculeDepositStatus';
 export * from './getLBTCTotalSupply';
+export * from './getStakeAndBakeFee';

package/src/web3Sdk/lbtcAddressConfig.ts

@@ -17,12 +17,17 @@ const stageConfig: LbtcTokenConfig = {
 
   [OChainId.base]: PLACEHOLDER_ADDRESS,
   [OChainId.baseSepoliaTestnet]: '0x731eFa688F3679688cf60A3993b8658138953ED6',
-  
+
+  [OChainId.berachain]: PLACEHOLDER_ADDRESS,
   [OChainId.berachainBartioTestnet]:
     '0xc47e4b3124597FDF8DD07843D4a7052F2eE80C30',
 
   [OChainId.corn]: PLACEHOLDER_ADDRESS,
   [OChainId.swell]: PLACEHOLDER_ADDRESS,
+
+  [OChainId.sonic]: PLACEHOLDER_ADDRESS,
+  [OChainId.morph]: PLACEHOLDER_ADDRESS,
+  [OChainId.morphHolesky]: PLACEHOLDER_ADDRESS,
 };
 
 const testnetConfig: LbtcTokenConfig = {
@@ -36,11 +41,17 @@ const testnetConfig: LbtcTokenConfig = {
 
   [OChainId.base]: PLACEHOLDER_ADDRESS,
   [OChainId.baseSepoliaTestnet]: PLACEHOLDER_ADDRESS,
+
+  [OChainId.berachain]: PLACEHOLDER_ADDRESS,
   [OChainId.berachainBartioTestnet]:
     '0xc47e4b3124597FDF8DD07843D4a7052F2eE80C30',
 
   [OChainId.corn]: PLACEHOLDER_ADDRESS,
   [OChainId.swell]: PLACEHOLDER_ADDRESS,
+
+  [OChainId.sonic]: PLACEHOLDER_ADDRESS,
+  [OChainId.morph]: PLACEHOLDER_ADDRESS,
+  [OChainId.morphHolesky]: PLACEHOLDER_ADDRESS,
 };
 
 const prodConfig: LbtcTokenConfig = {
@@ -54,10 +65,15 @@ const prodConfig: LbtcTokenConfig = {
   [OChainId.base]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
   [OChainId.baseSepoliaTestnet]: PLACEHOLDER_ADDRESS,
 
+  [OChainId.berachain]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
   [OChainId.berachainBartioTestnet]: PLACEHOLDER_ADDRESS,
 
   [OChainId.corn]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
   [OChainId.swell]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
+
+  [OChainId.sonic]: PLACEHOLDER_ADDRESS,
+  [OChainId.morph]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
+  [OChainId.morphHolesky]: PLACEHOLDER_ADDRESS,
 };
 
 export function getLbtcAddressConfig(env: TEnv = defaultEnv): LbtcTokenConfig {

package/src/web3Sdk/signNetworkFee/signNetworkFee.stories.tsx

@@ -1,5 +1,4 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { OEnv } from '../../common/types/types';
 import { Button } from '../../stories/components/Button';
 import { CodeBlock } from '../../stories/components/CodeBlock';
 import { useConnect } from '../../stories/hooks/useConnect';
@@ -7,6 +6,7 @@ import useQuery from '../../stories/hooks/useQuery';
 import { fromCamelCase } from '../../stories/utils/fromCamelCase';
 import { MS_PER_DAY } from '../const';
 import { ISignNetworkFeeParams, signNetworkFee } from './signNetworkFee';
+import { defaultEnv } from '../../common/const';
 
 const { name } = signNetworkFee;
 const nameWithWhitespaces = fromCamelCase(name);
@@ -23,7 +23,7 @@ type Story = StoryObj<typeof meta>;
 
 export const WithParams: Story = {
   args: {
-    env: OEnv.stage,
+    env: defaultEnv,
   },
 };
 

package/src/web3Sdk/signStakeAndBake/contracts.ts

@@ -23,13 +23,13 @@ export const STAKE_AND_BAKE_VAULTS: Record<number, IStakeAndBakeVault[]> = {
       address: '0x4A3cD83CEbb91E0Cd31EdA2Ee0F4AebfcCFCbBb6',
     },
   ],
-  // [OChainId.ethereum]: [
-  //   {
-  //     key: 'veda',
-  //     name: 'Veda / Lombard DeFi Vault',
-  //     address: '0x5401b8620e5fb570064ca9114fd1e135fd77d57c',
-  //   },
-  // ],
+  [OChainId.ethereum]: [
+    {
+      key: 'veda',
+      name: 'Veda / Lombard DeFi Vault',
+      address: '0xC8bbF6153D7Ba105f1399D992ebd32B0541996ef',
+    },
+  ],
   [OChainId.binanceSmartChain]: [
     {
       key: 'veda',
@@ -44,13 +44,6 @@ export const STAKE_AND_BAKE_VAULTS: Record<number, IStakeAndBakeVault[]> = {
       address: '0x72143309A662bDB4aad5cA65Ab59eD8977D047C5',
     },
   ],
-  // [OChainId.base]: [
-  //   {
-  //     key: 'veda',
-  //     name: 'Veda / Lombard DeFi Vault',
-  //     address: '0x5401b8620e5fb570064ca9114fd1e135fd77d57c',
-  //   },
-  // ],
 } as const;
 
 export const SUPPORTED_STAKE_AND_BAKE_CHAINS = Object.keys(