@scallop-io/sui-scallop-sdk 0.44.2 → 0.44.3

package/src/types/constant/common.ts

@@ -4,7 +4,9 @@ import {
   SUPPORT_ORACLES,
   SUPPORT_PACKAGES,
   SUPPORT_SPOOLS,
-  SUPPORT_REWARD_POOLS,
+  SUPPORT_SPOOLS_REWARDS,
+  SUPPORT_BORROW_INCENTIVE_POOLS,
+  SUPPORT_BORROW_INCENTIVE_REWARDS,
 } from '../../constants';
 
 type ParseMarketCoins<T extends string> = `s${T}`;
@@ -17,7 +19,8 @@ export type SupportCoins =
 export type SupportAssetCoins =
   | SupportPoolCoins
   | SupportCollateralCoins
-  | SupportRewardCoins;
+  | SupportStakeRewardCoins
+  | SupportBorrowIncentiveRewardCoins;
 export type SupportPoolCoins = (typeof SUPPORT_POOLS)[number];
 export type SupportCollateralCoins = (typeof SUPPORT_COLLATERALS)[number];
 export type SupportMarketCoins =
@@ -28,7 +31,11 @@ export type SupportStakeCoins = Extract<
   SupportPoolCoins,
   ParseCoins<SupportStakeMarketCoins>
 >;
-export type SupportRewardCoins = (typeof SUPPORT_REWARD_POOLS)[number];
+export type SupportStakeRewardCoins = (typeof SUPPORT_SPOOLS_REWARDS)[number];
+export type SupportBorrowIncentiveCoins =
+  (typeof SUPPORT_BORROW_INCENTIVE_POOLS)[number];
+export type SupportBorrowIncentiveRewardCoins =
+  (typeof SUPPORT_BORROW_INCENTIVE_REWARDS)[number];
 
 export type SupportOracleType = (typeof SUPPORT_ORACLES)[number];
 

package/src/types/constant/enum.ts

