@scallop-io/sui-scallop-sdk 3.0.2 → 4.1.0

package/src/txBuilders/vesca/moveCalls.ts

@@ -0,0 +1,147 @@
+import { SUI_CLOCK_OBJECT_ID } from '@scallop-io/sui-kit';
+import type {
+  AddressesInterface,
+  GenerateVeScaNormalMethod,
+} from 'src/types/index.js';
+
+type VeScaProps = 'id' | 'table' | 'treasury' | 'config' | 'subsTable';
+
+/**
+ * Generate veSCA normal methods.
+ *
+ * @param ctx - Pure Move-call context (address reads, coin-type parsing, moveCall).
+ * @param txBlock - TxBlock created by SuiKit .
+ * @return veSCA normal methods.
+ */
+export const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
+  ctx,
+  txBlock,
+}) => {
+  const veScaIds: Pick<AddressesInterface['vesca'], VeScaProps> = {
+    id: ctx.address.get('vesca.id'),
+    table: ctx.address.get('vesca.table'),
+    treasury: ctx.address.get('vesca.treasury'),
+    config: ctx.address.get('vesca.config'),
+    subsTable: ctx.address.get('vesca.subsTable'),
+  };
+
+  const clockObjectRef = txBlock.sharedObjectRef({
+    objectId: SUI_CLOCK_OBJECT_ID,
+    mutable: false,
+    initialSharedVersion: '1',
+  });
+
+  return {
+    lockSca: (scaCoin, unlockAtInSecondTimestamp) => {
+      return ctx.moveCall(
+        txBlock,
+        `${veScaIds.id}::ve_sca::mint_ve_sca_key`,
+        [
+          veScaIds.config,
+          veScaIds.table,
+          veScaIds.treasury,
+          scaCoin,
+          unlockAtInSecondTimestamp,
+          clockObjectRef,
+        ],
+        []
+      );
+    },
+    extendLockPeriod: (veScaKey, newUnlockAtInSecondTimestamp) => {
+      ctx.moveCall(
+        txBlock,
+        `${veScaIds.id}::ve_sca::extend_lock_period`,
+        [
+          veScaIds.config,
+          veScaKey,
+          veScaIds.table,
+          veScaIds.treasury,
+          newUnlockAtInSecondTimestamp,
+          clockObjectRef,
+        ],
+        []
+      );
+    },
+    extendLockAmount: (veScaKey, scaCoin) => {
+      ctx.moveCall(
+        txBlock,
+        `${veScaIds.id}::ve_sca::lock_more_sca`,
+        [
+          veScaIds.config,
+          veScaKey,
+          veScaIds.table,
+          veScaIds.treasury,
+          scaCoin,
+          clockObjectRef,
+        ],
+        []
+      );
+    },
+    renewExpiredVeSca: (veScaKey, scaCoin, newUnlockAtInSecondTimestamp) => {
+      ctx.moveCall(
+        txBlock,
+        `${veScaIds.id}::ve_sca::renew_expired_ve_sca`,
+        [
+          veScaIds.config,
+          veScaKey,
+          veScaIds.table,
+          veScaIds.treasury,
+          scaCoin,
+          newUnlockAtInSecondTimestamp,
+          clockObjectRef,
+        ],
+        []
+      );
+    },
+    redeemSca: (veScaKey) => {
+      return ctx.moveCall(
+        txBlock,
+        `${veScaIds.id}::ve_sca::redeem`,
+        [
+          veScaIds.config,
+          veScaKey,
+          veScaIds.table,
+          veScaIds.treasury,
+          clockObjectRef,
+        ],
+        []
+      );
+    },
+    mintEmptyVeSca: () => {
+      return ctx.moveCall(
+        txBlock,
+        `${veScaIds.id}::ve_sca::mint_ve_sca_placeholder_key`,
+        [veScaIds.config, veScaIds.table],
+        []
+      );
+    },
+    splitVeSca: (veScaKey, splitAmount) => {
+      return ctx.moveCall(txBlock, `${veScaIds.id}::ve_sca::split`, [
+        veScaIds.config,
+        veScaKey,
+        veScaIds.table,
+        veScaIds.subsTable,
+        txBlock.pure.u64(splitAmount),
+      ]);
+    },
+    mergeVeSca: (targetKey, sourceKey) => {
+      return ctx.moveCall(
+        txBlock,
+        `${veScaIds.id}::ve_sca::merge`,
+        [
+          veScaIds.config,
+          targetKey,
+          sourceKey,
+          veScaIds.table,
+          veScaIds.subsTable,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
+        ],
+        []
+      );
+    },
+  };
+};

