@lombard.finance/sdk 4.0.0 → 4.1.2

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

@@ -1,75 +0,0 @@
-import axios from 'axios';
-import BigNumber from 'bignumber.js';
-
-import { getApiConfig } from '../../common/api-config';
-import { getChainNameById } from '../../common/blockchain-identifier';
-import { ChainId } from '../../common/chains';
-import { MIN_STAKE_AMOUNT_BTC } from '../../common/constants';
-import { IEnvParam } from '../../common/parameters';
-import { toSatoshi } from '../../utils/satoshi';
-
-type ExchangeRateResponse = {
-  amount_out: string;
-};
-
-export interface IgetLBTCExchangeRateParams extends IEnvParam {
-  /**
-   * The optional chain id of the asset to get the exchange rate for.
-   * Note: Exchange rate it the same for all chains.
-   *
-   * @default OChainId.ethereum
-   */
-  chainId?: ChainId;
-  /**
-   * The amount of the LBTC (in satoshis) that a user would like to exchange to BTC.
-   */
-  amount?: BigNumber.Value;
-}
-
-export interface IgetLBTCExchangeRateResponse {
-  /**
-   * The exchanged amount (in satoshis).
-   */
-  amountOut: number;
-  /**
-   * The exchange rate for LBTC/BTC.
-   */
-  exchangeRate: number;
-  /**
-   * The minimum amount of BTC eligible for staking (in satoshis).
-   */
-  minAmount: number;
-}
-
-/**
- * Retrieves the exchange rate for LBTC.
- *
- * @deprecated This API endpoint is deprecated and will be removed in a future version.
- * The exchange rate is now always 1:1 as LBTC is a rebasing token.
- *
- * @param {IgetLBTCExchangeRateParams} parameters - The parameters.
- * @param {BigNumber.Value} parameters.amount - The optional amount to be exchanged.
- * @param {ChainId} parameters.chainId - The optional chain id.
- * @param {Env} parameters.env - The optional environment identifier.
- *
- * @returns {Promise<IgetLBTCExchangeRateResponse>} - The exchange rate.
- */
-export async function getLBTCExchangeRate({
-  env,
-  chainId = ChainId.ethereum,
-  amount = toSatoshi(1),
-}: IgetLBTCExchangeRateParams): Promise<IgetLBTCExchangeRateResponse> {
-  const { baseApiUrl } = getApiConfig(env);
-  const chainIdName = getChainNameById(chainId);
-
-  const { data } = await axios.get<ExchangeRateResponse>(
-    `api/v1/exchange/rate/${chainIdName}`,
-    { baseURL: baseApiUrl, params: { amount } },
-  );
-
-  const amountOut = BigNumber(data.amount_out).toNumber();
-  const exchangeRate = BigNumber(amount).dividedBy(data.amount_out).toNumber();
-  const minAmount = toSatoshi(MIN_STAKE_AMOUNT_BTC).toNumber();
-
-  return { amountOut, exchangeRate, minAmount };
-}

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

@@ -1,2 +0,0 @@
-export * from './get-exchange-ratio';
-export * from './getLBTCExchangeRate';

