@scallop-io/sui-scallop-sdk 0.44.17 → 0.44.19

package/src/types/query/borrowIncentive.ts

@@ -1,4 +1,7 @@
-import type { SupportBorrowIncentiveCoins } from '../constant';
+import type {
+  SupportBorrowIncentiveCoins,
+  SupportBorrowIncentiveRewardCoins,
+} from '../constant';
 
 export interface BorrowIncentiveAccountKey {
   id: string;
@@ -13,138 +16,256 @@ export type BorrowIncentivePools = OptionalKeys<
   Record<SupportBorrowIncentiveCoins, BorrowIncentivePool>
 >;
 
-export type BorrowIncentivePool = {
-  coinName: SupportBorrowIncentiveCoins;
+// 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;
   coinType: string;
-  rewardCoinType: string;
   coinDecimal: number;
-  rewardCoinDecimal: number;
   coinPrice: number;
-  rewardCoinPrice: number;
 } & Required<
   Pick<
-    ParsedBorrowIncentivePoolData,
-    'maxPoint' | 'distributedPoint' | 'maxStake'
+    ParsedBorrowIncentivePoolPointData,
+    'points' | 'distributedPoint' | 'weightedAmount'
   >
 > &
-  CalculatedBorrowIncentivePoolData &
-  BorrowIncentiveRewardPool;
+  CalculatedBorrowIncentivePoolPointData;
 
-export type OriginBorrowIncentivePoolData = {
-  created_at: string;
-  distributed_point: string;
+export type BorrowIncentivePool = {
+  coinName: SupportBorrowIncentiveCoins;
+  symbol: string;
+  coinType: string;
+  coinDecimal: number;
+  coinPrice: number;
+  points: OptionalKeys<
+    Record<SupportBorrowIncentiveRewardCoins, BorrowIncentivePoolPoints>
+  >;
+};
+
+// 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;
+  };
   distributed_point_per_period: string;
+  point_distribution_time: string;
+  distributed_point: string;
+  points: string;
   index: string;
+  base_weight: string;
+  weighted_amount: string;
   last_update: string;
-  max_distributed_point: string;
-  max_stakes: string;
-  point_distribution_time: string;
+};
+
+export type OriginBorrowIncentivePoolData = {
   pool_type: {
     name: string;
   };
+  points: OriginBorrowIncentivePoolPointData[]; // one borrow pool can have multiple points (e.g. sui and sca)
+  min_stakes: string;
+  max_stakes: string;
   stakes: string;
+  created_at: string;
+};
+
+export type ParsedBorrowIncentivePoolPointData = {
+  pointType: string;
+  distributedPointPerPeriod: number;
+  period: number;
+  distributedPoint: number;
+  points: number;
+  index: number;
+  baseWeight: number;
+  weightedAmount: number;
+  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;
-  maxPoint: number;
-  distributedPoint: number;
-  pointPerPeriod: number;
-  period: number;
-  maxStake: number;
+  poolPoints: OptionalKeys<
+    Record<
+      SupportBorrowIncentiveRewardCoins,
+      ParsedBorrowIncentivePoolPointData
+    >
+  >;
+  minStakes: number;
+  maxStakes: number;
   staked: number;
-  index: number;
   createdAt: number;
-  lastUpdate: number;
 };
 