package/src/{builders/vescaBuilder.ts → txBuilders/vesca/quick.ts}

@@ -1,12 +1,5 @@
-import {
-  SUI_CLOCK_OBJECT_ID,
-  SuiTxBlock,
-  Transaction,
-  SuiTxBlock as SuiKitTxBlock,
-} from '@scallop-io/sui-kit';
+import { SuiTxBlock } from '@scallop-io/sui-kit';
 import { SCA_COIN_TYPE } from 'src/constants/index.js';
-import { ScallopBuilder } from 'src/models/index.js';
-import { getVeSca, getVeScas } from 'src/queries/index.js';
 import {
   requireSender,
   checkLockSca,
@@ -15,25 +8,38 @@ import {
   checkRenewExpiredVeSca,
   checkVesca,
   getMoveCallTarget,
-  parseObjectAs,
-} from 'src/utils/index.js';
+} from '../../utils/builder.js';
 import type {
   TransactionObjectArgument,
   SuiObjectArg,
 } from '@scallop-io/sui-kit';
+import type { ScallopAddress, ScallopBuilder } from 'src/models/index.js';
 import type {
-  AddressesInterface,
-  DynamicFieldResponseWithContents,
-  GenerateVeScaNormalMethod,
   GenerateVeScaQuickMethod,
   QuickMethodReturnType,
-  ScallopTxBlock,
-  SuiTxBlockWithVeScaNormalMethods,
   TransactionCommand,
-  VeScaTxBlock,
 } from 'src/types/index.js';
 import type { SuiObjectData } from 'src/types/index.js';
 
