@scallop-io/sui-scallop-sdk 1.4.24-alpha.1 → 1.4.24-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "1.4.24-alpha.1",
+  "version": "1.4.24-alpha.2",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",
@@ -148,9 +148,8 @@
   },
   "scripts": {
     "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
-    "build": "pnpm run build:types && pnpm run build:tsup",
-    "build:tsup": "tsup ./src/index.ts --format esm,cjs --sourcemap",
-    "build:types": "tsc --build",
+    "build": "pnpm run build:tsup",
+    "build:tsup": "tsup ./src/index.ts --format esm,cjs --splitting --minify --treeshake --dts",
     "watch:tsup": "tsup ./src/index.ts --format esm,cjs --clean --splitting --watch",
     "watch:types": "tsc --watch",
     "watch": "pnpm run clean & pnpm run watch:types & pnpm run watch:tsup",

package/src/models/scallopIndexer.ts

@@ -269,4 +269,15 @@ export class ScallopIndexer {
   public async getCoinPrice(poolCoinName: SupportPoolCoins): Promise<number> {
     return (await this.getMarketPool(poolCoinName))?.coinPrice ?? 0;
   }
+
+  public async getCoinPrices(): Promise<Record<string, number>> {
+    const marketPools = await this.getMarketPools();
+    return Object.entries(marketPools).reduce(
+      (prev, [coinName, market]) => {
+        prev[coinName] = market.coinPrice;
+        return prev;
+      },
+      {} as Record<string, number>
+    );
+  }
 }

package/src/models/scallopQuery.ts

@@ -851,6 +851,14 @@ export class ScallopQuery {
     return this.indexer.getCoinPrice(poolName);
   }
 
+  /**
+   * Get all supported pool price from indexer
+   * @returns prices data
+   */
+  public async getCoinPricesByIndexer() {
+    return this.indexer.getCoinPrices();
+  }
+
   /**
    * Get all coin prices, including sCoin
    * @returns prices data
@@ -858,8 +866,14 @@ export class ScallopQuery {
   public async getAllCoinPrices(args?: {
     marketPools?: MarketPools;
     coinPrices?: CoinPrices;
+    indexer?: boolean;
   }) {
-    return getAllCoinPrices(this, args?.marketPools, args?.coinPrices);
+    return getAllCoinPrices(
+      this,
+      args?.marketPools,
+      args?.coinPrices,
+      args?.indexer
+    );
   }
 
   /**

package/src/queries/priceQuery.ts

@@ -133,16 +133,23 @@ export const getPythPrices = async (
 export const getAllCoinPrices = async (
   query: ScallopQuery,
   marketPools?: MarketPools,
-  coinPrices?: CoinPrices
+  coinPrices?: CoinPrices,
+  indexer: boolean = false
 ) => {
-  coinPrices = coinPrices ?? (await query.utils.getCoinPrices());
+  coinPrices =
+    coinPrices ??
+    (indexer
+      ? await query.getCoinPricesByIndexer()
+      : await query.utils.getCoinPrices());
+
   marketPools =
     marketPools ??
-    (await query.getMarketPools(undefined, { coinPrices })).pools;
+    (await query.getMarketPools(undefined, { coinPrices, indexer })).pools;
 
   if (!marketPools) {
     throw new Error(`Failed to fetch market pool for getAllCoinPrices`);
   }
+
   const sCoinPrices: OptionalKeys<Record<SupportSCoin, number>> = {};
   SUPPORT_SCOIN.forEach((sCoinName) => {
     const coinName = query.utils.parseCoinName(sCoinName);

package/dist/builders/borrowIncentiveBuilder.d.ts

@@ -1,12 +0,0 @@
-import { Transaction } from '@mysten/sui/transactions';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import type { ScallopBuilder } from 'src/models';
-import type { BorrowIncentiveTxBlock, ScallopTxBlock } from '../types';
-/**
- * Create an enhanced transaction block instance for interaction with borrow incentive modules of the Scallop contract.
- *
- * @param builder - Scallop builder instance.
- * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
- * @return Scallop borrow incentive txBlock.
- */
-export declare const newBorrowIncentiveTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction) => BorrowIncentiveTxBlock;

