@lombard.finance/sdk 3.4.0 → 3.5.6

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

@@ -3,13 +3,15 @@ import {
   getBasculeDepositStatus,
 } from '../getBasculeDepositStatus';
 import { CommonWriteParameters } from '../../common/parameters';
-import { CHAIN_ID_TO_VIEM_CHAIN_MAP } from '../../common/chains';
+import { CHAIN_ID_TO_VIEM_CHAIN_MAP, isKatanaChain } from '../../common/chains';
 import { makePublicClient } from '../../clients/public-client';
 import { makeWalletClient } from '../../clients/wallet-client';
 import { ensureHex } from '../../utils/hex';
-import { Hash } from 'viem';
+import { Hash, parseGwei } from 'viem';
 import { getTokenContractInfo } from '../../tokens/tokens';
 import { Token } from '../../tokens/token-addresses';
+import BigNumber from 'bignumber.js';
+import { estimateGasFees } from '../../utils/gas';
 
 export interface IClaimLBTCParams extends CommonWriteParameters {
   /**
@@ -45,14 +47,42 @@ export async function claimLBTC({
   rpcUrl,
   env,
 }: IClaimLBTCParams): Promise<Hash> {
-  const lbtcContract = getTokenContractInfo(Token.LBTC, chainId, env);
+  return mintToken({
+    data,
+    proofSignature,
+    account,
+    chainId,
+    provider,
+    rpcUrl,
+    env,
+    token: Token.LBTC,
+  });
+}
+
+export async function mintToken({
+  data,
+  proofSignature,
+  account,
+  chainId,
+  provider,
+  rpcUrl,
+  env,
+  token = Token.LBTC,
+}: IClaimLBTCParams & { token?: Token.LBTC | Token.BTCK }) {
+  if (![Token.LBTC, Token.BTCK].includes(token)) {
+    throw new Error('Unsupported token');
+  }
+
+  if (token === Token.BTCK && !isKatanaChain(chainId)) {
+    throw new Error('Operation not permitted');
+  }
 
-  // Check the deposit status against Bascule Drawbridge security.
-  // Block any deposit that is not reported.
+  const tokenContract = getTokenContractInfo(token, chainId, env);
   const basculeStatus = await getBasculeDepositStatus({
     chainId,
     rawPayload: data,
     env,
+    token,
   });
 
   if (basculeStatus !== BasculeDepositStatus.REPORTED) {
@@ -72,16 +102,26 @@ export async function claimLBTC({
     }
   }
 
-  const publicClient = makePublicClient({ chainId, rpcUrl });
+  const publicClient = makePublicClient({ chainId, rpcUrl, env });
   const walletClient = makeWalletClient({ chainId, provider });
 
-  const { request } = await publicClient.simulateContract({
-    address: lbtcContract.address,
+  const callData = {
+    address: tokenContract.address,
     account,
     chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    abi: lbtcContract.abi,
-    functionName: 'mint',
+    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.
     args: [ensureHex(data), ensureHex(proofSignature)],
+  } as const;
+
+  // Katana Tatara requires tip TODO: Recheck this part
+  const gasEstimationData = isKatanaChain(chainId)
+    ? await estimateGasFees(publicClient, callData, parseGwei('1'))
+    : {};
+
+  const { request } = await publicClient.simulateContract({
+    ...callData,
+    ...gasEstimationData,
   });
 
   const txHash = await walletClient.writeContract(request);

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

@@ -48,6 +48,7 @@ export interface IGetBasculeDepositStatusParameters
    * You can omit `deposit` parameter if `rawPayload` is provided.
    */
   rawPayload?: string;
+  token?: Token;
 }
 
 /**
@@ -69,6 +70,7 @@ export async function getBasculeDepositStatus({
   chainId,
   rpcUrl,
   env = DEFAULT_ENV,
+  token = Token.LBTC,
 }: IGetBasculeDepositStatusParameters) {
   const payload = deposit?.rawPayload || rawPayload;
 
@@ -78,12 +80,12 @@ export async function getBasculeDepositStatus({
     );
   }
 
-  const publicClient = makePublicClient({ chainId, rpcUrl });
-  const lbtcContract = getTokenContractInfo(Token.LBTC, chainId, env);
+  const publicClient = makePublicClient({ chainId, rpcUrl, env });
+  const tokenContractInfo = getTokenContractInfo(token, chainId, env);
 
   const basculeContractAddress = await publicClient.readContract({
-    abi: lbtcContract.abi,
-    address: lbtcContract.address,
+    abi: tokenContractInfo.abi,
+    address: tokenContractInfo.address,
     functionName: 'Bascule',
   });
 

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

@@ -5,12 +5,15 @@ import { CodeBlock } from '../../stories/components/CodeBlock';
 import { functionType } from '../../stories/components/decorators';
 import useQuery from '../../stories/hooks/useQuery';
 import { getLBTCMintingFee } from './getLBTCMintingFee';
+import { chainSelector, envSelector } from '../../stories/arg-types';
+import { Env } from '@lombard.finance/sdk-common';
 
 const meta = {
   title: 'read/getLBTCMintingFee',
   component: StoryView,
   tags: ['autodocs'],
   decorators: [functionType('read')],
+  argTypes: { ...chainSelector, ...envSelector },
 } satisfies Meta<typeof StoryView>;
 
 export default meta;
@@ -20,23 +23,17 @@ type Story = StoryObj<typeof meta>;
 export const Holesky: Story = {
   args: {
     chainId: ChainId.holesky,
+    env: undefined,
   },
 };
 
-export const Ethereum: Story = {
-  args: {
-    chainId: ChainId.ethereum,
-  },
-};
-
-type GetLBTCMintingFeeProps = {
-  chainId: ChainId;
-};
+type Params = Parameters<typeof getLBTCMintingFee>[0];
 
-export function StoryView(props: GetLBTCMintingFeeProps) {
+export function StoryView(props: Params) {
   const request = async () => {
     return getLBTCMintingFee({
       chainId: props.chainId,
+      env: props.env,
     });
   };
 

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

@@ -16,15 +16,31 @@ import { Token } from '../../tokens/token-addresses';
  *
  * @return {Promise<BigNumber>}
  */