+/**
+ * The explicit orchestration toolkit a veSCA quick method needs.
+ *
+ * @description
+ * Narrow context injected into {@link generateQuickVeScaMethod}. Built once from
+ * `builder` in the factory and passed (instead of `builder`) into the quick
+ * generator. Method signatures are taken via indexed-access types so they stay
+ * in sync with `ScallopBuilder`.
+ */
+export type VeScaActionContext = {
+  address: Pick<ScallopAddress, 'get'>;
+  utils: ScallopBuilder['utils'];
+  reads: {
+    getVeSca: ScallopBuilder['query']['getVeSca'];
+    getVeScas: ScallopBuilder['query']['getVeScas'];
+    isVeScaKeyInSubsTable: ScallopBuilder['query']['repos']['veSca']['isVeScaKeyInSubsTable'];
+  };
+};
+
 /**
  * Check and get veSCA data from transaction block.
  *
@@ -41,7 +47,7 @@ import type { SuiObjectData } from 'src/types/index.js';
  * If the veScaKey id is provided, directly return it.
  * Otherwise, automatically get veScaKey from the sender.
  *
- * @param builder - Scallop builder instance.
+ * @param ctx - veSCA action context (provides `reads.getVeSca` / `reads.getVeScas`).
  * @param txBlock - TxBlock created by SuiKit.
  * @param veScaKey - veSCA key.
  * @return veSCA key, ID, locked amount and unlock at timestamp.
@@ -49,14 +55,14 @@ import type { SuiObjectData } from 'src/types/index.js';
 
 export const requireVeSca = async (
   ...params: [
-    builder: ScallopBuilder,
+    ctx: VeScaActionContext,
     SuiTxBlock: SuiTxBlock,
     veScaKey?: SuiObjectData | string,
   ]
 ) => {
-  const [builder, txBlock, veScaKey] = params;
+  const [ctx, txBlock, veScaKey] = params;
   if (params.length === 3 && veScaKey && typeof veScaKey !== 'undefined') {
-    const veSca = await getVeSca(builder.utils, veScaKey);
+    const veSca = await ctx.reads.getVeSca(veScaKey);
 
     if (!veSca) {
       return undefined;
@@ -66,7 +72,7 @@ export const requireVeSca = async (
   }
 
   const sender = requireSender(txBlock);
-  const veScas = await getVeScas(builder, sender);
+  const veScas = await ctx.reads.getVeScas({ walletAddress: sender });
   if (veScas.length === 0) {
     return undefined;
   }
@@ -82,172 +88,21 @@ export const requireVeSca = async (
 };
 
 export const isInSubsTable = async (
-  ...params: [builder: ScallopBuilder, veScaKey: string, tableId: string]
+  ...params: [ctx: VeScaActionContext, veScaKey: string, tableId: string]
 ) => {
-  const [builder, veScaKey, tableId] = params;
+  const [ctx, veScaKey, tableId] = params;
   try {
-    const resp = (await builder.scallopSuiKit.queryGetDynamicFieldObject({
-      parentId: tableId,
-      name: {
-        type: '0x2::object::ID',
-        value: veScaKey,
-      },
-    })) as DynamicFieldResponseWithContents;
-
-    if (!resp?.object?.json) return false;
-
-    const value = parseObjectAs<{ contents?: unknown[] }>(
-      resp.object as SuiObjectData
-    );
-    return Array.isArray(value?.contents) && value.contents.length > 0;
+    return await ctx.reads.isVeScaKeyInSubsTable(veScaKey, tableId);
   } catch (e) {
-    console.error(e);
+    ctx.utils.logger.error('isInSubsTable lookup failed', {
+      veScaKey,
+      tableId,
+      message: (e as Error)?.message,
+    });
     return false;
   }
 };
 
-type VeScaProps = 'id' | 'table' | 'treasury' | 'config' | 'subsTable';
-
-/**
- * Generate veSCA normal methods.
- *
- * @param builder - Scallop builder instance.
- * @param txBlock - TxBlock created by SuiKit .
- * @return veSCA normal methods.
- */
-const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
-  builder,
-  txBlock,
-}) => {
-  const veScaIds: Pick<AddressesInterface['vesca'], VeScaProps> = {
-    id: builder.address.get('vesca.id'),
-    table: builder.address.get('vesca.table'),
-    treasury: builder.address.get('vesca.treasury'),
-    config: builder.address.get('vesca.config'),
-    subsTable: builder.address.get('vesca.subsTable'),
-  };
-
-  const clockObjectRef = txBlock.sharedObjectRef({
-    objectId: SUI_CLOCK_OBJECT_ID,
-    mutable: false,
-    initialSharedVersion: '1',
-  });
-
-  return {
-    lockSca: (scaCoin, unlockAtInSecondTimestamp) => {
-      return builder.moveCall(
-        txBlock,
-        `${veScaIds.id}::ve_sca::mint_ve_sca_key`,
-        [
-          veScaIds.config,
-          veScaIds.table,
-          veScaIds.treasury,
-          scaCoin,
-          unlockAtInSecondTimestamp,
-          clockObjectRef,
-        ],
-        []
-      );
-    },
-    extendLockPeriod: (veScaKey, newUnlockAtInSecondTimestamp) => {
-      builder.moveCall(
-        txBlock,
-        `${veScaIds.id}::ve_sca::extend_lock_period`,
-        [
-          veScaIds.config,
-          veScaKey,
-          veScaIds.table,
-          veScaIds.treasury,
-          newUnlockAtInSecondTimestamp,
-          clockObjectRef,
-        ],
-        []
-      );
-    },
-    extendLockAmount: (veScaKey, scaCoin) => {
-      builder.moveCall(
-        txBlock,
-        `${veScaIds.id}::ve_sca::lock_more_sca`,
-        [
-          veScaIds.config,
-          veScaKey,
-          veScaIds.table,
-          veScaIds.treasury,
-          scaCoin,
-          clockObjectRef,
-        ],
-        []
-      );
-    },
-    renewExpiredVeSca: (veScaKey, scaCoin, newUnlockAtInSecondTimestamp) => {
-      builder.moveCall(
-        txBlock,
-        `${veScaIds.id}::ve_sca::renew_expired_ve_sca`,
-        [
-          veScaIds.config,
-          veScaKey,
-          veScaIds.table,
-          veScaIds.treasury,
-          scaCoin,
-          newUnlockAtInSecondTimestamp,
-          clockObjectRef,
-        ],
-        []
-      );
-    },
-    redeemSca: (veScaKey) => {
-      return builder.moveCall(
-        txBlock,
-        `${veScaIds.id}::ve_sca::redeem`,
-        [
-          veScaIds.config,
-          veScaKey,
-          veScaIds.table,
-          veScaIds.treasury,
-          clockObjectRef,
-        ],
-        []
-      );
-    },
-    mintEmptyVeSca: () => {
-      return builder.moveCall(
-        txBlock,
-        `${veScaIds.id}::ve_sca::mint_ve_sca_placeholder_key`,
-        [veScaIds.config, veScaIds.table],
-        []
-      );
-    },
-    splitVeSca: (veScaKey, splitAmount) => {
-      return builder.moveCall(txBlock, `${veScaIds.id}::ve_sca::split`, [
-        veScaIds.config,
-        veScaKey,
-        veScaIds.table,
-        veScaIds.subsTable,
-        txBlock.pure.u64(splitAmount),
-      ]);
-    },
-    mergeVeSca: (targetKey, sourceKey) => {
-      return builder.moveCall(
-        txBlock,
-        `${veScaIds.id}::ve_sca::merge`,
-        [
-          veScaIds.config,
-          targetKey,
-          sourceKey,
-          veScaIds.table,
-          veScaIds.subsTable,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
-        ],
-        []
-      );
-    },
-  };
-};
-
 /**
  * Generate veSCA quick methods.
  *
@@ -256,12 +111,12 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
  * help users organize transaction blocks, include get veSca info, and transfer
  * coins to the sender. So, they are all asynchronous methods.
  *
- * @param builder - Scallop builder instance.
+ * @param ctx - veSCA action context (address, utils, reads).
  * @param txBlock - TxBlock created by SuiKit .
  * @return veSCA quick methods.
  */