package/dist/builders/coreBuilder.d.ts

@@ -1,12 +0,0 @@
-import { Transaction } from '@mysten/sui/transactions';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import type { ScallopBuilder } from '../models';
-import type { CoreTxBlock, ScallopTxBlock, SuiTxBlockWithSpool } from '../types';
-/**
- * Create an enhanced transaction block instance for interaction with core modules of the Scallop contract.
- *
- * @param builder - Scallop builder instance.
- * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
- * @return Scallop core txBlock.
- */
-export declare const newCoreTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction | SuiTxBlockWithSpool) => CoreTxBlock;

package/dist/builders/index.d.ts

@@ -1,12 +0,0 @@
-import { Transaction } from '@mysten/sui/transactions';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import type { ScallopBuilder } from '../models';
-import type { ScallopTxBlock } from '../types';
-/**
- * Create a new ScallopTxBlock instance.
- *
- * @param builder - Scallop builder instance.
- * @param txBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
- * @return ScallopTxBlock.
- */
-export declare const newScallopTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction) => ScallopTxBlock;

package/dist/builders/loyaltyProgramBuilder.d.ts

@@ -1,12 +0,0 @@
-import { Transaction } from '@mysten/sui/transactions';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import { ScallopBuilder } from 'src/models';
-import { LoyaltyProgramTxBlock, ScallopTxBlock } from 'src/types';
-/**
- * Create an enhanced transaction block instance for interaction with loyalty program modules of the Scallop contract.
- *
- * @param builder - Scallop builder instance.
- * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
- * @return Scallop loyalty program txBlock.
- */
-export declare const newLoyaltyProgramTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction) => LoyaltyProgramTxBlock;

package/dist/builders/oracle.d.ts

@@ -1,14 +0,0 @@
-import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import type { ScallopBuilder } from '../models';
-import type { SupportAssetCoins } from '../types';
-/**
- * Update the price of the oracle for multiple coin.
- *
- * @param builder - The scallop builder.
- * @param txBlock - TxBlock created by SuiKit.
- * @param assetCoinNames - Specific an array of support asset coin name.
- * @param options - The options for update oracles.
- */
-export declare const updateOracles: (builder: ScallopBuilder, txBlock: SuiKitTxBlock, assetCoinNames?: SupportAssetCoins[], options?: {
-    usePythPullModel: boolean;
-}) => Promise<void>;

package/dist/builders/referralBuilder.d.ts

@@ -1,12 +0,0 @@
-import { ScallopBuilder } from 'src/models';
-import { ScallopTxBlock } from 'src/types';
-import { SuiTxBlock as SuiKitTxBlock, Transaction } from '@scallop-io/sui-kit';
-import { ReferralTxBlock } from 'src/types/builder/referral';
-/**
- * Create an enhanced transaction block instance for interaction with borrow incentive modules of the Scallop contract.
- *
- * @param builder - Scallop builder instance.
- * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
- * @return Scallop referral txBlock.
- */
-export declare const newReferralTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction) => ReferralTxBlock;

package/dist/builders/sCoinBuilder.d.ts

@@ -1,4 +0,0 @@
-import { Transaction, SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import { ScallopBuilder } from 'src/models';
-import { BaseScallopTxBlock, SCoinTxBlock, ScallopTxBlock } from 'src/types';
-export declare const newSCoinTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction | BaseScallopTxBlock) => SCoinTxBlock;

package/dist/builders/spoolBuilder.d.ts

@@ -1,12 +0,0 @@
-import { Transaction } from '@mysten/sui/transactions';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import type { ScallopBuilder } from '../models';
-import type { SpoolTxBlock, ScallopTxBlock, SuiTxBlockWithSCoin } from '../types';
-/**
- * Create an enhanced transaction block instance for interaction with spool modules of the Scallop contract.
- *
- * @param builder - Scallop builder instance.
- * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
- * @return Scallop spool txBlock.
- */
-export declare const newSpoolTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction | SuiTxBlockWithSCoin) => SpoolTxBlock;

package/dist/builders/vescaBuilder.d.ts

