@lombard.finance/sdk 4.0.0 → 4.1.2

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

@@ -1,71 +0,0 @@
-import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../../common/chains';
-import { chainSelector, makeTokenSelector } 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 { Token } from '../../tokens/token-addresses';
-import {
-  generateDepositBtcAddress,
-  IGenerateDepositBtcAddressParams,
-} from './generateDepositBtcAddress';
-
-const meta = {
-  title: 'api/generateDepositBtcAddress',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('api-post')],
-  argTypes: {
-    ...chainSelector,
-    ...makeTokenSelector([Token.LBTC, Token.BTCK, Token.BTCb]),
-  },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-const d = {
-  signature:
-    '0x9ca1c54532b42da150d7e1c87a55d2601a245d2a34f5c442e40d2793e2e7b739095cd1213aadd45db96d8459dd3a612daa01a08f661a5d67290bd806e4862f101c',
-  typedData:
-    '{"account":"0x659579F1460c38C3ce3288b47b074646CEF855fc","domain":{"name":"Lombard Staked Bitcoin","version":"1","chainId":1,"verifyingContract":"0x8236a87084f8b84306f72007f36f2618a5634494"},"message":{"chainId":1,"fee":"1100","expiry":1746119680},"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"}]}}',
-};
-
-export const WithParams: Story = {
-  args: {
-    address: EXAMPLE_EVM_ADDRESS,
-    token: Token.LBTC,
-    chainId: ChainId.ethereum,
-    signature: d.signature,
-    eip712Data: d.typedData,
-    env: DEFAULT_ENV,
-    referrerCode: '',
-    partnerId: 'lombard',
-  },
-};
-
-export function StoryView(props: IGenerateDepositBtcAddressParams) {
-  const { data, error, isLoading, refetch } = useQuery(
-    () => generateDepositBtcAddress(props),
-    [props],
-    false,
-  );
-
-  return (
-    <>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={generateDepositBtcAddress.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

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

@@ -1,235 +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 type {
-  ChainId,
-  SolanaChain,
-  StarknetChainId,
-  SuiChain,
-} from '../../common/chains';
-import type { IEnvParam } from '../../common/parameters';
-import { AddressKind, Token } from '../../tokens/token-addresses';
-import { getTokenContractInfo } from '../../tokens/tokens';
-import {
-  getErrorMessage,
-  TokenContractAddressNotFoundError,
-} from '../../utils/err';
-
-/**
- * The address which will be returned if the provided EVM address is sanctioned.
- */
-export const SANCTIONED_ADDRESS = 'sanctioned_address';
-const ADDRESS_URL = 'api/v1/address/generate';
-const SANCTIONS_MESSAGE = 'destination address is under sanctions';
-
-interface IGenerateNewAddressResponse {
-  address: string;
-}
-
-export interface IGenerateDepositBtcAddressParams extends IEnvParam {
-  /**
-   * The destination EVM user address where LBTC will be claimed.
-   */
-  address: string;
-  /**
-   * The intended destination token, defaults to LBTC.
-   */
-  token?: Token;
-  /**
-   * The destination chain ID where LBTC will be claimed.
-   */
-  chainId: ChainId | SuiChain | SolanaChain | StarknetChainId;
-  /**
-   * The signature of the address. The signature is generated by signing the address using EVM wallet.
-   */
-  signature: string;
-  /**
-   * The typed data object used to generate the signature if using a network fee authorization signature.
-   */
-  eip712Data?: string;
-  /**
-   * The captcha token.
-   */
-  captchaToken?: string;
-  /**
-   * The referrer code.
-   */
-  referrerCode?: string;
-  /**
-   * The referral ID.
-   */
-  partnerId?: string;
-  /**
-   * The typed data object used to generate the signature if using a stake and bake feature.
-   */
-  signatureData?: string;
-
-  /** The pubKey required for starknet addresses signatures. */
-  pubKey?: string;
-}
-
-const EXTRA_PARAMS_TOKENS = [Token.LBTC, Token.BTCK, Token.BTCb];
-const SUPPORTED_TOKENS = [Token.LBTC, Token.BTCK, Token.BTCb];
-
-/**
- * Generates a BTC deposit address.
- *
- * If the provided EVM address is sanctioned, the function will return the `SANCTIONED_ADDRESS`.
- *
- * @param {IGenerateDepositBtcAddressParams} parameters - The parameters for generating the deposit address.
- * @param {string} parameters.address - The destination EVM user address where LBTC will be claimed.
- * @param {ChainId} parameters.chainId - The destination chain ID where LBTC will be claimed.
- * @param {string} parameters.signature - The signature of the address. The signature is generated by signing the address using EVM wallet.
- * @param {string} parameters.eip712Data - The typed data object used to generate the signature if using a network fee authorization signature.
- * @param {string} parameters.captchaToken - The captcha token.
- * @param {string} parameters.referrerCode - The referrer code.
- * @param {string} parameters.partnerId - The partner ID.
- * @param {string} parameters.signatureData - The typed data object used to generate the signature if using a stake and bake feature.
- * @param {Env} parameters.env - The optional environment identifier.
- *
- * @returns {Promise<string>} The generated deposit address.
- */
-export async function generateDepositBtcAddress({
-  address,
-  token = Token.LBTC,
-  chainId,
-  signature,
-  eip712Data,
-  env,
-  referrerCode,
-  partnerId,
-  captchaToken,
-  signatureData,
-  pubKey,
-}: IGenerateDepositBtcAddressParams): Promise<string> {
-  const { baseApiUrl } = getApiConfig(env);
-  const toChain = getChainNameById(chainId);
-
-  if (!SUPPORTED_TOKENS.includes(token)) {
-    throw new Error(`Unsupported token: ${token}`);
-  }
-
-  let additionalParams = {};
-  if (toChain === BlockchainIdentifier.starknet) {
-    address = pad(address as Address, { size: 32 });
-    if (!pubKey) {
-      throw new Error('Missing parameter: pubKey');
-    }
-
-    additionalParams = {
-      public_key: pubKey,
-    };
-  }
-
-  // TODO: Refactor
-  // //primaryType: 'feeApproval', - NETWORK FEE
-  // //primaryType: 'Permit', - STAKE AND BAKE
-  // type generationFrom =
-  //   | 'network-fee'
-  //   | 'stake-and-bake'
-  //   | 'destination-address';
-
-  // let generation: generationFrom = 'destination-address';
-  // if (signatureData != null) {
-  //   try {
-  //     const typedData = JSON.parse(signatureData);
-  //     if (typedData?.primaryType === 'feeApproval') {
-  //       generation = 'network-fee';
-  //     } else if (typedData?.primaryType === 'Permit') {
-  //       generation = 'stake-and-bake';
-  //     }
-  //   } catch {
-  //     // NOOP
-  //   }
-  // }
-
-  /**
-   * The deposit address generation requires additional fields for tokens other
-   * than LBTC.
-   */
-  let tokenDataParams = {};
-  try {
-    if (
-      EXTRA_PARAMS_TOKENS.includes(token) &&
-      // FIXME: Refactor in order to pull in all token addresses from all supported networks to the sdk-common package.
-      // FIXME: Then remove this clause prior two token model.
-      !(
-        [
-          BlockchainIdentifier.sui,
-          BlockchainIdentifier.solana,
-          BlockchainIdentifier.starknet,
-        ] as BlockchainIdentifier[]
-      ).includes(toChain)
-    ) {
-      const tokenContractInfo = await getTokenContractInfo(
-        token,
-        chainId as ChainId,
-        env,
-        AddressKind.Adapter,
-      );
-      tokenDataParams = {
-        token_address: tokenContractInfo.address,
-      };
-    }
-  } catch (err) {
-    if (
-      err instanceof Error &&
-      err instanceof TokenContractAddressNotFoundError &&
-      EXTRA_PARAMS_TOKENS.includes(token)
-    ) {
-      throw new Error(
-        `Unable to generate BTC deposit address for given token: ${token} in ${chainId}, reason: ${err.message}`,
-      );
-    }
-  }
-
-  // TODO: Refactor
-  // const signatureDataRequestParams =
-  //   generation === 'network-fee'
-  //     ? {
-  //         eip_712_data: signatureData,
-  //       }
-  //     : generation === 'stake-and-bake'
-  //       ? { sb_signature_data: signatureData }
-  //       : {};
-
-  const requestParams = {
-    to_address: address,
-    to_address_signature: signature,
-    to_chain: toChain,
-    partner_id: partnerId,
-    nonce: 0,
-    captcha: captchaToken,
-    referrer_code: referrerCode,
-    eip_712_data: eip712Data,
-    sb_signature_data: signatureData,
-    ...tokenDataParams,
-    ...additionalParams,
-  };
-
-  try {
-    const { data } = await axios.post<IGenerateNewAddressResponse>(
-      ADDRESS_URL,
-      requestParams,
-      { baseURL: baseApiUrl },
-    );
-
-    return data.address;
-  } catch (error) {
-    const errorMsg = getErrorMessage(error);
-
-    if (isSanctioned(errorMsg)) {
-      return SANCTIONED_ADDRESS;
-    }
-    throw new Error(errorMsg);
-  }
-}
-
-function isSanctioned(errorMsg: string): boolean {
-  return errorMsg.includes(SANCTIONS_MESSAGE);
-}

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

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

package/src/api-functions/get-badges-by-address/get-badges-by-address.ts

@@ -1,13 +0,0 @@
-import { Address } from 'viem';
-
-import { IEnvParam } from '../../common/parameters';
-
-export type GetBadgesByAddress = {
-  /** The account address */
-  address: Address;
-} & IEnvParam;
-
-export async function getBadgesByAddress(_props: GetBadgesByAddress) {
-  // TODO: Move badges logic to SDK
-  throw new Error('Not implemented');
-}

package/src/api-functions/get-badges-by-address/index.ts

@@ -1 +0,0 @@
-export * from './get-badges-by-address';

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

@@ -1,38 +0,0 @@
-import axios from 'axios';
-
-import { getApiConfig } from '../../common/api-config';
-import type { IEnvParam } from '../../common/parameters';
-
-interface ApiResponse {
-  exists?: boolean;
-  referrer?: string;
-}
-
-export interface GetDepositAddressReferrerParams extends IEnvParam {
-  address: string;
-}
-
-export interface DepositAddressReferrerResult {
-  hasDepositAddress: boolean;
-  referrer?: string;
-}
-
-/**
- * Fetch the referrer associated with a previously generated BTC deposit address.
- *
- * @param params - Address lookup parameters
- */
-export async function getDepositAddressReferrer({
-  address,
-  env,
-}: GetDepositAddressReferrerParams): Promise<DepositAddressReferrerResult> {
-  const { baseApiUrl } = getApiConfig(env);
-  const { data } = await axios.get<ApiResponse>(
-    `${baseApiUrl}/api/v1/address/exists/${address}`,
-  );
-
-  return {
-    hasDepositAddress: Boolean(data.exists),
-    referrer: data.referrer,
-  };
-}

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

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

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

@@ -1,59 +0,0 @@
-import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../../common/chains';
-import { chainSelector, makeTokenSelector } 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 { Token } from '../../tokens/token-addresses';
-import { getDepositBtcAddress } from './getDepositBtcAddress';
-import { IGetDepositBtcAddressParameters } from './types';
-
-const meta = {
-  title: 'api/getDepositBtcAddress',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('api-get')],
-  argTypes: {
-    ...chainSelector,
-    ...makeTokenSelector([Token.LBTC, Token.BTCK, Token.BTCb]),
-  },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    token: Token.LBTC,
-    address: EXAMPLE_EVM_ADDRESS,
-    chainId: ChainId.ethereum,
-    env: DEFAULT_ENV,
-    partnerId: 'lombard',
-  },
-};
-
-export function StoryView(props: IGetDepositBtcAddressParameters) {
-  const { data, error, isLoading, refetch } = useQuery(
-    () => getDepositBtcAddress(props),
-    [props],
-    false,
-  );
-
-  return (
-    <>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getDepositBtcAddress.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

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);
-      }
-    },
-  );
-});