btc-wallet 0.5.40-beta → 0.5.42-beta

package/README.md

@@ -103,11 +103,7 @@ Get the native BTC balance for a given Bitcoin address.
 ```typescript
 import { getBtcBalance } from 'btc-wallet';
 
-const balance = await getBtcBalance(address: string, option?: {
-  /** if csna is provided, available balance will be calculated protocol fee and repay amount */
-  csna?: string;
-  env?: ENV;
-});
+const balance = await getBtcBalance(address: string);
 // Returns balance in satoshis
 ```
 
@@ -129,18 +125,17 @@ const result = await getDepositAmount(
 
 // Returns
 interface DepositAmountResult {
-  depositAmount: number;            // Original deposit amount
-  totalDepositAmount: number;       // Total amount needed including all fees
-  protocolFee: number;             // Protocol fee
-  repayAmount: number;             // Amount to repay if there's debt
+  depositAmount: number;            // Original deposit amount to be sent
+  receiveAmount: number;            // Amount to be received after deducting fees and repayments
+  protocolFee: number;              // Protocol fee
+  repayAmount: number;              // Amount to repay if there's debt
   newAccountMinDepositAmount: number; // Minimum deposit amount for new accounts
 }
 
-To complete the deposit, you will need to send `totalDepositAmount` of BTC, which includes:
-- Original deposit amount
-- Protocol fees
-- Repayment amount (if you have existing debt)
-- New account minimum deposit (for first-time users)
+When making a deposit:
+- The user sends the `depositAmount` of BTC
+- After deducting protocol fees and repayment amounts, the user receives `receiveAmount` on NEAR
+- For new accounts, the function will throw an error if the `receiveAmount` is less than the minimum required amount
 ```
 
 ### `getWithdrawTransaction`

package/dist/core/btcUtils.d.ts

@@ -16,11 +16,7 @@ export declare function getBtcUtxos(account: string): Promise<{
     };
 }[]>;
 export declare function calculateGasFee(account: string, amount: number, feeRate?: number): Promise<any>;
-export declare function getBtcBalance(account?: string, option?: {
-    /** if csna is provided, available balance will be calculated protocol fee and repay amount */
-    csna?: string;
-    env?: ENV;
-}): Promise<{
+export declare function getBtcBalance(account?: string): Promise<{
     rawBalance: number;
     balance: number;
     availableBalance: number;
@@ -37,7 +33,7 @@ export declare function getDepositAmount(amount: string, option?: {
     newAccountMinDepositAmount?: boolean;
 }): Promise<{
     depositAmount: number;
-    totalDepositAmount: number;
+    receiveAmount: number;
     protocolFee: number;
     repayAmount: string | number;
     newAccountMinDepositAmount: string | number;

package/dist/index.js

@@ -3943,7 +3943,7 @@ function calculateGasFee(account, amount, feeRate) {
     return fee;
   });
 }
-function getBtcBalance(account, option) {
+function getBtcBalance(account) {
   return __async(this, null, function* () {
     if (!account) {
       const res = yield retryOperation(getBtcProvider, (res2) => !!res2.account);
@@ -3958,11 +3958,7 @@ function getBtcBalance(account, option) {
     const rawBalance = (utxos == null ? void 0 : utxos.reduce((acc, cur) => acc + cur.value, 0)) || 0;
     const balance = rawBalance / __pow(10, btcDecimals);
     const estimatedFee = yield calculateGasFee(account, rawBalance);
-    let availableRawBalance = (rawBalance - estimatedFee).toFixed(0);
-    if (option == null ? void 0 : option.csna) {
-      const { protocolFee, repayAmount } = yield getDepositAmount(rawBalance.toString(), option);
-      availableRawBalance = new import_big2.default(availableRawBalance).minus(protocolFee).minus(repayAmount).toFixed(0);
-    }
+    const availableRawBalance = (rawBalance - estimatedFee).toFixed(0);
     const availableBalance = new import_big2.default(availableRawBalance).div(__pow(10, btcDecimals)).round(btcDecimals, import_big2.default.roundDown).toNumber();
     return {
       rawBalance,
@@ -3999,10 +3995,15 @@ function getDepositAmount(amount, option) {
     const depositAmount = Math.max(Number(min_deposit_amount), Number(amount));
     const protocolFee = Math.max(Number(fee_min), Number(depositAmount) * fee_rate);
     const newAccountMinDepositAmount = !(accountInfo == null ? void 0 : accountInfo.nonce) && _newAccountMinDepositAmount ? NEW_ACCOUNT_MIN_DEPOSIT_AMOUNT : 0;
-    const totalDepositAmount = new import_big2.default(depositAmount).plus(protocolFee).plus(repayAmount).plus(newAccountMinDepositAmount).round(0, import_big2.default.roundDown).toNumber();
+    const receiveAmount = new import_big2.default(depositAmount).minus(protocolFee).minus(repayAmount).round(0, import_big2.default.roundDown).toNumber();
+    if (Number(newAccountMinDepositAmount) > 0 && receiveAmount < Number(newAccountMinDepositAmount)) {
+      throw new Error(
+        `Receive amount (${receiveAmount}) is less than minimum required amount for new account (${newAccountMinDepositAmount})`
+      );
+    }
     return {
       depositAmount,
-      totalDepositAmount,
+      receiveAmount,
       protocolFee,
       repayAmount,
       newAccountMinDepositAmount
@@ -4066,7 +4067,7 @@ function executeBTCDepositAndAction(_0) {
       if (new import_big2.default(depositAmount).lt(0)) {
         throw new Error("amount must be greater than 0");
       }
-      const { totalDepositAmount, protocolFee, repayAmount } = yield getDepositAmount(depositAmount, {
+      const { receiveAmount, protocolFee, repayAmount } = yield getDepositAmount(depositAmount, {
         env,
         newAccountMinDepositAmount
       });
@@ -4116,7 +4117,7 @@ function executeBTCDepositAndAction(_0) {
         "Deposit Amount": depositAmount,
         "Protocol Fee": protocolFee,
         "Repay Amount": repayAmount,
-        "Total Deposit Amount": totalDepositAmount,
+        "Receive Amount": receiveAmount,
         "Fee Rate": _feeRate
       });
       const postActionsStr = newActions.length > 0 ? JSON.stringify(newActions) : void 0;
@@ -4126,7 +4127,7 @@ function executeBTCDepositAndAction(_0) {
         postActions: postActionsStr,
         extraMsg: depositMsg.extra_msg
       });
-      const txHash = yield sendBitcoin(userDepositAddress, totalDepositAmount, _feeRate);
+      const txHash = yield sendBitcoin(userDepositAddress, Number(depositAmount), _feeRate);
       yield receiveDepositMsg(config.base_url, {
         btcPublicKey,
         txHash,
@@ -4916,7 +4917,7 @@ function getGroup(state) {
 
 // src/index.ts
 var getVersion = () => {
-  return "0.5.40-beta";
+  return "0.5.42-beta";
 };
 if (typeof window !== "undefined") {
   window.__BTC_WALLET_VERSION = getVersion();