@scallop-io/sui-scallop-sdk 0.46.39 → 0.46.40

package/dist/models/scallopQuery.d.ts

@@ -401,4 +401,8 @@ export declare class ScallopQuery {
      * @returns Loyalty program information
      */
     getLoyaltyProgramInfos(veScaKey?: string | SuiObjectData): Promise<import("../types").LoyaltyProgramInfo | null>;
+    /**
+     * Get flashloan fee for specified assets
+     */
+    getFlashLoanFees(assetCoinNames?: SupportAssetCoins[]): Promise<Record<"eth" | "btc" | "usdc" | "usdt" | "sui" | "apt" | "sol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca", number>>;
 }

package/dist/queries/coreQuery.d.ts

@@ -150,3 +150,10 @@ export declare const getMarketCoinAmounts: (query: ScallopQuery, marketCoinNames
  * @return Owned market coin amount.
  */
 export declare const getMarketCoinAmount: (query: ScallopQuery, marketCoinName: SupportMarketCoins, ownerAddress?: string) => Promise<number>;
+/**
+ * Get flashloan fee for specific asset
+ * @param query - The Scallop query instance.
+ * @param assetNames - Specific an array of support pool coin name.
+ * @returns Record of asset name to flashloan fee in decimal
+ */
+export declare const getFlashLoanFees: (query: ScallopQuery, assetNames: SupportPoolCoins[]) => Promise<Record<SupportPoolCoins, number>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "0.46.39",
+  "version": "0.46.40",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/constants/flashloan.ts

@@ -0,0 +1,18 @@
+import { OptionalKeys, SupportPoolCoins } from 'src/types';
+
+export const FlashLoanFeeObjectMap: OptionalKeys<
+  Record<SupportPoolCoins, string>
+> = {
+  vsui: '0x0069cddee7a5c0b1d34beb5ef0620f978096525f1830b055f38b110f40d73fbb',
+  btc: '0x2078490aa37d8fb42b511e5c95e217cb957d141267e16980bc802d76b42719f7',
+  sui: '0x27614284a8f0a699ffd35aae8f2572c937ec76771cb21b0d7930ec4491a76ed4',
+  usdt: '0x5b61983a19b5159ca348d291e4b595f42db70ccda32852a2ed85528aa65171e4',
+  apt: '0x9d5898edcd1e4abcb044273242293a9d036f6a977bf3fe57ab71f5a87c505ee6',
+  afsui: '0xac87fde83d434554ec300c1334c9a622aa5b59e82a04334dc99e1cc1f75d4eae',
+  hasui: '0xb9f505d532de1d6c9f3a8522a2d16f2958b75c0ed939d4f80b96f584a2a8ed5e',
+  usdc: '0xd241d6a7e44ac11a6689370ed9a98eec389b98b8a6695c61fddede9fa7567b90',
+  eth: '0xd252acb058e77877810c1290564e290a8f9fcab5bc9aca2884ede8a38810cf34',
+  sca: '0xe04e46471754b6f48d81c549ecfec09de02733715a63bec02364c6ac7c4dd2dc',
+  cetus: '0xe65a73d11c31b2d323ad2b9f6b4bb0a3c0df9c1b212eef66c854941186a5ddc7',
+  sol: '0xe84bdb35b790fc7bdd1645122ac6ac0fc904531d6772c9e25904fece322c5f34',
+};

package/src/constants/index.ts

@@ -1,3 +1,4 @@
 export * from './common';
 export * from './enum';
 export * from './vesca';
+export * from './flashloan';

package/src/models/scallopQuery.ts

@@ -1,5 +1,5 @@
 import { SuiKit } from '@scallop-io/sui-kit';
-import { ADDRESSES_ID, SUPPORT_SPOOLS } from '../constants';
+import { ADDRESSES_ID, SUPPORT_POOLS, SUPPORT_SPOOLS } from '../constants';
 import {
   queryMarket,
   getObligations,
@@ -32,6 +32,7 @@ import {
   getPythPrices,
   getVeScaTreasuryInfo,
   getLoyaltyProgramInformations,
+  getFlashLoanFees,
 } from '../queries';
 import {
   ScallopQueryParams,
@@ -593,4 +594,13 @@ export class ScallopQuery {
   public async getLoyaltyProgramInfos(veScaKey?: string | SuiObjectData) {
     return await getLoyaltyProgramInformations(this, veScaKey);
   }
+
+  /**
+   * Get flashloan fee for specified assets
+   */
+  public async getFlashLoanFees(
+    assetCoinNames: SupportAssetCoins[] = [...SUPPORT_POOLS]
+  ) {
+    return await getFlashLoanFees(this, assetCoinNames);
+  }
 }

package/src/queries/coreQuery.ts

@@ -4,6 +4,7 @@ import {
   PROTOCOL_OBJECT_ID,
   SUPPORT_COLLATERALS,
   BORROW_FEE_PROTOCOL_ID,
+  FlashLoanFeeObjectMap,
 } from '../constants';
 import {
   parseOriginMarketPoolData,
@@ -875,3 +876,94 @@ export const getMarketCoinAmount = async (
   });
   return BigNumber(amount).toNumber();
 };
+
+/**
+ * Get flashloan fee for specific asset
+ * @param query - The Scallop query instance.
+ * @param assetNames - Specific an array of support pool coin name.
+ * @returns Record of asset name to flashloan fee in decimal
+ */
+
+export const getFlashLoanFees = async (
+  query: ScallopQuery,
+  assetNames: SupportPoolCoins[]
+): Promise<Record<SupportPoolCoins, number>> => {
+  const FEE_RATE = 1e4;
+  const missingAssets: SupportPoolCoins[] = [];
+
+  // create mapping from asset type to asset name
+  const assetTypeMap = assetNames.reduce(
+    (prev, curr) => {
+      const assetType = query.utils.parseCoinType(curr).slice(2);
+      prev[assetType] = curr;
+      return prev;
+    },
+    {} as Record<string, SupportPoolCoins>
+  );
+
+  // use the mapped object first
+  const objIds = assetNames
+    .map((assetName) => {
+      if (!FlashLoanFeeObjectMap[assetName]) {
+        missingAssets.push(assetName);
+        return null;
+      } else {
+        return FlashLoanFeeObjectMap[assetName];
+      }
+    })
+    .filter((t) => !!t) as string[];
+
+  const flashloanFeeObjects = await query.cache.queryGetObjects(objIds, {
+    showContent: true,
+  });
+
+  if (missingAssets.length > 0) {
+    // get market object
+    const marketObjectId = query.address.get('core.market');
+    const marketObjectRes = await query.cache.queryGetObject(marketObjectId, {
+      showContent: true,
+    });
+    if (marketObjectRes.data?.content?.dataType !== 'moveObject')
+      throw new Error('Failed to get market object');
+
+    // get vault
+    const vault = (marketObjectRes.data.content.fields as any).vault;
+
+    // get vault balance sheet object id
+    const flashloanFeesTableId = vault.fields.flash_loan_fees.fields.table
+      .fields.id.id as string;
+
+    // the balance sheet is a VecSet<0x1::type_name::TypeName
+    const balanceSheetDynamicFields = await query.cache.queryGetDynamicFields({
+      parentId: flashloanFeesTableId,
+      limit: 50,
+    });
+
+    // get the dynamic object ids
+    const dynamicFieldObjectIds = balanceSheetDynamicFields.data
+      .filter((field) => {
+        const assetType = (field.name.value as any).name as string;
+        return !!assetTypeMap[assetType];
+      })
+      .map((field) => field.objectId);
+
+    flashloanFeeObjects.push(
+      ...(await query.cache.queryGetObjects(dynamicFieldObjectIds, {
+        showContent: true,
+      }))
+    );
+  }
+
+  return flashloanFeeObjects.reduce(
+    (prev, curr) => {
+      if (curr.content?.dataType === 'moveObject') {
+        const objectFields = curr.content.fields as any;
+        const assetType = (curr.content.fields as any).name.fields.name;
+        const feeNumerator = +objectFields.value;
+        prev[assetTypeMap[assetType]] = feeNumerator / FEE_RATE;
+      }
+      return prev;
+    },
+    {} as Record<SupportPoolCoins, number>
+  );
+};