btc-wallet 0.3.27 → 0.3.29

package/README.md

@@ -69,6 +69,7 @@ interface ExecuteBTCDepositAndActionParams<T extends boolean = true> {
   fixedAmount?: boolean;   // optional: whether to use fixed amount
   env?: 'mainnet' | 'testnet' | 'private_mainnet' | 'dev'; // optional: defaults to NEAR network environment
   pollResult?: T;         // optional: whether to poll for transaction result
+  registerDeposit?: string; // optional: whether to register deposit,default 0.000125 NEAR
 }
 
 // Example 1: dApp one-click BTC deposit
@@ -78,7 +79,8 @@ await executeBTCDepositAndAction({
     amount: '1000000',     // in smallest units
     msg: 'Deposit'
   },
-  feeRate: 5
+  feeRate: 5,
+  registerDeposit: '100000000000000000000000',  // default 0.000125 NEAR, you can set it according to your needs
 });
 
 // Example 2: Direct Satoshi bridge deposit
@@ -99,6 +101,32 @@ const balance = await getBtcBalance(address: string);
 // Returns balance in satoshis
 ```
 
+### `estimateDepositAmount`
+
+Estimate the amount of BTC tokens that will be received on NEAR after depositing native BTC through Satoshi bridge. This takes into account bridge fees and minimum deposit requirements.
+
+```typescript
+import { estimateDepositAmount } from 'btc-wallet';
+
+// Estimate receivable amount
+const receiveAmount = await estimateDepositAmount(
+  amount: string,           // amount in smallest units (satoshis)
+  options?: {
+    env?: 'mainnet' | 'testnet' | 'private_mainnet' | 'dev' // optional: defaults to NEAR network environment
+  }
+);
+
+// Example
+const amount = '100000000'; // 1 BTC in satoshis
+const estimatedReceive = await estimateDepositAmount(amount);
+console.log('Estimated receive amount:', estimatedReceive);
+```
+
+The estimated amount will be less than the input amount due to:
+- Bridge fees
+- Minimum deposit requirements
+- Protocol fees
+
 ## Requirements
 
 - React 17.0.0 or higher

package/dist/core/btcUtils.d.ts

@@ -51,6 +51,8 @@ interface ExecuteBTCDepositAndActionParams<T extends boolean = true> {
         msg: string;
     };
     amount?: string;
+    /** if registerDeposit is true, It will consume the deposit, otherwise it will be 0.000125 NEAR */
+    registerDeposit?: string;
     feeRate?: number;
     fixedAmount?: boolean;
     env?: ENV;
@@ -60,5 +62,5 @@ interface ExecuteBTCDepositAndActionParams<T extends boolean = true> {
  * @param T - if true, return the poll result, otherwise return the btcTxHash
  */
 type ExecuteBTCDepositAndActionReturn<T extends boolean> = T extends true ? FinalExecutionOutcome[] : string;
-export declare function executeBTCDepositAndAction<T extends boolean = true>({ action, amount, feeRate, fixedAmount, pollResult, env, }: ExecuteBTCDepositAndActionParams<T>): Promise<ExecuteBTCDepositAndActionReturn<T>>;
+export declare function executeBTCDepositAndAction<T extends boolean = true>({ action, amount, feeRate, fixedAmount, pollResult, registerDeposit, env, }: ExecuteBTCDepositAndActionParams<T>): Promise<ExecuteBTCDepositAndActionReturn<T>>;
 export {};

package/dist/index.js

@@ -3230,6 +3230,9 @@ Dialog.style = `
 // src/core/btcUtils.ts
 var MINIMUM_DEPOSIT_AMOUNT = 5e3;
 var MINIMUM_DEPOSIT_AMOUNT_BASE = 1e3;
