@lombard.finance/sdk 3.7.4 → 4.1.0

package/src/api-functions/getDepositBtcAddress/getDepositBtcAddress.test.ts

@@ -1,265 +0,0 @@
-import { describe, expect, it, type Mock, vi } from 'vitest';
-vi.mock('./make-request', async () => {
-  return {
-    makeRequest: vi.fn(async () => undefined),
-  };
-});
-
-import { Env } from '@lombard.finance/sdk-common';
-
-import { getChainNameById } from '../../common/blockchain-identifier';
-import { ChainId } from '../../common/chains';
-import { Token, TOKEN_ADDRESSES } from '../../tokens/token-addresses';
-import { DAY, now, toUnix } from '../../utils/time';
-import { getDepositBtcAddress } from './getDepositBtcAddress';
-import { makeRequest } from './make-request';
-import { IDepositAddress, IGetDepositBtcAddressesParameters } from './types';
-
-const ACCOUNT_ADDRESS_A = '0x1111111111111111111111111111111111111111';
-
-const DEPOSIT_ADDRESS_A = 'bc1aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa';
-const DEPOSIT_ADDRESS_B = 'bc1bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb';
-const DEPOSIT_ADDRESS_C = 'bc1ccccccccccccccccccccccccccccccccccccccc';
-
-const makeDepositAddress = (
-  depositAddress: string,
-  chainId: ChainId,
-  toAddress: string,
-  createdAt: number,
-  token?: Token,
-) =>
-  ({
-    btc_address: depositAddress,
-    type: 'ADDRESS_TYPE_DEPOSIT',
-    deposit_metadata: {
-      to_address: toAddress,
-      to_blockchain: getChainNameById(chainId),
-      referral: 'lombard',
-      ...(token != null
-        ? {
-            token_address: TOKEN_ADDRESSES[token]?.[Env.prod]?.[chainId],
-            aux_version: 1,
-          }
-        : {}),
-    },
-    created_at: createdAt.toString(),
-  }) as IDepositAddress;
-
-describe('getDepositBtcAddress', () => {
-  it.each([
-    [
-      'Wants LBTC on Ethereum, should return the most recent LBTC address',
-      [
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_A,
-          ChainId.ethereum,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 2),
-          Token.LBTC,
-        ),
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_B,
-          ChainId.ethereum,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 1),
-          Token.LBTC,
-        ),
-      ],
-      Token.LBTC,
-      ChainId.ethereum,
-      DEPOSIT_ADDRESS_B,
-    ],
-
-    [
-      'Wants LBTC on Ethereum, no token information in the API response, should return the most recent LBTC address',
-      [
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_A,
-          ChainId.ethereum,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 2),
-        ),
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_B,
-          ChainId.ethereum,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 1),
-        ),
-      ],
-      Token.LBTC,
-      ChainId.ethereum,
-      DEPOSIT_ADDRESS_B,
-    ],
-
-    [
-      'Wants LBTC on Katana, only NativeLBTC address, should throw an error',
-      [
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_A,
-          ChainId.katana,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 2),
-          Token.BTCb,
-        ),
-      ],
-      Token.LBTC,
-      ChainId.katana,
-      undefined,
-    ],
-
-    [
-      'Wants NativeLBTC on Katana, should return the most recent NativeLBTC address',
-      [
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_A,
-          ChainId.katana,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 1),
-          Token.LBTC,
-        ),
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_B,
-          ChainId.katana,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 2),
-          Token.LBTC,
-        ),
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_C,
-          ChainId.katana,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 2),
-          Token.BTCb,
-        ),
-      ],
-      Token.BTCb,
-      ChainId.katana,
-      DEPOSIT_ADDRESS_C,
-    ],
-
-    [
-      'Wants BTCK (alias of NativeLBTC) on Katana, should return the most recent NativeLBTC address',
-      [
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_A,
-          ChainId.katana,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 2),
-          Token.BTCb,
-        ),
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_B,
-          ChainId.katana,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 0),
-          Token.LBTC,
-        ),
-      ],
-      Token.BTCK,
-      ChainId.katana,
-      DEPOSIT_ADDRESS_A,
-    ],
-
-    [
-      'Wants NativeLBTC on Katana, no token information in the API response, should throw an error',
-      [
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_A,
-          ChainId.katana,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 2),
-        ),
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_B,
-          ChainId.katana,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 0),
-        ),
-      ],
-      Token.BTCK,
-      ChainId.katana,
-      undefined,
-    ],
-
-    [
-      'Wants LBTC on Ethereum, should return the most recent LBTC address (legacy call)',
-      [
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_A,
-          ChainId.ethereum,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 2),
-        ),
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_B,
-          ChainId.katana,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 0),
-        ),
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_C,
-          ChainId.base,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 0),
-          Token.LBTC,
-        ),
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_C,
-          ChainId.base,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 0),
-          Token.BTCb,
-        ),
-      ],
-      undefined,
-      ChainId.ethereum,
-      DEPOSIT_ADDRESS_A,
-    ],
-
-    [
-      'Wants NativeLBTC on Ethereum, no token address for NativeLBTC on Ethereum, should throw an error.',
-      [
-        makeDepositAddress(
-          DEPOSIT_ADDRESS_A,
-          ChainId.ethereum,
-          ACCOUNT_ADDRESS_A,
-          toUnix(now() - DAY * 2),
-        ),
-      ],
-      Token.BTCb,
-      ChainId.ethereum,
-      undefined,
-    ],
-  ])(
-    '$0',
-    async (
-      _description: string,
-      API_RESPONSE: IDepositAddress[],
-      token: Token | undefined,
-      chainId: ChainId,
-      expectedAddress: string | undefined,
-    ) => {
-      const params: IGetDepositBtcAddressesParameters = {
-        address: ACCOUNT_ADDRESS_A,
-        chainId,
-        env: Env.prod,
-        partnerId: 'lombard',
-      };
-
-      (makeRequest as Mock).mockImplementation(async () => API_RESPONSE);
-
-      if (!expectedAddress) {
-        await expect(
-          getDepositBtcAddress({ ...params, token }),
-        ).rejects.toThrow();
-      } else {
-        const address = await getDepositBtcAddress({
-          ...params,
-          token,
-        });
-
-        expect(address).toBe(expectedAddress);
-      }
-    },
-  );
-});