@@ -3,7 +3,9 @@ import {
   SupportAssetCoins,
   SupportMarketCoins,
   SupportStakeMarketCoins,
-  SupportRewardCoins,
+  SupportStakeRewardCoins,
+  SupportBorrowIncentiveCoins,
+  SupportBorrowIncentiveRewardCoins,
 } from './common';
 
 export type Coins = {
@@ -22,8 +24,12 @@ export type StakeMarketCoins = {
   [K in SupportStakeMarketCoins]: K;
 };
 
-export type RewardCoins = {
-  [key in SupportStakeMarketCoins]: SupportRewardCoins;
+export type StakeRewardCoins = {
+  [key in SupportStakeMarketCoins]: SupportStakeRewardCoins;
+};
+
+export type BorrowIncentiveRewardCoins = {
+  [key in SupportBorrowIncentiveCoins]: SupportBorrowIncentiveRewardCoins;
 };
 
 export type AssetCoinIds = {

package/src/types/query/borrowIncentive.ts

@@ -0,0 +1,150 @@
+import type { SupportBorrowIncentiveCoins } from '../constant';
+
+export interface BorrowIncentiveAccountKey {
+  id: string;
+  onwerId: string;
+}
+
+type OptionalKeys<T> = {
+  [K in keyof T]?: T[K];
+};
+
+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,
+    'maxPoint' | 'distributedPoint' | 'maxStake'
+  >
+> &
+  CalculatedBorrowIncentivePoolData &
+  BorrowIncentiveRewardPool;
+
+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 ParsedBorrowIncentivePoolData = {
+  poolType: string;
+  maxPoint: number;
+  distributedPoint: number;
+  pointPerPeriod: number;
+  period: number;
+  maxStake: number;
+  staked: number;
+  index: number;
+  createdAt: number;
+  lastUpdate: number;
+};
+
+export type CalculatedBorrowIncentivePoolData = {
+  stakedAmount: number;
+  stakedCoin: number;
+  stakedValue: number;
+  distributedPointPerSec: number;
+  accumulatedPoints: number;
+  currentPointIndex: number;
+  currentTotalDistributedPoint: number;
+  startDate: Date;
+  endDate: Date;
+};
+
+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 ParsedBorrowIncentiveRewardPoolData = {
+  rewardType: string;
+  claimedRewards: number;
+  exchangeRateNumerator: number;
+  exchangeRateDenominator: 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 ParsedBorrowIncentiveAccountData = {
+  poolType: string;
+  amount: number;
+  index: number;
+  points: number;
+  totalPoints: number;
+};
+
+/**
+ * The query interface for `incentive_pools_query::incentive_pools_data` inspectTxn.
+ */
+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;
+}

package/src/types/query/core.ts

@@ -255,7 +255,7 @@ export type Market = {
   data?: MarketQueryInterface;
 };
 
-export type Obligation = { id: string; keyId: string };
+export type Obligation = { id: string; keyId: string; locked: boolean };
 
 /**
  * The query interface for `market_query::market_data` inspectTxn.

package/src/types/query/index.ts

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

package/src/types/query/spool.ts

@@ -4,13 +4,6 @@ type OptionalKeys<T> = {
   [K in keyof T]?: T[K];
 };
 
-export type StakePools = OptionalKeys<
-  Record<SupportStakeMarketCoins, StakePool>
->;
-export type RewardPools = OptionalKeys<
-  Record<SupportStakeMarketCoins, RewardPool>
->;
-export type StakeAccounts = Record<SupportStakeMarketCoins, StakeAccount[]>;
 export type Spools = OptionalKeys<Record<SupportStakeMarketCoins, Spool>>;
 
 export type Spool = {
@@ -24,10 +17,13 @@ export type Spool = {
   coinPrice: number;
   marketCoinPrice: number;
   rewardCoinPrice: number;
-} & CalculatedStakePoolData &
-  CalculatedRewardPoolData;
+} & Required<
+  Pick<ParsedSpoolData, 'maxPoint' | 'distributedPoint' | 'maxStake'>
+> &
+  CalculatedSpoolData &
+  SpoolRewardPool;
 
-export type OriginStakePoolData = {
+export type OriginSpoolData = {
   stakeType: { fields: { name: string } };
   maxDistributedPoint: string;
   distributedPoint: string;
@@ -40,7 +36,7 @@ export type OriginStakePoolData = {
   lastUpdate: string;
 };
 
-export type ParsedStakePoolData = {
+export type ParsedSpoolData = {
   stakeType: string;
   maxPoint: number;
   distributedPoint: number;
@@ -53,7 +49,7 @@ export type ParsedStakePoolData = {
   lastUpdate: number;
 };
 
-export type CalculatedStakePoolData = {
+export type CalculatedSpoolData = {
   stakedAmount: number;
   stakedCoin: number;
   stakedValue: number;
@@ -65,7 +61,15 @@ export type CalculatedStakePoolData = {
   endDate: Date;
 };
 
-export type OriginRewardPoolData = {
+export type SpoolRewardPool = Required<
+  Pick<
+    ParsedSpoolRewardPoolData,
+    'exchangeRateNumerator' | 'exchangeRateDenominator'
+  >
+> &
+  CalculatedSpoolRewardPoolData;
+
+export type OriginSpoolRewardPoolData = {
   claimed_rewards: string;
   exchange_rate_denominator: string;
   exchange_rate_numerator: string;
@@ -73,7 +77,7 @@ export type OriginRewardPoolData = {
   spool_id: string;
 };
 
-export type ParsedRewardPoolData = {
+export type ParsedSpoolRewardPoolData = {
   claimedRewards: number;
   exchangeRateNumerator: number;
   exchangeRateDenominator: number;
@@ -81,7 +85,7 @@ export type ParsedRewardPoolData = {
   spoolId: string;
 };
 
-export type CalculatedRewardPoolData = {
+export type CalculatedSpoolRewardPoolData = {
   rewardApr: number;
   totalRewardAmount: number;
   totalRewardCoin: number;
@@ -93,10 +97,16 @@ export type CalculatedRewardPoolData = {
   claimedRewardCoin: number;
   claimedRewardValue: number;
   rewardPerSec: number;
-  exchangeRateNumerator: number;
-  exchangeRateDenominator: number;
 };
 
+export type StakePools = OptionalKeys<
+  Record<SupportStakeMarketCoins, StakePool>
+>;
+export type StakeRewardPools = OptionalKeys<
+  Record<SupportStakeMarketCoins, StakeRewardPool>
+>;
+export type StakeAccounts = Record<SupportStakeMarketCoins, StakeAccount[]>;
+
 export interface StakeAccount {
   id: string;
   type: string;
@@ -123,7 +133,7 @@ export interface StakePool {
   lastUpdate: number;
 }
 
-export interface RewardPool {
+export interface StakeRewardPool {
   id: string;
   type: string;
   stakePoolId: string;

package/src/utils/builder.ts

@@ -0,0 +1,15 @@
+import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+
+/**
+ * Check and get the sender from the transaction block.
+ *
+ * @param txBlock - TxBlock created by SuiKit.
+ * @return Sender of transaction.
+ */
+export const requireSender = (txBlock: SuiKitTxBlock) => {
+  const sender = txBlock.blockData.sender;
+  if (!sender) {
+    throw new Error('Sender is required');
+  }
+  return sender;
+};

package/src/utils/index.ts

@@ -1,3 +1,3 @@
-export * from './oracle';
+export * from './builder';
 export * from './query';
 export * from './util';