@rhea-finance/cross-chain-sdk 0.1.8 → 0.1.10

package/README.md

@@ -163,11 +163,13 @@ The following steps describe how to create a multi-chain account:
 import type {
   IChain,
   IIntentsQuoteResult,
+  Asset,
 } from "@rhea-finance/cross-chain-sdk";
 import {
   format_wallet,
   serializationObj,
   getCreateMcaCustomRecipientMsg,
+  getCreateMcaFeeData,
   intentsQuotation,
   prepare_sign_message_evm,
   process_signature_evm,
@@ -200,7 +202,19 @@ const customRecipientMsg = getCreateMcaCustomRecipientMsg({
   signedMessages: [signedMessage],
 });
 
-// Step 4: Get intents quote to obtain depositAddress
+// Step 4: Get create MCA fee data
+// Get the on-chain fee for creating an MCA account
+// Parameters:
+//   asset: The Asset object
+//   bufferMultiple: Optional buffer multiplier (default 1.05)
+const mcaFee = await getCreateMcaFeeData({
+  asset: asset,
+  bufferMultiple: 1.05, // optional, default 1.05
+});
+// mcaFee.amountRaw     - fee amount with token precision (for contract calls)
+// mcaFee.amountReadable - human-readable fee amount
+
+// Step 5: Get intents quote to obtain depositAddress
 const res_quote: IIntentsQuoteResult = await intentsQuotation({
   originAsset: "nep141:xxx",
   destinationAsset: "nep141:xxx",
@@ -213,8 +227,18 @@ const res_quote: IIntentsQuoteResult = await intentsQuotation({
   customRecipientMsg: customRecipientMsg,
 });
 
-// Step 5: Get depositAddress and transfer funds to complete MCA creation
+// Step 6: Get depositAddress and transfer funds to complete MCA creation
 const depositAddress = res_quote.quoteSuccessResult?.quote?.depositAddress;
+
+// Step 7: Calculate total fee
+// Total fee = MCA creation fee + intents quotation fee (cross-chain bridge/swap fee)
+// quoteFeeData is returned by intentsQuotation when quoteStatus is "success"
+//   quoteFeeData.feeAmount - bridge/swap fee amount (readable)
+//   quoteFeeData.feeUsd    - bridge/swap fee in USD
+const quoteFee = res_quote.quoteFeeData;
+// Total fee (readable) = mcaFee.amountReadable + quoteFee.feeAmount
+// Total fee (USD)       = mcaFee amount in USD  + quoteFee.feeUsd
+
 // Transfer funds to depositAddress using your wallet
 ```
 
@@ -307,6 +331,11 @@ const result = await getSupplyDepositData({
 // Transfer to depositAddress to complete Supply
 const depositAddress = result.depositAddress;
 // result also contains quoteResult's full quote data
+
+// quoteFeeData - cross-chain bridge/swap fee (present when quote succeeds)
+const quoteFeeData = result.quoteResult?.quoteFeeData;
+// quoteFeeData.feeAmount - bridge/swap fee amount (readable)
+// quoteFeeData.feeUsd    - bridge/swap fee in USD
 ```
 
 ### Cross-chain Repay
@@ -437,6 +466,11 @@ const { businessMap, quoteResult } = await prepareBusinessDataOnWithdraw({
   decreaseCollateralAmoun,
 });
 
+// quoteFeeData - cross-chain bridge/swap fee (present when quote succeeds)
+const quoteFeeData = quoteResult?.quoteFeeData;
+// quoteFeeData.feeAmount - bridge/swap fee amount (readable)
+// quoteFeeData.feeUsd    - bridge/swap fee in USD
+
 const wallet = format_wallet({ chain, identityKey });
 const signedBusiness = await sign_message({
   chain,
@@ -759,6 +793,33 @@ if (relayer_result?.code == 0) {
 }
 ```
 
+### Get farm details for an asset
+
+```typescript
+import {
+  getFarmDetailsOfAsset,
+  getAssetDetailsView,
+} from "@rhea-finance/cross-chain-sdk";
+
+// Get assets view (IAssetsView)
+const assets = await getAssetDetailsView();
+
+// Get farm details for a specific asset
+const farmDetails = getFarmDetailsOfAsset({
+  assets,
+  assetId: "zec.omft.near",
+  booster: 1.5, // optional, default 1.5
+});
+
+// farmDetails: IFarmDetailsOfAsset
+console.log(farmDetails.minFarmApy);    // market farm APY (min)
+console.log(farmDetails.maxFarmApy);    // max farm APY (with booster)
+console.log(farmDetails.tokenNetRewards); // reward token metadata
+console.log(farmDetails.canBeBooster);  // whether asset can be boosted
+console.log(farmDetails.supplyApy);     // supply APR (%)
+console.log(farmDetails.borrowApy);    // borrow APR (%)
+```
+
 ### Cross-chain Withdraw Rewards
 
 ```typescript
@@ -882,6 +943,7 @@ if (res.status === "success") {
 - `getPrices` - Get price information
 - `getBalance` - Get balance
 - `getFarms` - Get liquidity mining information
+- `getFarmDetailsOfAsset` - Get farm details (APY, rewards, canBeBooster) for an asset
 - `getConfig` - Get configuration
 - `getBoosterTokens` - Get booster token information
 - `getTokenDetail` - Get token details
@@ -910,6 +972,7 @@ if (res.status === "success") {
 
 **MCA Creation**
 - `getCreateMcaCustomRecipientMsg` - Get custom recipient message for creating MCA
+- `getCreateMcaFeeData` - Get the on-chain fee for creating an MCA account. Returns `{ amountRaw, amountReadable }`. Parameters: `asset` (Asset object), `bufferMultiple` (optional, default 1.5)
 - `getZcashCreateMcaDepositAddress` - Get deposit address when creating MCA with Zcash (Old way)
 - `getZcashResponseDataByAddress` - Get Zcash deposit/creation data by address (Old way)
 
@@ -925,6 +988,14 @@ if (res.status === "success") {
 - `prepareBusinessDataOnWithdrawRewards` - Prepare cross-chain withdraw rewards business data
 
 
+**Intents Quotation**
+- `intentsQuotation` - Get cross-chain swap/bridge quote. Returns `IIntentsQuoteResult` which includes:
+  - `quoteStatus` - `"success"` or `"error"`
+  - `quoteSuccessResult` - Quote details (depositAddress, amounts, etc.)
+  - `quoteFeeData` - Fee data for the cross-chain bridge/swap (only present when `quoteStatus` is `"success"`):
+    - `feeAmount` - Bridge/swap fee amount (readable, = amountInFormatted - amountOutFormatted)
+    - `feeUsd` - Bridge/swap fee in USD (= amountInUsd - amountOutUsd)
+
 **General Utilities**
 - `format_wallet` - Format wallet address
 - `serializationObj` - Serialize object

package/dist/index.cjs

@@ -1,14 +1,14 @@
 'use strict';
 
 var Decimal13 = require('decimal.js');
-var Big = require('big.js');
+var Big3 = require('big.js');
 var ramda = require('ramda');
 var _7 = require('lodash');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var Decimal13__default = /*#__PURE__*/_interopDefault(Decimal13);
-var Big__default = /*#__PURE__*/_interopDefault(Big);
+var Big3__default = /*#__PURE__*/_interopDefault(Big3);
 var _7__default = /*#__PURE__*/_interopDefault(_7);
 
 var __create = Object.create;
@@ -18167,9 +18167,19 @@ async function fetchIntentsQuotation(params) {
     });
     const quote = response?.quote;
     if (quote) {
+      const feeAmountBig = new Big3__default.default(quote?.amountInFormatted || 0).minus(
+        quote?.amountOutFormatted || 0
+      );
+      const feeUsdBig = new Big3__default.default(quote?.amountInUsd || 0).minus(
+        quote?.amountOutUsd || 0
+      );
       return {
         quoteStatus: "success",
-        quoteSuccessResult: response
+        quoteSuccessResult: response,
+        quoteFeeData: {
+          feeAmount: feeAmountBig.gt(0) ? feeAmountBig.toFixed() : "0",
+          feeUsd: feeUsdBig.gt(0) ? feeUsdBig.toFixed() : "0"
+        }
       };
     } else {
       return {
@@ -18521,7 +18531,7 @@ async function getSwapActionsList({
   });
   return {
     swapActionsList,
-    amountOut: new Big__default.default(amount_out || 0).mul(1 - slippage).toFixed(0, Big__default.default.roundDown)
+    amountOut: new Big3__default.default(amount_out || 0).mul(1 - slippage).toFixed(0, Big3__default.default.roundDown)
   };
 }
 async function swap_tx_query({
@@ -18536,7 +18546,7 @@ async function swap_tx_query({
     tokenInAmount: amountToken,
     tokenOutId
   });
-  if (res_swap.length <= 0 || new Big__default.default(amountOut).lte(0)) {
+  if (res_swap.length <= 0 || new Big3__default.default(amountOut).lte(0)) {
     return {
       status: "error",
       message: "No path available to make a swap"
@@ -19832,7 +19842,7 @@ function getUnclaimedRewards({
   const sumByToken = {};
   const add = (rewardTokenId, unclaimedAmount) => {
     if (unclaimedAmount === "0") return;
-    sumByToken[rewardTokenId] = Big__default.default(sumByToken[rewardTokenId] || "0").plus(unclaimedAmount).toFixed(0);
+    sumByToken[rewardTokenId] = Big3__default.default(sumByToken[rewardTokenId] || "0").plus(unclaimedAmount).toFixed(0);
   };
   Object.values(tokennetbalance).forEach((farm) => {
     Object.entries(farm).forEach(([rewardTokenId, data]) => {
@@ -19887,6 +19897,24 @@ async function getSimpleWithdrawData(params) {
   }
   return result;
 }
+async function getCreateMcaFeeData({
+  bufferMultiple = 1.05,
+  asset
+}) {
+  const feeList = await getCreateMcaFeePaged();
+  const nearValueList = await getNearValuesPaged();
+  const tokenId = asset.token_id;
+  const mcaFee = feeList[tokenId] || "0";
+  const nearValue = nearValueList[tokenId] || "0";
+  const totalFee = Big3__default.default(mcaFee).plus(Big3__default.default(nearValue).mul(0.1)).toFixed(0, Big3__default.default.roundDown);
+  const decimals = asset.metadata?.decimals ?? 0;
+  const amountRaw = Big3__default.default(totalFee).mul(bufferMultiple).toFixed(0, Big3__default.default.roundDown);
+  const amountReadable = toReadableNumber(decimals, amountRaw);
+  return {
+    amountRaw,
+    amountReadable
+  };
+}
 
 // src/utils/transformers/account.ts
 init_polyfills();
@@ -20071,6 +20099,59 @@ var getAllFarms = async () => {
     throw new Error("getAllFarms");
   }
 };
+function getFarmDetailsOfAsset({
+  assets,
+  assetId,
+  booster = 1.5
+}) {
+  const asset = assets[assetId];
+  if (!asset) {
+    return {
+      minFarmApy: 0,
+      maxFarmApy: 0,
+      tokenNetRewards: [],
+      canBeBooster: false,
+      supplyApy: 0,
+      borrowApy: 0
+    };
+  }
+  const tokenNetFarms = asset.farms.tokennetbalance || {};
+  const assetDecimals = (asset.metadata?.decimals ?? 0) + (asset.config?.extra_decimals ?? 0);
+  const rewardMetas = [];
+  for (const rewardTokenId of Object.keys(tokenNetFarms)) {
+    const rewardAsset = assets[rewardTokenId];
+    if (rewardAsset?.metadata) rewardMetas.push(rewardAsset.metadata);
+  }
+  const firstFarm = Object.values(tokenNetFarms)[0];
+  const canBeBooster = !!(firstFarm?.booster_log_bases && Object.keys(firstFarm.booster_log_bases).length > 0);
+  const marketFarmApy = Object.entries(tokenNetFarms).reduce(
+    (acc, [rewardTokenId, farmData]) => {
+      const rewardAsset = assets[rewardTokenId];
+      if (!rewardAsset) return acc;
+      const rewardAPY = new Decimal13__default.default(farmData.reward_per_day).div(
+        new Decimal13__default.default(10).pow(
+          (rewardAsset.metadata?.decimals ?? 0) + (rewardAsset.config?.extra_decimals ?? 0)
+        )
+      ).mul(365).mul(rewardAsset.price?.usd || "0").div(
+        new Decimal13__default.default(shrinkToken(farmData.boosted_shares, assetDecimals)).mul(
+          asset.price?.usd || "0"
+        )
+      ).mul(100);
+      return acc.plus(rewardAPY);
+    },
+    new Decimal13__default.default(0)
+  );
+  const supplyApr = new Decimal13__default.default(asset.supply_apr || 0).mul(100).toNumber();
+  const borrowApr = new Decimal13__default.default(asset.borrow_apr || 0).mul(100).toNumber();
+  return {
+    minFarmApy: marketFarmApy.toNumber(),
+    maxFarmApy: marketFarmApy.mul(booster).toNumber(),
+    supplyApy: supplyApr,
+    borrowApy: borrowApr,
+    tokenNetRewards: rewardMetas,
+    canBeBooster
+  };
+}
 
 // src/view/zcash.ts
 init_polyfills();
@@ -20769,7 +20850,7 @@ async function prepareBusinessDataOnWithdrawRewards({
         }
       });
     }
-    const bridgeTokenAmount = new Big__default.default(amountOut).toFixed(0, Decimal13__default.default.ROUND_DOWN);
+    const bridgeTokenAmount = new Big3__default.default(amountOut).toFixed(0, Decimal13__default.default.ROUND_DOWN);
     const quoteResult = await intentsQuotation({
       originAsset,
       destinationAsset,
@@ -20805,7 +20886,7 @@ async function prepareBusinessDataOnWithdrawRewards({
       ]
     };
     const businessMapExtra = {
-      nonce: new Big__default.default(nonce).plus(1).toFixed(0),
+      nonce: new Big3__default.default(nonce).plus(1).toFixed(0),
       deadline,
       tx_requests: [
         ...mca_register_receive_token_tx,
@@ -21078,7 +21159,9 @@ exports.getBorrowMaxAmount = getBorrowMaxAmount;
 exports.getConfig = getConfig2;
 exports.getCreateMcaCustomRecipientMsg = getCreateMcaCustomRecipientMsg;
 exports.getCreateMcaFee = getCreateMcaFee;
+exports.getCreateMcaFeeData = getCreateMcaFeeData;
 exports.getCreateMcaFeePaged = getCreateMcaFeePaged;
+exports.getFarmDetailsOfAsset = getFarmDetailsOfAsset;
 exports.getListWalletsByMca = getListWalletsByMca;
 exports.getMcaByWallet = getMcaByWallet;
 exports.getMultichainLendingConfig = getMultichainLendingConfig;