package/src/api-functions/getDepositBtcAddress/getDepositBtcAddress.ts

@@ -1,166 +0,0 @@
-import { Address, pad } from 'viem';
-
-import { getChainNameById } from '../../common/blockchain-identifier';
-import {
-  isSolanaChain,
-  isStarknetChainId,
-  isSuiChain,
-  isValidChain,
-} from '../../common/chains';
-import {
-  AddressKind,
-  getSolanaTokenAddress,
-  getStarknetTokenAddress,
-  getSuiTokenAddress,
-  Token,
-} from '../../tokens/token-addresses';
-import { getTokenContractInfo } from '../../tokens/tokens';
-import { makeRequest } from './make-request';
-import type {
-  IGetDepositBtcAddressesParameters,
-  IGetDepositBtcAddressParameters,
-} from './types';
-
-/**
- * Returns the current address for depositing BTC by given parameters.
- *
- * @throws {Error} - Throws an error if no address found or the provided chain id is not supported.
- */
-export async function getDepositBtcAddress({
-  address,
-  chainId,
-  env,
-  partnerId,
-  token = Token.LBTC,
-}: IGetDepositBtcAddressParameters) {
-  const _addresses = await makeRequest({
-    address,
-    chainId,
-    env,
-    partnerId,
-  });
-
-  let depositAddress: string | undefined = undefined;
-
-  if (![Token.LBTC, Token.BTCK, Token.BTCb].includes(token)) {
-    throw new Error('Unsupported token');
-  }
-
-  // Filter deposit addresses by the destination token
-  let tokenAddressFilter:
-    | { token_address: string; aux_version?: number }
-    | undefined = undefined;
-  try {
-    if (isValidChain(chainId)) {
-      const tokenContractInfo = await getTokenContractInfo(
-        token,
-        chainId,
-        env,
-        AddressKind.Adapter,
-      );
-      tokenAddressFilter = {
-        token_address: tokenContractInfo.address.toLowerCase(),
-      };
-    }
-
-    if (isSuiChain(chainId)) {
-      const tokenAddress = getSuiTokenAddress(chainId, env);
-      if (tokenAddress) {
-        tokenAddressFilter = {
-          token_address: tokenAddress.toLowerCase(),
-        };
-      }
-    }
-
-    if (isSolanaChain(chainId)) {
-      const tokenAddress = getSolanaTokenAddress(chainId, env);
-      if (tokenAddress) {
-        tokenAddressFilter = {
-          token_address: tokenAddress.toLowerCase(),
-        };
-      }
-    }
-
-    if (isStarknetChainId(chainId)) {
-      // api returns the address of the asset router contract
-      const tokenAddress = getStarknetTokenAddress(chainId, env, 'assetRouter');
-      if (tokenAddress) {
-        tokenAddressFilter = {
-          token_address: tokenAddress.toLowerCase(),
-        };
-      }
-    }
-  } catch {
-    // NOOP
-  }
-
-  if (isStarknetChainId(chainId)) {
-    address = pad(address as Address, { size: 32 }).toLowerCase();
-  }
-
-  const addresses = (_addresses || [])
-    .filter(
-      a =>
-        // filter by chain id
-        a.deposit_metadata.to_blockchain.toLowerCase() ===
-          getChainNameById(chainId).toLowerCase() &&
-        // filter by address
-        a.deposit_metadata.to_address.toLowerCase() === address.toLowerCase(),
-    )
-    .filter(a => {
-      if (!tokenAddressFilter) {
-        return false;
-      }
-
-      // check if token addresses are matched
-      let isForToken =
-        a.deposit_metadata.token_address?.toLowerCase() ===
-        tokenAddressFilter.token_address;
-      // check if aux version is matched (if provided)
-      if (tokenAddressFilter.aux_version != null) {
-        isForToken =
-          isForToken &&
-          a.deposit_metadata.aux_version === tokenAddressFilter.aux_version;
-      }
-
-      // token_address can also be empty (null) when the address is for LBTC.
-      if (token === Token.LBTC) {
-        isForToken = isForToken || !a.deposit_metadata.token_address;
-      }
-
-      // Get only the addresses for the specified token.
-      return isForToken;
-    });
-
-  if (addresses && addresses.length > 0) {
-    const mostRecentAddress = addresses.reduce((mostRecent, cur) => {
-      if (cur.created_at > mostRecent.created_at) {
-        return cur;
-      }
-      return mostRecent;
-    }, addresses[0]);
-
-    if (!mostRecentAddress.deprecated) {
-      depositAddress = mostRecentAddress.btc_address;
-    }
-  }
-
-  if (!depositAddress) {
-    throw new Error(
-      `No deposit address found for ${address} on chain ${chainId}`,
-    );
-  }
-
-  return depositAddress;
-}
-
-/**
- * Returns the addresses for depositing BTC by given parameters.
- * @throws {Error} - Throws an error if chain id is not supported.
- */
-export async function getDepositBtcAddresses(
-  parameters: IGetDepositBtcAddressesParameters,
-) {
-  const addresses = await makeRequest(parameters);
-  return addresses;
-}

