@scallop-io/sui-scallop-sdk 0.44.25 → 0.44.27

package/dist/types/builder/borrowIncentive.d.ts

@@ -1,4 +1,4 @@
-import type { SuiTxBlock as SuiKitTxBlock, SuiAddressArg, SuiTxArg } from '@scallop-io/sui-kit';
+import type { SuiTxBlock as SuiKitTxBlock, SuiObjectArg } from '@scallop-io/sui-kit';
 import type { TransactionResult } from '@mysten/sui.js/transactions';
 import type { ScallopBuilder } from '../../models';
 import type { SupportBorrowIncentiveCoins, SupportBorrowIncentiveRewardCoins } from '../constant';
@@ -11,16 +11,17 @@ export type BorrowIncentiveIds = {
     obligationAccessStore: string;
 };
 export type BorrowIncentiveNormalMethods = {
-    stakeObligation: (obligation: SuiAddressArg, obligationKey: SuiAddressArg) => void;
-    stakeObligationWithVesca: (obligation: SuiAddressArg, obligationKey: SuiAddressArg, veScaKey: SuiTxArg) => void;
-    unstakeObligation: (obligation: SuiAddressArg, obligationKey: SuiAddressArg) => void;
-    claimBorrowIncentive: (obligation: SuiAddressArg, obligationKey: SuiAddressArg, coinName: SupportBorrowIncentiveCoins, rewardType: SupportBorrowIncentiveRewardCoins) => TransactionResult;
+    stakeObligation: (obligation: SuiObjectArg, obligationKey: SuiObjectArg) => void;
+    stakeObligationWithVesca: (obligation: SuiObjectArg, obligationKey: SuiObjectArg, veScaKey: SuiObjectArg) => void;
+    unstakeObligation: (obligation: SuiObjectArg, obligationKey: SuiObjectArg) => void;
+    claimBorrowIncentive: (obligation: SuiObjectArg, obligationKey: SuiObjectArg, coinName: SupportBorrowIncentiveCoins, rewardType: SupportBorrowIncentiveRewardCoins) => TransactionResult;
+    deactivateBoost: (obligation: SuiObjectArg, veScaKey: SuiObjectArg) => void;
 };
 export type BorrowIncentiveQuickMethods = {
-    stakeObligationQuick(obligation?: SuiAddressArg, obligationKey?: SuiAddressArg): Promise<void>;
-    stakeObligationWithVeScaQuick(obligation?: SuiAddressArg, obligationKey?: SuiAddressArg, veScaKey?: SuiAddressArg): Promise<void>;
-    unstakeObligationQuick(obligation?: SuiAddressArg, obligationKey?: SuiAddressArg): Promise<void>;
-    claimBorrowIncentiveQuick(coinName: SupportBorrowIncentiveCoins, rewardType: SupportBorrowIncentiveRewardCoins, obligation?: SuiAddressArg, obligationKey?: SuiAddressArg): Promise<TransactionResult>;
+    stakeObligationQuick(obligation?: SuiObjectArg, obligationKey?: SuiObjectArg): Promise<void>;
+    stakeObligationWithVeScaQuick(obligation?: SuiObjectArg, obligationKey?: SuiObjectArg, veScaKey?: SuiObjectArg): Promise<void>;
+    unstakeObligationQuick(obligation?: SuiObjectArg, obligationKey?: SuiObjectArg): Promise<void>;
+    claimBorrowIncentiveQuick(coinName: SupportBorrowIncentiveCoins, rewardType: SupportBorrowIncentiveRewardCoins, obligation?: SuiObjectArg, obligationKey?: SuiObjectArg): Promise<TransactionResult>;
 };
 export type SuiTxBlockWithBorrowIncentiveNormalMethods = SuiKitTxBlock & BorrowIncentiveNormalMethods;
 export type BorrowIncentiveTxBlock = SuiTxBlockWithBorrowIncentiveNormalMethods & BorrowIncentiveQuickMethods;

package/dist/types/builder/vesca.d.ts

