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

package/src/builders/coreBuilder.ts

@@ -70,6 +70,10 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
     coinDecimalsRegistry: builder.address.get('core.coinDecimalsRegistry'),
     xOracle: builder.address.get('core.oracles.xOracle'),
   };
+
+  const referralPkgId = builder.address.get('referral.id');
+  const referralWitnessType = `${referralPkgId}::scallop_referral_program::REFERRAL_WITNESS`;
+
   return {
     openObligation: () =>
       txBlock.moveCall(
@@ -160,6 +164,30 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
         [coinType]
       );
     },
+    borrowWithReferral: (
+      obligation,
+      obligationKey,
+      borrowReferral,
+      amount,
+      poolCoinName
+    ) => {
+      const coinType = builder.utils.parseCoinType(poolCoinName);
+      return txBlock.moveCall(
+        `${coreIds.protocolPkg}::borrow::borrow_with_referral`,
+        [
+          coreIds.version,
+          obligation,
+          obligationKey,
+          coreIds.market,
+          coreIds.coinDecimalsRegistry,
+          borrowReferral,
+          amount,
+          coreIds.xOracle,
+          SUI_CLOCK_OBJECT_ID,
+        ],
+        [coinType, referralWitnessType]
+      );
+    },
     borrowEntry: (obligation, obligationKey, amount, poolCoinName) => {
       const coinType = builder.utils.parseCoinType(poolCoinName);
       return txBlock.moveCall(
@@ -319,6 +347,32 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
         poolCoinName
       );
     },
