@lombard.finance/sdk 2.5.2 → 3.2.0

package/src/clients/wallet-client.ts

@@ -0,0 +1,33 @@
+import { CHAIN_ID_TO_VIEM_CHAIN_MAP, ChainId } from '../common/chains';
+import {
+  createWalletClient,
+  custom,
+  EIP1193Provider,
+  WalletClient,
+} from 'viem';
+
+type MakeClientParameters = {
+  provider: EIP1193Provider;
+  chainId: ChainId;
+};
+
+/**
+ * Creates the client for specified `chainId`.
+ * @param chainId - The chain id
+ * @param rpcUrl - The overridden RPC url for specified chain id.
+ * @returns The public client instance
+ */
+export function makeWalletClient({
+  provider,
+  chainId,
+}: MakeClientParameters): WalletClient {
+  const chain = CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId];
+  const transport = custom(provider);
+
+  const client = createWalletClient({
+    chain,
+    transport,
+  });
+
+  return client as WalletClient<typeof transport>;
+}

package/src/{sdk/apiConfig.ts → common/api-config.ts}

@@ -1,5 +1,4 @@
-import { defaultEnv } from '@lombard.finance/sdk-common';
-import { Env } from '@lombard.finance/sdk-common';
+import { DEFAULT_ENV, Env } from '@lombard.finance/sdk-common';
 
 interface IApiConfig {
   baseApiUrl: string;
@@ -21,8 +20,15 @@ const prodConfig: IApiConfig = {
   bffApiUrl: 'https://bff.prod.lombard.finance',
 };
 
-export const getApiConfig = (env: Env = defaultEnv): IApiConfig => {
+const devConfig: IApiConfig = {
+  baseApiUrl: 'https://staging.prod.lombard.finance',
+  bffApiUrl: 'http://localhost:8001',
+};
+
+export const getApiConfig = (env: Env = DEFAULT_ENV): IApiConfig => {
   switch (env) {
+    case Env.dev:
+      return devConfig;
     case Env.prod:
       return prodConfig;
     case Env.testnet:

package/src/common/blockchain-identifier.ts

@@ -0,0 +1,134 @@
+import { DEFAULT_ENV, Env } from '@lombard.finance/sdk-common';
+import {
+  ChainId,
+  SOLANA_DEVNET_CHAIN,
+  SOLANA_MAINNET_CHAIN,
+  SOLANA_TESTNET_CHAIN,
+  SUI_MAINNET_CHAIN,
+  SUI_TESTNET_CHAIN,
+  SolanaChain,
+  SuiChain,
+} from './chains';
+
+export const BlockchainIdentifier = {
+  eth: 'DESTINATION_BLOCKCHAIN_ETHEREUM',
+  ethOld: 'BLOCKCHAIN_ETHEREUM',
+
+  base: 'DESTINATION_BLOCKCHAIN_BASE',
+  baseOld: 'BLOCKCHAIN_BASE',
+
+  bsc: 'DESTINATION_BLOCKCHAIN_BSC',
+  bscOld: 'BLOCKCHAIN_BSC',
+
+  sui: 'DESTINATION_BLOCKCHAIN_SUI',
+  suiOld: 'BLOCKCHAIN_SUI',
+
+  sonic: 'DESTINATION_BLOCKCHAIN_SONIC',
+  sonicOld: 'BLOCKCHAIN_SONIC',
+
+  solana: 'DESTINATION_BLOCKCHAIN_SOLANA',
+  solanaOld: 'BLOCKCHAIN_SOLANA',
+} as const;
+
+export type BlockchainIdentifier =
+  (typeof BlockchainIdentifier)[keyof typeof BlockchainIdentifier];
+
+export function getChainNameById(
+  chainId: ChainId | SuiChain | SolanaChain,
+): BlockchainIdentifier {
+  if (
+    chainId === ChainId.ethereum ||
+    chainId === ChainId.holesky ||
+    chainId === ChainId.sepolia
+  ) {
+    return BlockchainIdentifier.eth;
+  }
+
+  if (chainId === ChainId.base || chainId === ChainId.baseSepoliaTestnet) {
+    return BlockchainIdentifier.base;
+  }
+
+  if (
+    chainId === ChainId.binanceSmartChain ||
+    chainId === ChainId.binanceSmartChainTestnet
+  ) {
+    return BlockchainIdentifier.bsc;
+  }
+
+  if (chainId === ChainId.sonic || chainId === ChainId.sonicBlazeTestnet) {
+    return BlockchainIdentifier.sonic;
+  }
+
+  if (chainId === SUI_TESTNET_CHAIN || chainId === SUI_MAINNET_CHAIN) {
+    return BlockchainIdentifier.sui;
+  }
+
+  if (
+    chainId === SOLANA_DEVNET_CHAIN ||
+    chainId === SOLANA_TESTNET_CHAIN ||
+    chainId === SOLANA_MAINNET_CHAIN
+  ) {
+    return BlockchainIdentifier.solana;
+  }
+
+  throw new Error(`Unknown chain ID: ${chainId}`);
+}
+
+export const getEthNetworkByEnv = (env: Env) =>
+  env === Env.prod ? ChainId.ethereum : ChainId.holesky;
+
+export const getBscNetworkByEnv = (env: Env) =>
+  env === Env.prod
+    ? ChainId.binanceSmartChain
+    : ChainId.binanceSmartChainTestnet;
+
+export const getBaseNetworkByEnv = (env: Env) =>
+  env === Env.prod ? ChainId.base : ChainId.baseSepoliaTestnet;
+
+export const getSuiNetworkByEnv = (env: Env) =>
+  env === Env.prod ? SUI_MAINNET_CHAIN : SUI_TESTNET_CHAIN;
+
+export const getSonicNetworkByEnv = (env: Env) =>
+  env === Env.prod ? ChainId.sonic : ChainId.sonicBlazeTestnet;
+
+export const getSolanaNetworkByEnv = (env: Env) =>
+  env === Env.prod ? SOLANA_MAINNET_CHAIN : SOLANA_DEVNET_CHAIN;
+
+/**
+ * @param chain the chain ID
+ * @param env
+ * @returns the chain name
+ */
+export function getChainIdByName(
+  chain: string,
+  env: Env = DEFAULT_ENV,
+): ChainId | SuiChain | SolanaChain {
+  switch (chain as BlockchainIdentifier) {
+    case BlockchainIdentifier.eth:
+    case BlockchainIdentifier.ethOld:
+      return getEthNetworkByEnv(env);
+
+    case BlockchainIdentifier.base:
+    case BlockchainIdentifier.baseOld:
+      return getBaseNetworkByEnv(env);
+
+    case BlockchainIdentifier.bsc:
+    case BlockchainIdentifier.bscOld:
+      return getBscNetworkByEnv(env);
+
+    case BlockchainIdentifier.sui:
+    case BlockchainIdentifier.suiOld:
+      return getSuiNetworkByEnv(env);
+
+    case BlockchainIdentifier.sonic:
+    case BlockchainIdentifier.sonicOld:
+      return getSonicNetworkByEnv(env);
+
+    case BlockchainIdentifier.solana:
+    case BlockchainIdentifier.solanaOld:
+      return getSolanaNetworkByEnv(env);
+
+    default:
+      return ChainId.ethereum;
+  }
+}

package/src/common/chains.ts

@@ -0,0 +1,84 @@
+import {
+  base,
+  baseSepolia,
+  berachain,
+  berachainTestnetbArtio,
+  bsc,
+  bscTestnet,
+  corn,
+  etherlink,
+  holesky,
+  mainnet,
+  morph,
+  morphHolesky,
+  sepolia,
+  sonic,
+  sonicBlazeTestnet,
+  swellchain,
+} from 'viem/chains';
+
+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;
+export const SUI_MAINNET_CHAIN = 'sui:mainnet' as const;
+
+export type SuiChain =
+  | typeof SUI_DEVNET_CHAIN
+  | typeof SUI_TESTNET_CHAIN
+  | typeof SUI_LOCALNET_CHAIN
+  | typeof SUI_MAINNET_CHAIN;
+
+export const SOLANA_MAINNET_CHAIN = 'solana:mainnet-beta' as const;
+export const SOLANA_TESTNET_CHAIN = 'solana:testnet' as const;
+export const SOLANA_DEVNET_CHAIN = 'solana:devnet' as const;
+
+export type SolanaChain =
+  | typeof SOLANA_MAINNET_CHAIN
+  | typeof SOLANA_TESTNET_CHAIN
+  | typeof SOLANA_DEVNET_CHAIN;
+
+export const ChainId = {
+  ethereum: 1,
+  base: 8453,
+  berachain: 80094,
+  binanceSmartChain: 56,
+  corn: 21000000,
+  etherlink: 42793,
+  morph: 2818,
+  sonic: 146,
+  swell: 1923,
+  // Testnets:
+  baseSepoliaTestnet: 84532,
+  berachainBartioTestnet: 80084,
+  binanceSmartChainTestnet: 97,
+  holesky: 17000,
+  morphHolesky: 2810,
+  sepolia: 11155111,
+  sonicBlazeTestnet: 57054,
+} as const;
+
+export type ChainId = (typeof ChainId)[keyof typeof ChainId];
+
+export const CHAIN_ID_TO_VIEM_CHAIN_MAP = {
+  [ChainId.ethereum]: mainnet,
+  [ChainId.base]: base,
+  [ChainId.berachain]: berachain,
+  [ChainId.binanceSmartChain]: bsc,
+  [ChainId.corn]: corn,
+  [ChainId.etherlink]: etherlink,
+  [ChainId.morph]: morph,
+  [ChainId.sonic]: sonic,
+  [ChainId.swell]: swellchain,
+  // Testnets:
+  [ChainId.baseSepoliaTestnet]: baseSepolia,
+  [ChainId.berachainBartioTestnet]: berachainTestnetbArtio,
+  [ChainId.binanceSmartChainTestnet]: bscTestnet,
+  [ChainId.holesky]: holesky,
+  [ChainId.morphHolesky]: morphHolesky,
+  [ChainId.sepolia]: sepolia,
+  [ChainId.sonicBlazeTestnet]: sonicBlazeTestnet,
+};
+
+export function isValidChain(chainId: number): chainId is ChainId {
+  return Object.values(ChainId).includes(chainId as ChainId);
+}

package/src/common/contract-info.ts

@@ -0,0 +1,8 @@
+import { Abi, Address } from 'viem';
+import { ChainId } from './chains';
+
+export type ContractInfo = {
+  abi: Abi;
+  address: Address;
+  chainId: ChainId;
+};

package/src/common/parameters.ts

@@ -0,0 +1,51 @@
+import { Env } from '@lombard.finance/sdk-common';
+import { ChainId } from './chains';
+import { Address, EIP1193Provider } from 'viem';
+
+export interface IEnvParam {
+  /**
+   * Optional environment identifier. If not provided, it defaults to `prod`.
+   *
+   * @default Env.prod
+   */
+  env?: Env;
+}
+
+export interface CommonParameters extends IEnvParam {
+  /**
+   * Chain ID for identifying the blockchain network (e.g., Ethereum, Binance Smart Chain, etc.)
+   */
+  chainId: ChainId;
+
+  /**
+   * Optional RPC URL to connect to the blockchain. If not provided, a default RPC URL might be used.
+   */
+  rpcUrl?: string;
+}
+
+export interface CommonReadParameters extends CommonParameters {
+  /**
+   * The account address.
+   */
+  account: Address;
+}
+
+export interface CommonOptionalWriteParameters extends CommonParameters {
+  /**
+   * The provider (required). An instance of the `EIP1193Provider` which adheres to the EIP-1193 standard for communication with Ethereum-compatible providers.
+   * @type {EIP1193Provider}
+   */
+  provider?: EIP1193Provider;
+}
+
+export interface CommonWriteParameters extends CommonParameters {
+  /**
+   * The account address.
+   */
+  account: Address;
+  /**
+   * An instance of the `EIP1193Provider` which adheres to the EIP-1193 standard for communication with Ethereum-compatible providers.
+   * @type {EIP1193Provider}
+   */
+  provider: EIP1193Provider;
+}

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

@@ -0,0 +1,76 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { Button } from '../../stories/components/Button';
+import { CodeBlock } from '../../stories/components/CodeBlock';
+import {
+  canPerformAction,
+  useConnection,
+} from '../../stories/hooks/useConnection';
+import useQuery from '../../stories/hooks/useQuery';
+import { approveLBTC, IApproveLBTCParams } from './approveLBTC';
+import { Vault, VAULTS } from '../../vaults/lib/config';
+import { ChainId } from '../../common/chains';
+import { Env } from '@lombard.finance/sdk-common';
+import {
+  functionType,
+  wagmiDecorator,
+} from '../../stories/components/decorators';
+import { ConnectButton } from '../../stories/components/ConnectButton';
+
+const meta = {
+  title: 'write/approveLBTC',
+  component: StoryView,
+  tags: ['autodocs'],
+  decorators: [wagmiDecorator, functionType('write')],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const WithParams: Story = {
+  args: {
+    chainId: ChainId.holesky,
+    spender: VAULTS[Vault.Veda].spenderContracts[ChainId.holesky]?.address,
+    amount: 0.00001,
+    env: Env.stage,
+  },
+};
+
+type Props = Omit<IApproveLBTCParams, 'account' | 'provider'>;
+
+export function StoryView(props: Props) {
+  const connection = useConnection();
+
+  const request = async () => {
+    if (!canPerformAction(connection)) {
+      return;
+    }
+
+    return approveLBTC({
+      ...props,
+
+      account: connection.account.address,
+      // chainId: connection.account.chainId,
+      provider: connection.provider,
+    });
+  };
+
+  const { data, error, isLoading, refetch } = useQuery(request, [], false);
+
+  return (
+    <>
+      <div className="mb-4">
+        <ConnectButton />
+      </div>
+
+      <Button
+        onClick={refetch}
+        disabled={isLoading || !connection.account.address}
+        isLoading={isLoading}
+        actionName={approveLBTC.name}
+      />
+
+      <CodeBlock text={error || data} />
+    </>
+  );
+}

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

@@ -0,0 +1,65 @@
+import { CHAIN_ID_TO_VIEM_CHAIN_MAP } from '../../common/chains';
+import { makeWalletClient } from '../../clients/wallet-client';
+import { CommonWriteParameters } from '../../common/parameters';
+import { toSatoshi } from '../../utils/satoshi';
+import { Address, Hash } from 'viem';
+import { makePublicClient } from '../../clients/public-client';
+import BigNumber from 'bignumber.js';
+import { getTokenContractInfo } from '../../tokens/tokens';
+import { Token } from '../../tokens/token-addresses';
+
+export interface IApproveLBTCParams extends CommonWriteParameters {
+  /**
+   * The spender account address.
+   */
+  spender: Address;
+  /**
+   * The approved amount of LBTC.
+   */
+  amount: BigNumber.Value;
+}
+
+/**
+ * Approves the provided spender to withdraw a specified amount of LBTC from
+ * your account.
+ *
+ * @param {IApproveLBTCParams} parameters - The parameters.
+ * @param {Address} spender - The spender account address.
+ * @param {BigNumber.Value} - The amount of LBTC.
+ * @param {Address} parameters.account - The EVM account address.
+ * @param {ChainId} parameters.chainId - The chain id.
+ * @param {EIP1193Provider} parameters.provider - The EIP1193 provider.
+ * @param {string} parameters.rpcUrl - The optional rpc url.
+ * @param {Env} parameters.env - The optional environment identifier.
+ *
+ * @returns {Promise<Hash>}
+ */
+export async function approveLBTC({
+  account,
+  spender,
+  amount,
+  chainId,
+  provider,
+  rpcUrl,
+  env,
+}: IApproveLBTCParams): Promise<Hash> {
+  const publicClient = makePublicClient({ chainId, rpcUrl });
+  const walletClient = makeWalletClient({ chainId, provider });
+
+  const lbtcContract = getTokenContractInfo(Token.LBTC, chainId, env);
+
+  const amountSat = toSatoshi(amount).toNumber();
+
+  const { request } = await publicClient.simulateContract({
+    address: lbtcContract.address,
+    account,
+    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
+    abi: lbtcContract.abi,
+    functionName: 'approve',
+    args: [spender, BigInt(amountSat)],
+  });
+
+  const txHash = await walletClient.writeContract(request);
+
+  return txHash;
+}

package/src/{web3Sdk → contract-functions}/claimLBTC/claimLBTC.stories.tsx

@@ -1,15 +1,24 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { defaultEnv } from '@lombard.finance/sdk-common';
+import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
 import { Button } from '../../stories/components/Button';
 import { CodeBlock } from '../../stories/components/CodeBlock';
-import { useConnect } from '../../stories/hooks/useConnect';
+import {
+  canPerformAction,
+  useConnection,
+} from '../../stories/hooks/useConnection';
 import useQuery from '../../stories/hooks/useQuery';
 import { claimLBTC, IClaimLBTCParams } from './claimLBTC';
+import {
+  functionType,
+  wagmiDecorator,
+} from '../../stories/components/decorators';
+import { ConnectButton } from '../../stories/components/ConnectButton';
 
 const meta = {
-  title: 'Web3SDK/claimLBTC',
+  title: 'write/claimLBTC',
   component: StoryView,
   tags: ['autodocs'],
+  decorators: [wagmiDecorator, functionType('write')],
 } satisfies Meta<typeof StoryView>;
 
 export default meta;
@@ -20,59 +29,42 @@ export const WithParams: Story = {
   args: {
     proofSignature: '',
     data: '',
-    env: defaultEnv,
+    env: DEFAULT_ENV,
   },
 };
 
 type ClaimLBTCProps = Pick<IClaimLBTCParams, 'data' | 'env' | 'proofSignature'>;
 
 export function StoryView(props: ClaimLBTCProps) {
-  const {
-    data: connectData,
-    error: connectError,
-    isLoading: isConnectLoading,
-    connect,
-  } = useConnect();
+  const connection = useConnection();
 
   const request = async () => {
-    if (!connectData) {
+    if (!canPerformAction(connection)) {
       return;
     }
 
     return claimLBTC({
-      ...connectData,
       ...props,
+      account: connection.account.address,
+      chainId: connection.account.chainId,
+      provider: connection.provider,
     });
   };
 
   const { data, error, isLoading, refetch } = useQuery(request, [], false);
 
-  const formattedConnectData = connectData && {
-    account: connectData.account,
-    chainId: connectData.chainId,
-  };
-
   return (
     <>
       <div className="mb-4">
-        <Button
-          onClick={connect}
-          disabled={isConnectLoading}
-          isLoading={isConnectLoading}
-        >
-          Connect
-        </Button>
-
-        <CodeBlock text={connectError || formattedConnectData} />
+        <ConnectButton />
       </div>
 
       <Button
         onClick={refetch}
-        disabled={isLoading || !connectData}
+        disabled={isLoading || !connection.account.address}
         isLoading={isLoading}
-      >
-        Claim LBTC
-      </Button>
+        actionName={claimLBTC.name}
+      />
 
       <CodeBlock text={error || data} />
     </>

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

@@ -0,0 +1,90 @@
+import {
+  BasculeDepositStatus,
+  getBasculeDepositStatus,
+} from '../getBasculeDepositStatus';
+import { CommonWriteParameters } from '../../common/parameters';
+import { CHAIN_ID_TO_VIEM_CHAIN_MAP } 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 { getTokenContractInfo } from '../../tokens/tokens';
+import { Token } from '../../tokens/token-addresses';
+
+export interface IClaimLBTCParams extends CommonWriteParameters {
+  /**
+   * Raw payload from deposit notarization.
+   */
+  data: string;
+  /**
+   * Signature from deposit notarization.
+   */
+  proofSignature: string;
+}
+
+/**
+ * Claims LBTC.
+ *
+ * @param {IClaimLBTCParams} parameters - The parameters.
+ * @param {string} data - The raw payload from the deposit, see `IDeposit.rawPayload`
+ * @param {string} proofSignature - The signature from the deposit, see `IDeposit.signature`
+ * @param {Address} parameters.account - The EVM account address.
+ * @param {ChainId} parameters.chainId - The chain id.
+ * @param {EIP1193Provider} parameters.provider - The EIP1193 provider.
+ * @param {string} parameters.rpcUrl - The optional rpc url.
+ * @param {Env} parameters.env - The optional environment identifier.
+ *
+ * @returns {Promise<Hash>} transaction promise
+ */
+export async function claimLBTC({
+  data,
+  proofSignature,
+  account,
+  chainId,
+  provider,
+  rpcUrl,
+  env,
+}: IClaimLBTCParams): Promise<Hash> {
+  const lbtcContract = getTokenContractInfo(Token.LBTC, chainId, env);
+
+  // Check the deposit status against Bascule Drawbridge security.
+  // Block any deposit that is not reported.
+  const basculeStatus = await getBasculeDepositStatus({
+    chainId,
+    rawPayload: data,
+    env,
+  });
+
+  if (basculeStatus !== BasculeDepositStatus.REPORTED) {
+    switch (basculeStatus) {
+      case BasculeDepositStatus.UNREPORTED:
+        throw new Error(
+          'The deposit cannot be claimed because it is unreported or potentially still pending, please try again later.',
+        );
+      case BasculeDepositStatus.WITHDRAWN:
+        throw new Error(
+          'The deposit cannot be claimed because it is withdrawn already.',
+        );
+      default: // unknown bascule deposit status
+        throw new Error(
+          'The deposit cannot be claimed because it is blocked by bridge security.',
+        );
+    }
+  }
+
+  const publicClient = makePublicClient({ chainId, rpcUrl });
+  const walletClient = makeWalletClient({ chainId, provider });
+
+  const { request } = await publicClient.simulateContract({
+    address: lbtcContract.address,
+    account,
+    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
+    abi: lbtcContract.abi,
+    functionName: 'mint',
+    args: [ensureHex(data), ensureHex(proofSignature)],
+  });
+
+  const txHash = await walletClient.writeContract(request);
+
+  return txHash;
+}