@scallop-io/sui-scallop-sdk 0.44.28 → 0.46.0

package/src/queries/vescaQuery.ts

@@ -1,8 +1,14 @@
 import BigNumber from 'bignumber.js';
 import { Vesca } from '../types';
-import type { SuiObjectResponse, SuiObjectData } from '@mysten/sui.js/client';
+import {
+  type SuiObjectResponse,
+  type SuiObjectData,
+  DevInspectResults,
+} from '@mysten/sui.js/client';
 import type { ScallopQuery } from '../models';
-import { IS_VE_SCA_TEST, MAX_LOCK_DURATION } from 'src/constants';
+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';
 /**
  * Query all owned veSca key.
  *
@@ -15,10 +21,8 @@ export const getVescaKeys = async (
   ownerAddress?: string
 ) => {
   const owner = ownerAddress || query.suiKit.currentAddress();
-  const veScaPkgId = IS_VE_SCA_TEST
-    ? '0xb220d034bdf335d77ae5bfbf6daf059c2cc7a1f719b12bfed75d1736fac038c8'
-    : query.address.get('vesca.id');
-  const veScaKeyType = `${veScaPkgId}::ve_sca::VeScaKey`;
+  const veScaObjId = query.address.get('vesca.object');
+  const veScaKeyType = `${veScaObjId}::ve_sca::VeScaKey`;
   const keyObjectsResponse: SuiObjectResponse[] = [];
   let hasNextPage = false;
   let nextCursor: string | null | undefined = null;
@@ -61,13 +65,18 @@ export const getVeScas = async (query: ScallopQuery, ownerAddress?: string) => {
   const keyObjectDatas = await getVescaKeys(query, ownerAddress);
   const keyObjectId: string[] = keyObjectDatas.map((data) => data.objectId);
 
-  const veScas: Vesca[] = [];
-  for (const keyId of keyObjectId) {
+  const veScas: (Vesca | undefined)[] = Array(keyObjectId.length).fill(null);
+  const tasks = keyObjectId.map(async (keyId, idx) => {
     const veSca = await getVeSca(query, keyId);
-    if (veSca) veScas.push(veSca);
-  }
+    if (veSca) {
+      veScas[idx] = veSca;
+    }
+  });
+  await Promise.allSettled(tasks);
 
-  return veScas;
+  return veScas
+    .filter(Boolean)
+    .sort((a, b) => a!.currentVeScaBalance - b!.currentVeScaBalance);
 };
 
 /**
@@ -83,17 +92,14 @@ export const getVeSca = async (
   veScaKeyId?: string,
   ownerAddress?: string
 ) => {
-  const tableId = IS_VE_SCA_TEST
-    ? '0xc607241e4a679fe376d1170b2fbe07b64917bfe69100d4825241cda20039d4bd'
-    : query.address.get(`vesca.tableId`);
+  const tableId = query.address.get(`vesca.tableId`);
   veScaKeyId =
     veScaKeyId || (await getVescaKeys(query, ownerAddress))[0].objectId;
 
   let vesca: Vesca | undefined = undefined;
 
-  const veScaDynamicFieldObjectResponse = await query.suiKit
-    .client()
-    .getDynamicFieldObject({
+  const veScaDynamicFieldObjectResponse =
+    await query.cache.queryGetDynamicFieldObject({
       parentId: tableId,
       name: {
         type: '0x2::object::ID',
@@ -135,3 +141,75 @@ export const getVeSca = async (
 
   return vesca;
 };
+
+/**
+ * Get current total veSca treasury amount.
+ */
+export const getTotalVeScaTreasuryAmount = async (
+  query: ScallopQuery
+): Promise<string> => {
+  const veScaPkgId = query.address.get('vesca.id');
+  const veScaConfig = query.address.get('vesca.config');
+  const veScaTreasury = query.address.get('vesca.treasury');
+
+  // refresh query
+  const refreshQueryTarget = `${veScaPkgId}::treasury::refresh`;
+  const refreshArgs = [veScaConfig, veScaTreasury, SUI_CLOCK_OBJECT_ID];
+
+  // query total veSca amount
+  const veScaAmountQueryTarget = `${veScaPkgId}::treasury::total_ve_sca_amount`;
+  const veScaAmountArgs = [veScaTreasury, SUI_CLOCK_OBJECT_ID];
+
+  // resolve each args
+  const resolvedRefreshArgs = await Promise.all(
+    refreshArgs.map(async (arg) => {
+      if (typeof arg === 'string') {
+        return (await query.cache.queryGetObject(arg, { showContent: true }))
+          .data;
+      }
+      return arg;
+    })
+  );
+
+  const resolvedVeScaAmountArgs = await Promise.all(
+    veScaAmountArgs.map(async (arg) => {
+      if (typeof arg === 'string') {
+        return (await query.cache.queryGetObject(arg, { showContent: true }))
+          .data;
+      }
+      return arg;
+    })
+  );
+
+  const txb = new SuiTxBlock();
+  // refresh first
+  txb.moveCall(refreshQueryTarget, resolvedRefreshArgs);
+  txb.moveCall(veScaAmountQueryTarget, resolvedVeScaAmountArgs);
+
+  const txBytes = await txb.txBlock.build({
+    client: query.suiKit.client(),
+    onlyTransactionKind: true,
+    protocolConfig: await query.cache.getProtocolConfig(),
+  });
+
+  // return result
+  const res = await query.cache.queryClient.fetchQuery<DevInspectResults>({
+    queryKey: [
+      'getTotalVeScaTreasuryAmount',
+      JSON.stringify([...refreshArgs, ...veScaAmountArgs]),
+    ],
+    queryFn: async () => {
+      return await query.suiKit.inspectTxn(txBytes);
+    },
+    staleTime: 8000,
+  });
+
+  const results = res.results;
+  if (results && results[1].returnValues) {
+    const value = Uint8Array.from(results[1].returnValues[0][0]);
+    const type = results[1].returnValues[0][1];
+    return bcs.de(type, value);
+  }
+
+  return '0';
+};

