@scallop-io/sui-scallop-sdk 0.46.48 → 0.46.50

package/dist/models/scallopBuilder.d.ts

@@ -51,7 +51,7 @@ export declare class ScallopBuilder {
      * @param sender - Sender address.
      * @return Take coin and left coin.
      */
-    selectCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, assetCoinName: SupportAssetCoins, amount: number, sender: string): Promise<{
+    selectCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, assetCoinName: SupportAssetCoins, amount: number, sender?: string): Promise<{
         takeCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
         leftCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
     }>;
@@ -64,7 +64,7 @@ export declare class ScallopBuilder {
      * @param sender - Sender address.
      * @return Take coin and left coin.
      */
-    selectMarketCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, marketCoinName: SupportMarketCoins, amount: number, sender: string): Promise<{
+    selectMarketCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, marketCoinName: SupportMarketCoins, amount: number, sender?: string): Promise<{
         takeCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
         leftCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
         totalAmount: number;
@@ -78,7 +78,7 @@ export declare class ScallopBuilder {
      * @param sender - Sender address.
      * @return Take coin and left coin.
      */
-    selectSCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, sCoinName: SupportSCoin, amount: number, sender: string): Promise<{
+    selectSCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, sCoinName: SupportSCoin, amount: number, sender?: string): Promise<{
         takeCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
         leftCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
         totalAmount: number;

package/dist/models/scallopQuery.d.ts

@@ -4,7 +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';
+import { SuiObjectData } from '@mysten/sui.js/client';
 /**
  * @description
  * It provides methods for getting on-chain data from the Scallop contract.
@@ -24,6 +24,7 @@ export declare class ScallopQuery {
     utils: ScallopUtils;
     indexer: ScallopIndexer;
     cache: ScallopCache;
+    walletAddress: string;
     constructor(params: ScallopQueryParams, instance?: ScallopInstanceParams);
     /**
      * Request the scallop API to initialize data.

package/dist/queries/loyaltyProgramQuery.d.ts

@@ -1,4 +1,4 @@
-import { SuiObjectData } from '@mysten/sui.js/src/client';
+import { SuiObjectData } from '@mysten/sui.js/client';
 import { ScallopQuery } from 'src/models';
 import { LoyaltyProgramInfo } from 'src/types';
 /**

package/dist/queries/priceQuery.d.ts

@@ -1,4 +1,4 @@
-import { SuiObjectData } from '@mysten/sui.js/src/client';
+import { SuiObjectData } from '@mysten/sui.js/client';
 import type { ScallopQuery } from '../models';
 import type { SupportAssetCoins } from '../types';
 /**

package/dist/types/model.d.ts

@@ -27,7 +27,9 @@ export type ScallopBuilderParams = ScallopParams & {
     walletAddress?: string;
     pythEndpoints?: string[];
 };
-export type ScallopQueryParams = ScallopParams;
+export type ScallopQueryParams = ScallopParams & {
+    walletAddress?: string;
+};
 export type ScallopUtilsParams = ScallopParams & {
     pythEndpoints?: string[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "0.46.48",
+  "version": "0.46.50",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/models/scallopBuilder.ts

@@ -122,7 +122,7 @@ export class ScallopBuilder {
     txBlock: ScallopTxBlock | SuiKitTxBlock,
     assetCoinName: SupportAssetCoins,
     amount: number,
-    sender: string
+    sender: string = this.walletAddress
   ) {
     const coinType = this.utils.parseCoinType(assetCoinName);
     const coins = await this.utils.selectCoins(amount, coinType, sender);
@@ -143,7 +143,7 @@ export class ScallopBuilder {
     txBlock: ScallopTxBlock | SuiKitTxBlock,
     marketCoinName: SupportMarketCoins,
     amount: number,
-    sender: string
+    sender: string = this.walletAddress
   ) {
     const marketCoinType = this.utils.parseMarketCoinType(marketCoinName);
     const coins = await this.utils.selectCoins(amount, marketCoinType, sender);
@@ -171,7 +171,7 @@ export class ScallopBuilder {
     txBlock: ScallopTxBlock | SuiKitTxBlock,
     sCoinName: SupportSCoin,
     amount: number,
-    sender: string
+    sender: string = this.walletAddress
   ) {
     const sCoinType = this.utils.parseSCoinType(sCoinName);
     const coins = await this.utils.selectCoins(amount, sCoinType, sender);

package/src/models/scallopClient.ts

@@ -742,12 +742,12 @@ export class ScallopClient {
     const sender = walletAddress || this.walletAddress;
     txBlock.setSender(sender);
 
-    const marketCoin = await txBlock.unstakeQuick(
+    const sCoin = await txBlock.unstakeQuick(
       amount,
       stakeMarketCoinName,
       stakeAccountId
     );
-    txBlock.transferObjects([marketCoin], sender);
+    txBlock.transferObjects([sCoin], sender);
 
     if (sign) {
       return (await this.suiKit.signAndSendTxn(
@@ -793,13 +793,16 @@ export class ScallopClient {
     const stakeMarketCoin = await txBlock.unstakeQuick(
       amount,
       stakeMarketCoinName,
-      stakeAccountId
+      stakeAccountId,
+      false
     );
     const stakeCoinName =
       this.utils.parseCoinName<SupportStakeCoins>(stakeMarketCoinName);
     if (stakeMarketCoin) {
       const coin = txBlock.withdraw(stakeMarketCoin, stakeCoinName);
       txBlock.transferObjects([coin], sender);
+    } else {
+      throw new Error(`No stake found for ${stakeMarketCoinName}`);
     }
 
     if (sign) {

package/src/models/scallopQuery.ts

@@ -52,12 +52,13 @@ import { ScallopUtils } from './scallopUtils';
 import { ScallopIndexer } from './scallopIndexer';
 import { ScallopCache } from './scallopCache';
 import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
-import { SuiObjectData } from '@mysten/sui.js/src/client';
+import { SuiObjectData } from '@mysten/sui.js/client';
 import {
   getSCoinAmount,
   getSCoinAmounts,
   getSCoinTotalSupply,
 } from 'src/queries/sCoinQuery';
+import { normalizeSuiAddress } from '@mysten/sui.js/utils';
 
 /**
  * @description
@@ -79,6 +80,7 @@ export class ScallopQuery {
   public utils: ScallopUtils;
   public indexer: ScallopIndexer;
   public cache: ScallopCache;
+  public walletAddress: string;
 
   public constructor(
     params: ScallopQueryParams,
@@ -106,6 +108,9 @@ export class ScallopQuery {
         query: this,
       });
     this.indexer = new ScallopIndexer(this.params, { cache: this.cache });
+    this.walletAddress = normalizeSuiAddress(
+      params?.walletAddress || this.suiKit.currentAddress()
+    );
   }
 
   /**
@@ -205,7 +210,7 @@ export class ScallopQuery {
    * @param ownerAddress - The owner address.
    * @return Obligations data.
    */
-  public async getObligations(ownerAddress?: string) {
+  public async getObligations(ownerAddress: string = this.walletAddress) {
     return await getObligations(this, ownerAddress);
   }
 
@@ -228,7 +233,7 @@ export class ScallopQuery {
    */
   public async getCoinAmounts(
     assetCoinNames?: SupportAssetCoins[],
-    ownerAddress?: string
+    ownerAddress: string = this.walletAddress
   ) {
     return await getCoinAmounts(this, assetCoinNames, ownerAddress);
   }
@@ -242,7 +247,7 @@ export class ScallopQuery {
    */
   public async getCoinAmount(
     assetCoinName: SupportAssetCoins,
-    ownerAddress?: string
+    ownerAddress: string = this.walletAddress
   ) {
     return await getCoinAmount(this, assetCoinName, ownerAddress);
   }
@@ -256,7 +261,7 @@ export class ScallopQuery {
    */
   public async getMarketCoinAmounts(
     marketCoinNames?: SupportMarketCoins[],
-    ownerAddress?: string
+    ownerAddress: string = this.walletAddress
   ) {
     return await getMarketCoinAmounts(this, marketCoinNames, ownerAddress);
   }
@@ -270,7 +275,7 @@ export class ScallopQuery {
    */
   public async getMarketCoinAmount(
     marketCoinName: SupportMarketCoins,
-    ownerAddress?: string
+    ownerAddress: string = this.walletAddress
   ) {
     return await getMarketCoinAmount(this, marketCoinName, ownerAddress);
   }
@@ -331,7 +336,7 @@ export class ScallopQuery {
    * @param ownerAddress - The owner address.
    * @return All Stake accounts data.
    */
-  public async getAllStakeAccounts(ownerAddress?: string) {
+  public async getAllStakeAccounts(ownerAddress: string = this.walletAddress) {
     return await getStakeAccounts(this, ownerAddress);
   }
 
@@ -344,7 +349,7 @@ export class ScallopQuery {
    */
   public async getStakeAccounts(
     stakeMarketCoinName: SupportStakeMarketCoins,
-    ownerAddress?: string
+    ownerAddress: string = this.walletAddress
   ) {
     const allStakeAccount = await this.getAllStakeAccounts(ownerAddress);
     return allStakeAccount[stakeMarketCoinName] ?? [];
@@ -472,7 +477,7 @@ export class ScallopQuery {
    */
   public async getLendings(
     poolCoinNames?: SupportPoolCoins[],
-    ownerAddress?: string,
+    ownerAddress: string = this.walletAddress,
     indexer: boolean = false
   ) {
     return await getLendings(this, poolCoinNames, ownerAddress, indexer);
@@ -488,7 +493,7 @@ export class ScallopQuery {
    */
   public async getLending(
     poolCoinName: SupportPoolCoins,
-    ownerAddress?: string,
+    ownerAddress: string = this.walletAddress,
     indexer: boolean = false
   ) {
     return await getLending(this, poolCoinName, ownerAddress, indexer);
@@ -505,7 +510,7 @@ export class ScallopQuery {
    * @return All obligation accounts information.
    */
   public async getObligationAccounts(
-    ownerAddress?: string,
+    ownerAddress: string = this.walletAddress,
     indexer: boolean = false
   ) {
     return await getObligationAccounts(this, ownerAddress, indexer);
@@ -524,7 +529,7 @@ export class ScallopQuery {
    */
   public async getObligationAccount(
     obligationId: string,
-    ownerAddress?: string,
+    ownerAddress: string = this.walletAddress,
     indexer: boolean = false
   ) {
     return await getObligationAccount(
@@ -619,7 +624,7 @@ export class ScallopQuery {
    */
   public async getSCoinAmounts(
     sCoinNames?: SupportSCoin[],
-    ownerAddress?: string
+    ownerAddress: string = this.walletAddress
   ) {
     return await getSCoinAmounts(this, sCoinNames, ownerAddress);
   }
@@ -633,7 +638,7 @@ export class ScallopQuery {
    */
   public async getSCoinAmount(
     sCoinName: SupportSCoin | SupportMarketCoins,
-    ownerAddress?: string
+    ownerAddress: string = this.walletAddress
   ) {
     const parsedSCoinName = this.utils.parseSCoinName(sCoinName);
     return parsedSCoinName

package/src/queries/loyaltyProgramQuery.ts

@@ -1,4 +1,4 @@
-import { SuiObjectData } from '@mysten/sui.js/src/client';
+import { SuiObjectData } from '@mysten/sui.js/client';
 import BigNumber from 'bignumber.js';
 import { ScallopQuery } from 'src/models';
 import { LoyaltyProgramInfo } from 'src/types';

package/src/queries/priceQuery.ts

@@ -1,4 +1,4 @@
-import { SuiObjectData } from '@mysten/sui.js/src/client';
+import { SuiObjectData } from '@mysten/sui.js/client';
 import type { ScallopQuery } from '../models';
 import type { SupportAssetCoins } from '../types';
 
@@ -61,35 +61,53 @@ export const getPythPrices = async (
   query: ScallopQuery,
   assetCoinNames: SupportAssetCoins[]
 ) => {
-  const seen: Record<string, boolean> = {};
-  const pythFeedObjectIds = assetCoinNames
-    .map((assetCoinName) => {
-      const pythFeedObjectId = query.address.get(
+  const pythPriceFeedIds = assetCoinNames.reduce(
+    (prev, assetCoinName) => {
+      const pythPriceFeed = query.address.get(
         `core.coins.${assetCoinName}.oracle.pyth.feedObject`
       );
-      if (seen[pythFeedObjectId]) return null;
+      if (!prev[pythPriceFeed]) {
+        prev[pythPriceFeed] = [assetCoinName];
+      } else {
+        prev[pythPriceFeed].push(assetCoinName);
+      }
+      return prev;
+    },
+    {} as Record<string, SupportAssetCoins[]>
+  );
 
-      seen[pythFeedObjectId] = true;
-      return pythFeedObjectId;
-    })
-    .filter((item) => !!item) as string[];
+  // Fetch multiple objects at once to save rpc calls
   const priceFeedObjects = await query.cache.queryGetObjects(
-    pythFeedObjectIds,
-    {
-      showContent: true,
-    }
+    Object.keys(pythPriceFeedIds),
+    { showContent: true }
+  );
+
+  const assetToPriceFeedMapping = priceFeedObjects.reduce(
+    (prev, priceFeedObject) => {
+      pythPriceFeedIds[priceFeedObject.objectId].forEach((assetCoinName) => {
+        prev[assetCoinName] = priceFeedObject;
+      });
+      return prev;
+    },
+    {} as Record<SupportAssetCoins, SuiObjectData>
   );
 
   return (
     await Promise.all(
-      priceFeedObjects.map(async (priceFeedObject, idx) => ({
-        coinName: assetCoinNames[idx],
-        price: await getPythPrice(query, assetCoinNames[idx], priceFeedObject),
-      }))
+      Object.entries(assetToPriceFeedMapping).map(
+        async ([assetCoinName, priceFeedObject]) => ({
+          coinName: assetCoinName,
+          price: await getPythPrice(
+            query,
+            assetCoinName as SupportAssetCoins,
+            priceFeedObject
+          ),
+        })
+      )
     )
   ).reduce(
     (prev, curr) => {
-      prev[curr.coinName] = curr.price;
+      prev[curr.coinName as SupportAssetCoins] = curr.price;
       return prev;
     },
     {} as Record<SupportAssetCoins, number>

package/src/types/model.ts

@@ -41,7 +41,9 @@ export type ScallopBuilderParams = ScallopParams & {
   pythEndpoints?: string[];
 };
 
-export type ScallopQueryParams = ScallopParams;
+export type ScallopQueryParams = ScallopParams & {
+  walletAddress?: string;
+};
 
 export type ScallopUtilsParams = ScallopParams & {
   pythEndpoints?: string[];

package/src/utils/query.ts

@@ -512,23 +512,25 @@ export const calculateBorrowIncentivePoolPointData = (
     .multipliedBy(rewardCoinPrice);
 
   const weightScale = BigNumber(1_000_000_000_000);
-  const rewardRate = rewardValueForYear
-    .multipliedBy(
-      BigNumber(parsedBorrowIncentivePoolPointData.baseWeight).dividedBy(
-        weightScale
+
+  const rewardRate =
+    rewardValueForYear
+      .multipliedBy(
+        BigNumber(parsedBorrowIncentivePoolPointData.baseWeight).dividedBy(
+          weightScale
+        )
       )
-    )
-    .dividedBy(weightedStakedValue)
-    .isFinite()
-    ? rewardValueForYear
-        .multipliedBy(
-          BigNumber(parsedBorrowIncentivePoolPointData.baseWeight).dividedBy(
-            weightScale
+      .dividedBy(weightedStakedValue)
+      .isFinite() && parsedBorrowIncentivePoolPointData.points > 0
+      ? rewardValueForYear
+          .multipliedBy(
+            BigNumber(parsedBorrowIncentivePoolPointData.baseWeight).dividedBy(
+              weightScale
+            )
           )
-        )
-        .dividedBy(weightedStakedValue)
-        .toNumber()
-    : Infinity;
+          .dividedBy(weightedStakedValue)
+          .toNumber()
+      : Infinity;
 
   return {
     distributedPointPerSec: distributedPointPerSec.toNumber(),

package/dist/test.d.ts

@@ -1 +0,0 @@
-export {};

package/src/test.ts

@@ -1,19 +0,0 @@
-import { Scallop } from './models';
-import * as dotenv from 'dotenv';
-dotenv.config();
-const scallop = new Scallop({
-  secretKey: process.env.SECRET_KEY as string,
-});
-
-const main = async () => {
-  const query = await scallop.createScallopQuery();
-
-  const res = await query.getVeScas(
-    '0xd1a70cfe7332e994a950b9c570e93def4b6d2ec53b34ff5c0cc9946226a7cf3d'
-  );
-  console.dir(res, { depth: null });
-};
-main()
-  .then()
-  .catch(console.error)
-  .finally(() => process.exit(0));