package/src/api-functions/getNetworkFeeSignature/getNetworkFeeSignature.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 } 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 {
-  getNetworkFeeSignature,
-  IGetNetworkFeeSignatureParams,
-} from './getNetworkFeeSignature';
-
-const meta = {
-  title: 'api/getNetworkFeeSignature',
-  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,
-  },
-};
-
-type GetNetworkFeeSignatureParamsProps = IGetNetworkFeeSignatureParams;
-
-export function StoryView(props: GetNetworkFeeSignatureParamsProps) {
-  const request = async () => {
-    return await getNetworkFeeSignature({
-      ...props,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getNetworkFeeSignature.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

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

@@ -1,116 +0,0 @@
-import axios from 'axios';
-
-import { getApiConfig } from '../../common/api-config';
-import { ChainId } from '../../common/chains';
-import { IEnvParam } from '../../common/parameters';
-import { getErrorMessage } from '../../utils/err';
-
-export interface IGetNetworkFeeSignatureParams extends IEnvParam {
-  /**
-   * Chain ID of the network to interact with
-   */
-  chainId: ChainId;
-  /**
-   * Destination address
-   */
-  address: string;
-  /**
-   * Token address (optional, required for BTC.b)
-   */
-  tokenAddress?: string;
-}
-
-interface IGetNetworkFeeSignatureResponse {
-  /**
-   * Expiration date of signature
-   */
-  expiration_date: string;
-  /**
-   * The flag signature exists
-   */
-  has_signature: boolean;
-  /**
-   * The auto mint is delayed
-   */
-  is_delayed: boolean;
-  /**
-   * Serialized signature when available
-   */
-  signature?: string;
-  /**
-   * Serialized typed data associated with the signature when available
-   */
-  typed_data?: string;
-}
-
-export interface IGetNetworkFeeSignatureMappedResponse {
-  /**
-   * Expiration date of signature
-   */
-  expirationDate: string;
-  /**
-   * The flag signature exists
-   */
-  hasSignature: boolean;
-  /**
-   * The auto mint is delayed
-   */
-  isDelayed: boolean;
-  /**
-   * Serialized signature when available
-   */
-  signature?: string;
-  /**
-   * Serialized typed data associated with the signature when available
-   */
-  typedData?: string;
-}
-
-/**
- * Returns the expiration date and the flag signature exists
- *
- * @param {IGetNetworkFeeSignatureParams} parameters - The parameters.
- * @param {string} parameters.address - The account address.
- * @param {ChainId} parameters.chainId - The chain id.
- * @param {Env} parameters.env - The optional environment identifier.
- *
- * @returns {Promise<IGetNetworkFeeSignatureResponse>}
- */
-export async function getNetworkFeeSignature({
-  address,
-  chainId,
-  env,
-  tokenAddress,
-}: IGetNetworkFeeSignatureParams): Promise<IGetNetworkFeeSignatureMappedResponse> {
-  const { baseApiUrl } = getApiConfig(env);
-
-  try {
-    const params: Record<string, string | number> = {
-      user_destination_address: address,
-      chain_id: chainId,
-    };
-
-    if (tokenAddress) {
-      params.token_address = tokenAddress;
-    }
-
-    const { data } = await axios.get<IGetNetworkFeeSignatureResponse>(
-      `${baseApiUrl}/api/v1/claimer/get-user-signature`,
-      {
-        params,
-      },
-    );
-
-    return {
-      expirationDate: data?.expiration_date,
-      hasSignature: data?.has_signature,
-      isDelayed: data?.is_delayed,
-      signature: data?.signature,
-      typedData: data?.typed_data,
-    };
-  } catch (error) {
-    const errorMessage = getErrorMessage(error);
-
-    throw new Error(errorMessage);
-  }
-}

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

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

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

@@ -1,51 +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 {
-  getPointsByAddress,
-  IGetPointsByAddressParameters,
-} from './getPointsByAddress';
-
-const meta = {
-  title: 'api/getPointsByAddress',
-  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: IGetPointsByAddressParameters) {
-  const { data, error, isLoading, refetch } = useQuery(
-    async () => await getPointsByAddress(props),
-    [props],
-    false,
-  );
-
-  return (
-    <>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getPointsByAddress.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

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

@@ -1,304 +0,0 @@
-import { DEFAULT_ENV, Env } from '@lombard.finance/sdk-common';
-import axios from 'axios';
-import BigNumber from 'bignumber.js';
-
-import { getApiConfig } from '../../common/api-config';
-import { IEnvParam } from '../../common/parameters';
-
-const CURRENT_SEASON = 2;
-
-/* -------------------------------------------------------------------------- */
-/*                                   Types                                    */
-/* -------------------------------------------------------------------------- */
-
-/**
- * Parameters for fetching points by address.
- */
-export interface IGetPointsByAddressParameters extends IEnvParam {
-  /** The address of the points earner. */
-  address: string;
-  /** The season to fetch (defaults to CURRENT_SEASON). */
-  season?: number;
-}
-
-/**
- * Breakdown of points earned from each supported DeFi protocol.
- */
-export interface IProtocolPointsBreakdown {
-  [protocolName: string]: number;
-}
-
-/**
- * Core points shared across all seasons.
- */
-export interface IPointsBase {
-  /** Points earned by holding LBTC. */
-  holdingPoints: number;
-  /** Points earned by taking positions in DeFi vaults. */
-  protocolPoints: number;
-  /** Points earned from referrals. */
-  referralPoints: number;
-  /** Total points earned. */
-  totalPoints: number;
-  /** Detailed breakdown of protocol-specific points. */
-  protocolPointsBreakdown: IProtocolPointsBreakdown;
-  /** Lux points earned from badges. */
-  badgesPoints: number;
-  /** Total Lux points excluding badges (only required in some seasons). */
-  totalWithoutBadgesPoints?: number;
-}
-
-/**
- * Points specific to Season 1.
- */
-export interface IPointsByAddressSeason1 extends IPointsBase {
-  /** Points earned in the OKX campaign. */
-  okxPoints: number;
-  /** Points earned in the first flash event. */
-  flashEvent1Points: number;
-  /** Points earned in the second flash event. */
-  flashEvent2Points: number;
-}
-
-/**
- * Points specific to Season 2.
- */
-export interface IPointsByAddressSeason2 extends IPointsBase {
-  /** Points earned from referees. */
-  refereePoints: number;
-  /** Points earned by checking in. */
-  checkinPoints: number;
-}
-
-/**
- * Raw API response format for Season 1.
- */
-interface IPointsResponseSeason1 {
-  holding_points: number;
-  protocol_points: number;
-  referee_points: number;
-  referrals_points: number;
-  total: number;
-  flash_event: number;
-  badges: number;
-  total_without_badges: number;
-  okx_campaign: number;
-  flash_event2: number;
-  protocol_points_map?: IProtocolPointsBreakdown;
-}
-
-/**
- * Raw API response format for Season 2.
- */
-interface IPointsResponseSeason2 {
-  holding_points: number;
-  protocol_points: number;
-  referee_points: number;
-  referrals_points: number;
-  total: number;
-  protocol_points_map?: IProtocolPointsBreakdown;
-  badge_points: number;
-  checkin_points: number;
-}
-
-/* -------------------------------------------------------------------------- */
-/*                                  Helpers                                   */
-/* -------------------------------------------------------------------------- */
-
-/**
- * Parses a number-like input into a BigNumber.
- *
- * @param input - The value to parse.
- * @param defaultValue - Value to use if input is invalid or undefined.
- * @returns A BigNumber representing the parsed value.
- */
-function parse(
-  input: string | number | null | undefined,
-  defaultValue = 0,
-): BigNumber {
-  return BigNumber(Number(input) || defaultValue);
-}
-
-/**
- * Converts a protocol points map to a strongly typed breakdown object.
- *
- * @param map - Optional protocol points map from the API.
- * @returns A normalized breakdown object with numeric values.
- */
-function toProtocolBreakdown(
-  map: IProtocolPointsBreakdown | undefined,
-): IProtocolPointsBreakdown {
-  return Object.entries(map || {}).reduce((acc, [k, v]) => {
-    acc[k] = parse(v).toNumber();
-    return acc;
-  }, {} as IProtocolPointsBreakdown);
-}
-
-/**
- * Constructs the Lombard points API endpoint for the given season and address.
- *
- * @param season - The Lux points season (e.g., 1 or 2).
- * @param address - Wallet address to query.
- * @param env - Target environment (defaults to DEFAULT_ENV).
- * @throws If the API endpoint cannot be determined or the season is invalid.
- */
-function getLombardPointsUrl(
-  season: number,
-  address: string,
-  env: Env = DEFAULT_ENV,
-): string {
-  const { baseApiUrl } = getApiConfig(env);
-  if (!baseApiUrl) {
-    throw new Error(
-      `Could not determine the API endpoint for the provided environment: ${
-        env || DEFAULT_ENV
-      }`,
-    );
-  }
-
-  switch (season) {
-    case 1:
-      return `${baseApiUrl}/api/v1/referral-system/season-1/points/${address}`;
-    case 2:
-      return `${baseApiUrl}/api/v1/referral-system/season-2/points/${address}`;
-    default:
-      throw new Error(`Invalid Lux season: ${season}`);
-  }
-}
-
-/* -------------------------------------------------------------------------- */
-/*                                Fetchers                                    */
-/* -------------------------------------------------------------------------- */
-
-/**
- * Fetches and parses Season 1 points for a given address.
- *
- * @param params - Address and environment parameters.
- * @returns A typed object containing all Season 1 point metrics.
- */
-async function fetchPointsSeason1({
-  address,
-  env,
-}: Omit<
-  IGetPointsByAddressParameters,
-  'season'
->): Promise<IPointsByAddressSeason1> {
-  const { data } = await axios.get<IPointsResponseSeason1>(
-    getLombardPointsUrl(1, address, env),
-  );
-
-  const referralPoints = parse(data.referee_points).plus(
-    parse(data.referrals_points),
-  );
-
-  return {
-    holdingPoints: parse(data.holding_points).toNumber(),
-    protocolPoints: parse(data.protocol_points).toNumber(),
-    referralPoints: referralPoints.toNumber(),
-    okxPoints: parse(data.okx_campaign).toNumber(),
-    flashEvent1Points: parse(data.flash_event).toNumber(),
-    flashEvent2Points: parse(data.flash_event2).toNumber(),
-    totalPoints: parse(data.total).toNumber(),
-    protocolPointsBreakdown: toProtocolBreakdown(data.protocol_points_map),
-    badgesPoints: parse(data.badges).toNumber(),
-    totalWithoutBadgesPoints: parse(data.total_without_badges).toNumber(),
-  };
-}
-
-/**
- * Fetches and parses Season 2 points for a given address.
- *
- * @param params - Address and environment parameters.
- * @returns A typed object containing all Season 2 point metrics.
- */
-async function fetchPointsSeason2({
-  address,
-  env,
-}: Omit<
-  IGetPointsByAddressParameters,
-  'season'
->): Promise<IPointsByAddressSeason2> {
-  const { data } = await axios.get<IPointsResponseSeason2>(
-    getLombardPointsUrl(2, address, env),
-  );
-
-  return {
-    holdingPoints: parse(data.holding_points).toNumber(),
-    protocolPoints: parse(data.protocol_points).toNumber(),
-    referralPoints: parse(data.referrals_points).toNumber(),
-    refereePoints: parse(data.referee_points).toNumber(),
-    badgesPoints: parse(data.badge_points).toNumber(),
-    checkinPoints: parse(data.checkin_points).toNumber(),
-    totalPoints: parse(data.total).toNumber(),
-    protocolPointsBreakdown: toProtocolBreakdown(data.protocol_points_map),
-    totalWithoutBadgesPoints: parse(data.total).toNumber(),
-  };
-}
-
-/* -------------------------------------------------------------------------- */
-/*                               Public API                                   */
-/* -------------------------------------------------------------------------- */
-
-/**
- * Retrieves Season 1 points for a given address.
- *
- * @param parameters - Address and environment parameters.
- * @returns A Season 1 points object.
- */
-export async function getPointsByAddress(
-  parameters: IGetPointsByAddressParameters & { season: 1 },
-): Promise<IPointsByAddressSeason1>;
-
-/**
- * Retrieves Season 2 points for a given address.
- *
- * @param parameters - Address and environment parameters.
- * @returns A Season 2 points object.
- */
-export async function getPointsByAddress(
-  parameters: IGetPointsByAddressParameters & { season: 2 },
-): Promise<IPointsByAddressSeason2>;
-
-/**
- * Retrieves points for the given address.
- * Defaults to the current season if none is specified.
- *
- * @param parameters - Address and optional environment/season parameters.
- * @returns A points object matching the requested or current season.
- */
-export async function getPointsByAddress(
-  parameters: IGetPointsByAddressParameters,
-): Promise<IPointsByAddressSeason1 | IPointsByAddressSeason2>;
-
-/**
- * Implementation of getPointsByAddress with overloads.
- */
-export async function getPointsByAddress({
-  address,
-  env,
-  season = CURRENT_SEASON,
-}: IGetPointsByAddressParameters): Promise<
-  IPointsByAddressSeason1 | IPointsByAddressSeason2
-> {
-  return season === 2
-    ? fetchPointsSeason2({ address, env })
-    : fetchPointsSeason1({ address, env });
-}
-
-/**
- * Convenience wrapper for fetching Season 1 points.
- *
- * @param params - Address and environment parameters.
- */
-export const getLuxSeason1Points = (
-  params: Omit<IGetPointsByAddressParameters, 'season'>,
-) => getPointsByAddress({ ...params, season: 1 });
-
-/**
- * Convenience wrapper for fetching Season 2 points.
- *
- * @param params - Address and environment parameters.
- */
-export const getLuxSeason2Points = (
-  params: Omit<IGetPointsByAddressParameters, 'season'>,
-) => getPointsByAddress({ ...params, season: 2 });

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

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

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

@@ -1,51 +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 {
-  getUnstakesByAddress,
-  IGetUnstakesByAddressParameters,
-} from './getUnstakesByAddress';
-
-const meta = {
-  title: 'api/getUnstakesByAddress',
-  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(parameters: IGetUnstakesByAddressParameters) {
-  const { data, error, isLoading, refetch } = useQuery(
-    async () => await getUnstakesByAddress(parameters),
-    [parameters],
-    false,
-  );
-
-  return (
-    <>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getUnstakesByAddress.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}