package/src/types/address.ts

@@ -73,6 +73,7 @@ export interface AddressesInterface {
     id: string;
     adminCap: string;
     object: string;
+    config: string;
     pools: Partial<
       Record<
         SupportStakeMarketCoins,
@@ -94,12 +95,26 @@ export interface AddressesInterface {
   };
   vesca: {
     id: string;
+    object: string;
     adminCap: string;
     tableId: string;
     table: string;
     treasury: string;
     config: string;
   };
+  referral: {
+    id: string;
+    version: string;
+    object: string;
+    adminCap: string;
+    referralBindings: string;
+    bindingTableId: string;
+    referralRevenuePool: string;
+    revenueTableId: string;
+    referralTiers: string;
+    tiersTableId: string;
+    authorizedWitnessList: string;
+  };
 }
 
 type AddressPathsProps<T> = T extends string

package/src/types/builder/core.ts

@@ -57,6 +57,13 @@ export type CoreNormalMethods = {
     amount: SuiTxArg,
     poolCoinName: SupportPoolCoins
   ) => TransactionResult;
+  borrowWithReferral: (
+    obligation: SuiAddressArg,
+    obligationKey: SuiAddressArg,
+    borrowReferral: SuiObjectArg,
+    amount: SuiTxArg,
+    poolCoinName: SupportPoolCoins
+  ) => TransactionResult;
   borrowEntry: (
     obligation: SuiAddressArg,
     obligationKey: SuiAddressArg,
@@ -97,6 +104,13 @@ export type CoreQuickMethods = {
     obligationId?: SuiAddressArg,
     obligationKey?: SuiAddressArg
   ) => Promise<TransactionResult>;
+  borrowWithReferralQuick: (
+    amount: number,
+    poolCoinName: SupportPoolCoins,
+    borrowReferral: SuiObjectArg,
+    obligationId?: SuiAddressArg,
+    obligationKey?: SuiAddressArg
+  ) => Promise<TransactionResult>;
   depositQuick: (
     amount: number,
     poolCoinName: SupportPoolCoins

package/src/types/builder/index.ts

@@ -2,6 +2,7 @@ import type { CoreTxBlock } from './core';
 import type { SpoolTxBlock } from './spool';
 import type { BorrowIncentiveTxBlock } from './borrowIncentive';
 import type { VeScaTxBlock } from './vesca';
+import type { ReferralTxBlock } from './referral';
 
 export type * from './core';
 export type * from './spool';
@@ -10,5 +11,6 @@ export type * from './vesca';
 
 export type ScallopTxBlock = CoreTxBlock &
   SpoolTxBlock &
+  ReferralTxBlock &
   BorrowIncentiveTxBlock &
   VeScaTxBlock;

package/src/types/builder/referral.ts

@@ -0,0 +1,51 @@
+import {
+  SuiObjectArg,
+  TransactionResult,
+  SuiTxBlock as SuiKitTxBlock,
+} from '@scallop-io/sui-kit';
+import { ScallopBuilder } from 'src/models';
+import { SupportPoolCoins } from '../constant';
+
+export type ReferralIds = {
+  referralPgkId: string;
+  referralBindings: string;
+  referralRevenuePool: string;
+  referralTiers: string;
+  authorizedWitnessList: string;
+  version: string;
+};
+
+export type ReferralNormalMethods = {
+  bindToReferral: (veScaKeyId: string) => void;
+  claimReferralTicket: (poolCoinName: SupportPoolCoins) => TransactionResult;
+  burnReferralTicket: (
+    ticket: SuiObjectArg,
+    poolCoinName: SupportPoolCoins
+  ) => void;
+  claimReferralRevenue: (
+    veScaKey: SuiObjectArg,
+    poolCoinName: SupportPoolCoins
+  ) => TransactionResult;
+};
+
+export type ReferralQuickMethods = {
+  claimReferralRevenueQuick: (
+    veScaKey: SuiObjectArg,
+    coinNames: SupportPoolCoins[]
+  ) => Promise<void>;
+};
+
+export type SuiTxBlockWithReferralNormalMethods = SuiKitTxBlock &
+  ReferralNormalMethods;
+export type ReferralTxBlock = SuiTxBlockWithReferralNormalMethods &
+  ReferralQuickMethods;
+
+export type GenerateReferralNormalMethod = (params: {
+  builder: ScallopBuilder;
+  txBlock: SuiKitTxBlock;
+}) => ReferralNormalMethods;
+
+export type GenerateReferralQuickMethod = (params: {
+  builder: ScallopBuilder;
+  txBlock: SuiTxBlockWithReferralNormalMethods;
+}) => ReferralQuickMethods;

package/src/types/builder/vesca.ts

@@ -29,6 +29,7 @@ export type VeScaNormalMethods = {
     newUnlockAtInSecondTimestamp: SuiTxArg
   ) => void;
   redeemSca: (veScaKey: SuiObjectArg) => TransactionResult;
+  mintEmptyVeSca: () => TransactionResult;
 };
 
 export type VeScaQuickMethods = {

package/src/types/model.ts

@@ -7,6 +7,7 @@ import type {
   ScallopUtils,
   ScallopBuilder,
 } from '../models';
+import { ScallopCache } from 'src/models/scallopCache';
 
 export type ScallopClientFnReturnType<T extends boolean> = T extends true
   ? SuiTransactionBlockResponse
@@ -18,6 +19,7 @@ export type ScallopInstanceParams = {
   query?: ScallopQuery;
   utils?: ScallopUtils;
   builder?: ScallopBuilder;
+  cache: ScallopCache;
 };
 
 export type ScallopAddressParams = {

package/src/types/query/borrowIncentive.ts

@@ -16,24 +16,6 @@ export type BorrowIncentivePools = OptionalKeys<
   Record<SupportBorrowIncentiveCoins, BorrowIncentivePool>
 >;
 
-// export type BorrowIncentivePool = {
-//   coinName: SupportBorrowIncentiveCoins;
-//   symbol: string;
-//   coinType: string;
-//   rewardCoinType: string;
-//   coinDecimal: number;
-//   rewardCoinDecimal: number;
-//   coinPrice: number;
-//   rewardCoinPrice: number;
-// } & Required<
-//   Pick<
-//     ParsedBorrowIncentivePoolData,
-//     'maxPoints' | 'distributedPoint' | 'maxStake'
-//   >
-// > &
-//   CalculatedBorrowIncentivePoolData &
-//   BorrowIncentiveRewardPool;
-
 export type BorrowIncentivePoolPoints = {
   symbol: string;
   coinName: SupportBorrowIncentiveRewardCoins;
@@ -60,21 +42,6 @@ export type BorrowIncentivePool = {
   >;
 };
 
-// export type OriginBorrowIncentivePoolData = {
-//   created_at: string;
-//   distributed_point: string;
-//   distributed_point_per_period: string;
-//   index: string;
-//   last_update: string;
-//   max_distributed_point: string;
-//   max_stakes: string;
-//   point_distribution_time: string;
-//   pool_type: {
-//     name: string;
-//   };
-//   stakes: string;
-// };
-
 export type OriginBorrowIncentivePoolPointData = {
   point_type: {
     name: string;
@@ -112,18 +79,6 @@ export type ParsedBorrowIncentivePoolPointData = {
   lastUpdate: number;
 };
 
-// export type ParsedBorrowIncentivePoolData = {
-//   poolType: string;
-//   maxPoint: number;
-//   distributedPoint: number;
-//   pointPerPeriod: number;
-//   period: number;
-//   maxStake: number;
-//   staked: number;
-//   index: number;
-//   createdAt: number;
-//   lastUpdate: number;
-// };
 export type ParsedBorrowIncentivePoolData = {
   poolType: string;
   poolPoints: OptionalKeys<
@@ -154,54 +109,10 @@ export type CalculatedBorrowIncentivePoolPointData = {
   rewardPerSec: number;
 };
 
-// export type BorrowIncentiveRewardPool = CalculatedBorrowIncentiveRewardPoolData;
-
-// export type OriginBorrowIncentiveRewardPoolData = {
-//   claimed_rewards: string;
-//   exchange_rate_denominator: string;
-//   exchange_rate_numerator: string;
-//   remaining_reward: string;
-//   reward_type: {
-//     name: string;
-//   };
-// };
-
-// export type ParsedBorrowIncentiveRewardPoolData = {
-//   rewardType: string;
-//   claimedRewards: number;
-//   exchangeRateDenominator: number;
-//   exchangeRateNumerator: number;
-//   remainingRewards: number;
-// };
-
-// export type CalculatedBorrowIncentiveRewardPoolData = {
-//   rewardApr: number;
-//   totalRewardAmount: number;
-//   totalRewardCoin: number;
-//   totalRewardValue: number;
-//   // remaindRewardAmount: number;
-//   // remaindRewardCoin: number;
-//   // remaindRewardValue: number;
-//   // claimedRewardAmount: number;
-//   // claimedRewardCoin: number;
-//   // claimedRewardValue: number;
-//   rewardPerSec: number;
-// };
-
 export type BorrowIncentiveAccounts = OptionalKeys<
   Record<SupportBorrowIncentiveCoins, ParsedBorrowIncentiveAccountData>
 >;
 
-// export type OriginBorrowIncentiveAccountData = {
-//   amount: string;
-//   index: string;
-//   points: string;
-//   pool_type: {
-//     name: string;
-//   };
-//   total_points: string;
-// };
-
 export type OriginBorrowIncentiveAccountPoolData = {
   point_type: {
     name: string;
@@ -220,14 +131,6 @@ export type OriginBorrowIncentiveAccountData = {
   debt_amount: string;
 };
 
-// export type ParsedBorrowIncentiveAccountData = {
-//   poolType: string;
-//   amount: number;
-//   index: number;
-//   points: number;
-//   totalPoints: number;
-// };
-
 export type ParsedBorrowIncentiveAccountPoolData = {
   pointType: string;
   weightedAmount: number;
@@ -250,11 +153,6 @@ export type ParsedBorrowIncentiveAccountData = {
 /**
  * The query interface for `incentive_pools_query::incentive_pools_data` inspectTxn.
  */
-// export interface BorrowIncentivePoolsQueryInterface {
-//   incentive_pools: OriginBorrowIncentivePoolData[];
-//   reward_pool: OriginBorrowIncentiveRewardPoolData;
-// }
-
 export interface BorrowIncentivePoolsQueryInterface {
   incentive_pools: OriginBorrowIncentivePoolData[];
 }
@@ -262,11 +160,6 @@ export interface BorrowIncentivePoolsQueryInterface {
 /**
  * The query interface for `incentive_account_query::incentive_account_data` inspectTxn.
  */
-// export interface BorrowIncentiveAccountsQueryInterface {
-//   incentive_states: OriginBorrowIncentiveAccountData[];
-//   total_points: string;
-// }
-
 export interface BorrowIncentiveAccountsQueryInterface {
   pool_records: OriginBorrowIncentiveAccountData[];
 }