@scallop-io/sui-scallop-sdk 0.46.55 → 0.46.57

package/src/queries/vescaQuery.ts

@@ -5,7 +5,7 @@ import {
   type SuiObjectData,
   DevInspectResults,
 } from '@mysten/sui.js/client';
-import type { ScallopQuery } from '../models';
+import type { ScallopUtils } from '../models';
 import { MAX_LOCK_DURATION } from 'src/constants';
 import { SUI_CLOCK_OBJECT_ID, SuiTxBlock } from '@scallop-io/sui-kit';
 import { bcs } from '@mysten/sui.js/bcs';
@@ -18,17 +18,17 @@ import { z as zod } from 'zod';
  * @return Owned veSca key.
  */
 export const getVescaKeys = async (
-  query: ScallopQuery,
+  utils: ScallopUtils,
   ownerAddress?: string
 ) => {
-  const owner = ownerAddress || query.suiKit.currentAddress();
-  const veScaObjId = query.address.get('vesca.object');
+  const owner = ownerAddress || utils.suiKit.currentAddress();
+  const veScaObjId = utils.address.get('vesca.object');
   const veScaKeyType = `${veScaObjId}::ve_sca::VeScaKey`;
   const keyObjectsResponse: SuiObjectResponse[] = [];
   let hasNextPage = false;
   let nextCursor: string | null | undefined = null;
   do {
-    const paginatedKeyObjectsResponse = await query.cache.queryGetOwnedObjects({
+    const paginatedKeyObjectsResponse = await utils.cache.queryGetOwnedObjects({
       owner,
       filter: {
         StructType: veScaKeyType,
@@ -63,12 +63,19 @@ export const getVescaKeys = async (
  * @param ownerAddress - The owner address.
  * @return Owned veScas.
  */
-export const getVeScas = async (query: ScallopQuery, ownerAddress?: string) => {
-  const keyObjectDatas = await getVescaKeys(query, ownerAddress);
+export const getVeScas = async (
+  {
+    utils,
+  }: {
+    utils: ScallopUtils;
+  },
+  ownerAddress?: string
+) => {
+  const keyObjectDatas = await getVescaKeys(utils, ownerAddress);
 
   const veScas: Vesca[] = Array(keyObjectDatas.length).fill(null);
   const tasks = keyObjectDatas.map(async (veScaKey, idx) => {
-    const veSca = await getVeSca(query, veScaKey);
+    const veSca = await getVeSca(utils, veScaKey);
     if (veSca) {
       veScas[idx] = veSca;
     }
@@ -96,12 +103,12 @@ type SuiObjectRefType = zod.infer<typeof SuiObjectRefZod>;
  * @returns Vesca data.
  */
 export const getVeSca = async (
-  query: ScallopQuery,
+  utils: ScallopUtils,
   veScaKey?: string | SuiObjectData,
   ownerAddress?: string
 ) => {
-  const tableId = query.address.get(`vesca.tableId`);
-  veScaKey = veScaKey || (await getVescaKeys(query, ownerAddress))[0];
+  const tableId = utils.address.get(`vesca.tableId`);
+  veScaKey = veScaKey || (await getVescaKeys(utils, ownerAddress))[0];
 
   if (!veScaKey) return undefined;
   if (typeof veScaKey === 'object') {
@@ -111,7 +118,7 @@ export const getVeSca = async (
   let vesca: Vesca | undefined = undefined;
 
   const veScaDynamicFieldObjectResponse =
-    await query.cache.queryGetDynamicFieldObject({
+    await utils.cache.queryGetDynamicFieldObject({
       parentId: tableId,
       name: {
         type: '0x2::object::ID',
@@ -162,12 +169,12 @@ export const getVeSca = async (
  * Get current total veSca treasury amount.
  */
 const getTotalVeScaTreasuryAmount = async (
-  query: ScallopQuery,
+  utils: ScallopUtils,
   veScaTreasury: SuiObjectData
 ): Promise<string> => {
-  const veScaPkgId = query.address.get('vesca.id');
-  const veScaConfig = query.address.get('vesca.config');
-  veScaTreasury = veScaTreasury ?? query.address.get('vesca.treasury');
+  const veScaPkgId = utils.address.get('vesca.id');
+  const veScaConfig = utils.address.get('vesca.config');
+  veScaTreasury = veScaTreasury ?? utils.address.get('vesca.treasury');
 
   // refresh query
   const refreshQueryTarget = `${veScaPkgId}::treasury::refresh`;
@@ -181,7 +188,7 @@ const getTotalVeScaTreasuryAmount = async (
   const resolvedRefreshArgs = await Promise.all(
     refreshArgs.map(async (arg) => {
       if (typeof arg === 'string') {
-        return (await query.cache.queryGetObject(arg, { showContent: true }))
+        return (await utils.cache.queryGetObject(arg, { showContent: true }))
           ?.data;
       }
       return arg;
@@ -191,7 +198,7 @@ const getTotalVeScaTreasuryAmount = async (
   const resolvedVeScaAmountArgs = await Promise.all(
     veScaAmountArgs.map(async (arg) => {
       if (typeof arg === 'string') {
-        return (await query.cache.queryGetObject(arg, { showContent: true }))
+        return (await utils.cache.queryGetObject(arg, { showContent: true }))
           ?.data;
       }
       return arg;
@@ -204,19 +211,18 @@ const getTotalVeScaTreasuryAmount = async (
   txb.moveCall(veScaAmountQueryTarget, resolvedVeScaAmountArgs);
 
   const txBytes = await txb.txBlock.build({
-    client: query.suiKit.client(),
+    client: utils.suiKit.client(),
     onlyTransactionKind: true,
-    protocolConfig: (await query.cache.getProtocolConfig()) ?? undefined,
   });
 
   // return result
-  const res = await query.cache.queryClient.fetchQuery<DevInspectResults>({
+  const res = await utils.cache.queryClient.fetchQuery<DevInspectResults>({
     queryKey: [
       'getTotalVeScaTreasuryAmount',
       JSON.stringify([...refreshArgs, ...veScaAmountArgs]),
     ],
     queryFn: async () => {
-      return await query.suiKit.inspectTxn(txBytes);
+      return await utils.suiKit.inspectTxn(txBytes);
     },
   });
 
@@ -236,10 +242,10 @@ const getTotalVeScaTreasuryAmount = async (
  * @returns VeScaTreasuryInfo
  */
 export const getVeScaTreasuryInfo = async (
-  query: ScallopQuery
+  utils: ScallopUtils
 ): Promise<VeScaTreasuryInfo | null> => {
-  const veScaTreasuryId = query.address.get('vesca.treasury');
-  const veScaTreasury = await query.cache.queryGetObject(veScaTreasuryId, {
+  const veScaTreasuryId = utils.address.get('vesca.treasury');
+  const veScaTreasury = await utils.cache.queryGetObject(veScaTreasuryId, {
     showContent: true,
   });
 
@@ -255,7 +261,7 @@ export const getVeScaTreasuryInfo = async (
     .shiftedBy(-9)
     .toNumber();
   const totalVeSca = BigNumber(
-    (await getTotalVeScaTreasuryAmount(query, veScaTreasury.data)) ?? 0
+    (await getTotalVeScaTreasuryAmount(utils, veScaTreasury.data)) ?? 0
   )
     .shiftedBy(-9)
     .toNumber();

package/src/types/builder/index.ts

@@ -1,10 +1,11 @@
-import type { CoreTxBlock } from './core';
+import type { CoreTxBlock, NestedResult } from './core';
 import type { SpoolTxBlock } from './spool';
 import type { BorrowIncentiveTxBlock } from './borrowIncentive';
 import type { VeScaTxBlock } from './vesca';
 import type { ReferralTxBlock } from './referral';
 import { LoyaltyProgramTxBlock } from './loyaltyProgram';
 import { SCoinTxBlock } from './sCoin';
+import { SupportAssetCoins } from '../constant';
 
 export type * from './core';
 export type * from './spool';
@@ -21,3 +22,12 @@ export type BaseScallopTxBlock = ReferralTxBlock &
 export type SuiTxBlockWithSCoin = BaseScallopTxBlock & SCoinTxBlock;
 export type SuiTxBlockWithSpool = SuiTxBlockWithSCoin & SpoolTxBlock;
 export type ScallopTxBlock = SuiTxBlockWithSpool & CoreTxBlock;
+
+export type SelectCoinReturnType<T extends SupportAssetCoins> = T extends 'sui'
+  ? {
+      takeCoin: NestedResult;
+    }
+  : {
+      takeCoin: NestedResult;
+      leftCoin: NestedResult;
+    };

package/src/types/builder/vesca.ts

@@ -32,6 +32,10 @@ export type VeScaNormalMethods = {
   mintEmptyVeSca: () => TransactionResult;
 };
 
+export type RedeemScaQuickReturnType<T extends boolean> = T extends true
+  ? void
+  : TransactionResult | undefined;
+
 export type VeScaQuickMethods = {
   /**
    * Quick methods to automate
@@ -70,7 +74,10 @@ export type VeScaQuickMethods = {
     veScaKey?: SuiObjectArg,
     autoCheck?: boolean
   ) => Promise<void>;
-  redeemScaQuick: (veScaKey?: SuiObjectArg) => Promise<void>;
+  redeemScaQuick: <T extends boolean>(
+    veSCaKey?: SuiObjectArg,
+    transferSca?: T
+  ) => Promise<RedeemScaQuickReturnType<T>>;
 };
 
 export type SuiTxBlockWithVeScaNormalMethods = SuiKitTxBlock &

package/src/types/model.ts

@@ -1,11 +1,15 @@
 import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
-import type { TransactionBlock } from '@mysten/sui.js/transactions';
+import type {
+  TransactionBlock,
+  TransactionResult,
+} from '@mysten/sui.js/transactions';
 import type { SuiKit, SuiKitParams, NetworkType } from '@scallop-io/sui-kit';
 import type {
   ScallopAddress,
   ScallopQuery,
   ScallopUtils,
   ScallopBuilder,
+  ScallopIndexer,
 } from '../models';
 import { ScallopCache } from 'src/models/scallopCache';
 
@@ -13,13 +17,42 @@ export type ScallopClientFnReturnType<T extends boolean> = T extends true
   ? SuiTransactionBlockResponse
   : TransactionBlock;
 
-export type ScallopInstanceParams = {
+export type ScallopClientVeScaReturnType<T extends boolean> = T extends true
+  ? SuiTransactionBlockResponse
+  : {
+      tx: TransactionBlock;
+      scaCoin: TransactionResult;
+    };
+
+export type ScallopBaseInstanceParams = {
   suiKit?: SuiKit;
+};
+
+export type ScallopCacheInstanceParams = ScallopBaseInstanceParams;
+
+export type ScallopAddressInstanceParams = ScallopBaseInstanceParams & {
+  cache?: ScallopCache;
+};
+
+export type ScallopIndexerInstanceParams = {
+  cache?: ScallopCache;
+};
+
+export type ScallopUtilsInstanceParams = ScallopBaseInstanceParams & {
   address?: ScallopAddress;
-  query?: ScallopQuery;
+};
+
+export type ScallopQueryInstanceParams = ScallopBaseInstanceParams & {
   utils?: ScallopUtils;
+  indexer?: ScallopIndexer;
+};
+
+export type ScallopBuilderInstanceParams = ScallopBaseInstanceParams & {
+  query?: ScallopQuery;
+};
+
+export type ScallopClientInstanceParams = ScallopBaseInstanceParams & {
   builder?: ScallopBuilder;
-  cache: ScallopCache;
 };
 
 export type ScallopAddressParams = {
@@ -30,20 +63,16 @@ export type ScallopAddressParams = {
 
 export type ScallopParams = {
   addressesId?: string;
+  walletAddress?: string;
 } & SuiKitParams;
 
-export type ScallopClientParams = ScallopParams & {
-  walletAddress?: string;
-};
+export type ScallopClientParams = ScallopParams;
 
 export type ScallopBuilderParams = ScallopParams & {
-  walletAddress?: string;
   pythEndpoints?: string[];
 };
 
-export type ScallopQueryParams = ScallopParams & {
-  walletAddress?: string;
-};
+export type ScallopQueryParams = ScallopParams;
 
 export type ScallopUtilsParams = ScallopParams & {
   pythEndpoints?: string[];

package/src/types/query/core.ts

@@ -125,6 +125,7 @@ export type MarketPool = {
   symbol: string;
   coinType: string;
   marketCoinType: string;
+  sCoinType: string;
   coinWrappedType: CoinWrappedType;
   coinDecimal: number;
   coinPrice: number;

package/src/utils/query.ts

@@ -697,7 +697,7 @@ export const maxBigNumber = (...args: BigNumber.Value[]) => {
 };
 
 /**
- * Dynamically adjust the decrease or increase ratio according to the amout
+ * Dynamically adjust the decrease or increase ratio according to the amount
  * @param amount - The amount required to calculate factor.
  * @param scaleStep - The scale step required to determine the factor..
  * @param type - The type of the calculation.