@lombard.finance/sdk 4.0.0 → 4.1.2

package/src/tokens/getTokenByAddress.stories.tsx

@@ -1,172 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../common/chains';
-import { chainSelector, envSelector } from '../stories/arg-types';
-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 { AddressKind, getTokenByAddress } from './token-addresses';
-
-const meta = {
-  title: 'tokens/getTokenByAddress',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-  argTypes: {
-    ...chainSelector,
-    ...envSelector,
-    tokenAddress: {
-      control: { type: 'text' },
-      description: 'Token contract address',
-    },
-    addressKind: {
-      options: Object.values(AddressKind),
-      control: { type: 'select' },
-    },
-  },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const LBTCOnEthereum: Story = {
-  args: {
-    tokenAddress: '0x8236a87084f8b84306f72007f36f2618a5634494',
-    chainId: ChainId.ethereum,
-    env: undefined,
-    addressKind: AddressKind.Token,
-  },
-};
-
-export const LBTCOnBase: Story = {
-  args: {
-    tokenAddress: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
-    chainId: ChainId.base,
-    env: undefined,
-    addressKind: AddressKind.Token,
-  },
-};
-
-export const BTCbOnKatanaTatara: Story = {
-  args: {
-    tokenAddress: '0x20eA7b8ABb4B583788F1DFC738C709a2d9675681',
-    chainId: ChainId.katanaTatara,
-    env: undefined,
-    addressKind: AddressKind.Token,
-  },
-};
-
-export const UnknownToken: Story = {
-  args: {
-    tokenAddress: '0x0000000000000000000000000000000000000000',
-    chainId: ChainId.ethereum,
-    env: undefined,
-    addressKind: AddressKind.Token,
-  },
-};
-
-interface StoryViewProps {
-  tokenAddress: string;
-  chainId: ChainId;
-  env?: Env;
-  addressKind: AddressKind;
-}
-
-/**
- * Reverse lookup: find which token a contract address belongs to.
- *
- * This function searches through all known token addresses to identify
- * which Lombard token matches the given address on a specific chain.
- *
- * **Supported Tokens:**
- * - LBTC
- * - BTCb
- *
- * **Address Kinds:**
- * - `Token`: The token contract address (default)
- * - `Adapter`: The bridge adapter address (for BTCb on Avalanche)
- *
- * **Use Cases:**
- * - Identify tokens from transaction logs
- * - Validate if an address is a known Lombard token
- * - Display token metadata based on contract address
- * - Parse events from smart contracts
- *
- * **Returns:**
- * - Token enum if found (e.g., `Token.LBTC`)
- * - `undefined` if address is not a known token
- *
- * **Note:** The comparison is case-insensitive
- */
-export function StoryView(props: StoryViewProps) {
-  const request = async () => {
-    const result = getTokenByAddress(
-      props.tokenAddress,
-      props.chainId,
-      props.env,
-      props.addressKind,
-    );
-    return result || 'Token not found';
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(
-    request,
-    [props.tokenAddress, props.chainId, props.env, props.addressKind],
-    false,
-  );
-
-  const isFound = data && data !== 'Token not found';
-
-  return (
-    <div className="container">
-      <div className="mb-3">
-        <h3>Token Address Reverse Lookup</h3>
-        <p className="text-muted">
-          Identify which Lombard token a contract address belongs to by
-          searching through known addresses.
-        </p>
-      </div>
-
-      <div className="card mb-3">
-        <div className="card-body">
-          <h5>Query Parameters</h5>
-          <ul>
-            <li>
-              <strong>Address:</strong>{' '}
-              <code className="text-break">{props.tokenAddress}</code>
-            </li>
-            <li>
-              <strong>Chain ID:</strong> {props.chainId}
-            </li>
-            <li>
-              <strong>Address Kind:</strong> {props.addressKind}
-            </li>
-          </ul>
-        </div>
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getTokenByAddress.name}
-      />
-
-      {data && (
-        <div className="mt-3">
-          <div
-            className={`alert ${isFound ? 'alert-success' : 'alert-warning'}`}
-          >
-            <strong>Result:</strong>{' '}
-            {isFound ? `✅ Found: ${data}` : '⚠️ Token not found'}
-          </div>
-        </div>
-      )}
-
-      <CodeBlock text={error || data} />
-    </div>
-  );
-}

package/src/tokens/getTokenContractInfo.stories.tsx

@@ -1,148 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../common/chains';
-import {
-  chainSelector,
-  envSelector,
-  makeTokenSelector,
-} from '../stories/arg-types';
-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 { AddressKind, Token } from './token-addresses';
-import { getTokenContractInfo } from './tokens';
-
-const meta = {
-  title: 'tokens/getTokenContractInfo',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-  argTypes: {
-    ...chainSelector,
-    ...envSelector,
-    ...makeTokenSelector([Token.LBTC, Token.BTCb, Token.BTCK]),
-    addressKind: {
-      options: Object.values(AddressKind),
-      control: { type: 'select' },
-    },
-  },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const LBTCTokenAddress: Story = {
-  args: {
-    token: Token.LBTC,
-    chainId: ChainId.ethereum,
-    env: undefined,
-    addressKind: AddressKind.Token,
-  },
-};
-
-export const BTCbAdapterAddress: Story = {
-  args: {
-    token: Token.BTCb,
-    chainId: ChainId.avalancheFuji,
-    env: undefined,
-    addressKind: AddressKind.Adapter,
-  },
-};
-
-export const BTCbTokenAddress: Story = {
-  args: {
-    token: Token.BTCb,
-    chainId: ChainId.avalancheFuji,
-    env: undefined,
-    addressKind: AddressKind.Token,
-  },
-};
-
-interface StoryViewProps {
-  token: Token;
-  chainId: ChainId;
-  env?: Env;
-  addressKind: AddressKind;
-}
-
-/**
- * Get token contract information with the appropriate ABI.
- *
- * This function returns the contract address, ABI, and chain ID for a token.
- * It automatically selects the correct ABI based on whether the contract has
- * been upgraded to the new version.
- *
- * **Address Kinds:**
- * - `Token`: The token contract address (default)
- * - `Adapter`: The bridge adapter address (for BTCb on Avalanche)
- *
- * **Use Cases:**
- * - Prepare contract calls with the correct ABI
- * - Get bridge adapter addresses for cross-chain operations
- * - Verify contract addresses before transactions
- *
- * **Contract Upgrades:**
- * - LBTC: May use either LBTC_ABI or STLBTC_ABI
- * - BTCK: May use either BTCK_ABI or NATIVE_LBTC_ABI
- * - BTCb: Uses NATIVE_LBTC_ABI or BRIDGE_TOKEN_ADAPTER_ABI
- */
-export function StoryView(props: StoryViewProps) {
-  const request = async () => {
-    return getTokenContractInfo(
-      props.token,
-      props.chainId,
-      props.env,
-      props.addressKind,
-    );
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(
-    request,
-    [props.token, props.chainId, props.env, props.addressKind],
-    false,
-  );
-
-  return (
-    <div className="container">
-      <div className="mb-3">
-        <h3>Token Contract Information</h3>
-        <p className="text-muted">
-          Retrieves contract address, ABI, and chain ID. Supports both token and
-          adapter addresses for bridge operations.
-        </p>
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getTokenContractInfo.name}
-      />
-
-      {data && (
-        <div className="mt-3">
-          <h5>Result Preview:</h5>
-          <ul>
-            <li>
-              <strong>Address:</strong> {data.address}
-            </li>
-            <li>
-              <strong>Chain ID:</strong> {data.chainId}
-            </li>
-            <li>
-              <strong>ABI Functions:</strong> {data.abi.length}
-            </li>
-            <li>
-              <strong>Address Kind:</strong> {props.addressKind}
-            </li>
-          </ul>
-        </div>
-      )}
-
-      <CodeBlock text={error || data} />
-    </div>
-  );
-}

package/src/tokens/getTokenInfo.stories.tsx

@@ -1,133 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../common/chains';
-import {
-  chainSelector,
-  envSelector,
-  makeTokenSelector,
-} from '../stories/arg-types';
-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 './token-addresses';
-import { getTokenInfo } from './tokens';
-
-const meta = {
-  title: 'tokens/getTokenInfo',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-  argTypes: {
-    ...chainSelector,
-    ...envSelector,
-    ...makeTokenSelector([Token.LBTC, Token.BTCb, Token.BTCK]),
-  },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const LBTCOnEthereum: Story = {
-  args: {
-    token: Token.LBTC,
-    chainId: ChainId.ethereum,
-    env: undefined,
-  },
-};
-
-export const BTCbOnKatanaTatara: Story = {
-  args: {
-    token: Token.BTCb,
-    chainId: ChainId.katanaTatara,
-    env: undefined,
-  },
-};
-
-export const LBTCOnBase: Story = {
-  args: {
-    token: Token.LBTC,
-    chainId: ChainId.base,
-    env: undefined,
-  },
-};
-
-type GetTokenInfoProps = Parameters<typeof getTokenInfo>;
-
-interface StoryViewProps {
-  token: GetTokenInfoProps[0];
-  chainId: GetTokenInfoProps[1];
-  env: GetTokenInfoProps[2];
-}
-
-/**
- * Get token information including symbol, decimals, address, and ABI.
- *
- * This function retrieves comprehensive token metadata for a given token
- * on a specific chain. It automatically detects if the contract is upgraded
- * and returns the appropriate ABI.
- *
- * **Use Cases:**
- * - Display token information in your UI
- * - Validate token contracts before interactions
- * - Get the correct ABI for contract calls
- *
- * **Returns:**
- * - `address`: The token contract address
- * - `abi`: The appropriate ABI for the token
- * - `symbol`: Token symbol (e.g., "LBTC")
- * - `decimals`: Number of decimal places
- */
-export function StoryView(props: StoryViewProps) {
-  const request = async () => {
-    return getTokenInfo(props.token, props.chainId, props.env);
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(
-    request,
-    [props.token, props.chainId, props.env],
-    false,
-  );
-
-  return (
-    <div className="container">
-      <div className="mb-3">
-        <h3>Token Information Query</h3>
-        <p className="text-muted">
-          Retrieves token metadata including symbol, decimals, address, and ABI.
-          Automatically detects upgraded contracts.
-        </p>
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getTokenInfo.name}
-      />
-
-      {data && (
-        <div className="mt-3">
-          <h5>Result Preview:</h5>
-          <ul>
-            <li>
-              <strong>Symbol:</strong> {data.symbol}
-            </li>
-            <li>
-              <strong>Decimals:</strong> {data.decimals}
-            </li>
-            <li>
-              <strong>Address:</strong> {data.address}
-            </li>
-            <li>
-              <strong>ABI Functions:</strong> {data.abi.length}
-            </li>
-          </ul>
-        </div>
-      )}
-
-      <CodeBlock text={error || data} />
-    </div>
-  );
-}

package/src/tokens/isUpgradedContract.stories.tsx

@@ -1,124 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../common/chains';
-import { chainSelector, envSelector } from '../stories/arg-types';
-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 './token-addresses';
-import { isUpgradedContract } from './tokens';
-
-const meta = {
-  title: 'tokens/isUpgradedContract',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-  argTypes: {
-    ...chainSelector,
-    ...envSelector,
-    token: {
-      options: [Token.LBTC, Token.BTCK],
-      control: { type: 'select' },
-    },
-  },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const LBTCOnEthereum: Story = {
-  args: {
-    token: Token.LBTC,
-    chainId: ChainId.ethereum,
-    env: undefined,
-  },
-};
-
-export const BTCKOnKatanaTatara: Story = {
-  args: {
-    token: Token.BTCK,
-    chainId: ChainId.katanaTatara,
-    env: undefined,
-  },
-};
-
-export const LBTCOnBase: Story = {
-  args: {
-    token: Token.LBTC,
-    chainId: ChainId.base,
-    env: undefined,
-  },
-};
-
-interface StoryViewProps {
-  token: Token.LBTC | Token.BTCK;
-  chainId: ChainId;
-  env?: Env;
-}
-
-/**
- * Check if a token contract has been upgraded to the new version.
- *
- * Lombard token contracts can be upgraded to new versions with additional
- * functionality. This function checks if a contract has the `getAssetRouter`
- * function, which indicates it's using the upgraded version.
- *
- * **Supported Tokens:**
- * - `LBTC`: Checks for STLBTC_ABI (upgraded) vs LBTC_ABI (legacy)
- * - `BTCK`: Checks for NATIVE_LBTC_ABI (upgraded) vs BTCK_ABI (legacy)
- *
- * **Use Cases:**
- * - Determine which ABI to use for contract interactions
- * - Feature detection for upgraded contract functions
- * - Display upgrade status in UI
- *
- * **Returns:**
- * - `true`: Contract is upgraded (has getAssetRouter)
- * - `false`: Contract is legacy or doesn't support upgrades
- */
-export function StoryView(props: StoryViewProps) {
-  const request = async () => {
-    return isUpgradedContract(props.token, props.chainId, props.env);
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(
-    request,
-    [props.token, props.chainId, props.env],
-    false,
-  );
-
-  return (
-    <div className="container">
-      <div className="mb-3">
-        <h3>Contract Upgrade Status</h3>
-        <p className="text-muted">
-          Checks if the token contract has been upgraded to the latest version
-          with enhanced functionality.
-        </p>
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={isUpgradedContract.name}
-      />
-
-      {typeof data === 'boolean' && (
-        <div className="mt-3">
-          <div className={`alert ${data ? 'alert-success' : 'alert-info'}`}>
-            <strong>Status:</strong>{' '}
-            {data
-              ? '✅ Contract is upgraded (uses enhanced ABI)'
-              : 'ℹ️ Contract uses legacy ABI'}
-          </div>
-        </div>
-      )}
-
-      <CodeBlock text={error ?? (data !== undefined ? data : null)} />
-    </div>
-  );
-}

package/src/tokens/lbtc-addresses.ts

@@ -1,18 +0,0 @@
-import { DEFAULT_ENV, Env } from '@lombard.finance/sdk-common';
-import { Address } from 'viem';
-
-import { ChainId } from '../common/chains';
-import { EVM_LBTC_ADDRESSES } from './token-addresses';
-
-type LbtcContractAddresses = Partial<Record<ChainId, Address>>;
-
-/**
- * Gets the collection of LBTC contract addresses based on the provided
- * environment.
- */
-export function getLbtcContractAddresses(
-  env: Env = DEFAULT_ENV,
-): LbtcContractAddresses {
-  const found = EVM_LBTC_ADDRESSES?.[env];
-  return found || {};
-}