@lombard.finance/sdk 4.0.0 → 4.1.0

package/src/tokens/cross-chain-addresses.stories.tsx

@@ -1,236 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-import { useState } from 'react';
-
-import {
-  SOLANA_DEVNET_CHAIN,
-  SOLANA_MAINNET_CHAIN,
-  SOLANA_TESTNET_CHAIN,
-  STARKNET_MAINNET_CHAIN,
-  STARKNET_SEPOLIA_CHAIN,
-  SUI_MAINNET_CHAIN,
-  SUI_TESTNET_CHAIN,
-} from '../common/chains';
-import { envSelector } from '../stories/arg-types';
-import { Button } from '../stories/components/Button';
-import { CodeBlock } from '../stories/components/CodeBlock';
-import { functionType } from '../stories/components/decorators';
-import {
-  getSolanaTokenAddress,
-  getStarknetTokenAddress,
-  getSuiTokenAddress,
-} from './token-addresses';
-
-const meta = {
-  title: 'tokens/cross-chain-addresses',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-  argTypes: {
-    ...envSelector,
-    blockchain: {
-      options: ['Sui', 'Solana', 'Starknet'],
-      control: { type: 'select' },
-    },
-  },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const SuiMainnet: Story = {
-  args: {
-    blockchain: 'Sui',
-    env: 'prod',
-  },
-};
-
-export const SolanaMainnet: Story = {
-  args: {
-    blockchain: 'Solana',
-    env: 'prod',
-  },
-};
-
-export const StarknetMainnet: Story = {
-  args: {
-    blockchain: 'Starknet',
-    env: 'prod',
-  },
-};
-
-export const SuiTestnet: Story = {
-  args: {
-    blockchain: 'Sui',
-    env: 'testnet',
-  },
-};
-
-interface StoryViewProps {
-  blockchain: 'Sui' | 'Solana' | 'Starknet';
-  env?: Env;
-}
-
-/**
- * Get LBTC token addresses for non-EVM blockchains.
- *
- * Lombard tokens are deployed across multiple blockchain ecosystems.
- * These helper functions provide easy access to token addresses for:
- *
- * **Sui Network:**
- * - `getSuiTokenAddress(chainId, env)`
- * - Supported: Mainnet, Testnet
- * - Returns Sui package/object address
- *
- * **Solana:**
- * - `getSolanaTokenAddress(chainId, env)`
- * - Supported: Mainnet, Testnet, Devnet
- * - Returns SPL token mint address
- *
- * **Starknet:**
- * - `getStarknetTokenAddress(chainId, env, variant)`
- * - Supported: Mainnet, Sepolia
- * - Variants: 'token' (default), 'assetRouter'
- * - Returns Cairo contract address
- *
- * **Use Cases:**
- * - Cross-chain integrations
- * - Multi-wallet support
- * - Token verification on different chains
- * - SDK initialization for non-EVM chains
- *
- * **Returns:**
- * - String address if deployed
- * - `undefined` if not deployed on that chain/environment
- */
-export function StoryView(props: StoryViewProps) {
-  const [results, setResults] = useState<Record<string, string | undefined>>(
-    {},
-  );
-
-  const handleFetch = () => {
-    const newResults: Record<string, string | undefined> = {};
-
-    if (props.blockchain === 'Sui') {
-      newResults['Sui Mainnet'] = getSuiTokenAddress(
-        SUI_MAINNET_CHAIN,
-        props.env,
-      );
-      newResults['Sui Testnet'] = getSuiTokenAddress(
-        SUI_TESTNET_CHAIN,
-        props.env,
-      );
-    } else if (props.blockchain === 'Solana') {
-      newResults['Solana Mainnet'] = getSolanaTokenAddress(
-        SOLANA_MAINNET_CHAIN,
-        props.env,
-      );
-      newResults['Solana Testnet'] = getSolanaTokenAddress(
-        SOLANA_TESTNET_CHAIN,
-        props.env,
-      );
-      newResults['Solana Devnet'] = getSolanaTokenAddress(
-        SOLANA_DEVNET_CHAIN,
-        props.env,
-      );
-    } else if (props.blockchain === 'Starknet') {
-      newResults['Starknet Mainnet (Token)'] = getStarknetTokenAddress(
-        STARKNET_MAINNET_CHAIN,
-        props.env,
-        'token',
-      );
-      newResults['Starknet Mainnet (Asset Router)'] = getStarknetTokenAddress(
-        STARKNET_MAINNET_CHAIN,
-        props.env,
-        'assetRouter',
-      );
-      newResults['Starknet Sepolia (Token)'] = getStarknetTokenAddress(
-        STARKNET_SEPOLIA_CHAIN,
-        props.env,
-        'token',
-      );
-      newResults['Starknet Sepolia (Asset Router)'] = getStarknetTokenAddress(
-        STARKNET_SEPOLIA_CHAIN,
-        props.env,
-        'assetRouter',
-      );
-    }
-
-    setResults(newResults);
-  };
-
-  return (
-    <div className="container">
-      <div className="mb-3">
-        <h3>Cross-Chain Token Addresses</h3>
-        <p className="text-muted">
-          Get LBTC token addresses for non-EVM blockchains (Sui, Solana,
-          Starknet).
-        </p>
-      </div>
-
-      <div className="card mb-3">
-        <div className="card-body">
-          <h5>Query Parameters</h5>
-          <ul>
-            <li>
-              <strong>Blockchain:</strong> {props.blockchain}
-            </li>
-            <li>
-              <strong>Environment:</strong> {props.env || 'prod (default)'}
-            </li>
-          </ul>
-        </div>
-      </div>
-
-      <Button onClick={handleFetch} actionName="Fetch Addresses" />
-
-      {Object.keys(results).length > 0 && (
-        <div className="mt-3">
-          <h5>Results:</h5>
-          <div className="card">
-            <div className="card-body">
-              <table className="table table-sm">
-                <thead>
-                  <tr>
-                    <th>Chain</th>
-                    <th>Status</th>
-                    <th>Address</th>
-                  </tr>
-                </thead>
-                <tbody>
-                  {Object.entries(results).map(([chain, address]) => (
-                    <tr key={chain}>
-                      <td>
-                        <strong>{chain}</strong>
-                      </td>
-                      <td>
-                        {address ? (
-                          <span className="badge bg-success">Deployed</span>
-                        ) : (
-                          <span className="badge bg-secondary">
-                            Not Deployed
-                          </span>
-                        )}
-                      </td>
-                      <td>
-                        {address ? (
-                          <code className="text-break">{address}</code>
-                        ) : (
-                          <span className="text-muted">N/A</span>
-                        )}
-                      </td>
-                    </tr>
-                  ))}
-                </tbody>
-              </table>
-            </div>
-          </div>
-
-          <CodeBlock text={results} />
-        </div>
-      )}
-    </div>
-  );
-}

package/src/tokens/denomination-utils.stories.tsx

@@ -1,176 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { useState } from 'react';
-
-import { Button } from '../stories/components/Button';
-import { CodeBlock } from '../stories/components/CodeBlock';
-import { functionType } from '../stories/components/decorators';
-import { fromBaseDenomination, toBaseDenomination } from './tokens';
-
-const meta = {
-  title: 'tokens/denomination-conversion',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-  argTypes: {
-    amount: {
-      control: { type: 'text' },
-      description: 'Amount to convert',
-    },
-    decimals: {
-      control: { type: 'number', min: 0, max: 18 },
-      description: 'Number of decimal places',
-    },
-  },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const BTCToSatoshi: Story = {
-  args: {
-    amount: '1',
-    decimals: 8,
-  },
-};
-
-export const LBTCToWei: Story = {
-  args: {
-    amount: '0.5',
-    decimals: 8,
-  },
-};
-
-export const SmallAmount: Story = {
-  args: {
-    amount: '0.00000001',
-    decimals: 8,
-  },
-};
-
-interface StoryViewProps {
-  amount: string;
-  decimals: number;
-}
-
-/**
- * Convert between human-readable amounts and base denominations.
- *
- * These utility functions handle conversion between display values and
- * contract-compatible base units (like satoshis for BTC or wei for ETH).
- *
- * **Functions:**
- *
- * 1. `toBaseDenomination(amount, decimals)`:
- *    - Converts human-readable amount to base units
- *    - Example: 1 BTC → 100,000,000 satoshis (decimals=8)
- *    - Use before sending amounts to smart contracts
- *
- * 2. `fromBaseDenomination(amount, decimals)`:
- *    - Converts base units to human-readable amount
- *    - Example: 100,000,000 satoshis → 1 BTC (decimals=8)
- *    - Use when displaying contract values to users
- *
- * **Common Decimal Places:**
- * - BTC/LBTC: 8 decimals
- * - ETH: 18 decimals
- * - USDC/USDT: 6 decimals
- *
- * **Important Notes:**
- * - Uses BigNumber.js for precision
- * - Rounds to nearest integer for base denomination
- * - No rounding for display denomination
- */
-export function StoryView(props: StoryViewProps) {
-  const [results, setResults] = useState<{
-    toBase: string;
-    fromBase: string;
-  } | null>(null);
-
-  const handleConvert = () => {
-    try {
-      const toBase = toBaseDenomination(props.amount, props.decimals);
-      const fromBase = fromBaseDenomination(toBase, props.decimals);
-
-      setResults({
-        toBase: toBase.toString(),
-        fromBase: fromBase.toString(),
-      });
-    } catch (err) {
-      setResults({
-        toBase: `Error: ${err}`,
-        fromBase: 'N/A',
-      });
-    }
-  };
-
-  return (
-    <div className="container">
-      <div className="mb-3">
-        <h3>Denomination Conversion Utilities</h3>
-        <p className="text-muted">
-          Convert between human-readable amounts and base denominations (wei,
-          satoshis, etc.)
-        </p>
-      </div>
-
-      <div className="card mb-3">
-        <div className="card-body">
-          <h5>Input Values</h5>
-          <ul>
-            <li>
-              <strong>Amount:</strong> {props.amount}
-            </li>
-            <li>
-              <strong>Decimals:</strong> {props.decimals}
-            </li>
-          </ul>
-        </div>
-      </div>
-
-      <Button onClick={handleConvert} actionName="Convert" />
-
-      {results && (
-        <div className="mt-3">
-          <div className="card mb-3">
-            <div className="card-body">
-              <h5>Conversion Results</h5>
-
-              <div className="mb-3">
-                <h6>toBaseDenomination():</h6>
-                <p className="text-muted mb-2">
-                  Converts to base units (for smart contract calls)
-                </p>
-                <code className="d-block p-2 bg-light">
-                  {props.amount} × 10^{props.decimals} = {results.toBase}
-                </code>
-              </div>
-
-              <div>
-                <h6>fromBaseDenomination():</h6>
-                <p className="text-muted mb-2">
-                  Converts back to human-readable (for display)
-                </p>
-                <code className="d-block p-2 bg-light">
-                  {results.toBase} ÷ 10^{props.decimals} = {results.fromBase}
-                </code>
-              </div>
-            </div>
-          </div>
-
-          <h5 className="mt-4">Example Usage:</h5>
-          <CodeBlock
-            text={{
-              example: {
-                input: `toBaseDenomination("${props.amount}", ${props.decimals})`,
-                output: results.toBase,
-                reverseInput: `fromBaseDenomination("${results.toBase}", ${props.decimals})`,
-                reverseOutput: results.fromBase,
-              },
-            }}
-          />
-        </div>
-      )}
-    </div>
-  );
-}

package/src/tokens/getLbtcContractAddresses.stories.tsx

@@ -1,158 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { getChain } from '../common/chains';
-import { 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 { getLbtcContractAddresses } from './lbtc-addresses';
-
-const meta = {
-  title: 'tokens/getLbtcContractAddresses',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-  argTypes: {
-    ...envSelector,
-  },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Production: Story = {
-  args: {
-    env: undefined,
-  },
-};
-
-export const Testnet: Story = {
-  args: {
-    env: 'testnet',
-  },
-};
-
-export const Development: Story = {
-  args: {
-    env: 'dev',
-  },
-};
-
-interface StoryViewProps {
-  env?: Env;
-}
-
-/**
- * Get all LBTC contract addresses for a specific environment.
- *
- * This function returns a complete mapping of LBTC contract addresses
- * across all supported EVM chains for a given environment (prod, testnet, dev).
- *
- * **Environments:**
- * - `prod`: Production/mainnet addresses
- * - `testnet`: Public testnet addresses
- * - `stage`: Staging environment
- * - `dev`: Development environment
- * - `ibc`: IBC environment
- *
- * **Supported Chains:**
- * - Ethereum
- * - Base
- * - Avalanche
- * - Berachain
- * - Binance Smart Chain
- * - BOB
- * - Corn
- * - Etherlink
- * - Katana
- * - Morph
- * - Sonic
- * - Swell
- * - TAC
- * - And their testnets
- *
- * **Use Cases:**
- * - Display all deployment addresses
- * - Validate contract addresses
- * - Multi-chain integration setup
- * - Configuration management
- *
- * **Returns:**
- * Object mapping ChainId to contract Address
- */
-export function StoryView(props: StoryViewProps) {
-  const request = async () => {
-    return getLbtcContractAddresses(props.env);
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(
-    request,
-    [props.env],
-    false,
-  );
-
-  // Count deployed chains
-  const deployedChains = data ? Object.keys(data).length : 0;
-
-  return (
-    <div className="container">
-      <div className="mb-3">
-        <h3>LBTC Contract Addresses</h3>
-        <p className="text-muted">
-          Retrieve all LBTC contract addresses across supported chains for a
-          specific environment.
-        </p>
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getLbtcContractAddresses.name}
-      />
-
-      {data && (
-        <div className="mt-3">
-          <div className="alert alert-info">
-            <strong>Deployed Chains:</strong> {deployedChains}
-          </div>
-
-          <h5>Chain Deployments:</h5>
-          <div className="card">
-            <div className="card-body">
-              <table className="table table-sm">
-                <thead>
-                  <tr>
-                    <th>Chain</th>
-                    <th>Address</th>
-                  </tr>
-                </thead>
-                <tbody>
-                  {Object.entries(data).map(([chainId, address]) => {
-                    const chain = getChain(Number(chainId));
-                    return (
-                      <tr key={chainId}>
-                        <td>
-                          <strong>{chain?.name || 'Unknown'}</strong> ({chainId}
-                          )
-                        </td>
-                        <td>
-                          <code className="text-break">{address}</code>
-                        </td>
-                      </tr>
-                    );
-                  })}
-                </tbody>
-              </table>
-            </div>
-          </div>
-        </div>
-      )}
-
-      <CodeBlock text={error || data} />
-    </div>
-  );
-}