-export async function getLBTCMintingFee({
+export async function getLBTCMintingFee(
+  props: CommonParameters,
+): Promise<BigNumber> {
+  return getMintingFee({ token: Token.LBTC, ...props });
+}
+
+/** Gets LBTC burn commission (fee) amount. */
+export async function getLBTCBurningFee(props: CommonParameters) {
+  return getBurningFee({ token: Token.LBTC, ...props });
+}
+
+export async function getMintingFee({
+  token,
   chainId,
   rpcUrl,
   env,
-}: CommonParameters): Promise<BigNumber> {
+}: { token: Token } & CommonParameters) {
+  if (![Token.LBTC, Token.BTCK].includes(token)) {
+    throw new Error(`Unsupported token: ${token}`);
+  }
+
   const environment = env || determineEnv(chainId);
 
-  const publicClient = makePublicClient({ chainId, rpcUrl });
-  const lbtcContract = getTokenContractInfo(Token.LBTC, chainId, environment);
+  const publicClient = makePublicClient({ chainId, rpcUrl, env: environment });
+  const lbtcContract = getTokenContractInfo(token, chainId, environment);
 
   const rawFeeValue = await publicClient.readContract({
     abi: lbtcContract.abi,
@@ -32,6 +48,29 @@ export async function getLBTCMintingFee({
     functionName: 'getMintFee',
   });
 
-  const lbtcMintFee = fromSatoshi(String(rawFeeValue));
-  return lbtcMintFee;
+  return fromSatoshi(String(rawFeeValue));
+}
+
+export async function getBurningFee({
+  token,
+  chainId,
+  rpcUrl,
+  env,
+}: { token: Token } & CommonParameters) {
+  if (![Token.LBTC, Token.BTCK].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 rawFeeValue = await publicClient.readContract({
+    abi: lbtcContract.abi,
+    address: lbtcContract.address,
+    functionName: 'getBurnCommission',
+  });
+
+  return fromSatoshi(String(rawFeeValue));
 }

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

@@ -6,12 +6,14 @@ import useQuery from '../../stories/hooks/useQuery';
 import { getLBTCTotalSupply } from './getLBTCTotalSupply';
 import { ChainId } from '../../common/chains';
 import { functionType } from '../../stories/components/decorators';
+import { chainSelector, envSelector } from '../../stories/arg-types';
 
 const meta = {
   title: 'read/getLBTCTotalSupply',
   component: StoryView,
   tags: ['autodocs'],
   decorators: [functionType('read')],
+  argTypes: { ...chainSelector, ...envSelector },
 } satisfies Meta<typeof StoryView>;
 
 export default meta;
@@ -21,7 +23,7 @@ type Story = StoryObj<typeof meta>;
 export const WithParams: Story = {
   args: {
     chainId: ChainId.ethereum,
-    env: DEFAULT_ENV,
+    env: undefined,
   },
 };
 

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

@@ -1,10 +1,10 @@
 import { CommonParameters } from '../../common/parameters';
-import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
 import BigNumber from 'bignumber.js';
 import { fromSatoshi } from '../../utils/satoshi';
 import { makePublicClient } from '../../clients/public-client';
 import { getTokenContractInfo } from '../../tokens/tokens';
 import { Token } from '../../tokens/token-addresses';
+import { determineEnv } from '../../utils/env';
 
 /**
  * Get the total supply of LBTC tokens.
@@ -19,10 +19,11 @@ import { Token } from '../../tokens/token-addresses';
 export async function getLBTCTotalSupply({
   chainId,
   rpcUrl,
-  env = DEFAULT_ENV,
+  env,
 }: CommonParameters): Promise<BigNumber> {
-  const publicClient = makePublicClient({ chainId, rpcUrl });
-  const lbtcContract = getTokenContractInfo(Token.LBTC, chainId, env);
+  const environment = env || determineEnv(chainId);
+  const publicClient = makePublicClient({ chainId, rpcUrl, env: environment });
+  const lbtcContract = getTokenContractInfo(Token.LBTC, chainId, environment);
 
   const totalSupplyRaw = await publicClient.readContract({
     abi: lbtcContract.abi,

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

@@ -13,6 +13,7 @@ import {
   functionType,
   wagmiDecorator,
 } from '../../stories/components/decorators';
+import { Env } from '@lombard.finance/sdk-common';
 
 const meta = {
   title: 'write/signNetworkFee',
@@ -29,6 +30,7 @@ export const WithParams: Story = {
   args: {
     fee: '1100',
     expiry: toUnix(now() + DAY),
+    env: Env.prod,
   },
 };
 

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

@@ -3,7 +3,7 @@ import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
 import { Button } from '../../stories/components/Button';
 import { CodeBlock } from '../../stories/components/CodeBlock';
 import useQuery from '../../stories/hooks/useQuery';
-import { IUnstakeLBTCParams, unstakeLBTC } from './unstakeLBTC';
+import { redeemToken } from './unstakeLBTC';
 import { ConnectButton } from '../../stories/components/ConnectButton';
 import {
   canPerformAction,
@@ -13,12 +13,17 @@ import {
   functionType,
   wagmiDecorator,
 } from '../../stories/components/decorators';
+import { Token } from '../../tokens/token-addresses';
+import { makeTokenSelector } from '../../stories/arg-types';
 
 const meta = {
   title: 'write/unstakeLBTC',
   component: StoryView,
   tags: ['autodocs'],
   decorators: [wagmiDecorator, functionType('write')],
+  argTypes: {
+    ...makeTokenSelector([Token.LBTC, Token.BTCK]),
+  },
 } satisfies Meta<typeof StoryView>;
 
 export default meta;
@@ -28,12 +33,16 @@ type Story = StoryObj<typeof meta>;
 export const WithParams: Story = {
   args: {
     amount: 0.00001,
+    token: Token.LBTC,
     btcAddress: '',
     env: DEFAULT_ENV,
   },
 };
 
-type ClaimLBTCProps = Pick<IUnstakeLBTCParams, 'btcAddress' | 'env' | 'amount'>;
+type ClaimLBTCProps = Omit<
+  Parameters<typeof redeemToken>[0],
+  'account' | 'chainId' | 'provider'
+>;
 
 export function StoryView(props: ClaimLBTCProps) {
   const connection = useConnection();
@@ -44,9 +53,11 @@ export function StoryView(props: ClaimLBTCProps) {
       return;
     }
 
-    return unstakeLBTC({
+    return redeemToken({
       amount: props.amount,
       btcAddress: props.btcAddress,
+      env: props.env,
+      token: props.token,
 
       account: connection.account.address,
       chainId: connection.account.chainId,
@@ -71,7 +82,7 @@ export function StoryView(props: ClaimLBTCProps) {
         onClick={refetch}
         disabled={isLoading || !connection.account.address}
         isLoading={isLoading}
-        actionName={unstakeLBTC.name}
+        actionName={redeemToken.name}
       />
 
       <CodeBlock text={error || data} />

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

@@ -3,11 +3,12 @@ import { CommonWriteParameters } from '../../common/parameters';
 import { toSatoshi } from '../../utils/satoshi';
 import { makeWalletClient } from '../../clients/wallet-client';
 import { makePublicClient } from '../../clients/public-client';
-import { CHAIN_ID_TO_VIEM_CHAIN_MAP } from '../../common/chains';
-import { Hex } from 'viem';
+import { CHAIN_ID_TO_VIEM_CHAIN_MAP, isKatanaChain } from '../../common/chains';
+import { Hex, parseGwei } from 'viem';
 import BigNumber from 'bignumber.js';
 import { getTokenContractInfo } from '../../tokens/tokens';
 import { Token } from '../../tokens/token-addresses';
+import { estimateGasFees } from '../../utils/gas';
 
 /**
  * The unstake parameters.
@@ -43,24 +44,65 @@ export async function unstakeLBTC({
   rpcUrl,
   env,
 }: IUnstakeLBTCParams): Promise<Hex> {
+  return redeemToken({
+    btcAddress,
+    amount,
+    account,
+    chainId,
+    provider,
+    rpcUrl,
+    env,
+    token: Token.LBTC,
+  });
+}
+
+export async function redeemToken({
+  btcAddress,
+  amount,
+  account,
+  chainId,
+  provider,
+  rpcUrl,
+  env,
+  token = Token.LBTC,
+}: IUnstakeLBTCParams & { token?: Token.LBTC | Token.BTCK }) {
+  if (![Token.LBTC, Token.BTCK].includes(token)) {
+    throw new Error('Unsupported token');
+  }
+
+  if (token === Token.BTCK && !isKatanaChain(chainId)) {
+    throw new Error('Operation not permitted');
+  }
+
   const outputScript = getOutputScript(btcAddress, env);
-  const amountSat = toSatoshi(amount).toNumber();
 
-  const lbtcContract = getTokenContractInfo(Token.LBTC, chainId, env);
+  const amountSat = toSatoshi(amount).toNumber();
 
-  const publicClient = makePublicClient({ chainId, rpcUrl });
+  const publicClient = makePublicClient({ chainId, rpcUrl, env });
   const walletClient = makeWalletClient({ provider, chainId });
 
-  const { request } = await publicClient.simulateContract({
-    address: lbtcContract.address,
+  const tokenContract = getTokenContractInfo(token, chainId, env);
+
+  const callData = {
+    abi: tokenContract.abi,
+    address: tokenContract.address,
     account,
     chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    abi: lbtcContract.abi,
-    functionName: 'redeem',
+    functionName: 'redeem', // FIXME: both LBTC and Native LBTC have the same redeem method, change this if Native LBTC ABI changes.
     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'))
+    : {};
 
-  const txHash = await walletClient.writeContract(request);
+  const { request } = await publicClient.simulateContract(callData);
+
+  const txHash = await walletClient.writeContract({
+    ...request,
+    ...gasEstimationData,
+  });
 
   return txHash;
 }

package/src/index.ts

@@ -25,6 +25,7 @@ export {
   SUI_TESTNET_CHAIN,
 } from './common/chains';
 export * from './tokens/lbtc-addresses';
+export * from './tokens/token-addresses';
 export * from './utils/satoshi';
 
 // Metrics:

package/src/stories/arg-types.ts

@@ -0,0 +1,34 @@
+import { ArgTypes } from 'storybook/internal/types';
+import { ChainId } from '../common/chains';
+import { Env } from '@lombard.finance/sdk-common';
+import { Token } from '../tokens/token-addresses';
+
+export const chainSelector: Partial<ArgTypes> = {
+  chainId: {
+    mapping: ChainId,
+    options: Object.keys(ChainId),
+    control: { type: 'select' },
+  },
+};
+
+export const envSelector: Partial<ArgTypes> = {
+  env: {
+    mapping: Env,
+    options: Object.keys(Env),
+    control: { type: 'select' },
+  },
+};
+
+export const makeTokenSelector = (tokens?: Token[]): Partial<ArgTypes> => ({
+  token: {
+    mapping: Token,
+    options: Object.keys(Token).filter(tk => {
+      if (!tokens) return true;
+
+      const entries = Object.entries(Token);
+      const keys = tokens.map(tv => entries.find(([, v]) => v === tv)?.[0]);
+      return keys.includes(tk);
+    }),
+    control: { type: 'select' },
+  },
+});

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

@@ -19,6 +19,7 @@ import {
   swellchain,
 } from 'viem/chains';
 import { createConfig, http, WagmiProvider } from 'wagmi';
+import { katana, katanaTatara } from '../../../common/chains';
 
 const config = createConfig({
   chains: [
@@ -27,6 +28,7 @@ const config = createConfig({
     berachain,
     bsc,
     corn,
+    katana,
     morph,
     sonic,
     swellchain,
@@ -35,6 +37,7 @@ const config = createConfig({
     berachainTestnetbArtio,
     bscTestnet,
     holesky,
+    katanaTatara,
     morphHolesky,
     sepolia,
     sonicBlazeTestnet,
@@ -45,6 +48,7 @@ const config = createConfig({
     [berachain.id]: http(rpcUrlConfig[berachain.id]),
     [bsc.id]: http(rpcUrlConfig[bsc.id]),
     [corn.id]: http(rpcUrlConfig[corn.id]),
+    [katana.id]: http(rpcUrlConfig[katana.id]),
     [morph.id]: http(rpcUrlConfig[morph.id]),
     [sonic.id]: http(rpcUrlConfig[sonic.id]),
     [swellchain.id]: http(rpcUrlConfig[swellchain.id]),
@@ -53,6 +57,7 @@ const config = createConfig({
     [berachainTestnetbArtio.id]: http(rpcUrlConfig[berachainTestnetbArtio.id]),
     [bscTestnet.id]: http(rpcUrlConfig[bscTestnet.id]),
     [holesky.id]: http(rpcUrlConfig[holesky.id]),
+    [katanaTatara.id]: http(rpcUrlConfig[katanaTatara.id]),
     [morphHolesky.id]: http(rpcUrlConfig[morphHolesky.id]),
     [sepolia.id]: http(rpcUrlConfig[sepolia.id]),
     [sonicBlazeTestnet.id]: http(rpcUrlConfig[sonicBlazeTestnet.id]),