@scallop-io/sui-scallop-sdk 0.46.36 → 0.46.37

package/dist/models/scallopQuery.d.ts

@@ -4,6 +4,7 @@ import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
 import { ScallopIndexer } from './scallopIndexer';
 import { ScallopCache } from './scallopCache';
+import { SuiObjectData } from '@mysten/sui.js/src/client';
 /**
  * @description
  * It provides methods for getting on-chain data from the Scallop contract.
@@ -370,14 +371,14 @@ export declare class ScallopQuery {
      * @param walletAddress
      * @returns array of veSca
      */
-    getVeScas(walletAddress: string): Promise<(import("../types").Vesca | undefined)[]>;
+    getVeScas(walletAddress?: string): Promise<import("../types").Vesca[]>;
     /**
      * Get total vesca treasury with movecall
      * @returns Promise<string | undefined>
      */
-    getTotalVeScaTreasuryAmount(): Promise<string>;
+    getVeScaTreasuryInfo(): Promise<import("../types").VeScaTreasuryInfo | null>;
     /**
-     * Return binded veScaKeyId of walletAddress if exist
+     * Return binded referrer veScaKeyId of referee walletAddress if exist
      * @param walletAddress
      * @returns veScaKeyId
      */
@@ -394,4 +395,10 @@ export declare class ScallopQuery {
      * @returns veScaKey
      */
     getBindedVeScaKey(obligationId: string): Promise<string | null>;
+    /**
+     * Get user's veSCA loyalty program informations
+     * @param walletAddress
+     * @returns Loyalty program information
+     */
+    getLoyaltyProgramInfos(veScaKey?: string | SuiObjectData): Promise<import("../types").LoyaltyProgramInfo | null>;
 }

package/dist/models/scallopUtils.d.ts

@@ -171,5 +171,5 @@ export declare class ScallopUtils {
      * @param unlockAtInSecondTimestamp The unlock timestamp from veSca object.
      * @return New unlock at in seconds timestamp.
      */
-    getUnlockAt(extendLockPeriodInDay?: number, unlockAtInSecondTimestamp?: number): number;
+    getUnlockAt(extendLockPeriodInDay?: number, unlockAtInMillisTimestamp?: number): number;
 }

package/dist/queries/index.d.ts

@@ -5,3 +5,4 @@ export * from './priceQuery';
 export * from './portfolioQuery';
 export * from './vescaQuery';
 export * from './referralQuery';
+export * from './loyaltyProgramQuery';

package/dist/queries/loyaltyProgramQuery.d.ts

@@ -0,0 +1,10 @@
+import { SuiObjectData } from '@mysten/sui.js/src/client';
+import { ScallopQuery } from 'src/models';
+import { LoyaltyProgramInfo } from 'src/types';
+/**
+ * Get user's loyalty program information and pending rewards if exists
+ * @param query
+ * @param veScaKey
+ * @returns
+ */
+export declare const getLoyaltyProgramInformations: (query: ScallopQuery, veScaKey?: string | SuiObjectData) => Promise<LoyaltyProgramInfo | null>;

package/dist/queries/vescaQuery.d.ts

@@ -1,4 +1,4 @@
-import { Vesca } from '../types';
+import { VeScaTreasuryInfo, Vesca } from '../types';
 import { type SuiObjectData } from '@mysten/sui.js/client';
 import type { ScallopQuery } from '../models';
 /**
@@ -16,17 +16,19 @@ export declare const getVescaKeys: (query: ScallopQuery, ownerAddress?: string)
  * @param ownerAddress - The owner address.
  * @return Owned veScas.
  */
-export declare const getVeScas: (query: ScallopQuery, ownerAddress?: string) => Promise<(Vesca | undefined)[]>;
+export declare const getVeScas: (query: ScallopQuery, ownerAddress?: string) => Promise<Vesca[]>;
 /**
  * Get veSca data.
  *
  * @param query - The Scallop query instance.
- * @param veScaKeyId - The vesca key id.
+ * @param veScaKey - The vesca key id.
  * @param ownerAddress - The owner address.
  * @returns Vesca data.
  */
