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

package/dist/models/scallopQuery.d.ts

@@ -382,4 +382,16 @@ export declare class ScallopQuery {
      * @return Total value locked.
      */
     getTvl(indexer?: boolean): Promise<import("../types").TotalValueLocked>;
+    /**
+     * Get binded obligationId from a veScaKey if it exists.
+     * @param veScaKey
+     * @returns obligationId
+     */
+    getBindedObligationId(veScaKey: string): Promise<string | null>;
+    /**
+     * Get binded veSCA key from a obligationId if it exists.
+     * @param obligationId
+     * @returns veScaKey
+     */
+    getBindedVeScaKey(obligationId: string): Promise<string | null>;
 }

package/dist/queries/borrowIncentiveQuery.d.ts

@@ -35,3 +35,11 @@ export declare const queryBorrowIncentiveAccounts: (query: ScallopQuery, obligat
     vsui?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
     sca?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
 }>;
+/**
+ * Check veSca bind status
+ * @param query
+ * @param veScaKey
+ * @returns
+ */
+export declare const getBindedObligationId: (query: ScallopQuery, veScaKeyId: string) => Promise<string | null>;
+export declare const getBindedVeScaKey: (query: ScallopQuery, obliationId: string) => Promise<string | null>;

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

@@ -1,4 +1,4 @@
-import type { SuiTxBlock as SuiKitTxBlock, SuiTxArg, SuiObjectArg } 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';
@@ -12,7 +12,7 @@ export type BorrowIncentiveIds = {
 };
 export type BorrowIncentiveNormalMethods = {
     stakeObligation: (obligation: SuiObjectArg, obligationKey: SuiObjectArg) => void;
-    stakeObligationWithVesca: (obligation: SuiObjectArg, obligationKey: SuiObjectArg, veScaKey: SuiTxArg) => 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;

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

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

package/package.json

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

package/src/builders/borrowIncentiveBuilder.ts

@@ -2,7 +2,11 @@ import { TransactionBlock } from '@mysten/sui.js/transactions';
 import { SUI_CLOCK_OBJECT_ID } from '@mysten/sui.js/utils';
 import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import { borrowIncentiveRewardCoins } from '../constants/enum';
-import { getObligations, getObligationLocked } from '../queries';
+import {
+  getObligations,
+  getObligationLocked,
+  getBindedObligationId,
+} from '../queries';
 import { requireSender } from '../utils';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
 import type { ScallopBuilder } from '../models';
@@ -61,66 +65,20 @@ 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,
   };
 };
 