@@ -1,4 +1,4 @@
-import { SuiTxBlock as SuiKitTxBlock, SuiAddressArg, SuiObjectArg, SuiTxArg } from '@scallop-io/sui-kit';
+import { SuiTxBlock as SuiKitTxBlock, SuiObjectArg, SuiTxArg } from '@scallop-io/sui-kit';
 import type { TransactionResult } from '@mysten/sui.js/transactions';
 import { ScallopBuilder } from 'src/models';
 export type VescaIds = {
@@ -9,17 +9,17 @@ export type VescaIds = {
 };
 export type VeScaNormalMethods = {
     lockSca: (scaCoin: SuiObjectArg, unlockAtInSecondTimestamp: SuiTxArg) => TransactionResult;
-    extendLockPeriod: (veScaKey: SuiAddressArg, newUnlockAtInSecondTimestamp: SuiTxArg) => void;
-    extendLockAmount: (veScaKey: SuiAddressArg, scaCoin: SuiObjectArg) => void;
-    renewExpiredVeSca: (veScaKey: SuiAddressArg, scaCoin: SuiObjectArg, newUnlockAtInSecondTimestamp: SuiTxArg) => void;
-    redeemSca: (veScaKey: SuiAddressArg) => TransactionResult;
+    extendLockPeriod: (veScaKey: SuiObjectArg, newUnlockAtInSecondTimestamp: SuiTxArg) => void;
+    extendLockAmount: (veScaKey: SuiObjectArg, scaCoin: SuiObjectArg) => void;
+    renewExpiredVeSca: (veScaKey: SuiObjectArg, scaCoin: SuiObjectArg, newUnlockAtInSecondTimestamp: SuiTxArg) => void;
+    redeemSca: (veScaKey: SuiObjectArg) => TransactionResult;
 };
 export type VeScaQuickMethods = {
     lockScaQuick(amountOrCoin?: SuiObjectArg | number, lockPeriodInDays?: number, autoCheck?: boolean): Promise<void>;
-    extendLockPeriodQuick: (lockPeriodInDays: number, veScaKey?: SuiAddressArg, autoCheck?: boolean) => Promise<void>;
-    extendLockAmountQuick: (scaAmount: number, veScaKey?: SuiAddressArg, autoCheck?: boolean) => Promise<void>;
-    renewExpiredVeScaQuick: (scaAmount: number, lockPeriodInDays: number, veScaKey?: SuiAddressArg, autoCheck?: boolean) => Promise<void>;
-    redeemScaQuick: (veScaKey?: SuiAddressArg) => Promise<void>;
+    extendLockPeriodQuick: (lockPeriodInDays: number, veScaKey?: SuiObjectArg, autoCheck?: boolean) => Promise<void>;
+    extendLockAmountQuick: (scaAmount: number, veScaKey?: SuiObjectArg, autoCheck?: boolean) => Promise<void>;
+    renewExpiredVeScaQuick: (scaAmount: number, lockPeriodInDays: number, veScaKey?: SuiObjectArg, autoCheck?: boolean) => Promise<void>;
+    redeemScaQuick: (veScaKey?: SuiObjectArg) => Promise<void>;
 };
 export type SuiTxBlockWithVeScaNormalMethods = SuiKitTxBlock & VeScaNormalMethods;
 export type VeScaTxBlock = SuiTxBlockWithVeScaNormalMethods & VeScaQuickMethods;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "0.44.25",
+  "version": "0.44.27",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/builders/borrowIncentiveBuilder.ts

@@ -4,7 +4,7 @@ import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import { borrowIncentiveRewardCoins } from '../constants/enum';
 import { getObligations, getObligationLocked } from '../queries';
 import { requireSender } from '../utils';
-import type { SuiAddressArg } from '@scallop-io/sui-kit';
+import type { SuiObjectArg } from '@scallop-io/sui-kit';
 import type { ScallopBuilder } from '../models';
 import type {
   BorrowIncentiveIds,
@@ -39,8 +39,8 @@ const requireObligationInfo = async (
   ...params: [
     builder: ScallopBuilder,
     txBlock: SuiKitTxBlock,
-    obligationId?: SuiAddressArg,
-    obligationKey?: SuiAddressArg,
+    obligationId?: SuiObjectArg,
+    obligationKey?: SuiObjectArg,
   ]
 ) => {
   const [builder, txBlock, obligationId, obligationKey] = params;
@@ -61,10 +61,17 @@ const requireObligationInfo = async (
   if (obligations.length === 0) {
     throw new Error(`No obligation found for sender ${sender}`);
   }
+
+  const selectedObligation =
+    obligations.find(
+      (obligation) =>
+        obligation.id === obligationId || obligation.keyId === obligationKey
+    ) ?? obligations[0];
+
   return {
-    obligationId: obligations[0].id,
-    obligationKey: obligations[0].keyId,
-    obligationLocked: obligations[0].locked,
+    obligationId: selectedObligation.id,
+    obligationKey: selectedObligation.keyId,
+    obligationLocked: selectedObligation.locked,
   };
 };
 
@@ -220,6 +227,19 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
           [rewardType]
         );
       },
+      deactivateBoost: (obligation, veScaKey) => {
+        return txBlock.moveCall(
+          `${borrowIncentiveIds.borrowIncentivePkg}::user::deactivate_boost`,
+          [
+            borrowIncentiveIds.config,
+            borrowIncentiveIds.incentivePools,
+            borrowIncentiveIds.incentiveAccounts,
+            obligation,
+            veScaKey,
+            SUI_CLOCK_OBJECT_ID,
+          ]
+        );
+      },
     };
   };
 