-export declare const getVeSca: (query: ScallopQuery, veScaKeyId?: string, ownerAddress?: string) => Promise<Vesca | undefined>;
+export declare const getVeSca: (query: ScallopQuery, veScaKey?: string | SuiObjectData, ownerAddress?: string) => Promise<Vesca | undefined>;
 /**
- * Get current total veSca treasury amount.
+ * Get veSCA treasury informations
+ * @param query
+ * @returns VeScaTreasuryInfo
  */
-export declare const getTotalVeScaTreasuryAmount: (query: ScallopQuery) => Promise<string>;
+export declare const getVeScaTreasuryInfo: (query: ScallopQuery) => Promise<VeScaTreasuryInfo | null>;

package/dist/types/address.d.ts

@@ -85,6 +85,12 @@ export interface AddressesInterface {
         tiersTableId: string;
         authorizedWitnessList: string;
     };
+    loyaltyProgram: {
+        id: string;
+        object: string;
+        rewardPool: string;
+        userRewardTableId: string;
+    };
 }
 type AddressPathsProps<T> = T extends string ? [] : {
     [K in Extract<keyof T, string>]: [K, ...AddressPathsProps<T[K]>];

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

@@ -3,8 +3,10 @@ import type { SpoolTxBlock } from './spool';
 import type { BorrowIncentiveTxBlock } from './borrowIncentive';
 import type { VeScaTxBlock } from './vesca';
 import type { ReferralTxBlock } from './referral';
+import { LoyaltyProgramTxBlock } from './loyaltyProgram';
 export type * from './core';
 export type * from './spool';
 export type * from './borrowIncentive';
 export type * from './vesca';
-export type ScallopTxBlock = CoreTxBlock & SpoolTxBlock & ReferralTxBlock & BorrowIncentiveTxBlock & VeScaTxBlock;
+export type * from './loyaltyProgram';
+export type ScallopTxBlock = CoreTxBlock & SpoolTxBlock & ReferralTxBlock & LoyaltyProgramTxBlock & BorrowIncentiveTxBlock & VeScaTxBlock;

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

@@ -0,0 +1,23 @@
+import { SuiObjectArg, SuiTxBlock as SuiKitTxBlock, TransactionResult } from '@scallop-io/sui-kit';
+import { type ScallopBuilder } from 'src/models';
+export type LoyaltyProgramIds = {
+    loyaltyProgramPkgId: string;
+    rewardPool: string;
+    userRewardTableId: string;
+};
+export type LoyaltyProgramNormalMethods = {
+    claimLoyaltyRevenue: (veScaKey: SuiObjectArg) => TransactionResult;
+};
+export type LoyaltyProgramQuickMethods = {
+    claimLoyaltyRevenueQuick: (veScaKey?: SuiObjectArg) => Promise<void>;
+};
+export type SuiTxBlockWithLoyaltyProgramNormalMethods = SuiKitTxBlock & LoyaltyProgramNormalMethods;
+export type LoyaltyProgramTxBlock = SuiTxBlockWithLoyaltyProgramNormalMethods & LoyaltyProgramQuickMethods;
+export type GenerateLoyaltyProgramNormalMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiKitTxBlock;
+}) => LoyaltyProgramNormalMethods;
+export type GenerateLoyaltyProgramQuickMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlockWithLoyaltyProgramNormalMethods;
+}) => LoyaltyProgramQuickMethods;

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

