@lombard.finance/sdk 2.2.0 → 2.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lombard.finance/sdk",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -26,14 +26,15 @@
     "build-docs": "rimraf ./sdk-docs && typedoc --out sdk-docs"
   },
   "peerDependencies": {
-    "@bitcoin-js/tiny-secp256k1-asmjs": "2.2.3",
     "axios": "^1",
     "bignumber.js": "^9",
-    "bitcoinjs-lib": "6.1.5",
-    "web3": "^4"
+    "web3": "^4",
+    "bitcoinjs-lib": "6.1.5"
+  },
+  "dependencies": {
+    "@lombard.finance/sdk-common": "*"
   },
   "devDependencies": {
-    "@bitcoin-js/tiny-secp256k1-asmjs": "2.2.3",
     "@chromatic-com/storybook": "1.6.1",
     "@storybook/addon-essentials": "^8.2.9",
     "@storybook/addon-interactions": "^8.2.9",
@@ -45,7 +46,6 @@
     "@storybook/test": "^8.2.9",
     "axios": "^1.7.4",
     "bignumber.js": "^9.1.2",
-    "bitcoinjs-lib": "6.1.5",
     "bootstrap": "^5.3.3",
     "rimraf": "^5",
     "storybook": "^8.2.9",
@@ -54,4 +54,4 @@
     "web3": "^4.11.1",
     "web3-validator": "^2.0.6"
   }
-}
+}

package/src/common/const.ts

@@ -1,7 +1,3 @@
-import { OEnv, TEnv } from './types/types';
-
-export const defaultEnv: TEnv = OEnv.prod;
-
 /**
  * Address of the zero account.
  * Can also be used as a placeholder for unknown addresses.

package/src/common/types/internalTypes.ts

@@ -1,4 +1,4 @@
-import { TEnv } from './types';
+import { Env } from '@lombard.finance/sdk-common';
 
 export interface IEnvParam {
   /**
@@ -6,5 +6,5 @@ export interface IEnvParam {
    *
    * @default 'prod'
    */
-  env?: TEnv;
+  env?: Env;
 }

package/src/common/types/types.ts

@@ -1,10 +1,15 @@
-export const OEnv = {
-  prod: 'prod',
-  testnet: 'testnet',
-  stage: 'stage',
-} as const;
+import { Env } from '@lombard.finance/sdk-common';
+
+export const SUI_DEVNET_CHAIN = 'sui:devnet' as const;
+export const SUI_TESTNET_CHAIN = 'sui:testnet' as const;
+export const SUI_LOCALNET_CHAIN = 'sui:localnet' as const;
+export const SUI_MAINNET_CHAIN = 'sui:mainnet' as const;
 
