@scallop-io/sui-scallop-sdk 0.37.9 → 0.37.12

package/README.md

@@ -5,14 +5,14 @@
 </p>
 <p align="center">
     <a style="padding-right: 5px;" href="https://github.com/scallop-io/sui-scallop-sdk/releases">
-        <img alt="GitHub release" src="https://img.shields.io/github/v/release/@scallop-io/sui-scallop-sdk?display_name=tag">
+        <img alt="GitHub release" src="https://img.shields.io/github/v/release/scallop-io/sui-scallop-sdk?display_name=tag">
     </a>
     <a href="https://github.com/scallop-io/sui-scallop-sdk/blob/main/LICENSE">
-        <img alt="NPM" src="https://img.shields.io/npm/l/@scallop/sdk?registry_uri=https%3A%2F%2Fnpm.pkg.github.com%2F">
+        <img alt="GitHub licence" src="https://img.shields.io/github/license/scallop-io/sui-scallop-sdk?logoColor=blue">
     </a>
 </p>
 
-# The Typescript SDK for interacting with Scallop lending protocol on SUI network
+# The Typescript SDK for interacting with the Scallop lending protocol on the SUI network
 
 ## Description
 
@@ -61,7 +61,7 @@ This SDK is used to interact with [sui-lending-protocal](https://github.com/scal
 
 For the original codes, please refer to `test/index.spec.ts` file.
 
-You need to setup the `.env` file before testing. (Reference `.env.example`)
+You need to set up the `.env` file before testing. (Reference `.env.example`)
 
 - Setup the network
 
@@ -232,7 +232,7 @@ You need to setup the `.env` file before testing. (Reference `.env.example`)
 
 ## Use address manager
 
-General Users will basically only use the `get`, `getAddresses` or `getAllAddresses` methods to read addresses. Here are some simple examples:
+General Users will basically only use the `get`, `getAddresses`, or `getAllAddresses` methods to read addresses. Here are some simple examples:
 
 ```typescript
 const address = new ScallopAddress({
@@ -252,9 +252,9 @@ const allAddresses = addressBuilder.getAllAddresses();
 
 Scallop currently maintains this address `6462a088a7ace142bb6d7e9b` for use in the production environment.
 
-Of course, you can also directly use the [sui-scallop-api](https://github.com/scallop-io/sui-scallop-api) project to directly request an addresses.
+Of course, you can also directly use the [sui-scallop-api](https://github.com/scallop-io/sui-scallop-api) project to directly request addresses.
 
-The rest of the features are for Scallop administrators to use, and require a set of API authentication key to use the create, update, and delete address functions.
+The rest of the features are for Scallop administrators to use, and require a set of API authentication keys to use the create, update, and delete address functions.
 
 ```typescript
   const address = new ScallopAddress({

package/dist/constants/common.d.ts

@@ -1,5 +1,6 @@
 export declare const API_BASE_URL = "https://sui.api.scallop.io";
 export declare const ADDRESSES_ID = "6462a088a7ace142bb6d7e9b";
+export declare const PROTOCOL_OBJECT_ID = "0xefe8b36d5b2e43728cc323298626b83177803521d195cfb11e15b910e892fddf";
 export declare const SUPPORT_ASSET_COINS: readonly ["eth", "btc", "usdc", "usdt", "sui", "apt", "sol", "cetus"];
 export declare const SUPPORT_COLLATERAL_COINS: readonly ["eth", "btc", "usdc", "usdt", "sui", "apt", "sol", "cetus"];
 export declare const SUPPORT_ORACLES: readonly ["supra", "switchboard", "pyth"];

package/dist/index.js

@@ -32,6 +32,7 @@ var src_exports = {};
 __export(src_exports, {
   ADDRESSES_ID: () => ADDRESSES_ID,
   API_BASE_URL: () => API_BASE_URL,
+  PROTOCOL_OBJECT_ID: () => PROTOCOL_OBJECT_ID,
   SUI_COIN_TYPE_ARG_REGEX: () => SUI_COIN_TYPE_ARG_REGEX,
   SUPPORT_ASSET_COINS: () => SUPPORT_ASSET_COINS,
   SUPPORT_COLLATERAL_COINS: () => SUPPORT_COLLATERAL_COINS,
@@ -47,6 +48,7 @@ module.exports = __toCommonJS(src_exports);
 // src/constants/common.ts
 var API_BASE_URL = "https://sui.api.scallop.io";
 var ADDRESSES_ID = "6462a088a7ace142bb6d7e9b";
+var PROTOCOL_OBJECT_ID = "0xefe8b36d5b2e43728cc323298626b83177803521d195cfb11e15b910e892fddf";
 var SUPPORT_ASSET_COINS = [
   "eth",
   "btc",
@@ -512,7 +514,6 @@ var import_sui_kit5 = require("@scallop-io/sui-kit");
 // src/models/scallopUtils.ts
 var import_sui = require("@mysten/sui.js");
 var import_sui_kit = require("@scallop-io/sui-kit");
-var import_price_service_client = require("@pythnetwork/price-service-client");
 var ScallopUtils = class {
   constructor(params) {
     this._suiKit = new import_sui_kit.SuiKit(params);
@@ -532,23 +533,6 @@ var ScallopUtils = class {
     );
     return coins.map((c) => c.objectId);
   }
-  /**
-   * @description Fetch price feed VAAs of interest from the Pyth.
-   * @param priceIds Array of hex-encoded price ids.
-   * @param isTestnet Specify whether it is a test network.
-   * @return Array of base64 encoded VAAs.
-   */
-  async getVaas(priceIds, isTestnet) {
-    const connection = new import_price_service_client.PriceServiceConnection(
-      isTestnet ? "https://xc-testnet.pyth.network" : "https://xc-mainnet.pyth.network",
-      {
-        priceFeedRequestConfig: {
-          binary: true
-        }
-      }
-    );
-    return await connection.getLatestVaas(priceIds);
-  }
   /**
    * @description Handle non-standard coins.
    * @param coinPackageId Package id of coin.
@@ -619,17 +603,16 @@ var ScallopUtils = class {
    * @description Handle market coin types.
    *
    * @param coinPackageId Package id of coin.
-   * @param protocolPkgId Package id of protocol.
    * @param coinName specific support coin name.
    *
    * @return marketCoinType.
    */
-  parseMarketCoinType(coinPackageId, protocolPkgId, coinName) {
+  parseMarketCoinType(coinPackageId, coinName) {
     const coinType = this.parseCoinType(
       coinName === "sui" ? import_sui.SUI_FRAMEWORK_ADDRESS : coinPackageId,
       coinName
     );
-    return `${protocolPkgId}::reserve::MarketCoin<${coinType}>`;
+    return `${PROTOCOL_OBJECT_ID}::reserve::MarketCoin<${coinType}>`;
   }
 };
 
@@ -693,7 +676,6 @@ var queryMarket = async (scallopAddress, suiKit, scallopUtils, rateType) => {
     const symbol = coin.toUpperCase();
     const marketCoinType = scallopUtils.parseMarketCoinType(
       scallopAddress.get(`core.coins.${coin}.id`),
-      scallopAddress.get("core.packages.protocol.id"),
       coin
     );
     const wrappedType = coin === "usdc" || coin === "usdt" || coin === "eth" || coin === "btc" || coin === "apt" || coin === "sol" ? {
@@ -790,14 +772,12 @@ var queryObligation = async (obligationId, scallopAddress, suiKit) => {
   const queryResult = await suiKit.inspectTxn(txBlock);
   return queryResult.events[0].parsedJson;
 };
-var getObligations = async (ownerAddress, scallopAddress, suiKit) => {
+var getObligations = async (ownerAddress, suiKit) => {
   const owner = ownerAddress || suiKit.currentAddress();
   const keyObjectRefs = await suiKit.provider().getOwnedObjects({
     owner,
     filter: {
-      StructType: `${scallopAddress.get(
-        "core.packages.protocol.id"
-      )}::obligation::ObligationKey`
+      StructType: `${PROTOCOL_OBJECT_ID}::obligation::ObligationKey`
     }
   });
   const keyIds = keyObjectRefs.data.map((ref) => ref?.data?.objectId).filter((id) => id !== void 0);
@@ -987,8 +967,8 @@ var newTxBlock = (scallopAddress, scallopUtils) => {
 };
 
 // src/txBuilders/oracle.ts
-var import_bcs = require("@mysten/bcs");
 var import_sui3 = require("@mysten/sui.js");
+var import_pyth_sui_js = require("@pythnetwork/pyth-sui-js");
 var updateOraclesForWithdrawCollateral = async (txBlock, address, scallopUtils, suiKit, obligationId, isTestnet) => {
   const obligationCoinNames = await getObligationCoinNames(
     suiKit,
@@ -998,6 +978,7 @@ var updateOraclesForWithdrawCollateral = async (txBlock, address, scallopUtils,
   );
   return updateOracles(
     txBlock,
+    suiKit,
     address,
     scallopUtils,
     obligationCoinNames,
@@ -1016,6 +997,7 @@ var updateOraclesForBorrow = async (txBlock, address, scallopUtils, suiKit, obli
   ];
   return updateOracles(
     txBlock,
+    suiKit,
     address,
     scallopUtils,
     updateCoinNames,
@@ -1038,30 +1020,46 @@ var getObligationCoinNames = async (suiKit, obligationId, address, scallopUtils)
   });
   return obligationCoinNames;
 };
-var updateOracles = async (txBlock, address, scallopUtils, coinNames, isTestnet) => {
-  const updateCoinTypes = [...new Set(coinNames)];
-  for (const coinName of updateCoinTypes) {
-    await updateOracle(txBlock, address, scallopUtils, coinName, isTestnet);
+var updateOracles = async (txBlock, suiKit, address, scallopUtils, coinNames, isTestnet) => {
+  const rules = isTestnet ? ["pyth"] : ["pyth"];
+  if (rules.includes("pyth")) {
+    const pythClient = new import_pyth_sui_js.SuiPythClient(
+      suiKit.provider(),
+      address.get("core.oracles.pyth.state"),
+      address.get("core.oracles.pyth.wormholeState")
+    );
+    const priceIds = coinNames.map(
+      (coinName) => address.get(`core.coins.${coinName}.oracle.pyth.feed`)
+    );
+    const pythConnection = new import_pyth_sui_js.SuiPriceServiceConnection(
+      isTestnet ? "hermes-beta.pyth.network" : "https://hermes.pyth.network"
+    );
+    const priceUpdateData = await pythConnection.getPriceFeedsUpdateData(
+      priceIds
+    );
+    await pythClient.updatePriceFeeds(
+      txBlock.txBlock,
+      priceUpdateData,
+      priceIds
+    );
+  }
+  const updateCoinNames = [...new Set(coinNames)];
+  for (const coinName of updateCoinNames) {
+    await updateOracle(txBlock, rules, address, scallopUtils, coinName);
   }
 };
-var updateOracle = async (txBlock, address, scallopUtils, coinName, isTestnet) => {
+var updateOracle = async (txBlock, rules, address, scallopUtils, coinName) => {
   const coinPackageId = address.get(`core.coins.${coinName}.id`);
   const coinType = scallopUtils.parseCoinType(coinPackageId, coinName);
-  const [vaaFromFeeId] = await scallopUtils.getVaas(
-    [address.get(`core.coins.${coinName}.oracle.pyth.feed`)],
-    isTestnet
-  );
   updatePrice(
     txBlock,
-    isTestnet ? ["pyth"] : ["pyth"],
+    rules,
     address.get("core.packages.xOracle.id"),
     address.get("core.oracles.xOracle"),
     address.get("core.packages.pyth.id"),
     address.get("core.oracles.pyth.registry"),
     address.get("core.oracles.pyth.state"),
-    address.get("core.oracles.pyth.wormholeState"),
     address.get(`core.coins.${coinName}.oracle.pyth.feedObject`),
-    vaaFromFeeId,
     address.get("core.packages.switchboard.id"),
     address.get("core.oracles.switchboard.registry"),
     address.get(`core.coins.${coinName}.oracle.switchboard`),
@@ -1071,7 +1069,7 @@ var updateOracle = async (txBlock, address, scallopUtils, coinName, isTestnet) =
     coinType
   );
 };
-function updatePrice(txBlock, rules, xOraclePackageId, xOracleId, pythPackageId, pythRegistryId, pythStateId, pythWormholeStateId, pythFeedObjectId, pythVaaFromFeeId, switchboardPackageId, switchboardRegistryId, switchboardAggregatorId, supraPackageId, supraRegistryId, supraHolderId, coinType) {
+function updatePrice(txBlock, rules, xOraclePackageId, xOracleId, pythPackageId, pythRegistryId, pythStateId, pythFeedObjectId, switchboardPackageId, switchboardRegistryId, switchboardAggregatorId, supraPackageId, supraRegistryId, supraHolderId, coinType) {
   const request = priceUpdateRequest(
     txBlock,
     xOraclePackageId,
@@ -1084,9 +1082,7 @@ function updatePrice(txBlock, rules, xOraclePackageId, xOracleId, pythPackageId,
       pythPackageId,
       request,
       pythStateId,
-      pythWormholeStateId,
       pythFeedObjectId,
-      pythVaaFromFeeId,
       pythRegistryId,
       coinType
     );
@@ -1145,20 +1141,10 @@ function updateSwitchboardPrice(txBlock, packageId, request, aggregatorId, regis
     [coinType]
   );
 }
-function updatePythPrice(txBlock, packageId, request, stateId, wormholeStateId, feedObjectId, vaaFromFeeId, registryId, coinType) {
-  const [updateFee] = txBlock.splitSUIFromGas([1]);
+function updatePythPrice(txBlock, packageId, request, stateId, feedObjectId, registryId, coinType) {
   txBlock.moveCall(
     `${packageId}::rule::set_price`,
-    [
-      request,
-      wormholeStateId,
-      stateId,
-      feedObjectId,
-      registryId,
-      txBlock.pure([...(0, import_bcs.fromB64)(vaaFromFeeId)]),
-      updateFee,
-      import_sui3.SUI_CLOCK_OBJECT_ID
-    ],
+    [request, stateId, feedObjectId, registryId, import_sui3.SUI_CLOCK_OBJECT_ID],
     [coinType]
   );
 }
@@ -1173,12 +1159,7 @@ var selectCoin = async (txBlock, scallopAddress, scallopUtils, coinName, amount,
 };
 var selectMarketCoin = async (txBlock, scallopAddress, scallopUtils, coinName, amount, sender) => {
   const coinPackageId = scallopAddress.get(`core.coins.${coinName}.id`);
-  const protocolPackageId = scallopAddress.get("core.packages.protocol.id");
-  const coinType = scallopUtils.parseMarketCoinType(
-    coinPackageId,
-    protocolPackageId,
-    coinName
-  );
+  const coinType = scallopUtils.parseMarketCoinType(coinPackageId, coinName);
   const coins = await scallopUtils.selectCoins(sender, amount, coinType);
   const [takeCoin, leftCoin] = txBlock.takeAmountFromCoins(coins, amount);
   return { takeCoin, leftCoin };
@@ -1193,13 +1174,13 @@ var requireSender = (txBlock) => {
   return sender;
 };
 var requireObligationInfo = async (...args) => {
-  const [txBlock, scallopAddress, suiKit, obligationId, obligationKey] = args;
-  if (args.length === 4 && obligationId)
+  const [txBlock, suiKit, obligationId, obligationKey] = args;
+  if (args.length === 3 && obligationId)
     return { obligationId };
-  if (args.length === 5 && obligationId && obligationKey)
+  if (args.length === 4 && obligationId && obligationKey)
     return { obligationId, obligationKey };
   const sender = requireSender(txBlock);
-  const obligations = await getObligations(sender, scallopAddress, suiKit);
+  const obligations = await getObligations(sender, suiKit);
   if (obligations.length === 0) {
     throw new Error(`No obligation found for sender ${sender}`);
   }
@@ -1213,7 +1194,6 @@ var scallopQuickMethodsHandler = {
     const sender = requireSender(txBlock);
     const { obligationId: obligationArg } = await requireObligationInfo(
       txBlock,
-      scallopAddress,
       suiKit,
       obligationId
     );
@@ -1236,7 +1216,6 @@ var scallopQuickMethodsHandler = {
   takeCollateralQuick: ({ txBlock, suiKit, scallopUtils, scallopAddress, isTestnet }) => async (amount, coinName, obligationId, obligationKey) => {
     const { obligationId: obligationArg, obligationKey: obligationKeyArg } = await requireObligationInfo(
       txBlock,
-      scallopAddress,
       suiKit,
       obligationId,
       obligationKey
@@ -1290,7 +1269,6 @@ var scallopQuickMethodsHandler = {
   borrowQuick: ({ txBlock, suiKit, scallopUtils, scallopAddress, isTestnet }) => async (amount, coinName, obligationId, obligationKey) => {
     const { obligationId: obligationArg, obligationKey: obligationKeyArg } = await requireObligationInfo(
       txBlock,
-      scallopAddress,
       suiKit,
       obligationId,
       obligationKey
@@ -1315,7 +1293,6 @@ var scallopQuickMethodsHandler = {
     const sender = requireSender(txBlock);
     const { obligationId: obligationArg } = await requireObligationInfo(
       txBlock,
-      scallopAddress,
       suiKit,
       obligationId
     );
@@ -1335,9 +1312,10 @@ var scallopQuickMethodsHandler = {
       return txBlock.repay(obligationArg, takeCoin, coinName);
     }
   },
-  updateAssetPricesQuick: ({ txBlock, scallopUtils, scallopAddress, isTestnet }) => async (coinNames) => {
+  updateAssetPricesQuick: ({ txBlock, suiKit, scallopUtils, scallopAddress, isTestnet }) => async (coinNames) => {
     return updateOracles(
       txBlock,
+      suiKit,
       scallopAddress,
       scallopUtils,
       coinNames,
@@ -1400,7 +1378,7 @@ var ScallopClient = class {
    */
   async getObligations(ownerAddress) {
     const owner = ownerAddress || this.walletAddress;
-    return getObligations(owner, this.address, this.suiKit);
+    return getObligations(owner, this.suiKit);
   }
   /**
    * Query obligation data.
@@ -1640,6 +1618,7 @@ var Scallop = class {
 0 && (module.exports = {
   ADDRESSES_ID,
   API_BASE_URL,
+  PROTOCOL_OBJECT_ID,
   SUI_COIN_TYPE_ARG_REGEX,
   SUPPORT_ASSET_COINS,
   SUPPORT_COLLATERAL_COINS,