@scallop-io/sui-scallop-sdk 0.46.54 → 0.46.56

package/src/builders/coreBuilder.ts

@@ -44,7 +44,7 @@ const requireObligationInfo = async (
   if (params.length === 4 && obligationId && obligationKey)
     return { obligationId, obligationKey };
   const sender = requireSender(txBlock);
-  const obligations = await getObligations(builder.query, sender);
+  const obligations = await getObligations(builder, sender);
   if (obligations.length === 0) {
     throw new Error(`No obligation found for sender ${sender}`);
   }
@@ -391,10 +391,11 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
         obligationId,
         obligationKey
       );
-      const obligationCoinNames = await builder.utils.getObligationCoinNames(
-        obligationInfo.obligationId
-      );
-      const updateCoinNames = [...obligationCoinNames, poolCoinName];
+      const obligationCoinNames =
+        (await builder.utils.getObligationCoinNames(
+          obligationInfo.obligationId
+        )) ?? [];
+      const updateCoinNames = [...(obligationCoinNames ?? []), poolCoinName];
       await updateOracles(builder, txBlock, updateCoinNames);
       return txBlock.borrow(
         obligationInfo.obligationId,
@@ -416,9 +417,10 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
         obligationId,
         obligationKey
       );
-      const obligationCoinNames = await builder.utils.getObligationCoinNames(
-        obligationInfo.obligationId
-      );
+      const obligationCoinNames =
+        (await builder.utils.getObligationCoinNames(
+          obligationInfo.obligationId
+        )) ?? [];
       const updateCoinNames = [...obligationCoinNames, poolCoinName];
       await updateOracles(builder, txBlock, updateCoinNames);
       return txBlock.borrowWithReferral(

package/src/builders/loyaltyProgramBuilder.ts

@@ -1,5 +1,5 @@
 import { TransactionBlock } from '@mysten/sui.js/transactions';
-import { SuiObjectArg, SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import { coinIds } from 'src/constants';
 import { ScallopBuilder } from 'src/models';
 import {
@@ -43,7 +43,6 @@ const generateLoyaltyProgramQuickMethod: GenerateLoyaltyProgramQuickMethod = ({
       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
@@ -53,10 +52,7 @@ const generateLoyaltyProgramQuickMethod: GenerateLoyaltyProgramQuickMethod = ({
         coinIds.sca,
         requireSender(txBlock)
       );
-
-      if (toTransferObject.length > 0) {
-        txBlock.transferObjects(toTransferObject, sender);
-      }
+      txBlock.transferObjects([rewardCoin], sender);
     },
   };
 };

package/src/builders/spoolBuilder.ts

@@ -42,7 +42,7 @@ const requireStakeAccountIds = async (
   const [builder, txBlock, stakeMarketCoinName, stakeAccountId] = params;
   if (params.length === 4 && stakeAccountId) return [stakeAccountId];
   const sender = requireSender(txBlock);
-  const stakeAccounts = await getStakeAccounts(builder.query, sender);
+  const stakeAccounts = await getStakeAccounts(builder, sender);
   if (stakeAccounts[stakeMarketCoinName].length === 0) {
     throw new Error(`No stake account id found for sender ${sender}`);
   }
@@ -72,7 +72,7 @@ const requireStakeAccounts = async (
 ) => {
   const [builder, txBlock, stakeMarketCoinName, stakeAccountId] = params;
   const sender = requireSender(txBlock);
-  const stakeAccounts = await getStakeAccounts(builder.query, sender);
+  const stakeAccounts = await getStakeAccounts(builder, sender);
   if (stakeAccounts[stakeMarketCoinName].length === 0) {
     throw new Error(`No stake account found for sender ${sender}`);
   }

package/src/builders/vescaBuilder.ts

@@ -22,6 +22,7 @@ import type {
 import type {
   GenerateVeScaNormalMethod,
   GenerateVeScaQuickMethod,
+  RedeemScaQuickReturnType,
   ScallopTxBlock,
   SuiTxBlockWithVeScaNormalMethods,
   VeScaTxBlock,
@@ -50,7 +51,7 @@ export const requireVeSca = async (
 ) => {
   const [builder, txBlock, veScaKey] = params;
   if (params.length === 3 && veScaKey && typeof veScaKey === 'string') {
-    const veSca = await getVeSca(builder.query, veScaKey);
+    const veSca = await getVeSca(builder.utils, veScaKey);
 
     if (!veSca) {
       return undefined;
@@ -60,7 +61,7 @@ export const requireVeSca = async (
   }
 
   const sender = requireSender(txBlock);
-  const veScas = await getVeScas(builder.query, sender);
+  const veScas = await getVeScas(builder, sender);
   if (veScas.length === 0) {
     return undefined;
   }
@@ -334,7 +335,10 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
         txBlock.transferObjects(transferObjects, sender);
       }
     },
-    redeemScaQuick: async (veScaKey?: SuiObjectArg) => {
+    redeemScaQuick: async <S extends boolean>(
+      veScaKey?: SuiObjectArg,
+      transferSca: S = true as S
+    ) => {
       const sender = requireSender(txBlock);
       const veSca = await requireVeSca(builder, txBlock, veScaKey);
 
@@ -342,7 +346,11 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
 
       if (veSca) {
         const sca = txBlock.redeemSca(veSca.keyId);
-        txBlock.transferObjects([sca], sender);
+        if (transferSca) {
+          txBlock.transferObjects([sca], sender);
+          return;
+        }
+        return sca as RedeemScaQuickReturnType<S>;
       }
     },
   };

package/src/constants/common.ts

@@ -83,6 +83,8 @@ export const SUPPORT_SCOIN = [
   'seth',
   'ssca',
   'scetus',
+  'ssol',
+  'sbtc',
 ] as const;
 
 export const SUPPORT_SPOOLS_REWARDS = ['sui'] as const;

package/src/constants/enum.ts

@@ -68,6 +68,8 @@ export const sCoins: types.SCoins = {
   shasui: 'shasui',
   svsui: 'svsui',
   ssca: 'ssca',
+  ssol: 'ssol',
+  sbtc: 'sbtc',
 };
 
 export const stakeMarketCoins: types.StakeMarketCoins = {
@@ -150,6 +152,8 @@ export const sCoinIds: types.SCoinIds = {
     '0x9a2376943f7d22f88087c259c5889925f332ca4347e669dc37d54c2bf651af3c::scallop_ha_sui::SCALLOP_HA_SUI',
   svsui:
     '0xe1a1cc6bcf0001a015eab84bcc6713393ce20535f55b8b6f35c142e057a25fbe::scallop_v_sui::SCALLOP_V_SUI',
+  ssol: '0x1392650f2eca9e3f6ffae3ff89e42a3590d7102b80e2b430f674730bc30d3259::scallop_wormhole_sol::SCALLOP_WORMHOLE_SOL',
+  sbtc: '0x2cf76a9cf5d3337961d1154283234f94da2dcff18544dfe5cbdef65f319591b5::scallop_wormhole_btc::SCALLOP_WORMHOLE_BTC',
 } as const;
 
 // TEST VERSION

package/src/constants/pyth.ts

@@ -1,6 +1,6 @@
 export const PYTH_ENDPOINTS: {
-  [k in 'mainnet' | 'testnet']: Readonly<string[]>;
+  [k in 'mainnet' | 'testnet']: string[];
 } = {
   testnet: ['https://hermes-beta.pyth.network'],
   mainnet: ['https://hermes.pyth.network', 'https://scallop.rpc.p2p.world'],
-} as const;
+};

package/src/models/scallop.ts

@@ -38,7 +38,7 @@ export class Scallop {
   public suiKit: SuiKit;
   public cache: ScallopCache;
 
-  private _address: ScallopAddress;
+  private address: ScallopAddress;
 
   public constructor(
     params: ScallopParams,
@@ -48,17 +48,17 @@ export class Scallop {
     this.params = params;
     this.suiKit = new SuiKit(params);
     this.cache = new ScallopCache(
-      cacheOptions ?? DEFAULT_CACHE_OPTIONS,
       this.suiKit,
+      cacheOptions ?? DEFAULT_CACHE_OPTIONS,
       tokenBucket ??
         new TokenBucket(DEFAULT_TOKENS_PER_INTERVAL, DEFAULT_INTERVAL_IN_MS)
     );
-    this._address = new ScallopAddress(
+    this.address = new ScallopAddress(
       {
         id: params?.addressesId || ADDRESSES_ID,
         network: params?.networkType,
       },
-      this.cache
+      { cache: this.cache }
     );
   }
 
@@ -69,9 +69,9 @@ export class Scallop {
    * @return Scallop Address.
    */
   public async getScallopAddress(id?: string) {
-    await this._address.read(id);
+    await this.address.read(id);
 
-    return this._address;
+    return this.address;
   }
 
   /**
@@ -80,11 +80,9 @@ export class Scallop {
    * @return Scallop Builder.
    */
   public async createScallopBuilder() {
-    if (!this._address.getAddresses()) await this._address.read();
+    if (!this.address.getAddresses()) await this.address.read();
     const scallopBuilder = new ScallopBuilder(this.params, {
-      suiKit: this.suiKit,
-      address: this._address,
-      cache: this.cache,
+      query: await this.createScallopQuery(),
     });
 
     return scallopBuilder;
@@ -97,10 +95,10 @@ export class Scallop {
    * @return Scallop Client.
    */
   public async createScallopClient(walletAddress?: string) {
-    if (!this._address.getAddresses()) await this._address.read();
+    if (!this.address.getAddresses()) await this.address.read();
     const scallopClient = new ScallopClient(
       { ...this.params, walletAddress },
-      { suiKit: this.suiKit, address: this._address, cache: this.cache }
+      { builder: await this.createScallopBuilder() }
     );
 
     return scallopClient;
@@ -112,11 +110,9 @@ export class Scallop {
    * @return Scallop Query.
    */
   public async createScallopQuery() {
-    if (!this._address.getAddresses()) await this._address.read();
+    if (!this.address.getAddresses()) await this.address.read();
     const scallopQuery = new ScallopQuery(this.params, {
-      suiKit: this.suiKit,
-      address: this._address,
-      cache: this.cache,
+      utils: await this.createScallopUtils(),
     });
 
     return scallopQuery;
@@ -141,11 +137,9 @@ export class Scallop {
    * @return Scallop Utils.
    */
   public async createScallopUtils() {
-    if (!this._address.getAddresses()) await this._address.read();
+    if (!this.address.getAddresses()) await this.address.read();
     const scallopUtils = new ScallopUtils(this.params, {
-      suiKit: this.suiKit,
-      address: this._address,
-      cache: this.cache,
+      address: this.address,
     });
 
     return scallopUtils;

package/src/models/scallopAddress.ts

@@ -1,9 +1,10 @@
 import { API_BASE_URL, USE_TEST_ADDRESS } from '../constants';
-import type { NetworkType } from '@scallop-io/sui-kit';
+import { SuiKit, type NetworkType } from '@scallop-io/sui-kit';
 import type {
   ScallopAddressParams,
   AddressesInterface,
   AddressStringPath,
+  ScallopAddressInstanceParams,
 } from '../types';
 import { ScallopCache } from './scallopCache';
 import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
@@ -370,11 +371,20 @@ export class ScallopAddress {
   private _network: NetworkType;
   private _currentAddresses?: AddressesInterface;
   private _addressesMap: Map<NetworkType, AddressesInterface>;
-  private _cache: ScallopCache;
+  public cache: ScallopCache;
 
-  public constructor(params: ScallopAddressParams, cache?: ScallopCache) {
+  public constructor(
+    params: ScallopAddressParams,
+    instance?: ScallopAddressInstanceParams
+  ) {
     const { id, auth, network } = params;
-    this._cache = cache ?? new ScallopCache(DEFAULT_CACHE_OPTIONS);
+    this.cache =
+      instance?.cache ??
+      new ScallopCache(
+        instance?.suiKit ?? new SuiKit({}),
+        DEFAULT_CACHE_OPTIONS
+      );
+
     this._requestClient = axios.create({
       baseURL: API_BASE_URL,
       headers: {
@@ -573,7 +583,7 @@ export class ScallopAddress {
   public async read(id?: string) {
     const addressesId = id || this._id || undefined;
     if (addressesId !== undefined) {
-      const response = await this._cache.queryClient.fetchQuery({
+      const response = await this.cache.queryClient.fetchQuery({
         queryKey: ['api-getAddresses', addressesId],
         queryFn: async () => {
           return await this._requestClient.get(`/addresses/${addressesId}`, {

package/src/models/scallopBuilder.ts

@@ -9,12 +9,12 @@ import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
 import type { TransactionBlock } from '@mysten/sui.js/transactions';
 import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import type {
-  ScallopInstanceParams,
   ScallopBuilderParams,
   ScallopTxBlock,
   SupportMarketCoins,
   SupportAssetCoins,
   SupportSCoin,
+  ScallopBuilderInstanceParams,
 } from '../types';
 import { ScallopCache } from './scallopCache';
 import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
@@ -43,39 +43,43 @@ export class ScallopBuilder {
 
   public constructor(
     params: ScallopBuilderParams,
-    instance?: ScallopInstanceParams
+    instance?: ScallopBuilderInstanceParams
   ) {
-    this.params = params;
     this.suiKit = instance?.suiKit ?? new SuiKit(params);
-    this.cache =
-      instance?.cache ?? new ScallopCache(DEFAULT_CACHE_OPTIONS, this.suiKit);
-    this.address =
-      instance?.address ??
-      new ScallopAddress(
+
+    this.params = params;
+    this.walletAddress = normalizeSuiAddress(
+      params?.walletAddress || this.suiKit.currentAddress()
+    );
+
+    if (instance?.query) {
+      this.query = instance.query;
+      this.utils = this.query.utils;
+      this.address = this.utils.address;
+      this.cache = this.address.cache;
+    } else {
+      this.cache = new ScallopCache(this.suiKit, DEFAULT_CACHE_OPTIONS);
+      this.address = new ScallopAddress(
         {
           id: params?.addressesId || ADDRESSES_ID,
           network: params?.networkType,
         },
-        this.cache
+        {
+          cache: this.cache,
+        }
       );
-    this.query =
-      instance?.query ??
-      new ScallopQuery(params, {
-        suiKit: this.suiKit,
+      this.utils = new ScallopUtils(this.params, {
         address: this.address,
-        cache: this.cache,
       });
-    this.utils =
-      instance?.utils ??
-      new ScallopUtils(this.params, {
-        suiKit: this.suiKit,
-        address: this.address,
-        query: this.query,
-        cache: this.cache,
-      });
-    this.walletAddress = normalizeSuiAddress(
-      params?.walletAddress || this.suiKit.currentAddress()
-    );
+      this.query = new ScallopQuery(
+        {
+          walletAddress: this.walletAddress,
+        },
+        {
+          utils: this.utils,
+        }
+      );
+    }
     this.isTestnet = params.networkType
       ? params.networkType === 'testnet'
       : false;

package/src/models/scallopCache.ts

@@ -46,12 +46,12 @@ type QueryInspectTxnParams = {
 
 export class ScallopCache {
   public readonly queryClient: QueryClient;
-  public readonly _suiKit?: SuiKit;
+  public readonly _suiKit: SuiKit;
   private tokenBucket: TokenBucket;
 
   public constructor(
+    suiKit: SuiKit,
     cacheOptions?: QueryClientConfig,
-    suiKit?: SuiKit,
     tokenBucket?: TokenBucket
   ) {
     this.queryClient = new QueryClient(cacheOptions ?? DEFAULT_CACHE_OPTIONS);

package/src/models/scallopClient.ts

@@ -15,11 +15,13 @@ import { ScallopQuery } from './scallopQuery';
 import { ScallopCache } from './scallopCache';
 import { requireSender } from 'src/utils';
 import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
-import type { TransactionObjectArgument } from '@mysten/sui.js/transactions';
+import type {
+  TransactionObjectArgument,
+  TransactionResult,
+} from '@mysten/sui.js/transactions';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
 import type {
   ScallopClientFnReturnType,
-  ScallopInstanceParams,
   ScallopClientParams,
   SupportPoolCoins,
   SupportCollateralCoins,
@@ -29,6 +31,8 @@ import type {
   SupportBorrowIncentiveCoins,
   ScallopTxBlock,
   SupportSCoin,
+  ScallopClientVeScaReturnType,
+  ScallopClientInstanceParams,
 } from '../types';
 
 /**
@@ -56,48 +60,42 @@ export class ScallopClient {
 
   public constructor(
     params: ScallopClientParams,
-    instance?: ScallopInstanceParams
+    instance?: ScallopClientInstanceParams
   ) {
     this.params = params;
-    this.suiKit = instance?.suiKit ?? new SuiKit(params);
-    this.cache =
-      instance?.cache ?? new ScallopCache(DEFAULT_CACHE_OPTIONS, this.suiKit);
-    this.address =
-      instance?.address ??
-      new ScallopAddress(
+    this.suiKit =
+      instance?.suiKit ?? instance?.builder?.suiKit ?? new SuiKit(params);
+    this.walletAddress = normalizeSuiAddress(
+      params?.walletAddress || this.suiKit.currentAddress()
+    );
+
+    if (instance?.builder) {
+      this.builder = instance.builder;
+      this.query = this.builder.query;
+      this.utils = this.query.utils;
+      this.address = this.utils.address;
+      this.cache = this.address.cache;
+    } else {
+      this.cache = new ScallopCache(this.suiKit, DEFAULT_CACHE_OPTIONS);
+      this.address = new ScallopAddress(
         {
           id: params?.addressesId || ADDRESSES_ID,
           network: params?.networkType,
         },
-        this.cache
+        {
+          cache: this.cache,
+        }
       );
-    this.query =
-      instance?.query ??
-      new ScallopQuery(params, {
-        suiKit: this.suiKit,
+      this.utils = new ScallopUtils(this.params, {
         address: this.address,
-        cache: this.cache,
       });
-    this.utils =
-      instance?.utils ??
-      new ScallopUtils(params, {
-        suiKit: this.suiKit,
-        address: this.address,
-        query: this.query,
-        cache: this.cache,
+      this.query = new ScallopQuery(this.params, {
+        utils: this.utils,
       });
-    this.builder =
-      instance?.builder ??
-      new ScallopBuilder(params, {
-        suiKit: this.suiKit,
-        address: this.address,
+      this.builder = new ScallopBuilder(this.params, {
         query: this.query,
-        utils: this.utils,
-        cache: this.cache,
       });
-    this.walletAddress = normalizeSuiAddress(
-      params?.walletAddress || this.suiKit.currentAddress()
-    );
+    }
   }
 
   /**
@@ -1077,6 +1075,67 @@ export class ScallopClient {
     }
   }
 
+  /* ==================== VeSCA ==================== */
+  /**
+   * Claim unlocked SCA from all veSCA accounts.
+   */
+  public async claimAllUnlockedSca(): Promise<SuiTransactionBlockResponse>;
+  public async claimAllUnlockedSca<S extends boolean>(
+    sign?: S
+  ): Promise<ScallopClientVeScaReturnType<S>>;
+  public async claimAllUnlockedSca<S extends boolean>(
+    sign: S = true as S
+  ): Promise<ScallopClientVeScaReturnType<S>> {
+    // get all veSca keys
+    const veScaKeys = (
+      (await this.query.getVeScas(this.walletAddress)) ?? []
+    ).map(({ keyObject }) => keyObject);
+    if (veScaKeys.length === 0) {
+      throw new Error('No veSCA found in the wallet');
+    }
+
+    const scaCoins: TransactionResult[] = [];
+    const tx = this.builder.createTxBlock();
+    tx.setSender(this.walletAddress);
+
+    await Promise.all(
+      veScaKeys.map(async (key) => {
+        try {
+          const scaCoin = await tx.redeemScaQuick(key, false);
+          if (!scaCoin) return;
+          scaCoins.push(scaCoin);
+        } catch (e) {
+          // ignore
+        }
+      })
+    );
+
+    if (scaCoins.length === 0) {
+      throw new Error('No unlocked SCA found in the veSCA accounts');
+    }
+
+    if (scaCoins.length > 1) {
+      tx.mergeCoins(scaCoins[0], scaCoins.slice(1));
+    }
+    await this.utils.mergeSimilarCoins(
+      tx,
+      scaCoins[0],
+      'sca',
+      this.walletAddress
+    );
+
+    if (sign) {
+      return (await this.suiKit.signAndSendTxn(
+        tx
+      )) as ScallopClientVeScaReturnType<S>;
+    } else {
+      return {
+        tx: tx.txBlock,
+        scaCoin: scaCoins[0],
+      } as ScallopClientVeScaReturnType<S>;
+    }
+  }
+
   /* ==================== Other Method ==================== */
 
   /**

package/src/models/scallopIndexer.ts

@@ -17,11 +17,13 @@ import type {
   TotalValueLocked,
   ScallopQueryParams,
   ScallopParams,
-  ScallopInstanceParams,
   BorrowIncentivePoolPoints,
   SupportBorrowIncentiveRewardCoins,
+  ScallopIndexerInstanceParams,
 } from '../types';
 import { ScallopCache } from './scallopCache';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
+import { SuiKit } from '@scallop-io/sui-kit';
 
 /**
  * @description
@@ -36,13 +38,18 @@ import { ScallopCache } from './scallopCache';
  * ```
  */
 export class ScallopIndexer {
-  private readonly _cache: ScallopCache;
+  private readonly cache: ScallopCache;
   public readonly params: ScallopQueryParams;
   private readonly _requestClient: AxiosInstance;
 
-  public constructor(params: ScallopParams, instance?: ScallopInstanceParams) {
+  public constructor(
+    params: ScallopParams,
+    instance?: ScallopIndexerInstanceParams
+  ) {
     this.params = params;
-    this._cache = instance?.cache ?? new ScallopCache();
+    this.cache =
+      instance?.cache ??
+      new ScallopCache(new SuiKit({}), DEFAULT_CACHE_OPTIONS);
     this._requestClient = axios.create({
       baseURL: SDK_API_BASE_URL,
       headers: {
@@ -59,7 +66,7 @@ export class ScallopIndexer {
    * @return Market data.
    */
   public async getMarket(): Promise<Pick<Market, 'pools' | 'collaterals'>> {
-    const response = await this._cache.queryClient.fetchQuery({
+    const response = await this.cache.queryClient.fetchQuery({
       queryKey: ['market'],
       queryFn: async () => {
         return await this._requestClient.get<{
@@ -137,7 +144,7 @@ export class ScallopIndexer {
    * @return Spools data.
    */
   public async getSpools(): Promise<Required<Spools>> {
-    const response = await this._cache.queryClient.fetchQuery({
+    const response = await this.cache.queryClient.fetchQuery({
       queryKey: ['spools'],
       queryFn: async () => {
         return await this._requestClient.get<{
@@ -175,7 +182,7 @@ export class ScallopIndexer {
   public async getBorrowIncentivePools(): Promise<
     Required<BorrowIncentivePools>
   > {
-    const response = await this._cache.queryClient.fetchQuery({
+    const response = await this.cache.queryClient.fetchQuery({
       queryKey: ['borrowIncentivePools'],
       queryFn: async () => {
         return await this._requestClient.get<{
@@ -237,7 +244,7 @@ export class ScallopIndexer {
       supplyValueChangeRatio: number;
     }
   > {
-    const response = await this._cache.queryClient.fetchQuery({
+    const response = await this.cache.queryClient.fetchQuery({
       queryKey: ['totalValueLocked'],
       queryFn: async () => {
         return await this._requestClient.get<