@scallop-io/sui-scallop-sdk 3.0.2 → 4.1.0

package/src/queries/borrowIncentiveQuery.ts

@@ -1,361 +0,0 @@
-import { normalizeStructTag } from '@mysten/sui/utils';
-import {
-  parseOriginBorrowIncentivePoolData,
-  parseOriginBorrowIncentiveAccountData,
-  calculateBorrowIncentivePoolPointData,
-  getSharedObjectData,
-  parseObjectAs,
-  getDfObjectIdAndName,
-} from 'src/utils/index.js';
-import type {
-  ScallopAddress,
-  ScallopQuery,
-  ScallopSuiKit,
-  ScallopUtils,
-} from 'src/models/index.js';
-import type {
-  BorrowIncentivePoolsQueryInterface,
-  BorrowIncentivePools,
-  BorrowIncentiveAccountsQueryInterface,
-  BorrowIncentiveAccounts,
-  BorrowIncentivePoolPoints,
-  OptionalKeys,
-  CoinPrices,
-  MarketPools,
-} from 'src/types/index.js';
-import { BigNumber } from 'bignumber.js';
-import { SuiTxBlock } from '@scallop-io/sui-kit';
-import { queryKeys } from 'src/constants/index.js';
-
-/**
- * Query borrow incentive pools data using moveCall
- * @param address
- * @returns
- */
-const queryBorrowIncentivePools = async ({
-  address,
-  scallopSuiKit,
-}: {
-  address: ScallopAddress;
-  scallopSuiKit: ScallopSuiKit;
-}) => {
-  const queryPkgId = address.get('borrowIncentive.query');
-  const incentivePoolsId = address.get('borrowIncentive.incentivePools');
-
-  const txBlock = new SuiTxBlock();
-  const queryTarget = `${queryPkgId}::incentive_pools_query::incentive_pools_data`;
-  const incentivePoolsSharedObject = await getSharedObjectData(scallopSuiKit, {
-    tx: txBlock,
-    object: incentivePoolsId,
-    mutable: true,
-  });
-  const args = [incentivePoolsSharedObject];
-  const queryResult = await scallopSuiKit.queryInspectTxn({
-    queryTarget,
-    args,
-    txBlock,
-    keys: queryKeys.rpc.getInspectTxn({
-      queryTarget,
-      args: [incentivePoolsId],
-      node: scallopSuiKit.currentFullNode,
-    }),
-  });
-  // SDK v2: Extract transaction result using discriminated union pattern
-  const tx = queryResult?.Transaction ?? queryResult?.FailedTransaction;
-  const borrowIncentivePoolsQueryData = (tx?.events?.[0] as any)?.parsedJson as
-    | BorrowIncentivePoolsQueryInterface
-    | undefined;
-  return borrowIncentivePoolsQueryData;
-};
-
-/**
- * Get borrow incentive pools data.
- *
- * @param query - The Scallop query instance.
- * @param borrowIncentiveCoinNames - Specific an array of support borrow incentive coin name.
- * @param indexer - Whether to use indexer.
- * @return Borrow incentive pools data.
- */
-export const getBorrowIncentivePools = async (
-  query: ScallopQuery,
-  borrowIncentiveCoinNames: string[] = [...query.constants.whitelist.lending],
-  indexer: boolean = false,
-  marketPools?: MarketPools,
-  coinPrices?: CoinPrices
-) => {
-  const borrowIncentivePools: BorrowIncentivePools = {};
-  marketPools =
-    marketPools ??
-    (await query.getMarketPools(undefined, { coinPrices, indexer })).pools;
-  coinPrices = coinPrices ?? (await query.getAllCoinPrices({ marketPools }));
-
-  const borrowIncentivePoolsQueryData = await queryBorrowIncentivePools(query);
-
-  for (const pool of borrowIncentivePoolsQueryData?.incentive_pools ?? []) {
-    const borrowIncentivePoolPoints: OptionalKeys<
-      Record<string, BorrowIncentivePoolPoints>
-    > = {};
-    const parsedBorrowIncentivePoolData = parseOriginBorrowIncentivePoolData(
-      query.utils,
-      pool
-    );
-
-    const poolCoinType = normalizeStructTag(pool.pool_type.name);
-    const poolCoinName = query.utils.parseCoinNameFromType(poolCoinType);
-    const poolCoinPrice = coinPrices?.[poolCoinName] ?? 0;
-    const poolCoinDecimal = query.utils.getCoinDecimal(poolCoinName);
-
-    // Filter pools not yet supported by the SDK.
-    if (!borrowIncentiveCoinNames.includes(poolCoinName)) {
-      continue;
-    }
-
-    // pool points for borrow incentive reward
-    for (const [coinName, poolPoint] of Object.entries(
-      parsedBorrowIncentivePoolData.poolPoints
-    )) {
-      if (!poolPoint) continue;
-      const rewardCoinType = poolPoint.pointType;
-      const rewardCoinName = query.utils.parseCoinNameFromType(
-        rewardCoinType
-      ) as string;
-      // handle for scoin name
-      const rewardCoinDecimal = query.utils.getCoinDecimal(rewardCoinName);
-      if (rewardCoinDecimal === undefined)
-        throw new Error(`Coin decimal not found for ${rewardCoinName}`);
-
-      const rewardCoinPrice = coinPrices?.[rewardCoinName] ?? 0;
-
-      const symbol = query.utils.parseSymbol(rewardCoinName);
-      const coinDecimal = query.utils.getCoinDecimal(rewardCoinName);
-
-      const calculatedPoolPoint = calculateBorrowIncentivePoolPointData(
-        // parsedBorrowIncentivePoolData,
-        poolPoint,
-        rewardCoinPrice,
-        rewardCoinDecimal,
-        poolCoinPrice,
-        poolCoinDecimal
-      );
-
-      if (poolPoint.points > calculatedPoolPoint.accumulatedPoints) {
-        borrowIncentivePoolPoints[coinName as string] = {
-          symbol,
-          coinName: rewardCoinName,
-          coinType: rewardCoinType,
-          coinDecimal,
-          coinPrice: rewardCoinPrice,
-          points: poolPoint.points,
-          distributedPoint: poolPoint.distributedPoint,
-          weightedAmount: poolPoint.weightedAmount,
-          ...calculatedPoolPoint,
-        };
-      }
-    }
-
-    const stakedAmount = BigNumber(parsedBorrowIncentivePoolData.staked);
-    const stakedCoin = stakedAmount.shiftedBy(-1 * poolCoinDecimal);
-    const stakedValue = stakedCoin.multipliedBy(poolCoinPrice);
-
-    borrowIncentivePools[poolCoinName] = {
-      coinName: poolCoinName,
-      symbol: query.utils.parseSymbol(poolCoinName),
-      coinType: poolCoinType,
-      coinDecimal: poolCoinDecimal,
-      coinPrice: poolCoinPrice,
-      stakedAmount: stakedAmount.toNumber(),
-      stakedCoin: stakedCoin.toNumber(),
-      stakedValue: stakedValue.toNumber(),
-      points: borrowIncentivePoolPoints,
-    };
-  }
-
-  return borrowIncentivePools;
-};
-
-/**
- * Query borrow incentive accounts data.
- *
- * @param query - The Scallop query instance.
- * @param borrowIncentiveCoinNames - Specific an array of support borrow incentive coin name.
- * @return Borrow incentive accounts data.
- */
-export const queryBorrowIncentiveAccounts = async (
-  { utils }: { utils: ScallopUtils },
-  obligationId: string,
-  borrowIncentiveCoinNames: string[] = [...utils.constants.whitelist.lending]
-) => {
-  const txBlock = new SuiTxBlock();
-  const queryPkgId = utils.address.get('borrowIncentive.query');
-  const incentiveAccountsId = utils.address.get(
-    'borrowIncentive.incentiveAccounts'
-  );
-  const queryTarget = `${queryPkgId}::incentive_account_query::incentive_account_data`;
-  const [incentiveAccountVersion, obligationDataVersion] = await Promise.all([
-    getSharedObjectData(utils.scallopSuiKit, {
-      tx: txBlock,
-      object: incentiveAccountsId,
-      mutable: true,
-    }),
-    getSharedObjectData(utils.scallopSuiKit, {
-      tx: txBlock,
-      object: obligationId,
-      mutable: true,
-    }),
-  ]);
-
-  const args = [incentiveAccountVersion, obligationDataVersion];
-
-  const queryResult = await utils.scallopSuiKit.queryInspectTxn({
-    queryTarget,
-    args,
-    txBlock,
-    keys: queryKeys.rpc.getInspectTxn({
-      queryTarget,
-      args: [incentiveAccountsId, obligationId],
-      node: utils.scallopSuiKit.currentFullNode,
-    }),
-  });
-  // SDK v2: Extract transaction result using discriminated union pattern
-  const tx = queryResult?.Transaction ?? queryResult?.FailedTransaction;
-  const borrowIncentiveAccountsQueryData = (tx?.events?.[0] as any)
-    ?.parsedJson as BorrowIncentiveAccountsQueryInterface | undefined;
-
-  const borrowIncentiveAccounts: BorrowIncentiveAccounts = Object.values(
-    borrowIncentiveAccountsQueryData?.pool_records ?? []
-  ).reduce((accounts, accountData) => {
-    const parsedBorrowIncentiveAccount = parseOriginBorrowIncentiveAccountData(
-      utils,
-      accountData
-    );
-    const poolType = parsedBorrowIncentiveAccount.poolType;
-    const coinName = utils.parseCoinNameFromType(poolType);
-
-    if (
-      borrowIncentiveCoinNames &&
-      borrowIncentiveCoinNames.includes(coinName)
-    ) {
-      accounts[coinName] = parsedBorrowIncentiveAccount;
-    }
-
-    return accounts;
-  }, {} as BorrowIncentiveAccounts);
-
-  return borrowIncentiveAccounts;
-};
-
-/**
- * @deprecated Use getBindedObligation instead
- */
-export const getBindedObligationId = async (
-  {
-    address,
-    scallopSuiKit,
-  }: {
-    address: ScallopAddress;
-    scallopSuiKit: ScallopSuiKit;
-  },
-  veScaKeyId: string
-) => {
-  return (
-    await getBindedObligation(
-      {
-        address,
-        scallopSuiKit,
-      },
-      veScaKeyId
-    )
-  )?.obligationId;
-};
-
-/**
- * Check veSca bind status
- * @param query
- * @param veScaKey
- * @returns { obligationId, obligationKey } if binded, otherwise null
- */
-export const getBindedObligation = async (
-  {
-    address,
-    scallopSuiKit,
-  }: {
-    address: ScallopAddress;
-    scallopSuiKit: ScallopSuiKit;
-  },
-  veScaKeyId: string
-): Promise<{ obligationId: string; obligationKey: string } | null> => {
-  const borrowIncentiveObjectId = address.get('borrowIncentive.object');
-  const incentivePoolsId = address.get('borrowIncentive.incentivePools');
-  const veScaObjId = address.get('vesca.object');
-
-  // get incentive pools
-  const incentivePoolsResponse =
-    await scallopSuiKit.queryGetObject(incentivePoolsId);
-
-  const incentivePoolsObject = incentivePoolsResponse?.object;
-  if (!incentivePoolsObject) return null;
-  const incentivePoolFields = parseObjectAs<{ ve_sca_bind: { id: string } }>(
-    incentivePoolsObject
-  );
-  const veScaBindTableId = incentivePoolFields.ve_sca_bind.id as string;
-
-  // check if veSca is inside the bind table
-  const keyType = `${borrowIncentiveObjectId}::typed_id::TypedID<${veScaObjId}::ve_sca::VeScaKey>`;
-  const veScaBindTableResponse = await scallopSuiKit.queryGetDynamicFieldObject(
-    {
-      parentId: veScaBindTableId,
-      name: {
-        type: keyType,
-        value: veScaKeyId,
-      },
-    }
-  );
-
-  const veScaBindObject = veScaBindTableResponse?.object;
-  if (!veScaBindObject) return null;
-  const { id: obligationId } = parseObjectAs<{ id: string }>(veScaBindObject);
-  const { name: obligationKey } = getDfObjectIdAndName(veScaBindObject);
-
-  return { obligationId, obligationKey };
-};
-
-export const getBindedVeScaKey = async (
-  {
-    address,
-    scallopSuiKit,
-  }: {
-    address: ScallopAddress;
-    scallopSuiKit: ScallopSuiKit;
-  },
-  obligationId: string
-): Promise<string | null> => {
-  const borrowIncentiveObjectId = address.get('borrowIncentive.object');
-  const incentiveAccountsId = address.get('borrowIncentive.incentiveAccounts');
-  const corePkg = address.get('core.object');
-
-  // get IncentiveAccounts object
-  const incentiveAccountsObject =
-    await scallopSuiKit.queryGetObject(incentiveAccountsId);
-  if (!incentiveAccountsObject?.object) return null;
-  const incentiveAccountsTableId = (
-    parseObjectAs<Record<string, unknown>>(
-      incentiveAccountsObject.object
-    ) as any
-  ).accounts.id;
-
-  // Search in the table
-  const bindedIncentiveAcc = await scallopSuiKit.queryGetDynamicFieldObject({
-    parentId: incentiveAccountsTableId,
-    name: {
-      type: `${borrowIncentiveObjectId}::typed_id::TypedID<${corePkg}::obligation::Obligation>`,
-      value: obligationId,
-    },
-  });
-
-  if (!bindedIncentiveAcc?.object) return null;
-  const bindedIncentiveAccFields = parseObjectAs<Record<string, unknown>>(
-    bindedIncentiveAcc.object
-  ) as any;
-
-  return bindedIncentiveAccFields.binded_ve_sca_key?.id ?? null;
-};

