@lombard.finance/sdk 3.5.10 → 3.6.0

package/package.json

@@ -1,9 +1,13 @@
 {
+  "name": "@lombard.finance/sdk",
+  "version": "3.6.0",
   "dependencies": {
     "@lombard.finance/sdk-common": "^3.0.0",
-    "viem": "^2.23.15"
+    "viem": "^2.23.15",
+    "vite": "^6.3.5"
   },
   "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
     "@chromatic-com/storybook": "1.6.1",
     "@storybook/addon-essentials": "^8.2.9",
     "@storybook/addon-interactions": "^8.2.9",
@@ -40,7 +44,6 @@
     "src"
   ],
   "license": "MIT",
-  "name": "@lombard.finance/sdk",
   "peerDependencies": {
     "@layerzerolabs/lz-v2-utilities": "3.0.17",
     "axios": "^1",
@@ -58,6 +61,5 @@
     "watch": "vite build --watch"
   },
   "type": "module",
-  "types": "./src/index.ts",
-  "version": "3.5.10"
+  "types": "./src/index.ts"
 }

package/src/api-functions/generateDepositBtcAddress/generateDepositBtcAddress.stories.tsx

@@ -20,7 +20,7 @@ const meta = {
   decorators: [functionType('api-post')],
   argTypes: {
     ...chainSelector,
-    ...makeTokenSelector([Token.LBTC, Token.BTCK]),
+    ...makeTokenSelector([Token.LBTC, Token.BTCK, Token.NativeLBTC]),
   },
 } satisfies Meta<typeof StoryView>;
 

package/src/api-functions/generateDepositBtcAddress/generateDepositBtcAddress.ts

@@ -63,8 +63,8 @@ export interface IGenerateDepositBtcAddressParams extends IEnvParam {
   signatureData?: string;
 }
 
-const EXTRA_PARAMS_TOKENS = [Token.LBTC, Token.BTCK];
-const SUPPORTED_TOKENS = [Token.LBTC, Token.BTCK];
+const EXTRA_PARAMS_TOKENS = [Token.LBTC, Token.BTCK, Token.NativeLBTC];
+const SUPPORTED_TOKENS = [Token.LBTC, Token.BTCK, Token.NativeLBTC];
 
 /**
  * Generates a BTC deposit address.

package/src/api-functions/getDepositBtcAddress/getDepositBtcAddress.stories.tsx

@@ -20,7 +20,7 @@ const meta = {
   decorators: [functionType('api-get')],
   argTypes: {
     ...chainSelector,
-    ...makeTokenSelector([Token.LBTC, Token.BTCK]),
+    ...makeTokenSelector([Token.LBTC, Token.BTCK, Token.NativeLBTC]),
   },
 } satisfies Meta<typeof StoryView>;
 

package/src/api-functions/getDepositBtcAddress/getDepositBtcAddress.ts

@@ -4,7 +4,12 @@ import {
   BlockchainIdentifier,
   getChainNameById,
 } from '../../common/blockchain-identifier';
-import { ChainId, SolanaChain, SuiChain } from '../../common/chains';
+import {
+  ChainId,
+  isValidChain,
+  SolanaChain,
+  SuiChain,
+} from '../../common/chains';
 import { IEnvParam } from '../../common/parameters';
 import { Token } from '../../tokens/token-addresses';
 import { getTokenContractInfo } from '../../tokens/tokens';
@@ -176,7 +181,7 @@ export async function getDepositBtcAddress({
 
   let depositAddress: string | undefined = undefined;
 
-  if (![Token.LBTC, Token.BTCK].includes(token)) {
+  if (![Token.LBTC, Token.BTCK, Token.NativeLBTC].includes(token)) {
     throw new Error('Unsupported token');
   }
 
@@ -185,19 +190,13 @@ export async function getDepositBtcAddress({
     | { token_address: string; aux_version?: number }
     | undefined = undefined;
   try {
-    if (chainId === ChainId.katana || chainId === ChainId.katanaTatara) {
+    if (isValidChain(chainId)) {
       const tokenContractInfo = getTokenContractInfo(token, chainId, env);
 
-      if (token === Token.BTCK) {
-        tokenAddressFilter = {
-          token_address: tokenContractInfo.address.toLowerCase(),
-          aux_version: 1,
-        };
-      } else {
-        tokenAddressFilter = {
-          token_address: tokenContractInfo.address.toLowerCase(),
-        };
-      }
+      tokenAddressFilter = {
+        token_address: tokenContractInfo.address.toLowerCase(),
+        aux_version: token === Token.BTCK ? 1 : undefined,
+      };
     }
   } catch {
     // NOOP

package/src/bridge/index.ts

@@ -5,7 +5,13 @@ export { bridge, type BridgeParameters } from './lib/bridge';
 export { bridgeCCIP, type BridgeCCIPParameters } from './lib/ccip-bridge';
 
 /** OFT bridge func */