@@ -1,25 +0,0 @@
-import { SuiTxBlock, Transaction, SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import { ScallopBuilder } from '../models';
-import type { SuiObjectArg } from '@scallop-io/sui-kit';
-import type { ScallopTxBlock, VeScaTxBlock } from 'src/types';
-/**
- * Check and get veSCA data from transaction block.
- *
- * @description
- * If the veScaKey id is provided, directly return it.
- * Otherwise, automatically get veScaKey from the sender.
- *
- * @param builder - Scallop builder instance.
- * @param txBlock - TxBlock created by SuiKit.
- * @param veScaKey - veSCA key.
- * @return veSCA key, ID, locked amount and unlock at timestamp.
- */
-export declare const requireVeSca: (builder: ScallopBuilder, SuiTxBlock: SuiTxBlock, veScaKey?: SuiObjectArg | undefined) => Promise<import("src/types").Vesca | undefined>;
-/**
- * Create an enhanced transaction block instance for interaction with veSCA modules of the Scallop contract.
- *
- * @param builder - Scallop builder instance.
- * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
- * @return Scallop borrow incentive txBlock.
- */
-export declare const newVeScaTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction) => VeScaTxBlock;

package/dist/constants/cache.d.ts

@@ -1,14 +0,0 @@
-/**
- * Default cache options for the QueryClient.
- * @type {QueryClientConfig}
- * @description Default cache options for the QueryClient
- * We set the default to 5s to prevent duplicate requests from being requested (e.g. query MarketObject, etc.)
- */
-export declare const DEFAULT_CACHE_OPTIONS: {
-    defaultOptions: {
-        queries: {
-            staleTime: number;
-            gcTime: number;
-        };
-    };
-};

package/dist/constants/coinGecko.d.ts

@@ -1,2 +0,0 @@
-import { SupportPoolCoins } from 'src/types/constant/common';
-export declare const COIN_GECKGO_IDS: Record<SupportPoolCoins, string>;

package/dist/constants/common.d.ts

@@ -1,20 +0,0 @@
-export declare const API_BASE_URL: "https://sui.apis.scallop.io";
-export declare const SDK_API_BASE_URL: "https://sdk.api.scallop.io";
-export declare const IS_VE_SCA_TEST: boolean;
-export declare const USE_TEST_ADDRESS: boolean;
-export declare const ADDRESSES_ID: "65fb07c39c845425d71d7b18" | "675c65cd301dd817ea262e76";
-export declare const PROTOCOL_OBJECT_ID: "0xc9f859f98ca352a11b97a038c4b4162bee437b8df8caa047990fe9cb03d4f778" | "0xefe8b36d5b2e43728cc323298626b83177803521d195cfb11e15b910e892fddf";
-export declare const BORROW_FEE_PROTOCOL_ID: "0xc9f859f98ca352a11b97a038c4b4162bee437b8df8caa047990fe9cb03d4f778" | "0xc38f849e81cfe46d4e4320f508ea7dda42934a329d5a6571bb4c3cb6ea63f5da";
-export declare const SCA_COIN_TYPE: "0x6cd813061a3adf3602b76545f076205f0c8e7ec1d3b1eab9a1da7992c18c0524::sca::SCA" | "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA";
-export declare const OLD_BORROW_INCENTIVE_PROTOCOL_ID: "0xc63072e7f5f4983a2efaf5bdba1480d5e7d74d57948e1c7cc436f8e22cbeb410";
-export declare const SUPPORT_POOLS: readonly ["usdc", "sbeth", "sbusdt", "sbwbtc", "weth", "wbtc", "wusdc", "wusdt", "sui", "wapt", "wsol", "cetus", "afsui", "hasui", "vsui", "sca", "fud", "deep", "fdusd", "blub", "musd"];
-export declare const SUPPORT_COLLATERALS: readonly ["usdc", "sbeth", "sbusdt", "sbwbtc", "weth", "wbtc", "wusdc", "wusdt", "sui", "wapt", "wsol", "cetus", "afsui", "hasui", "vsui", "sca", "fdusd"];
-export declare const SUPPORT_SPOOLS: readonly ["susdc", "sweth", "ssui", "swusdc", "swusdt", "scetus", "safsui", "shasui", "svsui"];
-export declare const SUPPORT_SCOIN: readonly ["susdc", "ssbeth", "ssbusdt", "ssbwbtc", "ssui", "swusdc", "swusdt", "safsui", "shasui", "svsui", "sweth", "ssca", "scetus", "swsol", "swbtc", "sdeep", "sfud", "sfdusd", "sblub", "smusd"];
-export declare const SUPPORT_SUI_BRIDGE: readonly ["sbeth", "sbusdt", "sbwbtc"];
-export declare const SUPPORT_WORMHOLE: readonly ["wusdc", "wusdt", "weth", "wbtc", "wapt", "wsol"];
-export declare const SUPPORT_SPOOLS_REWARDS: readonly ["sui"];
-export declare const SUPPORT_BORROW_INCENTIVE_POOLS: readonly ["usdc", "sbeth", "sbusdt", "sbwbtc", "weth", "wbtc", "wusdc", "wusdt", "sui", "wapt", "wsol", "cetus", "afsui", "hasui", "vsui", "sca", "fud", "deep", "fdusd", "blub", "musd"];
-export declare const SUPPORT_BORROW_INCENTIVE_REWARDS: readonly ["usdc", "sbeth", "sbusdt", "sbwbtc", "weth", "wbtc", "wusdc", "wusdt", "sui", "wapt", "wsol", "cetus", "afsui", "hasui", "vsui", "sca", "fud", "deep", "fdusd", "blub", "musd", "susdc", "ssbeth", "ssbusdt", "ssbwbtc", "ssui", "swusdc", "swusdt", "safsui", "shasui", "svsui", "sweth", "ssca", "scetus", "swsol", "swbtc", "sdeep", "sfud", "sfdusd", "sblub", "smusd"];
-export declare const SUPPORT_ORACLES: readonly ["supra", "switchboard", "pyth"];
-export declare const SUPPORT_PACKAGES: readonly ["coinDecimalsRegistry", "math", "whitelist", "x", "protocol", "protocolWhitelist", "query", "supra", "pyth", "switchboard", "xOracle", "testCoin"];