-export type TEnv = (typeof OEnv)[keyof typeof OEnv];
+export type SuiChain =
+  | typeof SUI_DEVNET_CHAIN
+  | typeof SUI_TESTNET_CHAIN
+  | typeof SUI_LOCALNET_CHAIN
+  | typeof SUI_MAINNET_CHAIN;
 
 export const OChainId = {
   ethereum: 1,
@@ -14,13 +19,10 @@ export const OChainId = {
   sepolia: 11155111,
   base: 8453,
   baseSepoliaTestnet: 84532,
-
   berachain: 80094,
   berachainBartioTestnet: 80084,
-
   corn: 21000000,
   swell: 1923,
-
   sonic: 146,
   morph: 2818,
   morphHolesky: 2810,
@@ -35,13 +37,16 @@ export interface IEIP1193Provider {
   request: (args: any) => Promise<any>;
 }
 
-export const getEthNetworkByEnv = (env: TEnv) =>
-  env === OEnv.prod ? OChainId.ethereum : OChainId.holesky;
+export const getEthNetworkByEnv = (env: Env) =>
+  env === Env.prod ? OChainId.ethereum : OChainId.holesky;
 
-export const getBscNetworkByEnv = (env: TEnv) =>
-  env === OEnv.prod
+export const getBscNetworkByEnv = (env: Env) =>
+  env === Env.prod
     ? OChainId.binanceSmartChain
     : OChainId.binanceSmartChainTestnet;
 
-export const getBaseNetworkByEnv = (env: TEnv) =>
-  env === OEnv.prod ? OChainId.base : OChainId.baseSepoliaTestnet;
+export const getBaseNetworkByEnv = (env: Env) =>
+  env === Env.prod ? OChainId.base : OChainId.baseSepoliaTestnet;
+
+export const getSuiNetworkByEnv = (env: Env) =>
+  env === Env.prod ? 'sui:mainnet' : 'sui:testnet';

package/src/common/utils/convertSatoshi.ts

@@ -1,21 +1,25 @@
+import BigNumber from 'bignumber.js';
+
 const BTC_DECIMALS = 8;
-export const SATOSHI_SCALE = 10 ** BTC_DECIMALS;
+export const SATOSHI_SCALE = BigNumber(10).pow(BTC_DECIMALS);
 
 /**
- * Convert Satoshi to BTC
+ * Converts Satoshi to BTC
  * @param amount - Satoshi amount
  * @returns BTC amount
  */
-export function fromSatoshi(amount: number | string) {
-  return +amount / SATOSHI_SCALE;
+export function fromSatoshi(amount: number | string | BigNumber) {
+  return BigNumber(amount).dividedBy(SATOSHI_SCALE);
 }
 
 /**
- * Convert BTC to Satoshi
+ * Converts BTC to Satoshi
  *
  * @param amount - BTC amount
  * @returns Satoshi amount
  */
-export function toSatoshi(amount: number | string) {
-  return Math.floor(+amount * SATOSHI_SCALE);
+export function toSatoshi(amount: number | string | BigNumber) {
+  return BigNumber(amount)
+    .multipliedBy(SATOSHI_SCALE)
+    .decimalPlaces(0, BigNumber.ROUND_HALF_UP);
 }

package/src/index.ts

@@ -4,3 +4,5 @@ export * from './web3Sdk';
 export * from './common/types/types';
 export * from './common/utils/convertSatoshi';
 export * from './common/utils/isValidChain';
+export type { Env as TEnv } from '@lombard.finance/sdk-common';
+export { Env as OEnv } from '@lombard.finance/sdk-common';

package/src/sdk/apiConfig.ts

@@ -1,27 +1,31 @@
-import { defaultEnv } from '../common/const';
-import { OEnv, TEnv } from '../common/types/types';
+import { defaultEnv } from '@lombard.finance/sdk-common';
+import { Env } from '@lombard.finance/sdk-common';
 
 interface IApiConfig {
   baseApiUrl: string;
+  bffApiUrl: string | undefined;
 }
 
 const stageConfig: IApiConfig = {
   baseApiUrl: 'https://staging.prod.lombard.finance',
+  bffApiUrl: 'https://bff.stage.lombard.finance',
 };
 
 const testnetConfig: IApiConfig = {
   baseApiUrl: 'https://gastald-testnet.prod.lombard.finance',
+  bffApiUrl: undefined,
 };
 
 const prodConfig: IApiConfig = {
   baseApiUrl: 'https://mainnet.prod.lombard.finance',
+  bffApiUrl: 'https://bff.prod.lombard.finance',
 };
 
-export const getApiConfig = (env: TEnv = defaultEnv): IApiConfig => {
+export const getApiConfig = (env: Env = defaultEnv): IApiConfig => {
   switch (env) {
-    case OEnv.prod:
+    case Env.prod:
       return prodConfig;
-    case OEnv.testnet:
+    case Env.testnet:
       return testnetConfig;
     default:
       return stageConfig;

package/src/sdk/generateDepositBtcAddress/generateDepositBtcAddress.stories.tsx

@@ -1,5 +1,5 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { defaultEnv } from '../../common/const';
+import { defaultEnv } from '@lombard.finance/sdk-common';
 import { OChainId } from '../../common/types/types';
 import { Button } from '../../stories/components/Button';
 import { CodeBlock } from '../../stories/components/CodeBlock';

package/src/sdk/generateDepositBtcAddress/generateDepositBtcAddress.ts

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { IEnvParam } from '../../common/types/internalTypes';
-import { TChainId } from '../../common/types/types';
+import { SuiChain, TChainId } from '../../common/types/types';
 import { getErrorMessage } from '../../common/utils/getErrorMessage';
 import { getApiConfig } from '../apiConfig';
 import { getChainNameById } from '../utils/getChainNameById';
@@ -24,7 +24,7 @@ export interface IGenerateDepositBtcAddressParams extends IEnvParam {
   /**
    * The destination chain ID where LBTC will be claimed.
    */
-  chainId: TChainId;
+  chainId: TChainId | SuiChain;
   /**
    * The signature of the address. The signature is generated by signing the address using EVM wallet.
    */
@@ -105,5 +105,5 @@ export async function generateDepositBtcAddress({
 }
 
 function isSanctioned(errorMsg: string): boolean {
-  return !!errorMsg.includes(SANCTIONS_MESSAGE);
+  return errorMsg.includes(SANCTIONS_MESSAGE);
 }

package/src/sdk/getDepositBtcAddress/getDepositBtcAddress.stories.tsx

@@ -1,5 +1,5 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { defaultEnv } from '../../common/const';
+import { defaultEnv } from '@lombard.finance/sdk-common';
 import { OChainId } from '../../common/types/types';
 import { Button } from '../../stories/components/Button';
 import { CodeBlock } from '../../stories/components/CodeBlock';
@@ -40,8 +40,6 @@ export function StoryView(props: IGetDepositBtcAddressParams) {
     false,
   );
 
-  const test = true;
-
   return (
     <>
       <Button onClick={refetch} disabled={isLoading} isLoading={isLoading}>

package/src/sdk/getDepositBtcAddress/getDepositBtcAddress.ts

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { IEnvParam } from '../../common/types/internalTypes';
-import { TChainId } from '../../common/types/types';
+import { SuiChain, TChainId } from '../../common/types/types';
 import { getApiConfig } from '../apiConfig';
 import { TChainName } from '../internalTypes';
 import { getChainNameById } from '../utils/getChainNameById';
@@ -36,7 +36,7 @@ export interface IGetDepositBtcAddressParams extends IEnvParam {
   /**
    * The destination chain ID where LBTC will be claimed.
    */
-  chainId: TChainId;
+  chainId: TChainId | SuiChain;
   /**
    * The referral ID.
    */
@@ -111,7 +111,7 @@ export async function getDepositBtcAddresses({
   const { baseApiUrl } = getApiConfig(env);
   const toBlockchain = getChainNameById(chainId);
 
-  const requestrParams = {
+  const requestParams = {
     to_address: address,
     to_blockchain: toBlockchain,
     limit: 1,
@@ -122,7 +122,7 @@ export async function getDepositBtcAddresses({
 
   const { data } = await axios.get<IDepositAddressesResponse>(ADDRESS_URL, {
     baseURL: baseApiUrl,
-    params: requestrParams,
+    params: requestParams,
   });
 
   return data?.addresses || [];

package/src/sdk/getDepositsByAddress/getDepositsByAddress.stories.tsx

@@ -1,5 +1,5 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { defaultEnv } from '../../common/const';
+import { defaultEnv } from '@lombard.finance/sdk-common';
 import { Button } from '../../stories/components/Button';
 import { CodeBlock } from '../../stories/components/CodeBlock';
 import { exampleEvmAddress } from '../../stories/const';

package/src/sdk/getDepositsByAddress/getDepositsByAddress.ts

@@ -1,10 +1,11 @@
 import axios from 'axios';
 import BigNumber from 'bignumber.js';
 import { IEnvParam } from '../../common/types/internalTypes';
-import { TChainId, TEnv } from '../../common/types/types';
+import { SuiChain, TChainId } from '../../common/types/types';
 import { fromSatoshi } from '../../common/utils/convertSatoshi';
 import { getApiConfig } from '../apiConfig';
 import { getChainIdByName } from '../utils/getChainIdByName';
+import { Env } from '@lombard.finance/sdk-common';
 
 type Address = string;
 type Seconds = number;
@@ -59,7 +60,7 @@ export interface IDeposit {
   blockTime?: number;
   value: BigNumber;
   address: Address;
-  chainId: TChainId;
+  chainId: TChainId | SuiChain;
   isClaimed?: boolean;
   claimedTxId?: string;
   rawPayload?: string;
@@ -107,7 +108,7 @@ export async function getDepositsByAddress({
   return outputs.map(mapResponse(env));
 }
 
-function mapResponse(env?: TEnv) {
+function mapResponse(env?: Env) {
   return (data: IDepositResponse): IDeposit => ({
     txid: data.txid,
     index: data.index ?? 0,

package/src/sdk/getLBTCExchangeRate/getLBTCExchangeRate.stories.tsx

@@ -1,12 +1,12 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { defaultEnv } from '../../common/const';
+import { defaultEnv } from '@lombard.finance/sdk-common';
 import { OChainId } from '../../common/types/types';
 import { Button } from '../../stories/components/Button';
 import { CodeBlock } from '../../stories/components/CodeBlock';
 import useQuery from '../../stories/hooks/useQuery';
 import {
-    getLBTCExchangeRate,
-    IgetLBTCExchangeRateParams,
+  getLBTCExchangeRate,
+  IgetLBTCExchangeRateParams,
 } from './getLBTCExchangeRate';
 
 const meta = {

package/src/sdk/getNetworkFeeSignature/getNetworkFeeSignature.stories.tsx

@@ -1,4 +1,5 @@
 import type { Meta, StoryObj } from '@storybook/react';
+import { defaultEnv } from '@lombard.finance/sdk-common';
 import { Button } from '../../stories/components/Button';
 import { CodeBlock } from '../../stories/components/CodeBlock';
 import { useConnect } from '../../stories/hooks/useConnect';
@@ -7,7 +8,6 @@ import {
   getNetworkFeeSignature,
   IGetNetworkFeeSignatureParams,
 } from './getNetworkFeeSignature';
-import { defaultEnv } from '../../common/const';
 
 const meta = {
   title: 'SDK/getNetworkFeeSignature',

package/src/sdk/getPointsByAddress/getPointsByAddress.stories.tsx

@@ -0,0 +1,49 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { defaultEnv } from '@lombard.finance/sdk-common';
+import { Button } from '../../stories/components/Button';
+import { CodeBlock } from '../../stories/components/CodeBlock';
+import { exampleEvmAddress } from '../../stories/const';
+import useQuery from '../../stories/hooks/useQuery';
+import { fromCamelCase } from '../../stories/utils/fromCamelCase';
+import {
+  getPointsByAddress,
+  IGetPointsByAddressParameters,
+} from './getPointsByAddress';
+
+const { name } = getPointsByAddress;
+const nameWithWhitespaces = fromCamelCase(name);
+
+const meta = {
+  title: 'SDK/getPointsByAddress',
+  component: StoryView,
+  tags: ['autodocs'],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const WithParams: Story = {
+  args: {
+    address: exampleEvmAddress,
+    env: defaultEnv,
+  },
+};
+
+export function StoryView(props: IGetPointsByAddressParameters) {
+  const { data, error, isLoading, refetch } = useQuery(
+    () => getPointsByAddress(props),
+    [props],
+    false,
+  );
+
+  return (
+    <>
+      <Button onClick={refetch} disabled={isLoading} isLoading={isLoading}>
+        {nameWithWhitespaces}
+      </Button>
+
+      <CodeBlock text={error || data} />
+    </>
+  );
+}

package/src/sdk/getPointsByAddress/getPointsByAddress.ts

@@ -0,0 +1,163 @@
+import axios from 'axios';
+import { defaultEnv } from '@lombard.finance/sdk-common';
+import { IEnvParam } from '../../common/types/internalTypes';
+import { getApiConfig } from '../apiConfig';
+
+export interface IGetPointsByAddressParameters extends IEnvParam {
+  /**
+   * The address of the points earner.
+   */
+  address: string;
+}
+
+export interface IProtocolPointsBreakdown {
+  [protocolIdentifier: string]: number;
+}
+
+export interface IPointsByAddress {
+  /**
+   * The number of points earned by holding LBTC.
+   */
+  holdingPoints: number;
+  /**
+   * The number of points earned by taking positions in DeFi vaults.
+   */
+  protocolPoints: number;
+  /**
+   * The number of points earned by your referrals.
+   */
+  referralPoints: number;
+  /**
+   * The number of points earned in the OKX campaign.
+   */
+  okxPoints: number;
+  /**
+   * The number of points earned by participating in the flash events.
+   */
+  flashEventPoints: number;
+  /**
+   * The total number of points.
+   */
+  totalPoints: number;
+  /**
+   * The breakdown of points earned from each protocol.
+   */
+  protocolPointsBreakdown: IProtocolPointsBreakdown;
+}
+
+interface IPointsResponse {
+  holding_points?: number;
+  protocol_points?: number;
+  referee_points?: number;
+  referrals_points?: number;
+  total?: number;
+  protocol_points_map?: IProtocolPointsBreakdown;
+}
+
+interface IOkxPointsResponse {
+  data: boolean;
+  points?: string | number;
+}
+
+interface IFlashEventPointsResponse {
+  flashEvent1Points?: {
+    result?: {
+      rows?: { points?: string }[]; // take first entry
+    };
+  };
+  flashEvent2Points?: {
+    result?: {
+      rows?: { totalPoints?: string }[]; // take first entry
+    };
+  };
+}
+
+/**
+ * Retrieves the points earned by the provided address.
+ * @param {IGetPointsByAddressParameters} parameters
+ * @throws {Error} - Throws an error when the API endpoints cannot be determined or any of the API calls fail.
+ */
+export async function getPointsByAddress({
+  address,
+  env,
+}: IGetPointsByAddressParameters): Promise<IPointsByAddress> {
+  const { baseApiUrl, bffApiUrl } = getApiConfig(env);
+  if (!bffApiUrl || !baseApiUrl) {
+    throw new Error(
+      `Could not determine the API endpoint for the provided environment: ${env || defaultEnv}`,
+    );
+  }
+
+  const lombardPointsUrl = `${baseApiUrl}/api/v1/referral-system/season-1/points/${address}`;
+
+  /**
+   * TODO:
+   * OKX and flash event points will be a part of the above endpoint soon.
+   * Change this once it is implemented on the backend.
+   */
+
+  const okxPointsUrl = `${baseApiUrl}/api/v1/task/okx/user-task-verification?address=${address}&chain=1`;
+  const flashEventsPointsUrl = `${bffApiUrl}/sentio-api/flash-event-points/${address}`;
+
+  const lombardPointsRequest = axios.get<IPointsResponse>(lombardPointsUrl);
+  const okxPointsRequest = axios.get<IOkxPointsResponse>(okxPointsUrl);
+  const flashEventPointsRequest =
+    axios.get<IFlashEventPointsResponse>(flashEventsPointsUrl);
+
+  const [
+    { data: lombardPointsData },
+    { data: okxPointsData },
+    { data: flashEventPointsData },
+  ] = await Promise.all([
+    lombardPointsRequest,
+    okxPointsRequest,
+    flashEventPointsRequest,
+  ]);
+
+  const okxPoints = parse(okxPointsData?.points);
+
+  const flashEvent1Points = parse(
+    flashEventPointsData?.flashEvent1Points?.result?.rows?.[0]?.points,
+  );
+  const flashEvent2Points = parse(
+    flashEventPointsData?.flashEvent2Points?.result?.rows?.[0]?.totalPoints,
+  );
+  const flashEventPoints = flashEvent1Points + flashEvent2Points;
+
+  const holdingPoints = parse(lombardPointsData.holding_points);
+  const protocolPoints = parse(lombardPointsData.protocol_points);
+  const referralPoints =
+    parse(lombardPointsData.referee_points) +
+    parse(lombardPointsData.referrals_points);
+
+  const totalPoints =
+    holdingPoints +
+    protocolPoints +
+    referralPoints +
+    okxPoints +
+    flashEventPoints;
+
+  const protocolPointsBreakdown = Object.entries(
+    lombardPointsData.protocol_points_map || {},
+  ).reduce((acc, [k, v]) => {
+    acc[k] = parse(v);
+    return acc;
+  }, {} as IProtocolPointsBreakdown);
+
+  return {
+    holdingPoints,
+    protocolPoints,
+    referralPoints,
+    okxPoints,
+    flashEventPoints,
+    totalPoints,
+    protocolPointsBreakdown,
+  };
+}
+
+function parse(
+  input: string | number | null | undefined,
+  defaultValue = 0,
+): number {
+  return Number(input) || defaultValue;
+}

package/src/sdk/getPointsByAddress/index.ts

@@ -0,0 +1,6 @@
+export {
+  getPointsByAddress,
+  type IGetPointsByAddressParameters,
+  type IPointsByAddress,
+  type IProtocolPointsBreakdown,
+} from './getPointsByAddress';

package/src/sdk/getUnstakesByAddress/getUnstakesByAddress.stories.tsx

@@ -0,0 +1,49 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { defaultEnv } from '@lombard.finance/sdk-common';
+import { Button } from '../../stories/components/Button';
+import { CodeBlock } from '../../stories/components/CodeBlock';
+import { exampleEvmAddress } from '../../stories/const';
+import useQuery from '../../stories/hooks/useQuery';
+import { fromCamelCase } from '../../stories/utils/fromCamelCase';
+import {
+  getUnstakesByAddress,
+  IGetUnstakesByAddressParameters,
+} from './getUnstakesByAddress';
+
+const { name } = getUnstakesByAddress;
+const nameWithWhitespaces = fromCamelCase(name);
+
+const meta = {
+  title: 'SDK/getUnstakesByAddress',
+  component: StoryView,
+  tags: ['autodocs'],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const WithParams: Story = {
+  args: {
+    address: exampleEvmAddress,
+    env: defaultEnv,
+  },
+};
+
+export function StoryView(parameters: IGetUnstakesByAddressParameters) {
+  const { data, error, isLoading, refetch } = useQuery(
+    () => getUnstakesByAddress(parameters),
+    [parameters],
+    false,
+  );
+
+  return (
+    <>
+      <Button onClick={refetch} disabled={isLoading} isLoading={isLoading}>
+        {nameWithWhitespaces}
+      </Button>
+
+      <CodeBlock text={error || data} />
+    </>
+  );
+}