-export { bridgeOFT, type BridgeOFTParameters } from './lib/oft-bridge';
+export { bridgeOFT, type BridgeOFTParameters, } from './lib/oft-bridge';
 
 /** Utils */
-export { getBridgeInfo } from './lib/config';
+export {
+  getBridgeInfo,
+  OFT_HI_GAS_LIMIT_CHAINS,
+  OFT_GAS_LIMIT,
+  OFT_HI_GAS_LIMIT,
+} from './lib/config';
+

package/src/bridge/lib/config.ts

@@ -43,6 +43,7 @@ export const OFT_BRIDGE_CHAINS = [
   ChainId.corn,
   ChainId.etherlink,
   ChainId.swell,
+  ChainId.tac,
   // Testnets:
   ChainId.berachainBartioTestnet,
   ChainId.sepolia,
@@ -60,8 +61,13 @@ export const OFT_HI_GAS_LIMIT_CHAINS = [
   // Mainnets:
   ChainId.berachain,
   ChainId.etherlink,
+  ChainId.morph,
+  ChainId.sonic,
+  ChainId.corn,
+  ChainId.tac,
   // Testnets:
   ChainId.berachainBartioTestnet,
+  ChainId.morphHolesky,
 ];
 
 export type OFTBridgeChain = (typeof OFT_BRIDGE_CHAINS)[number];
@@ -266,6 +272,17 @@ const OFT_BRIDGES: OFTBridgeConfig[] = [
       },
     },
   ],
+  [
+    bridgeIdentifier([ChainId.ethereum, ChainId.tac]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0xA7c4d94F98b6e94C139c4645e4E9a94CD7C0Abf7',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.ethereum,
+      },
+    },
+  ],
 
   [
     bridgeIdentifier([ChainId.berachain, ChainId.ethereum]),
@@ -314,6 +331,17 @@ const OFT_BRIDGES: OFTBridgeConfig[] = [
       },
     },
   ],
+  [
+    bridgeIdentifier([ChainId.tac, ChainId.ethereum]),
+    {
+      type: BridgeType.OFT,
+      contract: {
+        address: '0x1298131cDa718bBcA7ACB1f2411e71c05E16f269',
+        abi: OFT_BRIDGE_ADAPTER_ABI as Abi,
+        chainId: ChainId.tac,
+      },
+    },
+  ],
 
   // Testnets:
 

package/src/bridge/lib/oft-bridge.ts