package/src/api-functions/getDepositBtcAddress/getDepositBtcAddresses.stories.tsx

@@ -1,57 +0,0 @@
-import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-import { ChainId } from '../../common/chains';
-import { chainSelector } from '../../stories/arg-types';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { functionType } from '../../stories/components/decorators';
-import { EXAMPLE_EVM_ADDRESS } from '../../stories/constants';
-import useQuery from '../../stories/hooks/useQuery';
-import { getDepositBtcAddresses } from './getDepositBtcAddress';
-import { IGetDepositBtcAddressesParameters } from './types';
-
-const meta = {
-  title: 'api/getDepositBtcAddresses',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('api-get')],
-  argTypes: {
-    ...chainSelector,
-  },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    address: EXAMPLE_EVM_ADDRESS,
-    chainId: ChainId.ethereum,
-    env: DEFAULT_ENV,
-    limit: 1,
-    offset: 0,
-    partnerId: 'lombard',
-  },
-};
-
-export function StoryView(props: IGetDepositBtcAddressesParameters) {
-  const { data, error, isLoading, refetch } = useQuery(
-    () => getDepositBtcAddresses(props),
-    [props],
-    false,
-  );
-
-  return (
-    <>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getDepositBtcAddresses.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/api-functions/getDepositBtcAddress/index.ts

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

package/src/api-functions/getDepositBtcAddress/make-request.ts

@@ -1,59 +0,0 @@
-import axios from 'axios';
-import { Address, pad } from 'viem';
-
-import { getApiConfig } from '../../common/api-config';
-import {
-  BlockchainIdentifier,
-  getChainNameById,
-} from '../../common/blockchain-identifier';
-import {
-  IApiError,
-  IDepositAddressesResponse,
-  IGetDepositBtcAddressesParameters,
-} from './types';
-
-export async function makeRequest({
-  address,
-  chainId,
-  env,
-  limit,
-  offset,
-  partnerId,
-}: IGetDepositBtcAddressesParameters) {
-  const { baseApiUrl } = getApiConfig(env);
-
-  // throws an error if `chainId` is unknown
-  const destinationBlockchain = getChainNameById(chainId);
-  if (destinationBlockchain === BlockchainIdentifier.starknet) {
-    address = pad(address as Address, { size: 32 });
-  }
-
-  const params = {
-    asc: false,
-    limit,
-    offset,
-    referralId: partnerId || 'lombard',
-  };
-
-  // remove undefined fields, undefined limit and offset params cause error
-  for (const [k, v] of Object.entries(params)) {
-    if (v === undefined) {
-      delete params[k as keyof typeof params];
-    }
-  }
-
-  const url = `api/v1/address/destination/${destinationBlockchain}/${address}`;
-  try {
-    const { data } = await axios.get<IDepositAddressesResponse>(url, {
-      baseURL: baseApiUrl,
-      params,
-    });
-
-    return data.addresses || [];
-  } catch (err) {
-    if (axios.isAxiosError<IApiError>(err)) {
-      const message = err.response?.data.message;
-      throw new Error(message);
-    }
-  }
-}

package/src/api-functions/getDepositBtcAddress/types.ts

@@ -1,106 +0,0 @@
-import { BlockchainIdentifier } from '../../common/blockchain-identifier';
-import {
-  ChainId,
-  SolanaChain,
-  StarknetChainId,
-  SuiChain,
-} from '../../common/chains';
-import { IEnvParam } from '../../common/parameters';
-import { Token } from '../../tokens/token-addresses';
-
-export interface IDepositAddress {
-  /**
-   * The deposit address for BTC.
-   */
-  btc_address: string;
-  /**
-   * The address creation timestamp.
-   */
-  created_at: string;
-  /**
-   * A flag determining whether an address is deprecated (no longer valid for depositing BTC).
-   */
-  deprecated?: boolean;
-  /**
-   * Type of an address.
-   * @constant {string} - ADDRESS_TYPE_DEPOSIT
-   */
-  type: string;
-  /**
-   * A flag determining whether an address has been used.
-   */
-  used?: boolean;
-
-  /**
-   * The deposit address metadata
-   */
-  deposit_metadata: {
-    /**
-     * The partner (referral) id.
-     */
-    referral: string;
-    /**
-     * The partner (referral) id.
-     */
-    partner_id: string;
-    /**
-     * The destination address.
-     */
-    to_address: string;
-    /**
-     * The destination blockchain corresponding to the `to_address`
-     */
-    to_blockchain: BlockchainIdentifier;
-    /**
-     * The destination token address
-     */
-    token_address?: string;
-    /**
-     * The aux version (paired with the token_address)
-     */
-    aux_version?: number;
-  };
-}
-
-export interface IDepositAddressesResponse {
-  addresses: IDepositAddress[];
-  has_more?: boolean;
-}
-
-export interface IApiError {
-  code: number;
-  message?: string;
-}
-
-export interface IGetDepositBtcAddressesParameters extends IEnvParam {
-  /**
-   * The destination address where LBTC will be claimed.
-   */
-  address: string;
-  /**
-   * The destination chain where the `address` exists and where LBTC will be claimed.
-   */
-  chainId: ChainId | SuiChain | SolanaChain | StarknetChainId;
-  /**
-   * The maximum number of items to return.
-   * @default {number} 1
-   */
-  limit?: number;
-
-  /**
-   * The number of items to skip before starting to return the items.
-   * @default {number} 0
-   */
-  offset?: number;
-
-  /**
-   * The partner (referral) id.
-   * @default {string} "lombard"
-   */
-  partnerId?: string;
-}
-
-export type IGetDepositBtcAddressParameters = { token?: Token } & Pick<
-  IGetDepositBtcAddressesParameters,
-  'address' | 'chainId' | 'env' | 'partnerId'
->;

package/src/api-functions/getDepositsByAddress/getDepositsByAddress.stories.tsx

@@ -1,50 +0,0 @@
-import { DEFAULT_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 { functionType } from '../../stories/components/decorators';
-import { EXAMPLE_EVM_ADDRESS } from '../../stories/constants';
-import useQuery from '../../stories/hooks/useQuery';
-import {
-  IGetDepositsByAddressParams,
-  getDepositsByAddress,
-} from './getDepositsByAddress';
-
-const meta = {
-  title: 'api/getDepositsByAddress',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('api-get')],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    address: EXAMPLE_EVM_ADDRESS,
-    env: DEFAULT_ENV,
-  },
-};
-
-export function StoryView(props: IGetDepositsByAddressParams) {
-  const { data, error, isLoading, refetch } = useQuery(
-    () => getDepositsByAddress(props),
-    [props],
-    false,
-  );
-
-  return (
-    <>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getDepositsByAddress.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}