-/**
- * Check veSca bind status
- * @param query
- * @param veScaKey
- * @returns
- */
-export const getBindedObligationId = async (
-  builder: ScallopBuilder,
-  veScaKey: string
-) => {
-  const borrowIncentiveObjectId = builder.address.get('borrowIncentive.object');
-  const incentivePoolsId = builder.address.get(
-    'borrowIncentive.incentivePools'
-  );
-  const veScaPkgId = IS_VE_SCA_TEST
-    ? '0xb220d034bdf335d77ae5bfbf6daf059c2cc7a1f719b12bfed75d1736fac038c8'
-    : builder.address.get('vesca.id');
-
-  const client = builder.suiKit.client();
-
-  // get incentive pools
-  const incentivePoolsResponse = await client.getObject({
-    id: incentivePoolsId,
-    options: {
-      showContent: true,
-    },
-  });
-
-  if (incentivePoolsResponse.data?.content?.dataType !== 'moveObject')
-    return false;
-  const incentivePoolFields = incentivePoolsResponse.data.content.fields as any;
-  const veScaBindTableId = incentivePoolFields.ve_sca_bind.fields.id
-    .id as string;
-
-  // check if veSca is inside the bind table
-  const keyType = `${borrowIncentiveObjectId}::typed_id::TypedID<${veScaPkgId}::ve_sca::VeScaKey>`;
-  const veScaBindTableResponse = await client.getDynamicFieldObject({
-    parentId: veScaBindTableId,
-    name: {
-      type: keyType,
-      value: veScaKey,
-    },
-  });
-
-  if (veScaBindTableResponse.data?.content?.dataType !== 'moveObject')
-    return false;
-  const veScaBindTableFields = veScaBindTableResponse.data.content
-    .fields as any;
-  // get obligationId pair
-  const obligationId = veScaBindTableFields.value.fields.id as string;
-
-  return obligationId;
-};
 /**
  * Generate borrow incentive normal methods.
  *
@@ -315,7 +273,7 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
           const veSca = await requireVeSca(builder, txBlock, veScaKey);
           if (veSca) {
             const bindedObligationId = await getBindedObligationId(
-              builder,
+              builder.query,
               veSca.keyId
             );
             // if bindedObligationId is equal to obligationId, then use it again

package/src/builders/vescaBuilder.ts

@@ -65,7 +65,11 @@ export const requireVeSca = async (
     return undefined;
   }
 
-  return veScas[0];
+  return veScas.reduce(
+    (prev, acc) =>
+      acc.currentVeScaBalance > prev.currentVeScaBalance ? acc : prev,
+    veScas[0]
+  ); // return veSCA with highest veSCA balance
 };
 
 /**
@@ -228,7 +232,7 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
             transferObjects.push(veScaKey);
           } else {
             // user must withdraw current unlocked SCA first if any
-            if (veSca.lockedScaAmount !== 0) {
+            if (veSca.lockedScaCoin !== 0) {
               const unlockedSca = txBlock.redeemSca(veSca.keyId);
               transferObjects.push(unlockedSca);
             }
@@ -309,7 +313,7 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
 
       if (veSca) {
         const transferObjects = [];
-        if (veSca.lockedScaAmount !== 0) {
+        if (veSca.lockedScaCoin !== 0) {
           const unlockedSca = txBlock.redeemSca(veSca.keyId);
           transferObjects.push(unlockedSca);
         }

package/src/models/scallopQuery.ts

@@ -25,6 +25,8 @@ import {
   getObligationAccounts,
   getObligationAccount,
   getTotalValueLocked,
+  getBindedObligationId,
+  getBindedVeScaKey,
 } from '../queries';
 import {
   ScallopQueryParams,
@@ -512,4 +514,22 @@ export class ScallopQuery {
   public async getTvl(indexer: boolean = false) {
     return await getTotalValueLocked(this, indexer);
   }
+
+  /**
+   * Get binded obligationId from a veScaKey if it exists.
+   * @param veScaKey
+   * @returns obligationId
+   */
+  public async getBindedObligationId(veScaKey: string) {
+    return await getBindedObligationId(this, veScaKey);
+  }
+
+  /**
+   * Get binded veSCA key from a obligationId if it exists.
+   * @param obligationId
+   * @returns veScaKey
+   */
+  public async getBindedVeScaKey(obligationId: string) {
+    return await getBindedVeScaKey(this, obligationId);
+  }
 }

package/src/queries/borrowIncentiveQuery.ts

@@ -1,6 +1,7 @@
 import { normalizeStructTag } from '@mysten/sui.js/utils';
 import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import {
+  IS_VE_SCA_TEST,
   SUPPORT_BORROW_INCENTIVE_POOLS,
   SUPPORT_BORROW_INCENTIVE_REWARDS,
 } from '../constants';
@@ -197,3 +198,97 @@ export const queryBorrowIncentiveAccounts = async (
 
   return borrowIncentiveAccounts;
 };
