@lombard.finance/sdk 2.2.1 → 2.4.1

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} />
+    </>
+  );
+}

package/src/sdk/getUnstakesByAddress/getUnstakesByAddress.ts

@@ -0,0 +1,133 @@
+import axios from 'axios';
+import { address, networks } from 'bitcoinjs-lib';
+
+import { IEnvParam } from '../../common/types/internalTypes';
+import { SuiChain, TChainId } from '../../common/types/types';
+import { fromSatoshi } from '../../common/utils/convertSatoshi';
+import { getApiConfig } from '../../sdk/apiConfig';
+import { TChainName } from '../../sdk/internalTypes';
+import { getChainIdByName } from '../../sdk/utils/getChainIdByName';
+import BigNumber from 'bignumber.js';
+
+interface IUnstakeResponse {
+  tx_hash: string;
+  blockchain: TChainName;
+  block_height: string;
+  block_time: string;
+  from_address: string;
+  output_script: string;
+  amount: string;
+  payout_txid?: string;
+  payout_index?: string;
+  sanctioned?: boolean;
+}
+
+interface IGetUnstakesResponse {
+  unstakes?: IUnstakeResponse[];
+}
+
+export interface IUnstake {
+  /**
+   * The unstake transaction hash.
+   */
+  txHash: string;
+  /**
+   * The chain id where unstake transaction happened.
+   */
+  chainId: TChainId | SuiChain;
+  /**
+   * The block height.
+   */
+  blockHeight: number;
+  /**
+   * The timestamp of the unstake transaction.
+   */
+  unstakeDate: Date;
+  /**
+   * The initiator of the unstake transaction.
+   */
+  fromAddress: string;
+  /**
+   * The destination address to which the funds (BTC) will be transferred.
+   */
+  toAddress: string;
+  /**
+   * The amount of BTC unstaked.
+   */
+  amount: BigNumber;
+  /**
+   * The BTC payout transaction hash.
+   *
+   * If empty then the unstake is still pending. The payout tx hash is only
+   * present for the completed unstake transactions.
+   *
+   * A withdrawal period of 9 days is required by Lombard — daily rebalancing
+   * cycle — and Babylon — 7 days unbonding period. After that the payout
+   * should be completed.
+   */
+  payoutTxHash?: string;
+  /**
+   * The index of the payout transaction corresponding to the unstake.
+   */
+  payoutTxIndex?: number;
+  /**
+   * A flag indicating whether the unstake transaction has been sanctioned and
+   * flagged as suspicious.
+   * See: https://docs.lombard.finance/technical-documentation/sanctions-and-risk-monitoring
+   */
+  sanctioned?: boolean;
+}
+
+export interface IGetUnstakesByAddressParameters extends IEnvParam {
+  /**
+   * The address of an initiator of the unstake.
+   */
+  address: string;
+}
+
+/**
+ * Gets all unstakes initiated by the specified address.
+ *
+ * @throws {Error} - Throws an error when there's no address specified.
+ */
+export async function getUnstakesByAddress({
+  address,
+  env = 'prod',
+}: IGetUnstakesByAddressParameters): Promise<IUnstake[]> {
+  const { baseApiUrl } = getApiConfig(env);
+
+  if (!address) {
+    throw new Error('No address specified.');
+  }
+
+  const {
+    data: { unstakes = [] },
+  } = await axios.get<IGetUnstakesResponse>(
+    `/api/v1/address/unstakes/${address}`,
+    {
+      baseURL: baseApiUrl,
+    },
+  );
+
+  return unstakes.map(unstakeData => mapResponse(unstakeData, env));
+}
+
+function mapResponse(data: IUnstakeResponse, env: IEnvParam['env']): IUnstake {
+  const btcAddress = address.fromOutputScript(
+    Buffer.from(data.output_script, 'hex'),
+    env === 'prod' ? networks.bitcoin : networks.testnet,
+  );
+
+  return {
+    txHash: data.tx_hash,
+    chainId: getChainIdByName(data.blockchain, env),
+    blockHeight: +data.block_height,
+    unstakeDate: new Date(+data.block_time * 1000),
+    fromAddress: data.from_address,
+    toAddress: btcAddress,
+    amount: fromSatoshi(data.amount),
+    payoutTxHash: data.payout_txid,
+    payoutTxIndex: data.payout_index ? +data.payout_index : undefined,
+    sanctioned: data.sanctioned,
+  };
+}

package/src/sdk/getUnstakesByAddress/index.ts

@@ -0,0 +1 @@
+export { getUnstakesByAddress } from './getUnstakesByAddress';