-export type CalculatedBorrowIncentivePoolData = {
+export type CalculatedBorrowIncentivePoolPointData = {
   stakedAmount: number;
   stakedCoin: number;
   stakedValue: number;
+  baseWeight: number;
+  weightedStakedAmount: number;
+  weightedStakedCoin: number;
+  weightedStakedValue: number;
   distributedPointPerSec: number;
   accumulatedPoints: number;
   currentPointIndex: number;
   currentTotalDistributedPoint: number;
-  startDate: Date;
-  endDate: Date;
+  rewardApr: number;
+  rewardPerSec: number;
 };
 
-export type BorrowIncentiveRewardPool = Required<
-  Pick<
-    ParsedBorrowIncentiveRewardPoolData,
-    'exchangeRateNumerator' | 'exchangeRateDenominator'
-  >
-> &
-  CalculatedBorrowIncentiveRewardPoolData;
-
-export type OriginBorrowIncentiveRewardPoolData = {
-  claimed_rewards: string;
-  exchange_rate_denominator: string;
-  exchange_rate_numerator: string;
-  remaining_reward: string;
-  reward_type: {
-    name: string;
-  };
-};
+// export type BorrowIncentiveRewardPool = CalculatedBorrowIncentiveRewardPoolData;
 
-export type ParsedBorrowIncentiveRewardPoolData = {
-  rewardType: string;
-  claimedRewards: number;
-  exchangeRateDenominator: number;
-  exchangeRateNumerator: number;
-  remainingRewards: number;
-};
+// export type OriginBorrowIncentiveRewardPoolData = {
+//   claimed_rewards: string;
+//   exchange_rate_denominator: string;
+//   exchange_rate_numerator: string;
+//   remaining_reward: string;
+//   reward_type: {
+//     name: string;
+//   };
+// };
 
-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 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;
+// export type OriginBorrowIncentiveAccountData = {
+//   amount: string;
+//   index: string;
+//   points: string;
+//   pool_type: {
+//     name: string;
+//   };
+//   total_points: string;
+// };
+
+export type OriginBorrowIncentiveAccountPoolData = {
+  point_type: {
+    name: string;
+  };
+  weighted_amount: string;
   points: string;
+  total_points: string;
+  index: string;
+};
+
+export type OriginBorrowIncentiveAccountData = {
+  points_list: OriginBorrowIncentiveAccountPoolData[];
   pool_type: {
     name: string;
   };
-  total_points: string;
+  debt_amount: string;
 };
 
-export type ParsedBorrowIncentiveAccountData = {
-  poolType: string;
-  amount: number;
-  index: number;
+// export type ParsedBorrowIncentiveAccountData = {
+//   poolType: string;
+//   amount: number;
+//   index: number;
+//   points: number;
+//   totalPoints: number;
+// };
+
+export type ParsedBorrowIncentiveAccountPoolData = {
+  pointType: string;
+  weightedAmount: number;
   points: number;
   totalPoints: number;
+  index: number;
+};
+
+export type ParsedBorrowIncentiveAccountData = {
+  pointList: OptionalKeys<
+    Record<
+      SupportBorrowIncentiveRewardCoins,
+      ParsedBorrowIncentiveAccountPoolData
+    >
+  >;
+  poolType: string;
+  debtAmount: number;
 };
 
 /**
  * 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[];
-  reward_pool: OriginBorrowIncentiveRewardPoolData;
 }
 
 /**
  * The query interface for `incentive_account_query::incentive_account_data` inspectTxn.
  */
+// export interface BorrowIncentiveAccountsQueryInterface {
+//   incentive_states: OriginBorrowIncentiveAccountData[];
+//   total_points: string;
+// }
+
 export interface BorrowIncentiveAccountsQueryInterface {
-  incentive_states: OriginBorrowIncentiveAccountData[];
-  total_points: string;
+  pool_records: OriginBorrowIncentiveAccountData[];
 }

package/src/types/query/index.ts

@@ -2,3 +2,4 @@ export type * from './core';
 export type * from './spool';
 export type * from './borrowIncentive';
 export type * from './portfolio';
+export type * from './vesca';

package/src/types/query/portfolio.ts

@@ -1,6 +1,10 @@
 import type { MarketPool } from './core';
 import type { Spool } from './spool';
-import type { SupportPoolCoins, SupportCollateralCoins } from '../constant';
+import type {
+  SupportPoolCoins,
+  SupportCollateralCoins,
+  SupportBorrowIncentiveRewardCoins,
+} from '../constant';
 
 type OptionalKeys<T> = {
   [K in keyof T]?: T[K];
@@ -110,17 +114,24 @@ export type ObligationDebt = {
   availableRepayCoin: number;
 };
 
+export type ObligationBorrowIcentiveReward = {
+  coinName: SupportBorrowIncentiveRewardCoins;
+  coinType: string;
+  symbol: string;
+  coinDecimal: number;
+  coinPrice: number;
+  availableClaimCoin: number;
+  availableClaimAmount: number;
+  boostValue: number;
+};
+
 export type ObligationBorrowIncentive = {
   coinName: SupportPoolCoins;
   coinType: string;
-  rewardCoinType: string;
   symbol: string;
   coinDecimal: number;
-  rewardCoinDecimal: number;
   coinPrice: number;
-  rewardCoinPrice: number;
-  availableClaimAmount: number;
-  availableClaimCoin: number;
+  rewards: ObligationBorrowIcentiveReward[];
 };
 
 export type TotalValueLocked = {

package/src/types/query/vesca.ts

@@ -0,0 +1,7 @@
+export type Vesca = {
+  id: string;
+  keyId: string;
+  lockedScaAmount: number;
+  lockedScaCoin: number;
+  unlockAt: number;
+};

package/src/types/utils.ts

@@ -1,6 +1,6 @@
 import type { SupportAssetCoins } from './constant';
 
-type OptionalKeys<T> = {
+export type OptionalKeys<T> = {
   [K in keyof T]?: T[K];
 };
 

package/src/utils/builder.ts

@@ -1,4 +1,12 @@
 import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import {
+  UNLOCK_ROUND_DURATION,
+  MAX_LOCK_DURATION,
+  MAX_LOCK_ROUNDS,
+  MIN_INITIAL_LOCK_AMOUNT,
+  MIN_TOP_UP_AMOUNT,
+} from '../constants';
+import type { SuiObjectArg } from '@scallop-io/sui-kit';
 
 /**
  * Check and get the sender from the transaction block.
@@ -13,3 +21,136 @@ export const requireSender = (txBlock: SuiKitTxBlock) => {
   }
   return sender;
 };
+
+export const checkLockSca = (
+  scaAmountOrCoin?: number | SuiObjectArg | undefined,
+  lockPeriodInDays?: number,
+  newUnlockAtInSecondTimestamp?: number,
+  prevUnlockAtInSecondTimestamp?: number
+) => {
+  const isInitialLock = !prevUnlockAtInSecondTimestamp;
+  const isLockExpired =
+    !isInitialLock &&
+    prevUnlockAtInSecondTimestamp * 1000 <= new Date().getTime();
+  if (isInitialLock || isLockExpired) {
+    if (scaAmountOrCoin !== undefined && lockPeriodInDays !== undefined) {
+      if (lockPeriodInDays <= 0) {
+        throw new Error('Lock period must be greater than 0');
+      }
+      if (
+        typeof scaAmountOrCoin === 'number' &&
+        scaAmountOrCoin < MIN_INITIAL_LOCK_AMOUNT
+      ) {
+        throw new Error(
+          `Minimum lock amount for ${
+            isLockExpired ? 'renewing expired veSca' : 'initial lock'
+          } is 10 SCA`
+        );
+      }
+      const extendLockPeriodInSecond = lockPeriodInDays * UNLOCK_ROUND_DURATION;
+      if (extendLockPeriodInSecond > MAX_LOCK_DURATION) {
+        throw new Error(
+          `Maximum lock period is ~4 years (${MAX_LOCK_ROUNDS} days)`
+        );
+      }
+    } else {
+      throw new Error(
+        `SCA amount and lock period is required for ${
+          isLockExpired ? 'renewing expired veSca' : 'initial lock'
+        }`
+      );
+    }
+  } else {
+    checkVesca(prevUnlockAtInSecondTimestamp);
+    if (
+      typeof scaAmountOrCoin === 'number' &&
+      scaAmountOrCoin < MIN_TOP_UP_AMOUNT
+    ) {
+      throw new Error('Minimum top up amount is 1 SCA');
+    }
+
+    if (!!newUnlockAtInSecondTimestamp && !!prevUnlockAtInSecondTimestamp) {
+      const totalLockDuration =
+        newUnlockAtInSecondTimestamp - prevUnlockAtInSecondTimestamp;
+      if (totalLockDuration > MAX_LOCK_DURATION - UNLOCK_ROUND_DURATION) {
+        throw new Error(
+          `Maximum lock period is ~4 years (${MAX_LOCK_ROUNDS - 1} days)`
+        );
+      }
+    }
+  }
+};
+
+export const checkExtendLockPeriod = (
+  lockPeriodInDays: number,
+  newUnlockAtInSecondTimestamp: number,
+  prevUnlockAtInSecondTimestamp?: number
+) => {
+  checkVesca(prevUnlockAtInSecondTimestamp);
+
+  if (lockPeriodInDays <= 0) {
+    throw new Error('Lock period must be greater than 0');
+  }
+
+  const isInitialLock = !prevUnlockAtInSecondTimestamp;
+  const isLockExpired =
+    !isInitialLock &&
+    prevUnlockAtInSecondTimestamp * 1000 <= new Date().getTime();
+  if (isLockExpired) {
+    throw new Error('veSca is expired, use renewExpiredVeScaQuick instead');
+  }
+
+  if (prevUnlockAtInSecondTimestamp) {
+    const totalLockDuration =
+      newUnlockAtInSecondTimestamp - prevUnlockAtInSecondTimestamp!;
+    if (totalLockDuration > MAX_LOCK_DURATION - UNLOCK_ROUND_DURATION) {
+      throw new Error(
+        `Maximum lock period is ~4 years (${MAX_LOCK_ROUNDS - 1} days)`
+      );
+    }
+  }
+};
+
+export const checkExtendLockAmount = (
+  scaAmount: number,
+  prevUnlockAtInSecondTimestamp?: number
+) => {
+  checkVesca(prevUnlockAtInSecondTimestamp);
+
+  if (scaAmount < MIN_TOP_UP_AMOUNT) {
+    throw new Error('Minimum top up amount is 1 SCA');
+  }
+
+  const isInitialLock = !prevUnlockAtInSecondTimestamp;
+  const isLockExpired =
+    !isInitialLock &&
+    prevUnlockAtInSecondTimestamp * 1000 <= new Date().getTime();
+  if (isLockExpired) {
+    throw new Error('veSca is expired, use renewExpiredVeScaQuick instead');
+  }
+};
+
+export const checkRenewExpiredVeSca = (
+  scaAmount: number,
+  lockPeriodInDays: number,
+  prevUnlockAtInSecondTimestamp?: number
+) => {
+  checkVesca(prevUnlockAtInSecondTimestamp);
+
+  if (scaAmount < MIN_INITIAL_LOCK_AMOUNT) {
+    throw new Error('Minimum lock amount for renewing expired vesca 10 SCA');
+  }
+
+  const extendLockPeriodInSecond = lockPeriodInDays * UNLOCK_ROUND_DURATION;
+  if (extendLockPeriodInSecond >= MAX_LOCK_DURATION - UNLOCK_ROUND_DURATION) {
+    throw new Error(
+      `Maximum lock period is ~4 years (${MAX_LOCK_ROUNDS - 1} days)`
+    );
+  }
+};
+
+export const checkVesca = (prevUnlockAtInSecondTimestamp?: number) => {
+  if (prevUnlockAtInSecondTimestamp === undefined) {
+    throw new Error('veSca not found');
+  }
+};