@@ -32,6 +32,7 @@ const DESTINATION_ENDPOINT_ID_MAP: Record<OFTBridgeChain, number> = {
   [ChainId.corn]: 30331,
   [ChainId.etherlink]: 30292,
   [ChainId.swell]: 30335,
+  [ChainId.tac]: 30377,
   // Testnets:
   [ChainId.sepolia]: 40161,
   [ChainId.berachainBartioTestnet]: 40291,

package/src/clients/rpc-url-config.ts

@@ -4,7 +4,7 @@ import { getApiConfig } from '../common/api-config';
 
 export type TRpcUrlConfig = Record<number, string>;
 
-export const RPC_URL = 'https://bff.prod.lombard.finance/multi-rpc/proxy';
+export const RPC_URL = 'https://bff.prod.lombard-fi.com/multi-rpc/proxy';
 // export const RPC_URL = 'http://localhost:8001/multi-rpc/proxy';
 
 export const rpcUrlConfig: TRpcUrlConfig = {
@@ -14,6 +14,7 @@ export const rpcUrlConfig: TRpcUrlConfig = {
   [ChainId.corn]: `${RPC_URL}/corn_maizenet`,
   [ChainId.katana]: `${RPC_URL}/katana`,
   [ChainId.sonic]: `${RPC_URL}/sonic_mainnet`,
+  [ChainId.tac]: `${RPC_URL}/tac`,
   // Testnets:
   [ChainId.baseSepoliaTestnet]: `${RPC_URL}/base_sepolia`,
   [ChainId.binanceSmartChainTestnet]:
@@ -36,6 +37,7 @@ export function getRpcUrlConfig(env: Env) {
     [ChainId.corn]: `${proxy}/corn_maizenet`,
     [ChainId.katana]: `${proxy}/katana`,
     [ChainId.sonic]: `${proxy}/sonic_mainnet`,
+    [ChainId.tac]: `${proxy}/tac`,
     // Testnets:
     [ChainId.baseSepoliaTestnet]: `${proxy}/base_sepolia`,
     [ChainId.binanceSmartChainTestnet]:

package/src/common/api-config.ts

@@ -7,23 +7,23 @@ interface IApiConfig {
 
 const stageConfig: IApiConfig = {
   baseApiUrl: 'https://staging.prod.lombard.finance',
-  bffApiUrl: 'https://bff.stage.lombard.finance',
+  bffApiUrl: 'https://bff.stage.lombard-fi.com',
 };
 
 const testnetConfig: IApiConfig = {
   baseApiUrl: 'https://gastald-testnet.prod.lombard.finance',
-  bffApiUrl: 'https://bff.stage.lombard.finance',
+  bffApiUrl: 'https://bff.stage.lombard-fi.com',
 };
 
 const prodConfig: IApiConfig = {
   baseApiUrl: 'https://mainnet.prod.lombard.finance',
-  bffApiUrl: 'https://bff.prod.lombard.finance',
+  bffApiUrl: 'https://bff.prod.lombard-fi.com',
 };
 
 const devConfig: IApiConfig = {
   baseApiUrl: 'https://bft-dev.stage.lombard.finance',
   // Note, bff on localhost works on 8001
-  bffApiUrl: 'https://bff.stage.lombard.finance',
+  bffApiUrl: 'https://bff.stage.lombard-fi.com',
 };
 
 export const getApiConfig = (env: Env = DEFAULT_ENV): IApiConfig => {

package/src/common/chains.ts

@@ -74,6 +74,25 @@ export const katanaTatara = defineChain({
   },
 });
 
+// FIXME: Remove this custom chain definition once TAC is supported by viem
+export const tac = defineChain({
+  id: 239,
+  name: 'TAC',
+  nativeCurrency: {
+    decimals: 18,
+    name: 'TAC',
+    symbol: 'TAC',
+  },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc.tac.build'],
+    },
+  },
+  blockExplorers: {
+    default: { name: 'TAC Explorer', url: 'https://explorer.tac.build' },
+  },
+});
+
 export const SUI_DEVNET_CHAIN = 'sui:devnet' as const;
 export const SUI_TESTNET_CHAIN = 'sui:testnet' as const;
 export const SUI_LOCALNET_CHAIN = 'sui:localnet' as const;
@@ -105,6 +124,7 @@ export const ChainId = {
   morph: 2818,
   sonic: 146,
   swell: 1923,
+  tac: 239,
   // Testnets:
   baseSepoliaTestnet: 84532,
   berachainBartioTestnet: 80084,
@@ -129,6 +149,7 @@ export const CHAIN_ID_TO_VIEM_CHAIN_MAP = {
   [ChainId.morph]: morph,
   [ChainId.sonic]: sonic,
   [ChainId.swell]: swellchain,
+  [ChainId.tac]: tac,
   // Testnets:
   [ChainId.baseSepoliaTestnet]: baseSepolia,
   [ChainId.berachainBartioTestnet]: berachainTestnetbArtio,
@@ -147,7 +168,7 @@ export const isKatanaChain = (chainId: unknown): chainId is KatanaChain => {
   );
 };
 
-export function isValidChain(chainId: number): chainId is ChainId {
+export function isValidChain(chainId: unknown): chainId is ChainId {
   return Object.values(ChainId).includes(chainId as ChainId);
 }
 

package/src/contract-functions/claimLBTC/claimLBTC.stories.tsx

@@ -22,7 +22,7 @@ const meta = {
   tags: ['autodocs'],
   decorators: [wagmiDecorator, functionType('write')],
   argTypes: {
-    ...makeTokenSelector([Token.LBTC, Token.BTCK]),
+    ...makeTokenSelector([Token.LBTC, Token.BTCK, Token.NativeLBTC]),
   },
 } satisfies Meta<typeof StoryView>;
 

package/src/contract-functions/claimLBTC/claimLBTC.ts

@@ -68,7 +68,7 @@ export async function mintToken({
   env,
   token = Token.LBTC,
 }: IClaimLBTCParams & { token?: Token }) {
-  if (![Token.LBTC, Token.BTCK].includes(token)) {
+  if (![Token.LBTC, Token.BTCK, Token.NativeLBTC].includes(token)) {
     throw new Error('Unsupported token');
   }
 
@@ -109,7 +109,8 @@ export async function mintToken({
     account,
     chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
     abi: tokenContract.abi,
-    functionName: token === Token.BTCK ? 'mintV1' : 'mint', // FIXME: mintV1 is the equivalent on Native LBTC contract of mint on LBTC contract, change if contract ABI changes.
+    functionName:
+      token === Token.BTCK || token === Token.NativeLBTC ? 'mintV1' : 'mint', // FIXME: mintV1 is the equivalent on Native LBTC contract of mint on LBTC contract, change if contract ABI changes.
     args: [ensureHex(data), ensureHex(proofSignature)],
   } as const;
 

package/src/contract-functions/getLBTCMintingFee/getLBTCMintingFee.tsx

@@ -3,8 +3,9 @@ import { CommonParameters } from '../../common/parameters';
 import { determineEnv } from '../../utils/env';
 import { fromSatoshi } from '../../utils/satoshi';
 import { makePublicClient } from '../../clients/public-client';
-import { getTokenContractInfo } from '../../tokens/tokens';
+import { getTokenContractInfo, isSTLBTCAbi } from '../../tokens/tokens';
 import { Token } from '../../tokens/token-addresses';
+import ASSET_ROUTER_ABI from '../../tokens/abi/ASSET_ROUTER_ABI';
 
 /**
  * Gets LBTC minting fee amount.
@@ -24,7 +25,7 @@ export async function getLBTCMintingFee(
 
 /** Gets LBTC burn commission (fee) amount. */
 export async function getLBTCBurningFee(props: CommonParameters) {
-  return getBurningFee({ token: Token.LBTC, ...props });
+  return getRedeemFee({ token: Token.LBTC, ...props });
 }
 
 export async function getMintingFee({
@@ -33,44 +34,110 @@ export async function getMintingFee({
   rpcUrl,
   env,
 }: { token: Token } & CommonParameters) {
-  if (![Token.LBTC, Token.BTCK].includes(token)) {
+  if (![Token.LBTC, Token.BTCK, Token.NativeLBTC].includes(token)) {
     throw new Error(`Unsupported token: ${token}`);
   }
 
   const environment = env || determineEnv(chainId);
 
   const publicClient = makePublicClient({ chainId, rpcUrl, env: environment });
-  const lbtcContract = getTokenContractInfo(token, chainId, environment);
+  const tokenContract = getTokenContractInfo(token, chainId, environment);
+  const tokenContractAbi = tokenContract.abi;
 
-  const rawFeeValue = await publicClient.readContract({
-    abi: lbtcContract.abi,
-    address: lbtcContract.address,
-    functionName: 'getMintFee',
-  });
+  let rawFeeValue = 0n;
+
+  if (isSTLBTCAbi(tokenContractAbi) || token === Token.NativeLBTC) {
+    const assetRouterAddress = await publicClient.readContract({
+      abi: tokenContractAbi,
+      address: tokenContract.address,
+      functionName: 'getAssetRouter',
+    });
+
+    const assetRouter = {
+      abi: ASSET_ROUTER_ABI,
+      address: assetRouterAddress,
+    };
+
+    rawFeeValue = await publicClient.readContract({
+      abi: assetRouter.abi,
+      address: assetRouter.address,
+      functionName: 'maxMintCommission',
+    });
+  } else {
+    rawFeeValue = await publicClient.readContract({
+      abi: tokenContract.abi,
+      address: tokenContract.address,
+      functionName: 'getMintFee',
+    });
+  }
 
   return fromSatoshi(String(rawFeeValue));
 }
 
-export async function getBurningFee({
+export async function getRedeemFee({
   token,
   chainId,
   rpcUrl,
   env,
 }: { token: Token } & CommonParameters) {
-  if (![Token.LBTC, Token.BTCK].includes(token)) {
+  if (![Token.LBTC, Token.BTCK, Token.NativeLBTC].includes(token)) {
     throw new Error(`Unsupported token: ${token}`);
   }
 
   const environment = env || determineEnv(chainId);
 
   const publicClient = makePublicClient({ chainId, rpcUrl, env: environment });
-  const lbtcContract = getTokenContractInfo(token, chainId, environment);
+  const tokenContract = getTokenContractInfo(token, chainId, environment);
+
+  let rawFeeValue = 0n;
+  if (
+    (token === Token.LBTC && isSTLBTCAbi(tokenContract.abi)) ||
+    token === Token.NativeLBTC
+  ) {
+    const nativeTokenContract = getTokenContractInfo(
+      Token.NativeLBTC,
+      chainId,
+      environment,
+    );
 
-  const rawFeeValue = await publicClient.readContract({
-    abi: lbtcContract.abi,
-    address: lbtcContract.address,
-    functionName: 'getBurnCommission',
-  });
+    const assetRouterAddress = await publicClient.readContract({
+      abi: tokenContract.abi,
+      address: tokenContract.address,
+      functionName: 'getAssetRouter',
+    });
+
+    const assetRouter = {
+      abi: ASSET_ROUTER_ABI,
+      address: assetRouterAddress,
+    };
+
+    const toNativeCommissionValue = await publicClient.readContract({
+      abi: assetRouter.abi,
+      address: assetRouter.address,
+      functionName: 'toNativeCommission',
+    });
+
+    const [redeemFeeValue /* redeemForBtcMinAmountValue, isRedeemEnabled */] =
+      await publicClient.readContract({
+        abi: assetRouter.abi,
+        address: assetRouter.address,
+        functionName: 'tokenConfig',
+        args: [nativeTokenContract.address],
+      });
+
+    if (token === Token.LBTC) {
+      rawFeeValue = toNativeCommissionValue + redeemFeeValue;
+    } else {
+      rawFeeValue = redeemFeeValue;
+    }
+  } else {
+    // legacy (and BTCK v1)
+    rawFeeValue = await publicClient.readContract({
+      abi: tokenContract.abi,
+      address: tokenContract.address,
+      functionName: 'getBurnCommission',
+    });
+  }
 
   return fromSatoshi(String(rawFeeValue));
 }

package/src/contract-functions/unstakeLBTC/unstakeLBTC.stories.tsx

@@ -22,7 +22,7 @@ const meta = {
   tags: ['autodocs'],
   decorators: [wagmiDecorator, functionType('write')],
   argTypes: {
-    ...makeTokenSelector([Token.LBTC, Token.BTCK]),
+    ...makeTokenSelector([Token.LBTC, Token.BTCK, Token.NativeLBTC]),
   },
 } satisfies Meta<typeof StoryView>;
 

package/src/contract-functions/unstakeLBTC/unstakeLBTC.ts

@@ -6,7 +6,7 @@ import { makePublicClient } from '../../clients/public-client';
 import { CHAIN_ID_TO_VIEM_CHAIN_MAP, isKatanaChain } from '../../common/chains';
 import { type Hex, parseGwei } from 'viem';
 import type BigNumber from 'bignumber.js';
-import { getTokenContractInfo } from '../../tokens/tokens';
+import { getTokenContractInfo, isSTLBTCAbi } from '../../tokens/tokens';
 import { Token } from '../../tokens/token-addresses';
 import { estimateGasFees } from '../../utils/gas';
 
@@ -66,7 +66,7 @@ export async function redeemToken({
   env,
   token = Token.LBTC,
 }: IUnstakeLBTCParams & { token?: Token }) {
-  if (![Token.LBTC, Token.BTCK].includes(token)) {
+  if (![Token.LBTC, Token.BTCK, Token.NativeLBTC].includes(token)) {
     throw new Error('Unsupported token');
   }
 
@@ -88,11 +88,13 @@ export async function redeemToken({
     address: tokenContract.address,
     account,
     chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    functionName: 'redeem', // FIXME: both LBTC and Native LBTC have the same redeem method, change this if Native LBTC ABI changes.
+    functionName:
+      isSTLBTCAbi(tokenContract.abi) || token === Token.NativeLBTC
+        ? 'redeemForBtc'
+        : 'redeem', // FIXME: Change this to `redeemForBtc` once all contracts are updated.
     args: [outputScript, BigInt(amountSat)],
   } as const;
 
-  // Katana Tatara requires tip TODO: Recheck if this is needed or is it just OKX wallet issue
   const gasEstimationData = isKatanaChain(chainId)
     ? await estimateGasFees(publicClient, callData, parseGwei('1'))
     : {};

package/src/index.ts

@@ -42,6 +42,9 @@ export {
   bridge,
   bridgeCCIP,
   bridgeOFT,
+  OFT_HI_GAS_LIMIT_CHAINS,
+  OFT_GAS_LIMIT,
+  OFT_HI_GAS_LIMIT,
   type BridgeParameters,
   type BridgeCCIPParameters,
   type BridgeOFTParameters,

package/src/stories/components/decorators/wagmi-decorator.tsx

@@ -19,7 +19,7 @@ import {
   swellchain,
 } from 'viem/chains';
 import { createConfig, http, WagmiProvider } from 'wagmi';
-import { katana, katanaTatara } from '../../../common/chains';
+import { katana, katanaTatara, tac } from '../../../common/chains';
 
 const config = createConfig({
   chains: [
@@ -32,6 +32,7 @@ const config = createConfig({
     morph,
     sonic,
     swellchain,
+    tac,
     // Testnets:
     baseSepolia,
     berachainTestnetbArtio,
@@ -52,6 +53,7 @@ const config = createConfig({
     [morph.id]: http(rpcUrlConfig[morph.id]),
     [sonic.id]: http(rpcUrlConfig[sonic.id]),
     [swellchain.id]: http(rpcUrlConfig[swellchain.id]),
+    [tac.id]: http(rpcUrlConfig[tac.id]),
     // Testnets:
     [baseSepolia.id]: http(rpcUrlConfig[baseSepolia.id]),
     [berachainTestnetbArtio.id]: http(rpcUrlConfig[berachainTestnetbArtio.id]),