package/dist/constants/enum.d.ts

@@ -1,14 +0,0 @@
-import type * as types from '../types';
-export declare const coinDecimals: types.SupportCoinDecimals;
-export declare const assetCoins: types.AssetCoins;
-export declare const marketCoins: types.MarketCoins;
-export declare const sCoins: types.SCoins;
-export declare const stakeMarketCoins: types.StakeMarketCoins;
-export declare const spoolRewardCoins: types.StakeRewardCoins;
-export declare const suiBridgeCoins: types.SuiBridgeCoins;
-export declare const coinIds: types.AssetCoinIds;
-export declare const wormholeCoinIds: types.WormholeCoinIds;
-export declare const voloCoinIds: types.VoloCoinIds;
-export declare const sCoinIds: types.SCoinIds;
-export declare const sCoinTypeToName: Record<string, "susdc" | "ssbeth" | "ssbusdt" | "ssbwbtc" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep" | "sfdusd" | "sblub" | "smusd">;
-export declare const sCoinRawNameToName: Record<string, "susdc" | "ssbeth" | "ssbusdt" | "ssbwbtc" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep" | "sfdusd" | "sblub" | "smusd">;

package/dist/constants/flashloan.d.ts

@@ -1,2 +0,0 @@
-import { OptionalKeys, SupportPoolCoins } from 'src/types';
-export declare const FlashLoanFeeObjectMap: OptionalKeys<Record<SupportPoolCoins, string>>;

package/dist/constants/index.d.ts

@@ -1,12 +0,0 @@
-export * from './cache';
-export * from './coinGecko';
-export * from './common';
-export * from './enum';
-export * from './flashloan';
-export * from './poolAddress';
-export * from './pyth';
-export * from './queryKeys';
-export * from './rpc';
-export * from './testAddress';
-export * from './vesca';
-export * from './testAddress';

package/dist/constants/poolAddress.d.ts