+    borrowWithReferralQuick: async (
+      amount,
+      poolCoinName,
+      borrowReferral,
+      obligationId,
+      obligationKey
+    ) => {
+      const obligationInfo = await requireObligationInfo(
+        builder,
+        txBlock,
+        obligationId,
+        obligationKey
+      );
+      const obligationCoinNames = await builder.utils.getObligationCoinNames(
+        obligationInfo.obligationId
+      );
+      const updateCoinNames = [...obligationCoinNames, poolCoinName];
+      await updateOracles(builder, txBlock, updateCoinNames);
+      return txBlock.borrowWithReferral(
+        obligationInfo.obligationId,
+        obligationInfo.obligationKey as SuiAddressArg,
+        borrowReferral,
+        amount,
+        poolCoinName
+      );
+    },
     repayQuick: async (amount, poolCoinName, obligationId) => {
       const sender = requireSender(txBlock);
       const obligationInfo = await requireObligationInfo(

package/src/builders/index.ts

@@ -6,6 +6,7 @@ import { newBorrowIncentiveTxBlock } from './borrowIncentiveBuilder';
 import { newVeScaTxBlock } from './vescaBuilder';
 import type { ScallopBuilder } from '../models';
 import type { ScallopTxBlock } from '../types';
+import { newReferralTxBlock } from './referralBuilder';
 
 /**
  * Create a new ScallopTxBlock instance.
@@ -23,15 +24,17 @@ export const newScallopTxBlock = (
     builder,
     vescaTxBlock
   );
-  const spoolTxBlock = newSpoolTxBlock(builder, borrowIncentiveTxBlock);
+  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) {
         return Reflect.get(vescaTxBlock, prop);
       } else if (prop in borrowIncentiveTxBlock) {
         return Reflect.get(borrowIncentiveTxBlock, prop);
+      } else if (prop in referralTxBlock) {
+        return Reflect.get(referralTxBlock, prop);
       } else if (prop in spoolTxBlock) {
         return Reflect.get(spoolTxBlock, prop);
       }

package/src/builders/referralBuilder.ts

@@ -0,0 +1,178 @@
+import { ScallopBuilder } from 'src/models';
+import { ScallopTxBlock, SupportCoins, SupportPoolCoins } from 'src/types';
+import {
+  SUI_CLOCK_OBJECT_ID,
+  SuiTxBlock as SuiKitTxBlock,
+  SuiObjectArg,
+  TransactionBlock,
+} from '@scallop-io/sui-kit';
+import {
+  GenerateReferralNormalMethod,
+  GenerateReferralQuickMethod,
+  ReferralIds,
+  ReferralTxBlock,
+  SuiTxBlockWithReferralNormalMethods,
+} from 'src/types/builder/referral';
+import { SUPPORT_POOLS } from 'src/constants';
+import { requireSender } from 'src/utils';
+
+const generateReferralNormalMethod: GenerateReferralNormalMethod = ({
+  builder,
+  txBlock,
+}) => {
+  const referralIds: ReferralIds = {
+    referralPgkId: builder.address.get('referral.id'),
+    referralBindings: builder.address.get('referral.referralBindings'),
+    referralRevenuePool: builder.address.get('referral.referralRevenuePool'),
+    authorizedWitnessList: builder.address.get(
+      'referral.authorizedWitnessList'
+    ),
+    referralTiers: builder.address.get('referral.referralTiers'),
+    version: builder.address.get('referral.version'),
+  };
+
+  const veScaTable = builder.address.get('vesca.table');
+
+  return {
+    bindToReferral: (veScaKeyId: string) => {
+      return txBlock.moveCall(
+        `${referralIds.referralPgkId}::referral_bindings::bind_ve_sca_referrer`,
+        [
+          referralIds.referralBindings,
+          txBlock.pure(veScaKeyId),
+          veScaTable,
+          SUI_CLOCK_OBJECT_ID,
+        ],
+        []
+      );
+    },
+    claimReferralTicket: (poolCoinName: SupportCoins) => {
+      const coinType = builder.utils.parseCoinType(poolCoinName);
+      return txBlock.moveCall(
+        `${referralIds.referralPgkId}::scallop_referral_program::claim_ve_sca_referral_ticket`,
+        [
+          referralIds.version,
+          veScaTable,
+          referralIds.referralBindings,
+          referralIds.authorizedWitnessList,
+          referralIds.referralTiers,
+          SUI_CLOCK_OBJECT_ID,
+        ],
+        [coinType]
+      );
+    },
+    burnReferralTicket: (ticket: SuiObjectArg, poolCoinName: SupportCoins) => {
+      const coinType = builder.utils.parseCoinType(poolCoinName);
+      return txBlock.moveCall(
+        `${referralIds.referralPgkId}::scallop_referral_program::burn_ve_sca_referral_ticket`,
+        [
+          referralIds.version,
+          ticket,
+          referralIds.referralRevenuePool,
+          SUI_CLOCK_OBJECT_ID,
+        ],
+        [coinType]
+      );
+    },
+    claimReferralRevenue: (
+      veScaKey: SuiObjectArg,
+      poolCoinName: SupportCoins
+    ) => {
+      const coinType = builder.utils.parseCoinType(poolCoinName);
+      return txBlock.moveCall(
+        `${referralIds.referralPgkId}::referral_revenue_pool::claim_revenue_with_ve_sca_key`,
+        [
+          referralIds.version,
+          referralIds.referralRevenuePool,
+          veScaKey,
+          SUI_CLOCK_OBJECT_ID,
+        ],
+        [coinType]
+      );
+    },
+  };
+};
+
+const generateReferralQuickMethod: GenerateReferralQuickMethod = ({
+  builder,
+  txBlock,
+}) => {
+  return {
+    claimReferralRevenueQuick: async (
+      veScaKey: SuiObjectArg,
+      coinNames: SupportPoolCoins[] = [...SUPPORT_POOLS]
+    ) => {
+      const sender = requireSender(txBlock);
+      const objToTransfer: SuiObjectArg[] = [];
+      for (const coinName of coinNames) {
+        if (coinName === 'sui') {
+          const rewardCoin = txBlock.claimReferralRevenue(veScaKey, coinName);
+          objToTransfer.push(rewardCoin);
+        } else {
+          // get the matching user coin if exists
+          const coins = await builder.suiKit.suiInteractor.selectCoins(
+            sender,
+            Infinity,
+            builder.utils.parseCoinType(coinName)
+          );
+
+          const rewardCoin = txBlock.claimReferralRevenue(veScaKey, coinName);
+          if (coins.length > 0) {
+            txBlock.mergeCoins(rewardCoin, coins);
+          }
+          objToTransfer.push(rewardCoin);
+        }
+      }
+      if (objToTransfer.length > 0) {
+        txBlock.transferObjects(objToTransfer, 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 borrow incentive txBlock.
+ */
+export const newReferralTxBlock = (
+  builder: ScallopBuilder,
+  initTxBlock?: ScallopTxBlock | SuiKitTxBlock | TransactionBlock
+) => {
+  const txBlock =
+    initTxBlock instanceof TransactionBlock
+      ? new SuiKitTxBlock(initTxBlock)
+      : initTxBlock
+      ? initTxBlock
+      : new SuiKitTxBlock();
+
+  const normalMethod = generateReferralNormalMethod({
+    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 SuiTxBlockWithReferralNormalMethods;
+
+  const quickMethod = generateReferralQuickMethod({
+    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 ReferralTxBlock;
+};

package/src/builders/vescaBuilder.ts

@@ -65,11 +65,7 @@ export const requireVeSca = async (
     return undefined;
   }
 
-  return veScas.reduce(
-    (prev, acc) =>
-      acc.currentVeScaBalance > prev.currentVeScaBalance ? acc : prev,
-    veScas[0]
-  ); // return veSCA with highest veSCA balance
+  return veScas[0]; // return veSCA with highest veSCA balance
 };
 
 /**
@@ -161,6 +157,13 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
         []
       );
     },
+    mintEmptyVeSca: () => {
+      return txBlock.moveCall(
+        `${veScaIds.pkgId}::ve_sca::mint_ve_sca_placeholder_key`,
+        [veScaIds.config, veScaIds.table],
+        []
+      );
+    },
   };
 };
 
@@ -378,7 +381,6 @@ export const newVeScaTxBlock = (
     },
   }) as SuiTxBlockWithVeScaNormalMethods;
 
-  // TODO: Add quickMethod for veSCA
   const quickMethod = generateQuickVeScaMethod({
     builder,
     txBlock: normalTxBlock,

package/src/constants/cache.ts

@@ -0,0 +1,15 @@
+import { QueryClientConfig } from '@tanstack/query-core';
+
+/**
+ * Default cache options for the QueryClient.
+ * @type {QueryClientConfig}
+ * @description Default cache options for the QueryClient
+ * We set the default to 5s to prevent duplicate requests from being requested (e.g. query MarketObject, etc.)
+ */
+export const DEFAULT_CACHE_OPTIONS: QueryClientConfig = {
+  defaultOptions: {
+    queries: {
+      staleTime: 3000,
+    },
+  },
+};

package/src/constants/common.ts

@@ -3,18 +3,25 @@ export const SDK_API_BASE_URL = 'https://sdk.api.scallop.io';
 
 export const IS_VE_SCA_TEST = false;
 
+// export const ADDRESSES_ID = '';
 export const ADDRESSES_ID = IS_VE_SCA_TEST
-  ? ('65fb07c39c845425d71d7b18' as const)
-  : ('6601955b8b0024600a917079' as const);
+  ? // ? ('65fb07c39c845425d71d7b18' as const)
+    ('65fb07c39c845425d71d7b18' as const)
+  : ('664dfe22898c36c159e28bc8' as const);
+// : ('6601955b8b0024600a917079' as const);
 // : ('6462a088a7ace142bb6d7e9b' as const);
 
 export const PROTOCOL_OBJECT_ID = IS_VE_SCA_TEST
   ? ('0xc9f859f98ca352a11b97a038c4b4162bee437b8df8caa047990fe9cb03d4f778' as const)
   : ('0xefe8b36d5b2e43728cc323298626b83177803521d195cfb11e15b910e892fddf' as const);
+// export const PROTOCOL_OBJECT_ID =
+//   '0x87ddec2984645dbbe2403a509cc6edf393a43acdba9b77d45da2bcbefcf733c1' as const;
 
 export const BORROW_FEE_PROTOCOL_ID = IS_VE_SCA_TEST
   ? ('0xc9f859f98ca352a11b97a038c4b4162bee437b8df8caa047990fe9cb03d4f778' as const)
   : ('0xc38f849e81cfe46d4e4320f508ea7dda42934a329d5a6571bb4c3cb6ea63f5da' as const); // test environment
+// export const BORROW_FEE_PROTOCOL_ID =
+//   '0x87ddec2984645dbbe2403a509cc6edf393a43acdba9b77d45da2bcbefcf733c1' as const;
 
 export const SCA_COIN_TYPE = IS_VE_SCA_TEST
   ? (`0x6cd813061a3adf3602b76545f076205f0c8e7ec1d3b1eab9a1da7992c18c0524::sca::SCA` as const)

package/src/constants/vesca.ts

@@ -1,7 +1,5 @@
-import { IS_VE_SCA_TEST } from './common';
-
 export const UNLOCK_ROUND_DURATION = 60 * 60 * 24; // 1 days in seconds
-export const MAX_LOCK_ROUNDS: number = IS_VE_SCA_TEST ? 9 : 1460; // 4 years in days (or 9 days for testing)
+export const MAX_LOCK_ROUNDS: number = 1460; // 4 years in days (or 9 days for testing)
 export const MAX_LOCK_DURATION: number =
   MAX_LOCK_ROUNDS * UNLOCK_ROUND_DURATION; // 4 years in seconds
 

package/src/models/index.ts

@@ -5,3 +5,4 @@ export * from './scallopBuilder';
 export * from './scallopQuery';
 export * from './scallopUtils';
 export * from './scallopIndexer';
+export * from './scallopCache';

package/src/models/scallop.ts

@@ -7,8 +7,14 @@ import { ScallopUtils } from './scallopUtils';
 import { ADDRESSES_ID } from '../constants';
 import type { ScallopParams } from '../types/';
 import { ScallopIndexer } from './scallopIndexer';
+import { ScallopCache } from './scallopCache';
+import { QueryClientConfig } from '@tanstack/query-core';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 
 /**
+ * @argument params - The parameters for the Scallop instance.
+ * @argument cacheOptions - The cache options for the QueryClient.
+ *
  * @description
  * The main instance that controls interaction with the Scallop contract.
  *
@@ -25,16 +31,24 @@ import { ScallopIndexer } from './scallopIndexer';
 export class Scallop {
   public params: ScallopParams;
   public suiKit: SuiKit;
+  public cache: ScallopCache;
 
   private _address: ScallopAddress;
 
-  public constructor(params: ScallopParams) {
+  public constructor(params: ScallopParams, cacheOptions?: QueryClientConfig) {
     this.params = params;
     this.suiKit = new SuiKit(params);
-    this._address = new ScallopAddress({
-      id: params?.addressesId || ADDRESSES_ID,
-      network: params?.networkType,
-    });
+    this.cache = new ScallopCache(
+      cacheOptions ?? DEFAULT_CACHE_OPTIONS,
+      this.suiKit
+    );
+    this._address = new ScallopAddress(
+      {
+        id: params?.addressesId || ADDRESSES_ID,
+        network: params?.networkType,
+      },
+      this.cache
+    );
   }
 
   /**
@@ -59,6 +73,7 @@ export class Scallop {
     const scallopBuilder = new ScallopBuilder(this.params, {
       suiKit: this.suiKit,
       address: this._address,
+      cache: this.cache,
     });
 
     return scallopBuilder;
@@ -74,7 +89,7 @@ export class Scallop {
     if (!this._address.getAddresses()) await this._address.read();
     const scallopClient = new ScallopClient(
       { ...this.params, walletAddress },
-      { suiKit: this.suiKit, address: this._address }
+      { suiKit: this.suiKit, address: this._address, cache: this.cache }
     );
 
     return scallopClient;
@@ -90,6 +105,7 @@ export class Scallop {
     const scallopQuery = new ScallopQuery(this.params, {
       suiKit: this.suiKit,
       address: this._address,
+      cache: this.cache,
     });
 
     return scallopQuery;
@@ -101,7 +117,9 @@ export class Scallop {
    * @return Scallop Indexer.
    */
   public async createScallopIndexer() {
-    const scallopIndexer = new ScallopIndexer();
+    const scallopIndexer = new ScallopIndexer(this.params, {
+      cache: this.cache,
+    });
 
     return scallopIndexer;
   }
@@ -116,6 +134,7 @@ export class Scallop {
     const scallopUtils = new ScallopUtils(this.params, {
       suiKit: this.suiKit,
       address: this._address,
+      cache: this.cache,
     });
 
     return scallopUtils;