package/src/sdk/getUserStakeAndBakeSignature/getUserStakeAndBakeSignature.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 {
   IGetUserStakeAndBakeSignatureParams,
   getUserStakeAndBakeSignature,
 } from './getUserStakeAndBakeSignature';
-import { defaultEnv } from '../../common/const';
 
 const meta = {
   title: 'SDK/getUserStakeAndBakeSignature',

package/src/sdk/index.ts

@@ -4,9 +4,11 @@ export * from './getDepositBtcAddress';
 export * from './getDepositsByAddress';
 export * from './getLBTCExchangeRate';
 export * from './getNetworkFeeSignature';
+export * from './getPointsByAddress';
+export * from './getUnstakesByAddress';
 export * from './getUserStakeAndBakeSignature';
+export * from './setReferral';
 export * from './storeNetworkFeeSignature';
 export * from './storeStakeAndBakeSignature';
 export * from './utils/getChainIdByName';
 export * from './utils/getChainNameById';
-export * from './setReferral';

package/src/sdk/internalTypes.ts

@@ -7,6 +7,9 @@ export const OChainName = {
 
   bsc: 'DESTINATION_BLOCKCHAIN_BSC',
   bscOld: 'BLOCKCHAIN_BSC',
+
+  sui: 'DESTINATION_BLOCKCHAIN_SUI',
+  suiOld: 'BLOCKCHAIN_SUI',
 } as const;
 
 export type TChainName = (typeof OChainName)[keyof typeof OChainName];

package/src/sdk/setReferral/setReferral.ts

@@ -13,17 +13,18 @@ export interface ISetReferralParams extends IEnvParam {
    */
   address: string;
   /**
-   * The signature of the address. The signature is generated by signing the address using EVM wallet.
+   * The signature of the address. The signature is generated by signing the address using wallet.
+   * Use `signTermsOfService` or `signLbtcDestinationAddr` functions.
    */
   signature: string;
-  /**
-   * The typed data object used to generate the signature if using a network fee authorization signature.
-   */
-  eip712Data: string;
   /**
    * The captcha token.
    */
   referrerCode: string;
+  /**
+   * The typed data object used to generate the signature if using a network fee authorization signature.
+   */
+  eip712Data?: string;
 }
 
 /**

package/src/sdk/storeNetworkFeeSignature/storeNetworkFeeSignature.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 {
   IStoreNetworkFeeSignatureParams,
   storeNetworkFeeSignature,
 } from './storeNetworkFeeSignature';
-import { defaultEnv } from '../../common/const';
 
 const meta = {
   title: 'SDK/storeNetworkFeeSignature',

package/src/sdk/storeStakeAndBakeSignature/storeStakeAndBakeSignature.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';
@@ -9,7 +10,6 @@ import {
   signStakeAndBake,
 } from '../../web3Sdk/signStakeAndBake/signStakeAndBake';
 import { storeStakeAndBakeSignature } from './storeStakeAndBakeSignature';
-import { defaultEnv } from '../../common/const';
 
 const meta = {
   title: 'SDK/storeStakeAndBakeSignature',

package/src/sdk/utils/getChainIdByName.ts

@@ -1,23 +1,25 @@
-import { defaultEnv } from '../../common/const';
+import { defaultEnv } from '@lombard.finance/sdk-common';
 import {
   getBaseNetworkByEnv,
   getBscNetworkByEnv,
   getEthNetworkByEnv,
+  getSuiNetworkByEnv,
   OChainId,
+  SuiChain,
   TChainId,
-  TEnv,
 } from '../../common/types/types';
+import { Env } from '@lombard.finance/sdk-common';
 import { OChainName, TChainName } from '../internalTypes';
 
 /**
- * @param chainId the chain ID
- *
+ * @param chain the chain ID
+ * @param env
  * @returns the chain name
  */
 export function getChainIdByName(
   chain: string,
-  env: TEnv = defaultEnv,
-): TChainId {
+  env: Env = defaultEnv,
+): TChainId | SuiChain {
   switch (chain as TChainName) {
     case OChainName.eth:
     case OChainName.ethOld:
@@ -31,6 +33,10 @@ export function getChainIdByName(
     case OChainName.bscOld:
       return getBscNetworkByEnv(env);
 
+    case OChainName.sui:
+    case OChainName.suiOld:
+      return getSuiNetworkByEnv(env);
+
     default:
       return OChainId.ethereum;
   }

package/src/sdk/utils/getChainNameById.ts

@@ -1,4 +1,4 @@
-import { OChainId, TChainId } from '../../common/types/types';
+import { OChainId, SuiChain, TChainId } from '../../common/types/types';
 import { OChainName, TChainName } from '../internalTypes';
 
 /**
@@ -6,19 +6,29 @@ import { OChainName, TChainName } from '../internalTypes';
  *
  * @returns the chain name
  */
-export function getChainNameById(chainId: TChainId): TChainName {
-  switch (chainId) {
-    case OChainId.ethereum:
-    case OChainId.holesky:
-    case OChainId.sepolia:
-      return OChainName.eth;
-    case OChainId.base:
-    case OChainId.baseSepoliaTestnet:
-      return OChainName.base;
-    case OChainId.binanceSmartChain:
-    case OChainId.binanceSmartChainTestnet:
-      return OChainName.bsc;
-    default:
-      throw new Error(`Unknown chain ID: ${chainId}`);
+export function getChainNameById(chainId: TChainId | SuiChain): TChainName {
+  if (
+    chainId === OChainId.ethereum ||
+    chainId === OChainId.holesky ||
+    chainId === OChainId.sepolia
+  ) {
+    return OChainName.eth;
   }
+
+  if (chainId === OChainId.base || chainId === OChainId.baseSepoliaTestnet) {
+    return OChainName.base;
+  }
+
+  if (
+    chainId === OChainId.binanceSmartChain ||
+    chainId === OChainId.binanceSmartChainTestnet
+  ) {
+    return OChainName.bsc;
+  }
+
+  if (chainId === 'sui:testnet' || chainId === 'sui:mainnet') {
+    return OChainName.sui;
+  }
+
+  throw new Error(`Unknown chain ID: ${chainId}`);
 }

package/src/web3Sdk/approveLBTC/approveLBTC.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 { useConnect } from '../../stories/hooks/useConnect';

package/src/web3Sdk/approveLBTC/approveLBTC.ts

@@ -31,7 +31,7 @@ export function approveLBTC({
 }: IApproveLBTCParams): Promise<IWeb3SendResult> {
   const provider = new Provider(providerParams);
   const tokenContract = getLbtcTokenContract(provider, env);
-  const amountSat = toSatoshi(amount);
+  const amountSat = toSatoshi(amount).toNumber();
 
   const tx = tokenContract.methods.approve(spender, amountSat);
 

package/src/web3Sdk/basculeAddressConfig.ts

@@ -1,8 +1,7 @@
-import {
-  defaultEnv,
-  ZERO_ADDRESS as PLACEHOLDER_ADDRESS,
-} from '../common/const';
-import { OChainId, OEnv, TChainId, TEnv } from '../common/types/types';
+import { ZERO_ADDRESS as PLACEHOLDER_ADDRESS } from '../common/const';
+import { OChainId, TChainId } from '../common/types/types';
+
+import { Env, defaultEnv } from '@lombard.finance/sdk-common';
 
 type BasculeTokenConfig = Record<TChainId, string>;
 
@@ -76,12 +75,12 @@ const prodConfig: BasculeTokenConfig = {
 };
 
 export function getBasculeAddressConfig(
-  env: TEnv = defaultEnv,
+  env: Env = defaultEnv,
 ): BasculeTokenConfig {
   switch (env) {
-    case OEnv.prod:
+    case Env.prod:
       return prodConfig;
-    case OEnv.testnet:
+    case Env.testnet:
       return testnetConfig;
     default:
       return stageConfig;

package/src/web3Sdk/claimLBTC/claimLBTC.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 { useConnect } from '../../stories/hooks/useConnect';

package/src/web3Sdk/getBasculeDepositStatus/getBasculeDepositStatus.stories.tsx

@@ -1,10 +1,13 @@
 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 { useConnect } from '../../stories/hooks/useConnect';
 import useQuery from '../../stories/hooks/useQuery';
-import { getBasculeDepositStatus, ICheckBasculeDepositStatusParams } from './getBasculeDepositStatus';
+import {
+  getBasculeDepositStatus,
+  ICheckBasculeDepositStatusParams,
+} from './getBasculeDepositStatus';
 
 const meta = {
   title: 'Web3SDK/getBasculeDepositStatus',

package/src/web3Sdk/getLBTCTotalSupply/getLBTCTotalSupply.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 { useConnect } from '../../stories/hooks/useConnect';
@@ -28,7 +28,6 @@ export const WithParams: Story = {
 type TotalSupplyLBTCProps = Pick<ILBTCTotalSupplyParams, 'env'>;
 
 export function StoryView(props: TotalSupplyLBTCProps) {
-
   const { data: connectData, error: connectError } = useConnect();
 
   const request = async () => {