+var NEAR_STORAGE_DEPOSIT_AMOUNT = "1250000000000000000000";
+var NBTC_STORAGE_DEPOSIT_AMOUNT = 3e3;
+var GAS_LIMIT = "50000000000000";
 function getBtcProvider() {
   if (typeof window === "undefined" || !window.btcContext) {
     throw new Error("BTC Provider is not initialized.");
@@ -3416,6 +3419,7 @@ function executeBTCDepositAndAction(_0) {
     feeRate,
     fixedAmount = true,
     pollResult = true,
+    registerDeposit,
     env = "mainnet"
   }) {
     var _a;
@@ -3439,47 +3443,50 @@ function executeBTCDepositAndAction(_0) {
       });
       const accountInfo = yield getAccountInfo(csna, config.accountContractId);
       const newActions = [];
-      const gasLimit = new import_big.default(50).mul(__pow(10, 12)).toFixed(0);
       const repayAction = yield checkGasTokenArrears(accountInfo == null ? void 0 : accountInfo.debt_info, env, false);
       if (repayAction) {
         newActions.push(__spreadProps(__spreadValues({}, repayAction), {
-          gas: gasLimit
+          gas: GAS_LIMIT
         }));
       }
       if (action || !action && new import_big.default((accountInfo == null ? void 0 : accountInfo.gas_token[config.token]) || 0).lt(MINIMUM_DEPOSIT_AMOUNT_BASE)) {
         newActions.push(
           action ? __spreadProps(__spreadValues({}, action), {
             amount: (repayAction == null ? void 0 : repayAction.amount) && !fixedAmount ? new import_big.default(receiveAmount).minus(repayAction.amount).toString() : receiveAmount.toString(),
-            gas: gasLimit
+            gas: GAS_LIMIT
           }) : {
             receiver_id: config.accountContractId,
             amount: MINIMUM_DEPOSIT_AMOUNT_BASE.toString(),
             msg: JSON.stringify("Deposit"),
-            gas: gasLimit
+            gas: GAS_LIMIT
           }
         );
       }
-      const depositMsg = {
-        recipient_id: csna,
-        post_actions: newActions.length > 0 ? newActions : void 0
-      };
       const storageDepositMsg = {};
-      if (!(accountInfo == null ? void 0 : accountInfo.nonce)) {
-        storageDepositMsg.btc_public_key = btcPublicKey;
-      }
       const registerRes = yield nearCall((action == null ? void 0 : action.receiver_id) || config.token, "storage_balance_of", {
         account_id: csna
       });
       if (!(registerRes == null ? void 0 : registerRes.available)) {
         storageDepositMsg.storage_deposit_msg = {
           contract_id: (action == null ? void 0 : action.receiver_id) || config.token,
-          deposit: new import_big.default(125e-5).mul(__pow(10, 24)).toFixed(0),
+          deposit: registerDeposit || NEAR_STORAGE_DEPOSIT_AMOUNT,
           registration_only: true
         };
       }
-      if (Object.keys(storageDepositMsg).length > 0) {
-        depositMsg.extra_msg = JSON.stringify(storageDepositMsg);
+      if (!(accountInfo == null ? void 0 : accountInfo.nonce)) {
+        storageDepositMsg.btc_public_key = btcPublicKey;
+        newActions.push({
+          receiver_id: config.accountContractId,
+          amount: NBTC_STORAGE_DEPOSIT_AMOUNT.toString(),
+          msg: JSON.stringify("RelayerFee"),
+          gas: GAS_LIMIT
+        });
       }
+      const depositMsg = {
+        recipient_id: csna,
+        post_actions: newActions.length > 0 ? newActions : void 0,
+        extra_msg: Object.keys(storageDepositMsg).length > 0 ? JSON.stringify(storageDepositMsg) : void 0
+      };
       console.log("get_user_deposit_address params:", { deposit_msg: depositMsg });
       const userDepositAddress = yield nearCall(
         config.bridgeContractId,
@@ -3994,7 +4001,7 @@ function setupBTCWallet({
 
 // src/index.ts
 var getVersion = () => {
-  return "0.3.27";
+  return "0.3.29";
 };
 if (typeof window !== "undefined") {
   window.__BTC_WALLET_VERSION = getVersion();