@scallop-io/sui-scallop-sdk 2.4.4 → 2.4.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "2.4.4",
+  "version": "2.4.6",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",
@@ -37,6 +37,28 @@
     "dist",
     "src"
   ],
+  "scripts": {
+    "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
+    "build": "pnpm run build:tsup",
+    "build:sourcemap": "tsup ./src/index.ts --format esm,cjs --sourcemap --dts",
+    "build:tsup": "tsup ./src/index.ts --format esm,cjs --splitting --minify --treeshake --dts",
+    "watch:tsup": "tsup ./src/index.ts --format esm,cjs --clean --splitting --watch",
+    "watch:types": "tsc --watch",
+    "watch": "pnpm run clean & pnpm run watch:types & pnpm run watch:tsup",
+    "test": "pnpm test:typecheck && pnpm test:unit",
+    "test:typecheck": "tsc -p ./test",
+    "test:unit": "vitest run --test-timeout=60000",
+    "test:watch": "vitest",
+    "format:fix": "prettier --ignore-path 'dist/* docs/*' --write '**/*.{ts,json,md}'",
+    "lint:fix": "eslint . --ignore-pattern dist --ignore-pattern misc --ext .ts --fix",
+    "prepare": "husky install",
+    "commit": "commit",
+    "release": "standard-version -f",
+    "release:major": "standard-version -r major",
+    "release:minor": "standard-version -r minor",
+    "release:patch": "standard-version -r patch",
+    "doc": "typedoc --out docs src/index.ts"
+  },
   "dependencies": {
     "@mysten/sui": "1.45.2",
     "@noble/hashes": "^2.0.1",
@@ -143,26 +165,5 @@
         }
       ]
     }
-  },
-  "scripts": {
-    "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
-    "build": "pnpm run build:tsup",
-    "build:sourcemap": "tsup ./src/index.ts --format esm,cjs --sourcemap --dts",
-    "build:tsup": "tsup ./src/index.ts --format esm,cjs --splitting --minify --treeshake --dts",
-    "watch:tsup": "tsup ./src/index.ts --format esm,cjs --clean --splitting --watch",
-    "watch:types": "tsc --watch",
-    "watch": "pnpm run clean & pnpm run watch:types & pnpm run watch:tsup",
-    "test": "pnpm test:typecheck && pnpm test:unit",
-    "test:typecheck": "tsc -p ./test",
-    "test:unit": "vitest run --test-timeout=60000",
-    "test:watch": "vitest",
-    "format:fix": "prettier --ignore-path 'dist/* docs/*' --write '**/*.{ts,json,md}'",
-    "lint:fix": "eslint . --ignore-pattern dist --ignore-pattern misc --ext .ts --fix",
-    "commit": "commit",
-    "release": "standard-version -f",
-    "release:major": "standard-version -r major",
-    "release:minor": "standard-version -r minor",
-    "release:patch": "standard-version -r patch",
-    "doc": "typedoc --out docs src/index.ts"
   }
-}
+}

package/src/builders/borrowIncentiveBuilder.ts

@@ -1,10 +1,8 @@
-import { Transaction } from '@mysten/sui/transactions';
-import {
-  SuiTxBlock as SuiKitTxBlock,
-  SUI_CLOCK_OBJECT_ID,
-} from '@scallop-io/sui-kit';
+import { SUI_CLOCK_OBJECT_ID } from '@scallop-io/sui-kit';
 import { getObligations, getObligationLocked } from 'src/queries';