@@ -16,6 +16,22 @@ export type VeScaNormalMethods = {
     mintEmptyVeSca: () => TransactionResult;
 };
 export type VeScaQuickMethods = {
+    /**
+     * Quick methods to automate
+     * lock initial SCA, extend lock period, lock more SCA, renew expired VeSCA, and redeem SCA
+     *
+     * **Flow:**
+     * - If only `amountOrCoin` is provided, it will lock the amount of existing not expired veSCA
+     * - If only `lockPeriodInDays` is provided, it will extend the lock period of existing not expired veSCA
+     *
+     * **Note:**
+     * - If one or both flow above is used on a expired veSCA, it will claim the unlocked SCA
+     *   and renew the veSCA first, and then flow continues
+     * - If users has no veSCA yet, they need to provide both `amountOrCoin` and `lockPeriodInDays` for initial lock
+     * @param amountOrCoin
+     * @param lockPeriodInDays
+     * @param autoCheck
+     */
     lockScaQuick(amountOrCoin?: SuiObjectArg | number, lockPeriodInDays?: number, autoCheck?: boolean): Promise<void>;
     extendLockPeriodQuick: (lockPeriodInDays: number, veScaKey?: SuiObjectArg, autoCheck?: boolean) => Promise<void>;
     extendLockAmountQuick: (scaAmount: number, veScaKey?: SuiObjectArg, autoCheck?: boolean) => Promise<void>;

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

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

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

@@ -0,0 +1,5 @@
+export type LoyaltyProgramInfo = {
+    pendingReward: number;
+    totalPoolReward: number;
+    isClaimEnabled: boolean;
+};

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

@@ -1,8 +1,26 @@
+import type { SuiObjectRef } from '@mysten/sui.js/client';
 export type Vesca = {
     id: string;
     keyId: string;
+    keyObject?: SuiObjectRef;
+    object?: SuiObjectRef;
     lockedScaAmount: string;
     lockedScaCoin: number;
     currentVeScaBalance: number;
     unlockAt: number;
 };
+export type VeScaTreasuryFields = {
+    total_ve_sca_amount: string;
+    sca_balance: string;
+    unlock_schedule: {
+        fields: {
+            locked_sca_amount: string;
+        };
+    };
+};
+export type VeScaTreasuryInfo = {
+    totalLockedSca: number;
+    totalVeSca: number;
+    averageLockingPeriod: number;
+    averageLockingPeriodUnit: string;
+};

package/dist/utils/builder.d.ts

@@ -7,8 +7,9 @@ import type { SuiObjectArg } from '@scallop-io/sui-kit';
  * @return Sender of transaction.
  */
 export declare const requireSender: (txBlock: SuiKitTxBlock) => string;
-export declare const checkLockSca: (scaAmountOrCoin?: number | SuiObjectArg | undefined, lockPeriodInDays?: number, newUnlockAtInSecondTimestamp?: number, prevUnlockAtInSecondTimestamp?: number) => void;
-export declare const checkExtendLockPeriod: (lockPeriodInDays: number, newUnlockAtInSecondTimestamp: number, prevUnlockAtInSecondTimestamp?: number) => void;
-export declare const checkExtendLockAmount: (scaAmount: number, prevUnlockAtInSecondTimestamp?: number) => void;
-export declare const checkRenewExpiredVeSca: (scaAmount: number, lockPeriodInDays: number, prevUnlockAtInSecondTimestamp?: number) => void;
-export declare const checkVesca: (prevUnlockAtInSecondTimestamp?: number) => void;
+export declare const checkVesca: (prevUnlockAtInMillisTimestamp?: number) => void;
+export declare const checkVescaExpired: (prevUnlockAtInMillisTimestamp: number) => void;
+export declare const checkExtendLockPeriod: (lockPeriodInDays: number, newUnlockAtInSecondTimestamp: number, prevUnlockAtInMillisTimestamp?: number) => void;
+export declare const checkLockSca: (scaAmountOrCoin: number | SuiObjectArg | undefined, lockPeriodInDays?: number, newUnlockAtInSecondTimestamp?: number, prevUnlockAtInMillisTimestamp?: number) => void;
+export declare const checkExtendLockAmount: (scaAmount: number, prevUnlockAtInMillisTimestamp?: number) => void;
+export declare const checkRenewExpiredVeSca: (scaAmount: number, lockPeriodInDays: number, prevUnlockAtInMillisTimestamp?: number) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "0.46.36",
+  "version": "0.46.37",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",
@@ -20,7 +20,7 @@
     "access": "public"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18.15.0"
   },
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -39,7 +39,7 @@
   ],
   "dependencies": {
     "@mysten/bcs": "^0.8.1",
-    "@mysten/sui.js": "^0.49.1",
+    "@mysten/sui.js": "^0.52.0",
     "@noble/curves": "^1.2.0",
     "@noble/hashes": "^1.3.2",
     "@pythnetwork/price-service-client": "^1.8.2",
@@ -51,7 +51,8 @@
     "bech32": "^2.0.0",
     "bignumber.js": "^9.1.2",
     "superstruct": "^1.0.3",
-    "tweetnacl": "^1.0.3"
+    "tweetnacl": "^1.0.3",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@commitlint/cli": "^18.2.0",
@@ -75,8 +76,8 @@
     "vitest": "^0.34.6"
   },
   "peerDependencies": {
-    "@mysten/sui.js": "0.49.1",
-    "@scallop-io/sui-kit": "^0.44.2",
+    "@mysten/sui.js": "0.52.0",
+    "@scallop-io/sui-kit": "^0.45.0",
     "bn.js": "^5.2.1"
   },
   "lint-staged": {

package/src/builders/index.ts

@@ -7,6 +7,7 @@ import { newVeScaTxBlock } from './vescaBuilder';
 import type { ScallopBuilder } from '../models';
 import type { ScallopTxBlock } from '../types';
 import { newReferralTxBlock } from './referralBuilder';
+import { newLoyaltyProgramTxBlock } from './loyaltyProgramBuilder';
 
 /**
  * Create a new ScallopTxBlock instance.
@@ -20,13 +21,15 @@ export const newScallopTxBlock = (
   initTxBlock?: ScallopTxBlock | SuiKitTxBlock | TransactionBlock
 ): ScallopTxBlock => {
   const vescaTxBlock = newVeScaTxBlock(builder, initTxBlock);
+  const loyaltyTxBlock = newLoyaltyProgramTxBlock(builder, vescaTxBlock);
   const borrowIncentiveTxBlock = newBorrowIncentiveTxBlock(
     builder,
-    vescaTxBlock
+    loyaltyTxBlock
   );
   const referralTxBlock = newReferralTxBlock(builder, borrowIncentiveTxBlock);
   const spoolTxBlock = newSpoolTxBlock(builder, referralTxBlock);
   const coreTxBlock = newCoreTxBlock(builder, spoolTxBlock);
+
   return new Proxy(coreTxBlock, {
     get: (target, prop) => {
       if (prop in vescaTxBlock) {
@@ -37,6 +40,8 @@ export const newScallopTxBlock = (
         return Reflect.get(referralTxBlock, prop);
       } else if (prop in spoolTxBlock) {
         return Reflect.get(spoolTxBlock, prop);
+      } else if (prop in loyaltyTxBlock) {
+        return Reflect.get(loyaltyTxBlock, prop);
       }
       return Reflect.get(target, prop);
     },

package/src/builders/loyaltyProgramBuilder.ts

@@ -0,0 +1,115 @@
+import { TransactionBlock } from '@mysten/sui.js/transactions';
+import { SuiObjectArg, SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import { coinIds } from 'src/constants';
+import { ScallopBuilder } from 'src/models';
+import {
+  GenerateLoyaltyProgramNormalMethod,
+  GenerateLoyaltyProgramQuickMethod,
+  LoyaltyProgramIds,
+  LoyaltyProgramTxBlock,
+  ScallopTxBlock,
+  SuiTxBlockWithLoyaltyProgramNormalMethods,
+} from 'src/types';
+import { requireSender } from 'src/utils';
+
+const generateLoyaltyProgramNormalMethod: GenerateLoyaltyProgramNormalMethod =
+  ({ builder, txBlock }) => {
+    const loyaltyProgramIds: LoyaltyProgramIds = {
+      loyaltyProgramPkgId: builder.address.get('loyaltyProgram.id'),
+      rewardPool: builder.address.get('loyaltyProgram.rewardPool'),
+      userRewardTableId: builder.address.get(
+        'loyaltyProgram.userRewardTableId'
+      ),
+    };
+
+    return {
+      claimLoyaltyRevenue: (veScaKey) => {
+        return txBlock.moveCall(
+          `${loyaltyProgramIds.loyaltyProgramPkgId}::reward_pool::redeem_reward`,
+          [loyaltyProgramIds.rewardPool, veScaKey]
+        );
+      },
+    };
+  };
+
+const generateLoyaltyProgramQuickMethod: GenerateLoyaltyProgramQuickMethod = ({
+  builder,
+  txBlock,
+}) => {
+  return {
+    claimLoyaltyRevenueQuick: async (veScaKey) => {
+      veScaKey = veScaKey || (await builder.query.getVeScas())[0]?.keyObject;
+      const sender = requireSender(txBlock);
+      if (!veScaKey) throw new Error(`No veScaKey found for user ${sender}`);
+
+      // claim the pending reward
+      const toTransferObject: SuiObjectArg[] = [];
+      const rewardCoin = txBlock.claimLoyaltyRevenue(veScaKey);
+
+      // get existing sca coin to merge with
+      try {
+        const existingScaCoin = await builder.suiKit.suiInteractor.selectCoins(
+          sender,
+          Infinity,
+          coinIds.sca
+        );
+        txBlock.mergeCoins(rewardCoin, existingScaCoin);
+      } catch (e) {
+        // ignore
+      } finally {
+        toTransferObject.push(rewardCoin);
+      }
+
+      if (toTransferObject.length > 0) {
+        txBlock.transferObjects(toTransferObject, sender);
+      }
+    },
+  };
+};
+
+/**
+ * Create an enhanced transaction block instance for interaction with borrow incentive modules of the Scallop contract.
+ *
+ * @param builder - Scallop builder instance.
+ * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
+ * @return Scallop loyalty program txBlock.
+ */
+export const newLoyaltyProgramTxBlock = (
+  builder: ScallopBuilder,
+  initTxBlock?: ScallopTxBlock | SuiKitTxBlock | TransactionBlock
+) => {
+  const txBlock =
+    initTxBlock instanceof TransactionBlock
+      ? new SuiKitTxBlock(initTxBlock)
+      : initTxBlock
+      ? initTxBlock
+      : new SuiKitTxBlock();
+
+  const normalMethod = generateLoyaltyProgramNormalMethod({
+    builder,
+    txBlock,
+  });
+
+  const normalTxBlock = new Proxy(txBlock, {
+    get: (target, prop) => {
+      if (prop in normalMethod) {
+        return Reflect.get(normalMethod, prop);
+      }
+      return Reflect.get(target, prop);
+    },
+  }) as SuiTxBlockWithLoyaltyProgramNormalMethods;
+
+  const quickMethod = generateLoyaltyProgramQuickMethod({
+    builder,
+    txBlock: normalTxBlock,
+  });
+
+  return new Proxy(normalTxBlock, {
+    get: (target, prop) => {
+      if (prop in quickMethod) {
+        return Reflect.get(quickMethod, prop);
+      }
+      return Reflect.get(target, prop);
+    },
+  }) as LoyaltyProgramTxBlock;
+};

package/src/builders/referralBuilder.ts

@@ -137,7 +137,7 @@ const generateReferralQuickMethod: GenerateReferralQuickMethod = ({
  *
  * @param builder - Scallop builder instance.
  * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
- * @return Scallop borrow incentive txBlock.
+ * @return Scallop referral txBlock.
  */
 export const newReferralTxBlock = (
   builder: ScallopBuilder,

package/src/builders/vescaBuilder.ts

@@ -212,6 +212,7 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
         lockPeriodInDays,
         veSca?.unlockAt
       );
+
       if (autoCheck)
         checkLockSca(
           amountOrCoin,
@@ -259,8 +260,11 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
       autoCheck = true
     ) => {
       const veSca = await requireVeSca(builder, txBlock, veScaKey);
+      const newUnlockAt = builder.utils.getUnlockAt(
+        lockPeriodInDays,
+        veSca?.unlockAt
+      );
 
-      const newUnlockAt = builder.utils.getUnlockAt(lockPeriodInDays);
       if (autoCheck)
         checkExtendLockPeriod(lockPeriodInDays, newUnlockAt, veSca?.unlockAt);