@@ -1,27 +0,0 @@
-import { OptionalKeys, SupportPoolCoins } from 'src/types';
-export declare const POOL_ADDRESSES: OptionalKeys<Record<SupportPoolCoins, {
-    coinName: string;
-    symbol: string;
-    coinType: string;
-    lendingPoolAddress: string;
-    borrowDynamic: string;
-    interestModel: string;
-    borrowFeeKey: string;
-    coinMetadataId: string;
-    decimals: number;
-    pythFeed: string;
-    pythFeedObjectId: string;
-    collateralPoolAddress?: string;
-    riskModel?: string;
-    supplyLimitKey?: string;
-    borrowLimitKey?: string;
-    sCoinType?: string;
-    sCoinName?: string;
-    sCoinSymbol?: string;
-    sCoinMetadataId?: string;
-    sCoinTreasury?: string;
-    isolatedAssetKey?: string;
-    spool?: string;
-    spoolReward?: string;
-    spoolName?: string;
-}>>;

package/dist/constants/pyth.d.ts

@@ -1,5 +0,0 @@
-import { SupportPoolCoins } from 'src/types';
-export declare const PYTH_ENDPOINTS: {
-    [k in 'mainnet' | 'testnet']: string[];
-};
-export declare const PYTH_FEED_IDS: Record<SupportPoolCoins, string>;

package/dist/constants/queryKeys.d.ts

@@ -1,54 +0,0 @@
-import type { GetDynamicFieldObjectParams, GetDynamicFieldsParams, GetOwnedObjectsParams, SuiObjectData, SuiObjectDataOptions } from '@mysten/sui/client';
-import type { SuiObjectArg, SuiTxArg } from '@scallop-io/sui-kit';
-export declare const queryKeys: {
-    api: {
-        getAddresses: (addressesId?: string) => (string | {
-            addressesId: string | undefined;
-        })[];
-        getMarket: () => string[];
-        getSpools: () => string[];
-        getBorrowIncentivePool: () => string[];
-        getTotalValueLocked: () => string[];
-    };
-    rpc: {
-        getInspectTxn: (queryTarget?: string, args?: SuiObjectArg[], typeArgs?: any[]) => (string | {
-            queryTarget: string | undefined;
-            args: string;
-            typeArgs: string | undefined;
-        })[];
-        getObject: (objectId?: string, options?: SuiObjectDataOptions) => (string | {
-            objectId: string | undefined;
-            options: SuiObjectDataOptions | undefined;
-        })[];
-        getObjects: (objectIds?: string[]) => (string | {
-            objectIds: string;
-        })[];
-        getOwnedObjects: (input?: Partial<GetOwnedObjectsParams>) => (string | {
-            walletAddress: string | undefined;
-            cursor: string | undefined;
-            options: SuiObjectDataOptions | undefined;
-            filter: string;
-            limit: number | undefined;
-        })[];
-        getDynamicFields: (input?: Partial<GetDynamicFieldsParams>) => (string | {
-            parentId: string | undefined;
-            cursor: string | undefined;
-            limit: number | undefined;
-        })[];
-        getDynamicFieldObject: (input?: Partial<GetDynamicFieldObjectParams>) => (string | {
-            parentId: string | undefined;
-            name: string;
-        })[];
-        getTotalVeScaTreasuryAmount: (refreshArgs?: any[], vescaAmountArgs?: (string | SuiObjectData | SuiTxArg)[]) => (string | {
-            refreshArgs: string;
-            vescaAmountArgs: string;
-        })[];
-        getAllCoinBalances: (owner?: string) => (string | {
-            owner: string | undefined;
-        })[];
-        getNormalizedMoveFunction: (target?: string) => (string | undefined)[];
-    };
-    oracle: {
-        getPythLatestPriceFeeds: () => string[];
-    };
-};

package/dist/constants/rpc.d.ts

@@ -1 +0,0 @@
-export declare const RPC_PROVIDERS: string[];

package/dist/constants/testAddress.d.ts

@@ -1,2 +0,0 @@
-import { AddressesInterface } from 'src/types';
-export declare const TEST_ADDRESSES: AddressesInterface;

package/dist/constants/vesca.d.ts

@@ -1,5 +0,0 @@
-export declare const UNLOCK_ROUND_DURATION: number;
-export declare const MAX_LOCK_ROUNDS: 1460;
-export declare const MAX_LOCK_DURATION: number;
-export declare const MIN_INITIAL_LOCK_AMOUNT: 10000000000;
-export declare const MIN_TOP_UP_AMOUNT: 1000000000;