-import { requireSender } from 'src/utils';
+import { requireSender, resolveTxBlock } from 'src/utils';
+import type { Transaction } from '@mysten/sui/transactions';
+import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
 import type { ScallopBuilder } from 'src/models';
 import type {
@@ -332,12 +330,7 @@ export const newBorrowIncentiveTxBlock = (
   builder: ScallopBuilder,
   initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction
 ) => {
-  const txBlock =
-    initTxBlock instanceof Transaction
-      ? new SuiKitTxBlock(initTxBlock)
-      : initTxBlock
-        ? initTxBlock
-        : new SuiKitTxBlock();
+  const txBlock = resolveTxBlock(initTxBlock);
 
   const normalMethod = generateBorrowIncentiveNormalMethod({
     builder,

package/src/builders/coreBuilder.ts

@@ -1,9 +1,9 @@
-import { Transaction } from '@mysten/sui/transactions';
 import { SUI_CLOCK_OBJECT_ID } from '@mysten/sui/utils';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import { getObligations } from '../queries';
 import { updateOracles } from './oracles';
-import { requireSender } from '../utils';
+import { requireSender, resolveTxBlock } from '../utils';
+import type { Transaction } from '@mysten/sui/transactions';
+import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
 import type { ScallopBuilder } from 'src/models';
 import type {
@@ -575,12 +575,7 @@ export const newCoreTxBlock = (
     | Transaction
     | SuiTxBlockWithSpool
 ) => {
-  const txBlock =
-    initTxBlock instanceof Transaction
-      ? new SuiKitTxBlock(initTxBlock)
-      : initTxBlock
-        ? initTxBlock
-        : new SuiKitTxBlock();
+  const txBlock = resolveTxBlock(initTxBlock);
 
   const normalMethod = generateCoreNormalMethod({
     builder,

package/src/builders/index.ts

@@ -10,6 +10,7 @@ import { newReferralTxBlock } from './referralBuilder';
 import { newObligationNamingTxBlock } from './obligationNamingBuilder';
 import { newLoyaltyProgramTxBlock } from './loyaltyProgramBuilder';
 import { newSCoinTxBlock } from './sCoinBuilder';
+import { SCALLOP_TX_BLOCK_MARKER } from 'src/utils';
 
 /**
  * Create a new ScallopTxBlock instance.
@@ -39,6 +40,7 @@ export const newScallopTxBlock = (
 
   return new Proxy(coreTxBlock, {
     get: (target, prop) => {
+      if (prop === SCALLOP_TX_BLOCK_MARKER) return true;
       if (prop in vescaTxBlock) {
         return Reflect.get(vescaTxBlock, prop);
       } else if (prop in borrowIncentiveTxBlock) {

package/src/builders/loyaltyProgramBuilder.ts

@@ -1,5 +1,5 @@
-import { Transaction } from '@mysten/sui/transactions';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import type { Transaction } from '@mysten/sui/transactions';
+import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import { ScallopBuilder } from 'src/models';
 import {
   GenerateLoyaltyProgramNormalMethod,
@@ -8,7 +8,7 @@ import {
   ScallopTxBlock,
   SuiTxBlockWithLoyaltyProgramNormalMethods,
 } from 'src/types';
-import { requireSender } from 'src/utils';
+import { requireSender, resolveTxBlock } from 'src/utils';
 
 const generateLoyaltyProgramNormalMethod: GenerateLoyaltyProgramNormalMethod =
   ({ builder, txBlock }) => {
@@ -105,12 +105,7 @@ export const newLoyaltyProgramTxBlock = (
   builder: ScallopBuilder,
   initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction
 ) => {
-  const txBlock =
-    initTxBlock instanceof Transaction
-      ? new SuiKitTxBlock(initTxBlock)
-      : initTxBlock
-        ? initTxBlock
-        : new SuiKitTxBlock();
+  const txBlock = resolveTxBlock(initTxBlock);
 
   const normalMethod = generateLoyaltyProgramNormalMethod({
     builder,

package/src/builders/obligationNamingBuilder.ts

@@ -1,6 +1,7 @@
 import { ScallopBuilder } from 'src/models';
 import { ScallopTxBlock } from 'src/types';
-import {
+import { resolveTxBlock } from 'src/utils';
+import type {
   SuiTxBlock as SuiKitTxBlock,
   SuiObjectArg,
   Transaction,
@@ -67,12 +68,7 @@ export const newObligationNamingTxBlock = (
   builder: ScallopBuilder,
   initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction
 ) => {
-  const txBlock =
-    initTxBlock instanceof Transaction
-      ? new SuiKitTxBlock(initTxBlock)
-      : initTxBlock
-        ? initTxBlock
-        : new SuiKitTxBlock();
+  const txBlock = resolveTxBlock(initTxBlock);
 
   const normalMethod = generateObligationNamingNormalMethod({
     builder,

package/src/builders/referralBuilder.ts

@@ -1,11 +1,6 @@
 import { ScallopBuilder } from 'src/models';
 import { ScallopTxBlock } from 'src/types';
-import {
-  SUI_CLOCK_OBJECT_ID,
-  SuiTxBlock as SuiKitTxBlock,
-  SuiObjectArg,
-  Transaction,
-} from '@scallop-io/sui-kit';
+import { SUI_CLOCK_OBJECT_ID } from '@scallop-io/sui-kit';
 import {
   GenerateReferralNormalMethod,
   GenerateReferralQuickMethod,
@@ -13,7 +8,12 @@ import {
   ReferralTxBlock,
   SuiTxBlockWithReferralNormalMethods,
 } from 'src/types/builder/referral';
-import { requireSender } from 'src/utils';
+import { requireSender, resolveTxBlock } from 'src/utils';
+import type {
+  SuiTxBlock as SuiKitTxBlock,
+  SuiObjectArg,
+  Transaction,
+} from '@scallop-io/sui-kit';
 
 const generateReferralNormalMethod: GenerateReferralNormalMethod = ({
   builder,
@@ -155,12 +155,7 @@ export const newReferralTxBlock = (
   builder: ScallopBuilder,
   initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction
 ) => {
-  const txBlock =
-    initTxBlock instanceof Transaction
-      ? new SuiKitTxBlock(initTxBlock)
-      : initTxBlock
-        ? initTxBlock
-        : new SuiKitTxBlock();
+  const txBlock = resolveTxBlock(initTxBlock);
 
   const normalMethod = generateReferralNormalMethod({
     builder,

package/src/builders/sCoinBuilder.ts

@@ -1,4 +1,3 @@
-import { Transaction, SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import { ScallopBuilder } from 'src/models';
 import {
   BaseScallopTxBlock,
@@ -9,7 +8,11 @@ import {
   SuiTxBlockWithSCoinNormalMethods,
   sCoinPkgIds,
 } from 'src/types';
-import { requireSender } from 'src/utils';
+import { requireSender, resolveTxBlock } from 'src/utils';
+import type {
+  Transaction,
+  SuiTxBlock as SuiKitTxBlock,
+} from '@scallop-io/sui-kit';
 
 const generateSCoinNormalMethod: GenerateSCoinNormalMethod = ({
   builder,
@@ -86,12 +89,7 @@ export const newSCoinTxBlock = (
     | Transaction
     | BaseScallopTxBlock
 ) => {
-  const txBlock =
-    initTxBlock instanceof Transaction
-      ? new SuiKitTxBlock(initTxBlock)
-      : initTxBlock
-        ? initTxBlock
-        : new SuiKitTxBlock();
+  const txBlock = resolveTxBlock(initTxBlock);
 
   const normalMethod = generateSCoinNormalMethod({
     builder,

package/src/builders/spoolBuilder.ts

@@ -1,8 +1,8 @@
-import { Transaction } from '@mysten/sui/transactions';
 import { SUI_CLOCK_OBJECT_ID } from '@mysten/sui/utils';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import { getStakeAccounts } from '../queries/spoolQuery';
-import { requireSender } from '../utils';
+import { requireSender, resolveTxBlock } from '../utils';
+import type { Transaction } from '@mysten/sui/transactions';
+import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import type { SuiAddressArg } from '@scallop-io/sui-kit';
 import type { TransactionResult } from '@mysten/sui/transactions';
 import type { ScallopBuilder } from 'src/models';
@@ -332,12 +332,7 @@ export const newSpoolTxBlock = (
     | Transaction
     | SuiTxBlockWithSCoin
 ) => {
-  const txBlock =
-    initTxBlock instanceof Transaction
-      ? new SuiKitTxBlock(initTxBlock)
-      : initTxBlock
-        ? initTxBlock
-        : new SuiKitTxBlock();
+  const txBlock = resolveTxBlock(initTxBlock);
 
   const normalMethod = generateSpoolNormalMethod({
     builder,

package/src/builders/vescaBuilder.ts

@@ -1,9 +1,4 @@
-import {
-  SUI_CLOCK_OBJECT_ID,
-  SuiTxBlock,
-  Transaction,
-  SuiTxBlock as SuiKitTxBlock,
-} from '@scallop-io/sui-kit';
+import { SUI_CLOCK_OBJECT_ID } from '@scallop-io/sui-kit';
 import { SCA_COIN_TYPE } from 'src/constants';
 import { ScallopBuilder } from 'src/models';
 import { getVeSca, getVeScas } from 'src/queries';
@@ -14,7 +9,13 @@ import {
   checkExtendLockAmount,
   checkRenewExpiredVeSca,
   checkVesca,
+  resolveTxBlock,
 } from 'src/utils';
+import type {
+  SuiTxBlock,
+  Transaction,
+  SuiTxBlock as SuiKitTxBlock,
+} from '@scallop-io/sui-kit';
 import type {
   TransactionObjectArgument,
   SuiObjectArg,
@@ -535,12 +536,7 @@ export const newVeScaTxBlock = (
   builder: ScallopBuilder,
   initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction
 ) => {
-  const txBlock =
-    initTxBlock instanceof Transaction
-      ? new SuiKitTxBlock(initTxBlock)
-      : initTxBlock
-        ? initTxBlock
-        : new SuiKitTxBlock();
+  const txBlock = resolveTxBlock(initTxBlock);
 
   const normalMethod = generateNormalVeScaMethod({
     builder,

package/src/queries/borrowIncentiveQuery.ts

@@ -136,19 +136,26 @@ export const getBorrowIncentivePools = async (
         poolCoinDecimal
       );
 
-      if (poolPoint.points > calculatedPoolPoint.accumulatedPoints) {
-        borrowIncentivePoolPoints[coinName as string] = {
-          symbol,
-          coinName: rewardCoinName,
-          coinType: rewardCoinType,
-          coinDecimal,
-          coinPrice: rewardCoinPrice,
-          points: poolPoint.points,
-          distributedPoint: poolPoint.distributedPoint,
-          weightedAmount: poolPoint.weightedAmount,
-          ...calculatedPoolPoint,
-        };
-      }
+      // A campaign is exhausted once every allocated point has been
+      // distributed (accumulatedPoints is min-capped at points). We still emit
+      // the pool point — the portfolio query needs it to surface users'
+      // already-accrued, unclaimed rewards — but zero out the APR so callers
+      // don't display a stale reward rate for an ended campaign.
+      const isExhausted =
+        poolPoint.points <= calculatedPoolPoint.accumulatedPoints;
+
+      borrowIncentivePoolPoints[coinName as string] = {
+        symbol,
+        coinName: rewardCoinName,
+        coinType: rewardCoinType,
+        coinDecimal,
+        coinPrice: rewardCoinPrice,
+        points: poolPoint.points,
+        distributedPoint: poolPoint.distributedPoint,
+        weightedAmount: poolPoint.weightedAmount,
+        ...calculatedPoolPoint,
+        ...(isExhausted ? { rewardApr: 0 } : {}),
+      };
     }
 
     const stakedAmount = BigNumber(parsedBorrowIncentivePoolData.staked);

package/src/utils/builder.ts

@@ -1,4 +1,4 @@
-import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import { SuiTxBlock as SuiKitTxBlock, Transaction } from '@scallop-io/sui-kit';
 import {
   UNLOCK_ROUND_DURATION,
   MAX_LOCK_DURATION,
@@ -7,6 +7,39 @@ import {
   MIN_TOP_UP_AMOUNT,
 } from 'src/constants';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
+import type { ScallopTxBlock } from 'src/types';
+
+/**
+ * Marker the outer `newScallopTxBlock` Proxy returns `true` for, so we can
+ * runtime-detect a `ScallopTxBlock` (otherwise indistinguishable from a plain
+ * `SuiKitTxBlock` since `ScallopTxBlock` is a TS-only type intersection).
+ */
+export const SCALLOP_TX_BLOCK_MARKER = Symbol.for('scallop.txBlock');
+
+export const isScallopTxBlock = (value: unknown): value is ScallopTxBlock => {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    (value as Record<symbol, unknown>)[SCALLOP_TX_BLOCK_MARKER] === true
+  );
+};
+
+/**
+ * Resolve the `initTxBlock` argument accepted by every `new*TxBlock` factory
+ * into a concrete `SuiKitTxBlock` instance.
+ * - `ScallopTxBlock` (detected via marker) → pass through
+ * - `Transaction` → wrap in a new `SuiKitTxBlock`
+ * - existing `SuiKitTxBlock` → pass through
+ * - `undefined` → fresh `SuiKitTxBlock`
+ */
+export const resolveTxBlock = (
+  initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction
+): SuiKitTxBlock => {
+  if (isScallopTxBlock(initTxBlock)) return initTxBlock;
+  if (initTxBlock instanceof SuiKitTxBlock) return initTxBlock;
+  if (initTxBlock instanceof Transaction) return new SuiKitTxBlock(initTxBlock);
+  return initTxBlock ?? new SuiKitTxBlock();
+};
 
 /**
  * Check and get the sender from the transaction block.