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

package/src/builders/loyaltyProgramBuilder.ts

@@ -1,142 +0,0 @@
-import { Transaction } from '@mysten/sui/transactions';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import { ScallopBuilder } from 'src/models/index.js';
-import {
-  GenerateLoyaltyProgramNormalMethod,
-  GenerateLoyaltyProgramQuickMethod,
-  LoyaltyProgramTxBlock,
-  ScallopTxBlock,
-  SuiTxBlockWithLoyaltyProgramNormalMethods,
-} from 'src/types/index.js';
-import { requireSender } from 'src/utils/index.js';
-
-const generateLoyaltyProgramNormalMethod: GenerateLoyaltyProgramNormalMethod =
-  ({ builder, txBlock }) => {
-    const loyaltyProgramIds = {
-      pkgId: builder.address.get('loyaltyProgram.id'),
-      scaRewardPool: builder.address.get('loyaltyProgram.rewardPool'),
-    };
-
-    const veScaProgramIds = {
-      object: builder.address.get('vesca.object'),
-      protocolConfig: builder.address.get('vesca.config'),
-      veScaTable: builder.address.get('vesca.table'),
-      subsTable: builder.address.get('vesca.subsTable'),
-    };
-
-    const veScaLoyaltyProgramIds = {
-      pkgId: builder.address.get('veScaLoyaltyProgram.id'),
-      veScaRewardPool: builder.address.get(
-        'veScaLoyaltyProgram.veScaRewardPool'
-      ),
-    };
-
-    return {
-      claimLoyaltyRevenue: (veScaKey) => {
-        return builder.moveCall(
-          txBlock,
-          `${loyaltyProgramIds.pkgId}::reward_pool::redeem_reward`,
-          [loyaltyProgramIds.scaRewardPool, veScaKey]
-        );
-      },
-      claimVeScaLoyaltyReward: (veScaKey) => {
-        return builder.moveCall(
-          txBlock,
-          `${veScaLoyaltyProgramIds.pkgId}::ve_sca_reward::redeem_reward`,
-          [
-            veScaLoyaltyProgramIds.veScaRewardPool,
-            veScaKey,
-            veScaProgramIds.protocolConfig,
-            veScaProgramIds.veScaTable,
-            veScaProgramIds.subsTable,
-          ]
-        );
-      },
-    };
-  };
-
-const generateLoyaltyProgramQuickMethod: GenerateLoyaltyProgramQuickMethod = ({
-  builder,
-  txBlock,
-}) => {
-  return {
-    claimLoyaltyRevenueQuick: async (veScaKey) => {
-      veScaKey = veScaKey ?? (await builder.query.getVeScas())[0]?.keyId;
-      const sender = requireSender(txBlock);
-      if (!veScaKey) throw new Error(`No veScaKey found for user ${sender}`);
-
-      // claim the pending reward
-      const rewardCoin = txBlock.claimLoyaltyRevenue(veScaKey);
-
-      // get existing sca coin to merge with
-      const scaCoinType = builder.constants.coinTypes.sca;
-      if (!scaCoinType) throw new Error('Coin type sca not found');
-
-      await builder.utils.mergeSimilarCoins(
-        txBlock,
-        rewardCoin,
-        scaCoinType,
-        requireSender(txBlock)
-      );
-      txBlock.transferObjects([rewardCoin], sender);
-    },
-    claimVeScaLoyaltyRewardQuick: async (veScaKey) => {
-      veScaKey = veScaKey ?? (await builder.query.getVeScas())[0]?.keyId;
-      const sender = requireSender(txBlock);
-      if (!veScaKey) throw new Error(`No veScaKey found for user ${sender}`);
-
-      // claim the pending reward
-      const rewardVeScaKey = txBlock.claimVeScaLoyaltyReward(veScaKey);
-
-      // transfer the reward veSca key to the sender
-      txBlock.transferObjects([rewardVeScaKey], sender);
-    },
-  };
-};
-
-/**
- * Create an enhanced transaction block instance for interaction with loyalty program 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 | Transaction
-) => {
-  const txBlock =
-    initTxBlock instanceof Transaction
-      ? 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

@@ -1,192 +0,0 @@
-import { ScallopBuilder } from 'src/models/index.js';
-import { ScallopTxBlock } from 'src/types/index.js';
-import {
-  SUI_CLOCK_OBJECT_ID,
-  SuiTxBlock as SuiKitTxBlock,
-  SuiObjectArg,
-  Transaction,
-} from '@scallop-io/sui-kit';
-import {
-  GenerateReferralNormalMethod,
-  GenerateReferralQuickMethod,
-  ReferralIds,
-  ReferralTxBlock,
-  SuiTxBlockWithReferralNormalMethods,
-} from 'src/types/builder/referral.js';
-import { requireSender } from 'src/utils/index.js';
-
-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');
-  const clockObjectRef = txBlock.sharedObjectRef({
-    objectId: SUI_CLOCK_OBJECT_ID,
-    mutable: false,
-    initialSharedVersion: '1',
-  });
-
-  return {
-    bindToReferral: (veScaKeyId: string) => {
-      builder.moveCall(
-        txBlock,
-        `${referralIds.referralPgkId}::referral_bindings::bind_ve_sca_referrer`,
-        [
-          referralIds.referralBindings,
-          txBlock.pure.id(veScaKeyId),
-          veScaTable,
-          clockObjectRef,
-        ],
-        []
-      );
-    },
-    claimReferralTicket: (poolCoinName: string) => {
-      const coinType = builder.utils.parseCoinType(poolCoinName);
-      return builder.moveCall(
-        txBlock,
-        `${referralIds.referralPgkId}::scallop_referral_program::claim_ve_sca_referral_ticket`,
-        [
-          referralIds.version,
-          veScaTable,
-          referralIds.referralBindings,
-          referralIds.authorizedWitnessList,
-          referralIds.referralTiers,
-          clockObjectRef,
-        ],
-        [coinType]
-      );
-    },
-    burnReferralTicket: (ticket: SuiObjectArg, poolCoinName: string) => {
-      const coinType = builder.utils.parseCoinType(poolCoinName);
-      builder.moveCall(
-        txBlock,
-        `${referralIds.referralPgkId}::scallop_referral_program::burn_ve_sca_referral_ticket`,
-        [
-          referralIds.version,
-          ticket,
-          referralIds.referralRevenuePool,
-          clockObjectRef,
-        ],
-        [coinType]
-      );
-    },
-    claimReferralRevenue: (veScaKey: SuiObjectArg, poolCoinName: string) => {
-      const coinType = builder.utils.parseCoinType(poolCoinName);
-      return builder.moveCall(
-        txBlock,
-        `${referralIds.referralPgkId}::referral_revenue_pool::claim_revenue_with_ve_sca_key`,
-        [
-          referralIds.version,
-          referralIds.referralRevenuePool,
-          veScaKey,
-          clockObjectRef,
-        ],
-        [coinType]
-      );
-    },
-    unbindReferral: () => {
-      return builder.moveCall(
-        txBlock,
-        `${referralIds.referralPgkId}::referral_bindings::unbind_ve_sca_referrer`,
-        [referralIds.referralBindings]
-      );
-    },
-  };
-};
-
-const generateReferralQuickMethod: GenerateReferralQuickMethod = ({
-  builder,
-  txBlock,
-}) => {
-  return {
-    claimReferralRevenueQuick: async (
-      veScaKey: SuiObjectArg,
-      coinNames: string[] = [...builder.constants.whitelist.lending]
-    ) => {
-      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 {
-          const rewardCoin = txBlock.claimReferralRevenue(veScaKey, coinName);
-          try {
-            // get the matching user coin if exists
-            const coins = await builder.suiKit.suiInteractor.selectCoins(
-              sender,
-              Infinity,
-              builder.utils.parseCoinType(coinName)
-            );
-            txBlock.mergeCoins(rewardCoin, coins.slice(0, 500));
-          } catch (_e) {
-            // ignore
-          } finally {
-            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 referral txBlock.
- */
-export const newReferralTxBlock = (
-  builder: ScallopBuilder,
-  initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction
-) => {
-  const txBlock =
-    initTxBlock instanceof Transaction
-      ? 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/sCoinBuilder.ts

@@ -1,124 +0,0 @@
-import { Transaction, SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import { ScallopBuilder } from 'src/models/index.js';
-import {
-  BaseScallopTxBlock,
-  GenerateSCoinNormalMethod,
-  GenerateSCoinQuickMethod,
-  SCoinTxBlock,
-  ScallopTxBlock,
-  SuiTxBlockWithSCoinNormalMethods,
-  sCoinPkgIds,
-} from 'src/types/index.js';
-import { requireSender } from 'src/utils/index.js';
-
-const generateSCoinNormalMethod: GenerateSCoinNormalMethod = ({
-  builder,
-  txBlock,
-}) => {
-  const sCoinPkgIds: sCoinPkgIds = {
-    pkgId: builder.address.get('scoin.id'),
-  };
-
-  return {
-    mintSCoin: (marketCoinName, marketCoin) => {
-      const sCoinType = builder.utils.parseSCoinType(marketCoinName);
-      if (!sCoinType)
-        throw new Error(`Invalid marketCoinName name: ${marketCoinName}`);
-
-      return builder.moveCall(
-        txBlock,
-        `${sCoinPkgIds.pkgId}::s_coin_converter::mint_s_coin`,
-        [builder.utils.getSCoinTreasury(marketCoinName), marketCoin],
-        [sCoinType, builder.utils.parseUnderlyingSCoinType(marketCoinName)]
-      );
-    },
-    burnSCoin: (sCoinName, sCoin) => {
-      const sCoinType = builder.utils.parseSCoinType(sCoinName);
-      if (!sCoinType) throw new Error(`Invalid sCoin name: ${sCoinName}`);
-
-      return builder.moveCall(
-        txBlock,
-        `${sCoinPkgIds.pkgId}::s_coin_converter::burn_s_coin`,
-        [builder.utils.getSCoinTreasury(sCoinName), sCoin],
-        [sCoinType, builder.utils.parseUnderlyingSCoinType(sCoinName)]
-      );
-    },
-  };
-};
-
-const generateSCoinQuickMethod: GenerateSCoinQuickMethod = ({
-  builder,
-  txBlock,
-}) => {
-  return {
-    mintSCoinQuick: async (marketCoinName, amount) => {
-      const sender = requireSender(txBlock);
-      const { leftCoin, takeCoin } = await builder.selectMarketCoin(
-        txBlock,
-        marketCoinName,
-        amount,
-        sender
-      );
-
-      txBlock.transferObjects([leftCoin], sender);
-      return txBlock.mintSCoin(marketCoinName, takeCoin);
-    },
-    burnSCoinQuick: async (sCoinName, amount) => {
-      const sender = requireSender(txBlock);
-      const { leftCoin, takeCoin } = await builder.selectSCoin(
-        txBlock,
-        sCoinName,
-        amount,
-        sender
-      );
-
-      txBlock.transferObjects([leftCoin], sender);
-      return txBlock.burnSCoin(sCoinName, takeCoin);
-    },
-  };
-};
-
-export const newSCoinTxBlock = (
-  builder: ScallopBuilder,
-  initTxBlock?:
-    | ScallopTxBlock
-    | SuiKitTxBlock
-    | Transaction
-    | BaseScallopTxBlock
-) => {
-  const txBlock =
-    initTxBlock instanceof Transaction
-      ? new SuiKitTxBlock(initTxBlock)
-      : initTxBlock
-        ? initTxBlock
-        : new SuiKitTxBlock();
-
-  const normalMethod = generateSCoinNormalMethod({
-    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 SuiTxBlockWithSCoinNormalMethods;
-
-  const quickMethod = generateSCoinQuickMethod({
-    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 SCoinTxBlock;
-};

package/src/index.ts

@@ -1,13 +0,0 @@
-export * from './constants/index.js';
-export {
-  Scallop,
-  ScallopConstants,
-  ScallopAddress,
-  ScallopBuilder,
-  ScallopQuery,
-  ScallopSuiKit,
-  ScallopClient,
-  ScallopIndexer,
-  ScallopUtils,
-} from './models/index.js';
-export type * from './types/index.js';