+
+/**
+ * Check veSca bind status
+ * @param query
+ * @param veScaKey
+ * @returns
+ */
+export const getBindedObligationId = async (
+  query: ScallopQuery,
+  veScaKeyId: string
+): Promise<string | null> => {
+  const borrowIncentiveObjectId = query.address.get('borrowIncentive.object');
+  const incentivePoolsId = query.address.get('borrowIncentive.incentivePools');
+  const veScaPkgId = IS_VE_SCA_TEST
+    ? '0xb220d034bdf335d77ae5bfbf6daf059c2cc7a1f719b12bfed75d1736fac038c8'
+    : query.address.get('vesca.id');
+
+  const client = query.suiKit.client();
+
+  // get incentive pools
+  const incentivePoolsResponse = await client.getObject({
+    id: incentivePoolsId,
+    options: {
+      showContent: true,
+    },
+  });
+
+  if (incentivePoolsResponse.data?.content?.dataType !== 'moveObject')
+    return null;
+  const incentivePoolFields = incentivePoolsResponse.data.content.fields as any;
+  const veScaBindTableId = incentivePoolFields.ve_sca_bind.fields.id
+    .id as string;
+
+  // check if veSca is inside the bind table
+  const keyType = `${borrowIncentiveObjectId}::typed_id::TypedID<${veScaPkgId}::ve_sca::VeScaKey>`;
+  const veScaBindTableResponse = await client.getDynamicFieldObject({
+    parentId: veScaBindTableId,
+    name: {
+      type: keyType,
+      value: veScaKeyId,
+    },
+  });
+
+  if (veScaBindTableResponse.data?.content?.dataType !== 'moveObject')
+    return null;
+  const veScaBindTableFields = veScaBindTableResponse.data.content
+    .fields as any;
+  // get obligationId pair
+  const obligationId = veScaBindTableFields.value.fields.id as string;
+
+  return obligationId;
+};
+
+export const getBindedVeScaKey = async (
+  query: ScallopQuery,
+  obliationId: string
+): Promise<string | null> => {
+  const borrowIncentiveObjectId = query.address.get('borrowIncentive.object');
+  const incentiveAccountsId = query.address.get(
+    'borrowIncentive.incentiveAccounts'
+  );
+  const corePkg = query.address.get('core.object');
+  const client = query.suiKit.client();
+
+  // get IncentiveAccounts object
+  const incentiveAccountsObject = await client.getObject({
+    id: incentiveAccountsId,
+    options: {
+      showContent: true,
+    },
+  });
+  if (incentiveAccountsObject.data?.content?.dataType !== 'moveObject')
+    return null;
+  const incentiveAccountsTableId = (
+    incentiveAccountsObject.data.content.fields as any
+  ).accounts.fields.id.id;
+
+  // Search in the table
+  const bindedIncentiveAcc = await client.getDynamicFieldObject({
+    parentId: incentiveAccountsTableId,
+    name: {
+      type: `${borrowIncentiveObjectId}::typed_id::TypedID<${corePkg}::obligation::Obligation>`,
+      value: obliationId,
+    },
+  });
+
+  if (bindedIncentiveAcc.data?.content?.dataType !== 'moveObject') return null;
+  const bindedIncentiveAccFields = bindedIncentiveAcc.data.content
+    .fields as any;
+
+  return (
+    bindedIncentiveAccFields.value.fields.binded_ve_sca_key?.fields.id ?? null
+  );
+};

package/src/queries/vescaQuery.ts

@@ -2,7 +2,7 @@ import BigNumber from 'bignumber.js';
 import { Vesca } from '../types';
 import type { SuiObjectResponse, SuiObjectData } from '@mysten/sui.js/client';
 import type { ScallopQuery } from '../models';
-import { IS_VE_SCA_TEST } from 'src/constants';
+import { IS_VE_SCA_TEST, MAX_LOCK_DURATION } from 'src/constants';
 /**
  * Query all owned veSca key.
  *
@@ -109,13 +109,26 @@ export const getVeSca = async (
   ) {
     const dynamicFields = (veScaDynamicFieldObject.content.fields as any).value
       .fields;
+
+    const remainingLockPeriodInMilliseconds = Math.max(
+      +dynamicFields.unlock_at * 1000 - Date.now(),
+      0
+    );
+    const lockedScaAmount = String(dynamicFields.locked_sca_amount);
+    const lockedScaCoin = BigNumber(dynamicFields.locked_sca_amount)
+      .shiftedBy(-9)
+      .toNumber();
+    const currentVeScaBalance =
+      lockedScaCoin *
+      (Math.floor(remainingLockPeriodInMilliseconds / 1000) /
+        MAX_LOCK_DURATION);
+
     vesca = {
       id: veScaDynamicFieldObject.objectId,
       keyId: veScaKeyId,
-      lockedScaAmount: BigNumber(dynamicFields.locked_sca_amount).toNumber(),
-      lockedScaCoin: BigNumber(dynamicFields.locked_sca_amount)
-        .shiftedBy(-9)
-        .toNumber(),
+      lockedScaAmount,
+      lockedScaCoin,
+      currentVeScaBalance,
       unlockAt: BigNumber(dynamicFields.unlock_at).toNumber(),
     } as Vesca;
   }

package/src/types/builder/borrowIncentive.ts

@@ -1,6 +1,5 @@
 import type {
   SuiTxBlock as SuiKitTxBlock,
-  SuiTxArg,
   SuiObjectArg,
 } from '@scallop-io/sui-kit';
 import type { TransactionResult } from '@mysten/sui.js/transactions';
@@ -27,7 +26,7 @@ export type BorrowIncentiveNormalMethods = {
   stakeObligationWithVesca: (
     obligation: SuiObjectArg,
     obligationKey: SuiObjectArg,
-    veScaKey: SuiTxArg
+    veScaKey: SuiObjectArg
   ) => void;
   unstakeObligation: (
     obligation: SuiObjectArg,

package/src/types/query/vesca.ts

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