-const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
-  builder,
+export const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
+  ctx,
   txBlock,
 }) => {
   return {
@@ -272,17 +127,33 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
       veScaKey,
     }) => {
       const sender = requireSender(txBlock);
-      const veSca = await requireVeSca(builder, txBlock, veScaKey);
+      const veSca = await requireVeSca(ctx, txBlock, veScaKey);
+
+      const newUnlockAt = ctx.utils.getUnlockAt(
+        lockPeriodInDays,
+        veSca?.unlockAt
+      );
+
+      // Validate before side effects (coin selection) so input-shape errors
+      // surface as the documented validation error, not a downstream
+      // "No valid coins" from selectCoins.
+      if (autoCheck)
+        checkLockSca(
+          amountOrCoin,
+          lockPeriodInDays,
+          newUnlockAt,
+          veSca?.unlockAt
+        );
 
       let scaCoin: TransactionObjectArgument | SuiObjectArg | undefined =
         undefined;
       const transferObjects = [];
       if (amountOrCoin !== undefined && typeof amountOrCoin === 'number') {
-        const coins = await builder.utils.selectCoins(
-          amountOrCoin,
-          SCA_COIN_TYPE,
-          sender
-        );
+        const coins = await ctx.utils.selectCoins({
+          amount: amountOrCoin,
+          coinType: SCA_COIN_TYPE,
+          ownerAddress: sender,
+        });
         const [takeCoin, leftCoin] = txBlock.takeAmountFromCoins(
           coins,
           amountOrCoin
@@ -294,19 +165,6 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
         scaCoin = amountOrCoin;
       }
 
-      const newUnlockAt = builder.utils.getUnlockAt(
-        lockPeriodInDays,
-        veSca?.unlockAt
-      );
-
-      if (autoCheck)
-        checkLockSca(
-          amountOrCoin,
-          lockPeriodInDays,
-          newUnlockAt,
-          veSca?.unlockAt
-        );
-
       const isInitialLock = !veSca;
       const isLockExpired =
         !isInitialLock && veSca.unlockAt <= new Date().getTime();
@@ -345,8 +203,8 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
       veScaKey,
       autoCheck = true,
     }) => {
-      const veSca = await requireVeSca(builder, txBlock, veScaKey);
-      const newUnlockAt = builder.utils.getUnlockAt(
+      const veSca = await requireVeSca(ctx, txBlock, veScaKey);
+      const newUnlockAt = ctx.utils.getUnlockAt(
         lockPeriodInDays,
         veSca?.unlockAt
       );
@@ -364,16 +222,16 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
       autoCheck = true,
     }) => {
       const sender = requireSender(txBlock);
-      const veSca = await requireVeSca(builder, txBlock, veScaKey);
+      const veSca = await requireVeSca(ctx, txBlock, veScaKey);
 
       if (autoCheck) checkExtendLockAmount(scaAmount, veSca?.unlockAt);
 
       if (veSca) {
-        const scaCoins = await builder.utils.selectCoins(
-          scaAmount,
-          SCA_COIN_TYPE,
-          sender
-        );
+        const scaCoins = await ctx.utils.selectCoins({
+          amount: scaAmount,
+          coinType: SCA_COIN_TYPE,
+          ownerAddress: sender,
+        });
         const [takeCoin, leftCoin] = txBlock.takeAmountFromCoins(
           scaCoins,
           scaAmount
@@ -390,9 +248,9 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
       autoCheck = true,
     }) => {
       const sender = requireSender(txBlock);
-      const veSca = await requireVeSca(builder, txBlock, veScaKey);
+      const veSca = await requireVeSca(ctx, txBlock, veScaKey);
 
-      const newUnlockAt = builder.utils.getUnlockAt(
+      const newUnlockAt = ctx.utils.getUnlockAt(
         lockPeriodInDays,
         veSca?.unlockAt
       );
@@ -405,11 +263,11 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
           const unlockedSca = txBlock.redeemSca(veSca.keyId);
           transferObjects.push(unlockedSca);
         }
-        const scaCoins = await builder.utils.selectCoins(
-          scaAmount,
-          SCA_COIN_TYPE,
-          sender
-        );
+        const scaCoins = await ctx.utils.selectCoins({
+          amount: scaAmount,
+          coinType: SCA_COIN_TYPE,
+          ownerAddress: sender,
+        });
         const [takeCoin, leftCoin] = txBlock.takeAmountFromCoins(
           scaCoins,
           scaAmount
@@ -428,7 +286,7 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
       transferSca?: T;
     }) => {
       const sender = requireSender(txBlock);
-      const veSca = await requireVeSca(builder, txBlock, veScaKey);
+      const veSca = await requireVeSca(ctx, txBlock, veScaKey);
 
       checkVesca(veSca?.unlockAt);
 
@@ -451,9 +309,9 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
       transferVeScaKey?: S;
     }) => {
       const isKeyInSubTable = await isInSubsTable(
-        builder,
+        ctx,
         veScaKey,
-        builder.address.get('vesca.subsTable')
+        ctx.address.get('vesca.subsTable')
       );
 
       const unstakeObligationBeforeStake = !!txBlock.txBlock
@@ -462,7 +320,7 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
           (txn: TransactionCommand) =>
             txn.$kind === 'MoveCall' &&
             getMoveCallTarget(txn) ===
-              `${builder.address.get('borrowIncentive.id')}::user::unstake_v2`
+              `${ctx.address.get('borrowIncentive.id')}::user::unstake_v2`
         );
 
       if (isKeyInSubTable && !unstakeObligationBeforeStake) {
@@ -481,10 +339,10 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
     },
     mergeVeScaQuick: async ({ targetVeScaKey, sourceVeScaKey }) => {
       // check targetKey and sourceKey
-      const table = builder.address.get('vesca.subsTableId');
+      const table = ctx.address.get('vesca.subsTableId');
       const [isTargetInSubTable, isSourceInSubTable] = await Promise.all([
-        isInSubsTable(builder, targetVeScaKey, table),
-        isInSubsTable(builder, sourceVeScaKey, table),
+        isInSubsTable(ctx, targetVeScaKey, table),
+        isInSubsTable(ctx, sourceVeScaKey, table),
       ]);
 
       const unstakeObligationBeforeStake = !!txBlock.txBlock
@@ -493,7 +351,7 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
           (txn: TransactionCommand) =>
             txn.$kind === 'MoveCall' &&
             getMoveCallTarget(txn) ===
-              `${builder.address.get('borrowIncentive.id')}::user::unstake_v2`
+              `${ctx.address.get('borrowIncentive.id')}::user::unstake_v2`
         );
 
       if (
@@ -506,8 +364,8 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
       }
 
       const [sourceVesca, targetVesca] = await Promise.all([
-        getVeSca(builder.utils, sourceVeScaKey),
-        getVeSca(builder.utils, targetVeScaKey),
+        ctx.reads.getVeSca(sourceVeScaKey),
+        ctx.reads.getVeSca(targetVeScaKey),
       ]);
 
       if (!sourceVesca || !targetVesca) {
@@ -531,50 +389,3 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
     },
   };
 };
-
-/**
- * Create an enhanced transaction block instance for interaction with veSCA 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 newVeScaTxBlock = (
-  builder: ScallopBuilder,
-  initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction
-) => {
-  const txBlock =
-    initTxBlock instanceof Transaction
-      ? new SuiKitTxBlock(initTxBlock)
-      : initTxBlock
-        ? initTxBlock
-        : new SuiKitTxBlock();
-
-  const normalMethod = generateNormalVeScaMethod({
-    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 SuiTxBlockWithVeScaNormalMethods;
-
-  const quickMethod = generateQuickVeScaMethod({
-    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 VeScaTxBlock;
-};