@lombard.finance/sdk 4.0.0 → 4.1.2

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

@@ -1,180 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../../common/chains';
-import { DefiProtocol } from '../../defi/defi-registry';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { functionType } from '../../stories/components/decorators';
-import useQuery from '../../stories/hooks/useQuery';
-import { Token } from '../../tokens/token-addresses';
-import { VEDA_VAULT_STAKE_AND_BAKE_CHAINS } from '../../vaults/lib/config';
-import {
-  getStakeAndBakeFee,
-  IGetStakeAndBakeFeeParams,
-} from './getStakeAndBakeFee';
-
-const meta = {
-  title: 'read/getStakeAndBakeFee',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const VedaDefaultToken: Story = {
-  args: {
-    protocol: DefiProtocol.Veda,
-    chainId: ChainId.ethereum,
-    env: Env.prod,
-  },
-  argTypes: {
-    protocol: {
-      options: Object.values(DefiProtocol),
-      control: { type: 'select' },
-      description: 'The DeFi protocol (Veda or Silo)',
-    },
-    chainId: {
-      mapping: ChainId,
-      options: VEDA_VAULT_STAKE_AND_BAKE_CHAINS.map(
-        ch => Object.entries(ChainId).find(([_, v]) => v === ch)?.[0],
-      ),
-      description: 'The chain',
-      control: { type: 'select' },
-    },
-    env: {
-      options: [Env.prod, Env.testnet, Env.stage, Env.dev],
-      control: { type: 'select' },
-      description: 'Environment',
-    },
-  },
-};
-
-export const VedaExplicitToken: Story = {
-  args: {
-    protocol: DefiProtocol.Veda,
-    token: Token.LBTC,
-    chainId: ChainId.ethereum,
-    env: Env.prod,
-  },
-  argTypes: {
-    protocol: {
-      options: Object.values(DefiProtocol),
-      control: { type: 'select' },
-      description: 'The DeFi protocol',
-    },
-    token: {
-      options: [Token.LBTC, 'BTC'],
-      control: { type: 'select' },
-      description: 'The token (LBTC or BTC for Veda)',
-    },
-    chainId: {
-      mapping: ChainId,
-      options: VEDA_VAULT_STAKE_AND_BAKE_CHAINS.map(
-        ch => Object.entries(ChainId).find(([_, v]) => v === ch)?.[0],
-      ),
-      description: 'The chain',
-      control: { type: 'select' },
-    },
-    env: {
-      options: [Env.prod, Env.testnet, Env.stage, Env.dev],
-      control: { type: 'select' },
-      description: 'Environment',
-    },
-  },
-};
-
-export const SiloDefaultToken: Story = {
-  args: {
-    protocol: DefiProtocol.Silo,
-    chainId: ChainId.avalancheFuji,
-    env: Env.testnet,
-  },
-  argTypes: {
-    protocol: {
-      options: Object.values(DefiProtocol),
-      control: { type: 'select' },
-      description: 'The DeFi protocol (Veda or Silo)',
-    },
-    chainId: {
-      options: ['avalancheFuji'],
-      mapping: { avalancheFuji: ChainId.avalancheFuji },
-      control: { type: 'select' },
-      description: 'The chain (Silo only supports Avalanche Fuji in testnet)',
-    },
-    env: {
-      options: [Env.testnet],
-      control: { type: 'select' },
-      description: 'Environment (Silo only available in testnet)',
-    },
-  },
-};
-
-export const SiloExplicitToken: Story = {
-  args: {
-    protocol: DefiProtocol.Silo,
-    token: Token.BTCb,
-    chainId: ChainId.avalancheFuji,
-    env: Env.testnet,
-  },
-  argTypes: {
-    protocol: {
-      options: Object.values(DefiProtocol),
-      control: { type: 'select' },
-      description: 'The DeFi protocol',
-    },
-    token: {
-      options: [Token.BTCb],
-      control: { type: 'select' },
-      description: 'The token (BTCb for Silo)',
-    },
-    chainId: {
-      options: ['avalancheFuji'],
-      mapping: { avalancheFuji: ChainId.avalancheFuji },
-      control: { type: 'select' },
-      description: 'The chain (Silo only supports Avalanche Fuji in testnet)',
-    },
-    env: {
-      options: [Env.testnet],
-      control: { type: 'select' },
-      description: 'Environment (Silo only available in testnet)',
-    },
-  },
-};
-
-type GetStakeAndBakeFeeProps = IGetStakeAndBakeFeeParams;
-
-export function StoryView(props: GetStakeAndBakeFeeProps) {
-  const request = async () => {
-    return getStakeAndBakeFee({
-      ...props,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  const value = data?.toFixed();
-
-  return (
-    <div>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getStakeAndBakeFee.name}
-      />
-
-      <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 Bake Fee: {value} LBTC</p>
-        </div>
-      )}
-    </div>
-  );
-}

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

@@ -1,101 +0,0 @@
-import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
-import BigNumber from 'bignumber.js';
-import { getContract } from 'viem';
-
-import { makePublicClient } from '../../clients/public-client';
-import { CommonParameters } from '../../common/parameters';
-import {
-  DefiProtocol,
-  DefiProtocols,
-  StakeAndBakeToken,
-} from '../../defi/defi-registry';
-import { Token } from '../../tokens/token-addresses';
-import { getErrorMessage } from '../../utils/err';
-import { fromSatoshi } from '../../utils/satoshi';
-import { getStakeAndBakeConfig } from '../signStakeAndBake/validation';
-
-/**
- * Default token mapping for each protocol.
- * Used when token is not explicitly provided.
- */
-const PROTOCOL_DEFAULT_TOKENS: Record<DefiProtocol, StakeAndBakeToken> = {
-  [DefiProtocol.Veda]: Token.LBTC,
-  [DefiProtocol.Silo]: Token.BTCb,
-};
-
-export interface IGetStakeAndBakeFeeParams extends CommonParameters {
-  /**
-   * The DeFi protocol identifier (e.g., Veda, Silo).
-   */
-  protocol?: DefiProtocol;
-  /**
-   * The token to query the fee for (optional).
-   * If not provided, defaults to the protocol's primary token:
-   * - Veda: LBTC
-   * - Silo: BTCb
-   */
-  token?: StakeAndBakeToken;
-}
-
-/**
- * Get Stake and bake fee for a specific DeFi protocol and token.
- *
- * If token is not provided, uses the default token for the protocol:
- * - Veda: LBTC
- * - Silo: BTCb
- *
- * @param {IGetStakeAndBakeFeeParams} parameters - The parameters.
- * @param {DefiProtocol} parameters.protocol - The optional DeFi protocol identifier (defaults to Veda).
- * @param {StakeAndBakeToken} parameters.token - The optional token (defaults to protocol's primary token).
- * @param {ChainId} parameters.chainId - The chain id.
- * @param {Env} parameters.env - The environment (prod, testnet, etc.).
- * @param {string} parameters.rpcUrl - The optional rpc url.
- *
- * @returns Stake and bake fee amount.
- */
-export async function getStakeAndBakeFee({
-  protocol = DefiProtocol.Veda,
-  token,
-  chainId,
-  env = DEFAULT_ENV,
-  rpcUrl,
-}: IGetStakeAndBakeFeeParams): Promise<BigNumber> {
-  const protocolInfo = DefiProtocols[protocol];
-  if (!protocolInfo) {
-    throw new Error(`Unknown protocol: ${protocol}`);
-  }
-
-  // Use provided token or default to protocol's primary token
-  const selectedToken = token ?? PROTOCOL_DEFAULT_TOKENS[protocol];
-
-  // We use getStakeAndBakeConfig to ensure chain/env compatibility
-  try {
-    const strategy = getStakeAndBakeConfig(
-      protocol,
-      selectedToken,
-      chainId,
-      env,
-    );
-
-    const spenderContract = strategy.spenderContract;
-    if (!spenderContract) {
-      throw new Error(
-        `Could not retrieve the stake and bake contract for ${protocol} on chain ${chainId}.`,
-      );
-    }
-
-    const client = makePublicClient({ chainId, rpcUrl });
-    const contract = getContract({
-      abi: spenderContract.abi,
-      address: spenderContract.address,
-      client,
-    });
-    const fee = await contract.read.getStakeAndBakeFee();
-    return fromSatoshi(String(fee));
-  } catch (error) {
-    const errorMessage = getErrorMessage(error);
-    throw new Error(
-      `Failed to get stake and bake fee for ${protocolInfo.name}: ${errorMessage}`,
-    );
-  }
-}

package/src/contract-functions/getStakeAndBakeFee/index.ts

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

package/src/contract-functions/index.ts

@@ -1,21 +0,0 @@
-// READ functions:
-export * from './getBasculeDepositStatus';
-export * from './getLBTCMintingFee';
-export * from './getLBTCTotalSupply';
-export * from './getPermitNonce';
-export * from './getStakeAndBakeFee';
-
-// WRITE functions:
-export * from './approveLBTC';
-export * from './approveToken';
-export * from './claimLBTC';
-export * from './claimUnstakeRedeem';
-export * from './deposit';
-export * from './signLbtcDestionationAddr';
-export * from './signNetworkFee';
-export * from './signStakeAndBake';
-export * from './unstakeLBTC';
-
-// VAULT READ functions:
-export * from './getSharesByAddress';
-export * from './getShareValue';

package/src/contract-functions/signLbtcDestionationAddr/index.ts

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

package/src/contract-functions/signLbtcDestionationAddr/signLbtcDestinationAddr.ts

@@ -1,32 +0,0 @@
-import { makeWalletClient } from '../../clients/wallet-client';
-import { CommonWriteParameters } from '../../common/parameters';
-
-export type SignLbtcDestinationAddrParams = Omit<
-  CommonWriteParameters,
-  'env' | 'rpcUrl'
->;
-
-/**
- * Signs the destination address for the LBTC in active chain
- * in the current account. Signing is necessary for the
- * generation of the deposit address.
- *
- * @param {SignLbtcDestinationAddrParams} parameters - The parameters.
- * @param {Address} parameters.account - The EVM account address.
- * @param {ChainId} parameters.chainId - The chain id.
- * @param {EIP1193Provider} parameters.provider - The EIP1193 provider.
- *
- * @returns {Promise<string>} The signature of the message.
- */
-export async function signLbtcDestinationAddr({
-  account,
-  chainId,
-  provider,
-}: SignLbtcDestinationAddrParams): Promise<string> {
-  const walletClient = makeWalletClient({ chainId, provider });
-
-  const message = `destination chain id is ${chainId}`;
-  const signed = await walletClient.signMessage({ account, message });
-
-  return signed;
-}

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

@@ -1,64 +0,0 @@
-import type { Meta } from '@storybook/react';
-
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { ConnectButton } from '../../stories/components/ConnectButton';
-import {
-  functionType,
-  wagmiDecorator,
-} from '../../stories/components/decorators';
-import {
-  canPerformAction,
-  useConnection,
-} from '../../stories/hooks/useConnection';
-import useQuery from '../../stories/hooks/useQuery';
-import { signLbtcDestinationAddr } from './signLbtcDestinationAddr';
-
-const meta = {
-  title: 'write/signLbtcDestionationAddr',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [wagmiDecorator, functionType('write')],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-export function StoryView() {
-  const connection = useConnection();
-
-  const request = async () => {
-    if (!canPerformAction(connection)) {
-      return;
-    }
-
-    return signLbtcDestinationAddr({
-      account: connection.account.address,
-      chainId: connection.account.chainId,
-      provider: connection.provider,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <p>
-        This method is used to get the signature of the Liquid BTC destination
-        address. The signature is used for generating the deposit address.
-      </p>
-
-      <div className="mb-4">
-        <ConnectButton />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !connection.account.address}
-        isLoading={isLoading}
-        actionName={signLbtcDestinationAddr.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/contract-functions/signNetworkFee/getTypedData.ts

@@ -1,41 +0,0 @@
-interface IGetTypedData {
-  chainId: number;
-  verifyingContract: string;
-  fee: string;
-  expiry: number;
-}
-
-export function getTypedData({
-  chainId,
-  verifyingContract,
-  fee,
-  expiry,
-}: IGetTypedData) {
-  return {
-    domain: {
-      name: 'Lombard Staked Bitcoin',
-      version: '1',
-      chainId,
-      verifyingContract,
-    },
-    message: {
-      chainId,
-      fee,
-      expiry,
-    },
-    primaryType: 'feeApproval',
-    types: {
-      EIP712Domain: [
-        { name: 'name', type: 'string' },
-        { name: 'version', type: 'string' },
-        { name: 'chainId', type: 'uint256' },
-        { name: 'verifyingContract', type: 'address' },
-      ],
-      feeApproval: [
-        { name: 'chainId', type: 'uint256' },
-        { name: 'fee', type: 'uint256' },
-        { name: 'expiry', type: 'uint256' },
-      ],
-    },
-  };
-}

package/src/contract-functions/signNetworkFee/index.ts

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

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

@@ -1,94 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { ConnectButton } from '../../stories/components/ConnectButton';
-import {
-  functionType,
-  wagmiDecorator,
-} from '../../stories/components/decorators';
-import {
-  canPerformAction,
-  useConnection,
-} from '../../stories/hooks/useConnection';
-import useQuery from '../../stories/hooks/useQuery';
-import { DAY, now, toUnix } from '../../utils/time';
-import { ISignNetworkFeeParams, signNetworkFee } from './signNetworkFee';
-
-const meta = {
-  title: 'write/signNetworkFee',
-  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: {
-    fee: '1100',
-    expiry: toUnix(now() + DAY),
-    env: Env.prod,
-  },
-};
-
-type SignNetworkFeeProps = Omit<
-  ISignNetworkFeeParams,
-  'account' | 'chainId' | 'provider'
->;
-
-export function StoryView(props: SignNetworkFeeProps) {
-  const connection = useConnection();
-
-  const request = async () => {
-    if (!canPerformAction(connection)) {
-      return;
-    }
-
-    return signNetworkFee({
-      ...props,
-
-      account: connection.account.address,
-      chainId: connection.account.chainId,
-      provider: connection.provider,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <p>
-        This method is used to get the signature of the Liquid BTC destination
-        address. The signature is used for auto-mint feature.
-      </p>
-
-      <div className="mb-4">
-        <ConnectButton />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !connection.account.address}
-        isLoading={isLoading}
-        actionName={signNetworkFee.name}
-      />
-
-      <div
-        style={{
-          padding: '20px 0 0',
-          fontFamily: 'monospace',
-          fontSize: '0.8em',
-        }}
-      >
-        <span style={{ fontWeight: '800' }}>24 hours from now:</span>{' '}
-        {toUnix(now() + DAY)}
-      </div>
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

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

@@ -1,106 +0,0 @@
-import BigNumber from 'bignumber.js';
-import { Hex } from 'viem';
-
-import { makeWalletClient } from '../../clients/wallet-client';
-import { CommonWriteParameters } from '../../common/parameters';
-import { Token } from '../../tokens/token-addresses';
-import { getTokenContractInfo } from '../../tokens/tokens';
-import { DAY, now, toUnix } from '../../utils/time';
-
-export interface ISignNetworkFeeParams extends CommonWriteParameters {
-  /**
-   * The authorized fee amount.
-   * Recommended amount is the same as retuned from `getLBTCMintingFee`.
-   */
-  fee: BigNumber.Value;
-  /**
-   * The expiration time of the signature.
-   * Defaults to 24h from now.
-   */
-  expiry?: number;
-  /**
-   * The token to use for signing.
-   * Defaults to Token.LBTC for backwards compatibility.
-   */
-  token?: Token;
-}
-
-export interface ISignNetworkFeeResponse {
-  /**
-   * The signature.
-   */
-  signature: Hex;
-  /**
-   * The typed data (JSON string) used for generating the returned signature.
-   */
-  typedData: string;
-}
-
-/**
- * Signs the network fee transaction in the current account.
- * Signing is necessary for the auto-mint.
- *
- * @param {ISignNetworkFeeParams} parameters - The parameters for signing network fee
- * @param {BigNumber.Value} parameters.fee - The fee amount (in satoshis).
- * @param {number} parameters.expiry = The optional expiration UNIX time of the 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.
- *
- * @returns {Promise<ISignNetworkFeeResponse>} A promise that resolves to the signature and typed data
- */
-export async function signNetworkFee({
-  fee,
-  expiry = toUnix(now() + DAY),
-  account,
-  chainId,
-  provider,
-  env,
-  token = Token.LBTC,
-}: ISignNetworkFeeParams): Promise<ISignNetworkFeeResponse> {
-  const tokenContract = await getTokenContractInfo(token, chainId, env);
-  const walletClient = makeWalletClient({
-    chainId,
-    provider,
-  });
-
-  type TypedData = Parameters<typeof walletClient.signTypedData>[0];
-  const typedData: TypedData = {
-    account,
-    domain: {
-      name: token === Token.BTCb ? 'Bitcoin' : 'Lombard Staked Bitcoin',
-      version: '1',
-      chainId,
-      verifyingContract: tokenContract.address,
-    },
-    message: {
-      chainId,
-      fee: BigInt(BigNumber(fee).toFixed()),
-      expiry,
-    },
-    primaryType: 'feeApproval',
-    types: {
-      EIP712Domain: [
-        { name: 'name', type: 'string' },
-        { name: 'version', type: 'string' },
-        { name: 'chainId', type: 'uint256' },
-        { name: 'verifyingContract', type: 'address' },
-      ],
-      feeApproval: [
-        { name: 'chainId', type: 'uint256' },
-        { name: 'fee', type: 'uint256' },
-        { name: 'expiry', type: 'uint256' },
-      ],
-    },
-  };
-
-  const signature = await walletClient.signTypedData(typedData);
-
-  return {
-    signature: signature,
-    typedData: JSON.stringify(typedData, (_, v) =>
-      typeof v === 'bigint' ? v.toString() : v,
-    ),
-  };
-}