package/src/builders/vescaBuilder.ts

@@ -1,6 +1,5 @@
 import {
   SUI_CLOCK_OBJECT_ID,
-  SuiAddressArg,
   SuiTxBlock,
   TransactionBlock,
   SuiTxBlock as SuiKitTxBlock,
@@ -46,7 +45,7 @@ export const requireVeSca = async (
   ...params: [
     builder: ScallopBuilder,
     SuiTxBlock: SuiTxBlock,
-    veScaKey?: SuiAddressArg,
+    veScaKey?: SuiObjectArg,
   ]
 ) => {
   const [builder, txBlock, veScaKey] = params;
@@ -254,7 +253,7 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
     },
     extendLockPeriodQuick: async (
       lockPeriodInDays: number,
-      veScaKey?: SuiAddressArg,
+      veScaKey?: SuiObjectArg,
       autoCheck = true
     ) => {
       const veSca = await requireVeSca(builder, txBlock, veScaKey);
@@ -269,7 +268,7 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
     },
     extendLockAmountQuick: async (
       scaAmount: number,
-      veScaKey?: SuiAddressArg,
+      veScaKey?: SuiObjectArg,
       autoCheck = true
     ) => {
       const sender = requireSender(txBlock);
@@ -295,7 +294,7 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
     renewExpiredVeScaQuick: async (
       scaAmount: number,
       lockPeriodInDays: number,
-      veScaKey?: SuiAddressArg,
+      veScaKey?: SuiObjectArg,
       autoCheck = true
     ) => {
       const sender = requireSender(txBlock);
@@ -329,7 +328,7 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
         txBlock.transferObjects(transferObjects, sender);
       }
     },
-    redeemScaQuick: async (veScaKey?: SuiAddressArg) => {
+    redeemScaQuick: async (veScaKey?: SuiObjectArg) => {
       const sender = requireSender(txBlock);
       const veSca = await requireVeSca(builder, txBlock, veScaKey);
 

package/src/types/builder/borrowIncentive.ts

@@ -1,7 +1,6 @@
 import type {
   SuiTxBlock as SuiKitTxBlock,
-  SuiAddressArg,
-  SuiTxArg,
+  SuiObjectArg,
 } from '@scallop-io/sui-kit';
 import type { TransactionResult } from '@mysten/sui.js/transactions';
 import type { ScallopBuilder } from '../../models';
@@ -21,45 +20,46 @@ export type BorrowIncentiveIds = {
 
 export type BorrowIncentiveNormalMethods = {
   stakeObligation: (
-    obligation: SuiAddressArg,
-    obligationKey: SuiAddressArg
+    obligation: SuiObjectArg,
+    obligationKey: SuiObjectArg
   ) => void;
   stakeObligationWithVesca: (
-    obligation: SuiAddressArg,
-    obligationKey: SuiAddressArg,
-    veScaKey: SuiTxArg
+    obligation: SuiObjectArg,
+    obligationKey: SuiObjectArg,
+    veScaKey: SuiObjectArg
   ) => void;
   unstakeObligation: (
-    obligation: SuiAddressArg,
-    obligationKey: SuiAddressArg
+    obligation: SuiObjectArg,
+    obligationKey: SuiObjectArg
   ) => void;
   claimBorrowIncentive: (
-    obligation: SuiAddressArg,
-    obligationKey: SuiAddressArg,
+    obligation: SuiObjectArg,
+    obligationKey: SuiObjectArg,
     coinName: SupportBorrowIncentiveCoins,
     rewardType: SupportBorrowIncentiveRewardCoins
   ) => TransactionResult;
+  deactivateBoost: (obligation: SuiObjectArg, veScaKey: SuiObjectArg) => void;
 };
 
 export type BorrowIncentiveQuickMethods = {
   stakeObligationQuick(
-    obligation?: SuiAddressArg,
-    obligationKey?: SuiAddressArg
+    obligation?: SuiObjectArg,
+    obligationKey?: SuiObjectArg
   ): Promise<void>;
   stakeObligationWithVeScaQuick(
-    obligation?: SuiAddressArg,
-    obligationKey?: SuiAddressArg,
-    veScaKey?: SuiAddressArg
+    obligation?: SuiObjectArg,
+    obligationKey?: SuiObjectArg,
+    veScaKey?: SuiObjectArg
   ): Promise<void>;
   unstakeObligationQuick(
-    obligation?: SuiAddressArg,
-    obligationKey?: SuiAddressArg
+    obligation?: SuiObjectArg,
+    obligationKey?: SuiObjectArg
   ): Promise<void>;
   claimBorrowIncentiveQuick(
     coinName: SupportBorrowIncentiveCoins,
     rewardType: SupportBorrowIncentiveRewardCoins,
-    obligation?: SuiAddressArg,
-    obligationKey?: SuiAddressArg
+    obligation?: SuiObjectArg,
+    obligationKey?: SuiObjectArg
   ): Promise<TransactionResult>;
 };
 

package/src/types/builder/vesca.ts

@@ -1,6 +1,5 @@
 import {
   SuiTxBlock as SuiKitTxBlock,
-  SuiAddressArg,
   SuiObjectArg,
   SuiTxArg,
 } from '@scallop-io/sui-kit';
@@ -20,16 +19,16 @@ export type VeScaNormalMethods = {
     unlockAtInSecondTimestamp: SuiTxArg
   ) => TransactionResult;
   extendLockPeriod: (
-    veScaKey: SuiAddressArg,
+    veScaKey: SuiObjectArg,
     newUnlockAtInSecondTimestamp: SuiTxArg
   ) => void;
-  extendLockAmount: (veScaKey: SuiAddressArg, scaCoin: SuiObjectArg) => void;
+  extendLockAmount: (veScaKey: SuiObjectArg, scaCoin: SuiObjectArg) => void;
   renewExpiredVeSca: (
-    veScaKey: SuiAddressArg,
+    veScaKey: SuiObjectArg,
     scaCoin: SuiObjectArg,
     newUnlockAtInSecondTimestamp: SuiTxArg
   ) => void;
-  redeemSca: (veScaKey: SuiAddressArg) => TransactionResult;
+  redeemSca: (veScaKey: SuiObjectArg) => TransactionResult;
 };
 
 export type VeScaQuickMethods = {
@@ -40,21 +39,21 @@ export type VeScaQuickMethods = {
   ): Promise<void>;
   extendLockPeriodQuick: (
     lockPeriodInDays: number,
-    veScaKey?: SuiAddressArg,
+    veScaKey?: SuiObjectArg,
     autoCheck?: boolean
   ) => Promise<void>;
   extendLockAmountQuick: (
     scaAmount: number,
-    veScaKey?: SuiAddressArg,
+    veScaKey?: SuiObjectArg,
     autoCheck?: boolean
   ) => Promise<void>;
   renewExpiredVeScaQuick: (
     scaAmount: number,
     lockPeriodInDays: number,
-    veScaKey?: SuiAddressArg,
+    veScaKey?: SuiObjectArg,
     autoCheck?: boolean
   ) => Promise<void>;
-  redeemScaQuick: (veScaKey?: SuiAddressArg) => Promise<void>;
+  redeemScaQuick: (veScaKey?: SuiObjectArg) => Promise<void>;
 };
 
 export type SuiTxBlockWithVeScaNormalMethods = SuiKitTxBlock &