package/src/queries/borrowLimitQuery.ts

@@ -1,33 +0,0 @@
-import { ScallopUtils } from 'src/models/index.js';
-import { parseObjectAs } from 'src/utils/index.js';
-
-const borrowLimitKeyType = `0xe7dbb371a9595631f7964b7ece42255ad0e738cc85fe6da26c7221b220f01af6::market_dynamic_keys::BorrowLimitKey`; // prod
-// const borrowLimitKeyType = `0xb784ea287d944e478a3ceaa071f8885072cce6b7224cf245914dc2f9963f460e::market_dynamic_keys::BorrowLimitKey`;
-
-/**
- * Return supply limit of a pool (including the decimals)
- * @param utils
- * @param poolName
- * @returns supply limit (decimals included)
- */
-export const getBorrowLimit = async (utils: ScallopUtils, poolName: string) => {
-  try {
-    const poolCoinType = utils.parseCoinType(poolName).slice(2);
-    const marketObject = utils.address.get('core.market');
-    if (!marketObject) return null;
-
-    const object = await utils.scallopSuiKit.queryGetDynamicFieldObject({
-      parentId: marketObject,
-      name: {
-        type: borrowLimitKeyType,
-        value: poolCoinType,
-      },
-    });
-
-    if (!object?.object?.json) return '0';
-    return parseObjectAs<string>(object.object);
-  } catch (e: any) {
-    console.error(`Error in getBorrowLimit for ${poolName}: ${e.message}`);
-    return '0';
-  }
-};