btc-wallet 0.4.4-beta → 0.4.6-beta

package/README.md

@@ -66,7 +66,6 @@ interface ExecuteBTCDepositAndActionParams<T extends boolean = true> {
   
   // Common optional parameters
   feeRate?: number;        // optional: custom fee rate for the BTC transaction
-  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

package/dist/core/btcUtils.d.ts

@@ -1,27 +1,25 @@
 import type { ENV } from '../config';
-import type { FinalExecutionOutcome } from '@near-wallet-selector/core';
+import type { FinalExecutionOutcome, Transaction } from '@near-wallet-selector/core';
 export interface AccountInfo {
     nonce: string;
     gas_token: Record<string, string>;
-    debt_info?: DebtInfo;
+    debt_info?: {
+        gas_token_id: string;
+        near_gas_debt_amount: string;
+        protocol_fee_debt_amount: string;
+    };
     relayer_fee?: {
         amount?: string;
     };
 }
-export interface DebtInfo {
-    gas_token_id: string;
-    near_gas_debt_amount: string;
-    protocol_fee_debt_amount: string;
-}
 export declare function getAccountInfo(csna: string, accountContractId: string): Promise<AccountInfo | undefined>;
 export declare function checkGasTokenBalance(csna: string, gasToken: string, minAmount: string, env: ENV): Promise<void>;
-type CheckGasTokenArrearsReturnType<T extends boolean> = T extends true ? void : {
+type CheckGasTokenDebtReturnType<T extends boolean> = T extends true ? void : {
     receiver_id: string;
     amount: string;
     msg: string;
 } | undefined;
-export declare function checkGasTokenArrears<T extends boolean>(accountInfo: AccountInfo | undefined, env: ENV, autoDeposit?: T): Promise<CheckGasTokenArrearsReturnType<T>>;
-export declare function queryGasTokenArrears(env: ENV): Promise<DebtInfo | undefined>;
+export declare function checkGasTokenDebt<T extends boolean>(accountInfo: AccountInfo | undefined, env: ENV, autoDeposit?: T): Promise<CheckGasTokenDebtReturnType<T>>;
 export declare function getBtcGasPrice(): Promise<number>;
 export declare function getBtcBalance(): Promise<{
     rawBalance: number;
@@ -34,17 +32,24 @@ export declare function getBtcBalance(): Promise<{
     availableBalance: number;
     maxSpendableBalance?: undefined;
 }>;
+export declare function getNBTCBalance(address: string, env?: ENV): Promise<{
+    balance: number;
+    availableBalance: number;
+    rawBalance: string;
+    rawAvailableBalance: number;
+}>;
 export declare function sendBitcoin(address: string, amount: number, feeRate: number): Promise<string>;
+/** estimate deposit receive amount, deduct protocol fee and repay amount */
 export declare function estimateDepositAmount(amount: string, option?: {
     env?: ENV;
-}): Promise<number>;
+}): Promise<string>;
 export declare function getDepositAmount(amount: string, option?: {
-    isEstimate?: boolean;
     env?: ENV;
 }): Promise<{
     depositAmount: number;
-    receiveAmount: number;
-    fee: number;
+    totalDepositAmount: number;
+    protocolFee: number;
+    repayAmount: string | number;
 }>;
 export declare function getCsnaAccountId(env: ENV): Promise<string>;
 interface ExecuteBTCDepositAndActionParams<T extends boolean = true> {
@@ -57,7 +62,6 @@ interface ExecuteBTCDepositAndActionParams<T extends boolean = true> {
     /** if registerDeposit is true, It will consume the deposit, otherwise it will be 0.000125 NEAR */
     registerDeposit?: string;
     feeRate?: number;
-    fixedAmount?: boolean;
     env?: ENV;
     pollResult?: T;
 }
@@ -65,6 +69,12 @@ 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, registerDeposit, env, }: ExecuteBTCDepositAndActionParams<T>): Promise<ExecuteBTCDepositAndActionReturn<T>>;
+export declare function executeBTCDepositAndAction<T extends boolean = true>({ action, amount, feeRate, pollResult, registerDeposit, env, }: ExecuteBTCDepositAndActionParams<T>): Promise<ExecuteBTCDepositAndActionReturn<T>>;
 export declare function checkSatoshiWhitelist(btcAccountId: string, env?: ENV): Promise<void>;
+interface WithdrawParams {
+    amount: string | number;
+    feeRate?: number;
+    env?: ENV;
+}
+export declare function getWithdrawTransaction({ amount, feeRate, env, }: WithdrawParams): Promise<Transaction>;
 export {};

package/dist/index.js

@@ -90,8 +90,8 @@ __export(src_exports, {
   UnisatConnector: () => UnisatConnector,
   WizzConnector: () => WizzConnector,
   XverseConnector: () => XverseConnector,
-  checkGasTokenArrears: () => checkGasTokenArrears,
   checkGasTokenBalance: () => checkGasTokenBalance,
+  checkGasTokenDebt: () => checkGasTokenDebt,
   checkSatoshiWhitelist: () => checkSatoshiWhitelist,
   estimateDepositAmount: () => estimateDepositAmount,
   executeBTCDepositAndAction: () => executeBTCDepositAndAction,
@@ -100,8 +100,9 @@ __export(src_exports, {
   getBtcGasPrice: () => getBtcGasPrice,
   getCsnaAccountId: () => getCsnaAccountId,
   getDepositAmount: () => getDepositAmount,
+  getNBTCBalance: () => getNBTCBalance,
   getVersion: () => getVersion,
-  queryGasTokenArrears: () => queryGasTokenArrears,
+  getWithdrawTransaction: () => getWithdrawTransaction,
   sendBitcoin: () => sendBitcoin,
   setupBTCWallet: () => setupBTCWallet,
   useAccountContract: () => useAccountContract,
@@ -2401,6 +2402,7 @@ function BtcWalletSelectorContextProvider({
   const [isProcessing, setIsProcessing] = (0, import_react11.useState)(false);
   const connectors = [
     new UnisatConnector(),
+    new XverseConnector(),
     new OKXConnector(),
     new BitgetConnector()
   ];
@@ -3240,9 +3242,10 @@ Dialog.style = `
   `;
 
 // src/core/btcUtils.ts
-var MINIMUM_DEPOSIT_AMOUNT_BASE = 0;
+var import_bitcoinjs_lib = __toESM(require("bitcoinjs-lib"), 1);
+var import_coinselect = __toESM(require("coinselect"), 1);
 var NEAR_STORAGE_DEPOSIT_AMOUNT = "1250000000000000000000";
-var NBTC_STORAGE_DEPOSIT_AMOUNT = 3e3;
+var NBTC_STORAGE_DEPOSIT_AMOUNT = "3000";
 var GAS_LIMIT = "50000000000000";
 function getBtcProvider() {
   if (typeof window === "undefined" || !window.btcContext) {
@@ -3300,11 +3303,11 @@ function checkGasTokenBalance(csna, gasToken, minAmount, env) {
     }
   });
 }
-function checkGasTokenArrears(accountInfo, env, autoDeposit) {
+function checkGasTokenDebt(accountInfo, env, autoDeposit) {
   return __async(this, null, function* () {
     var _a, _b, _c;
     const debtAmount = new import_big.default(((_a = accountInfo == null ? void 0 : accountInfo.debt_info) == null ? void 0 : _a.near_gas_debt_amount) || 0).plus(((_b = accountInfo == null ? void 0 : accountInfo.debt_info) == null ? void 0 : _b.protocol_fee_debt_amount) || 0).toString();
-    const relayerFeeAmount = ((_c = accountInfo == null ? void 0 : accountInfo.relayer_fee) == null ? void 0 : _c.amount) || "0";
+    const relayerFeeAmount = !(accountInfo == null ? void 0 : accountInfo.nonce) ? NBTC_STORAGE_DEPOSIT_AMOUNT : ((_c = accountInfo == null ? void 0 : accountInfo.relayer_fee) == null ? void 0 : _c.amount) || 0;
     const hasDebtArrears = new import_big.default(debtAmount).gt(0);
     const hasRelayerFeeArrears = new import_big.default(relayerFeeAmount).gt(0);
     if (!hasDebtArrears && !hasRelayerFeeArrears)
@@ -3314,7 +3317,7 @@ function checkGasTokenArrears(accountInfo, env, autoDeposit) {
     console.log("get_account:", accountInfo);
     const action = {
       receiver_id: config.accountContractId,
-      amount: transferAmount,
+      amount: transferAmount.toString(),
       msg: JSON.stringify(hasDebtArrears ? "Repay" : "RelayerFee")
     };
     if (!autoDeposit)
@@ -3334,14 +3337,6 @@ function checkGasTokenArrears(accountInfo, env, autoDeposit) {
     }
   });
 }
-function queryGasTokenArrears(env) {
-  return __async(this, null, function* () {
-    const config = yield getConfig(env);
-    const csna = yield getCsnaAccountId(env);
-    const accountInfo = yield getAccountInfo(csna, config.accountContractId);
-    return accountInfo == null ? void 0 : accountInfo.debt_info;
-  });
-}
 function getBtcGasPrice() {
   return __async(this, null, function* () {
     const network = yield getNetwork();
@@ -3383,6 +3378,18 @@ function getBtcBalance() {
     };
   });
 }
+function getNBTCBalance(address, env) {
+  return __async(this, null, function* () {
+    const config = yield getConfig(env || "mainnet");
+    const rawBalance = yield nearCall(config.token, "ft_balance_of", {
+      account_id: address
+    });
+    const balance = new import_big.default(rawBalance).div(__pow(10, 8)).round(8, import_big.default.roundDown).toNumber();
+    const rawAvailableBalance = new import_big.default(rawBalance).minus(1e3).toNumber();
+    const availableBalance = new import_big.default(rawAvailableBalance).div(__pow(10, 8)).round(8, import_big.default.roundDown).toNumber();
+    return { balance, availableBalance, rawBalance, rawAvailableBalance };
+  });
+}
 function sendBitcoin(address, amount, feeRate) {
   return __async(this, null, function* () {
     const { sendBitcoin: sendBitcoin2 } = getBtcProvider();
@@ -3392,28 +3399,29 @@ function sendBitcoin(address, amount, feeRate) {
 }
 function estimateDepositAmount(amount, option) {
   return __async(this, null, function* () {
-    const config = yield getConfig((option == null ? void 0 : option.env) || "mainnet");
-    const csna = yield getCsnaAccountId((option == null ? void 0 : option.env) || "mainnet");
-    const accountInfo = yield getAccountInfo(csna, config.accountContractId);
-    const { receiveAmount } = yield getDepositAmount(amount, __spreadProps(__spreadValues({}, option), { isEstimate: true }));
-    return (accountInfo == null ? void 0 : accountInfo.nonce) ? receiveAmount : new import_big.default(receiveAmount).minus(NBTC_STORAGE_DEPOSIT_AMOUNT).round(0, import_big.default.roundDown).toNumber();
+    return amount;
   });
 }
 function getDepositAmount(amount, option) {
   return __async(this, null, function* () {
-    const config = yield getConfig((option == null ? void 0 : option.env) || "mainnet");
+    const env = (option == null ? void 0 : option.env) || "mainnet";
+    const config = yield getConfig(env);
+    const csna = yield getCsnaAccountId(env);
+    const accountInfo = yield getAccountInfo(csna, config.accountContractId);
+    const debtAction = yield checkGasTokenDebt(accountInfo, env, false);
+    const repayAmount = (debtAction == null ? void 0 : debtAction.amount) || 0;
     const {
       deposit_bridge_fee: { fee_min, fee_rate },
       min_deposit_amount
     } = yield nearCall(config.bridgeContractId, "get_config", {});
-    const depositAmount = (option == null ? void 0 : option.isEstimate) ? Number(amount) : Math.max(Number(min_deposit_amount) + MINIMUM_DEPOSIT_AMOUNT_BASE, Number(amount));
-    const fee = Math.max(Number(fee_min), Number(depositAmount) * fee_rate);
-    const receiveAmount = new import_big.default(depositAmount).minus(fee).minus(MINIMUM_DEPOSIT_AMOUNT_BASE).round(0, import_big.default.roundDown).toNumber();
-    console.log("getDepositAmount:", { depositAmount, receiveAmount, fee });
+    const depositAmount = Math.max(Number(min_deposit_amount), Number(amount));
+    const protocolFee = Math.max(Number(fee_min), Number(depositAmount) * fee_rate);
+    const totalDepositAmount = new import_big.default(depositAmount).plus(protocolFee).plus(repayAmount).round(0, import_big.default.roundDown).toNumber();
     return {
       depositAmount,
-      receiveAmount: Math.max(receiveAmount, 0),
-      fee
+      totalDepositAmount,
+      protocolFee,
+      repayAmount
     };
   });
 }
@@ -3437,7 +3445,6 @@ function executeBTCDepositAndAction(_0) {
     action,
     amount,
     feeRate,
-    fixedAmount = true,
     pollResult = true,
     registerDeposit,
     env = "mainnet"
@@ -3454,24 +3461,23 @@ function executeBTCDepositAndAction(_0) {
         throw new Error("amount or action is required");
       }
       const csna = yield getCsnaAccountId(env);
-      const rawDepositAmount = (_a = action ? action.amount : amount) != null ? _a : "0";
-      if (new import_big.default(rawDepositAmount).lt(0)) {
+      const depositAmount = (_a = action ? action.amount : amount) != null ? _a : "0";
+      if (new import_big.default(depositAmount).lt(0)) {
         throw new Error("amount must be greater than 0");
       }
-      const { depositAmount, receiveAmount } = yield getDepositAmount(rawDepositAmount, {
+      const { totalDepositAmount, protocolFee, repayAmount } = yield getDepositAmount(depositAmount, {
         env
       });
       const accountInfo = yield getAccountInfo(csna, config.accountContractId);
       const newActions = [];
-      const arrearsAction = yield checkGasTokenArrears(accountInfo, env, false);
-      if (arrearsAction) {
-        newActions.push(__spreadProps(__spreadValues({}, arrearsAction), {
+      const debtAction = yield checkGasTokenDebt(accountInfo, env, false);
+      if (debtAction) {
+        newActions.push(__spreadProps(__spreadValues({}, debtAction), {
           gas: GAS_LIMIT
         }));
       }
       if (action) {
         newActions.push(__spreadProps(__spreadValues({}, action), {
-          amount: (arrearsAction == null ? void 0 : arrearsAction.amount) && !fixedAmount ? new import_big.default(receiveAmount).minus(arrearsAction.amount).toString() : receiveAmount.toString(),
           gas: GAS_LIMIT
         }));
       }
@@ -3488,12 +3494,6 @@ function executeBTCDepositAndAction(_0) {
       }
       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,
@@ -3507,10 +3507,14 @@ function executeBTCDepositAndAction(_0) {
         { deposit_msg: depositMsg }
       );
       const _feeRate = feeRate || (yield getBtcGasPrice());
-      const sendAmount = (arrearsAction == null ? void 0 : arrearsAction.amount) && fixedAmount ? new import_big.default(depositAmount).plus((arrearsAction == null ? void 0 : arrearsAction.amount) || 0).toString() : depositAmount;
-      console.log("user deposit address:", userDepositAddress);
-      console.log("send amount:", sendAmount);
-      console.log("fee rate:", _feeRate);
+      console.table({
+        "User Deposit Address": userDepositAddress,
+        "Deposit Amount": depositAmount,
+        "Protocol Fee": protocolFee,
+        "Repay Amount": repayAmount,
+        "Total Deposit Amount": totalDepositAmount,
+        "Fee Rate": _feeRate
+      });
       const postActionsStr = newActions.length > 0 ? JSON.stringify(newActions) : void 0;
       yield preReceiveDepositMsg(config.base_url, {
         btcPublicKey,
@@ -3518,7 +3522,7 @@ function executeBTCDepositAndAction(_0) {
         postActions: postActionsStr,
         extraMsg: depositMsg.extra_msg
       });
-      const txHash = yield sendBitcoin(userDepositAddress, Number(sendAmount), _feeRate);
+      const txHash = yield sendBitcoin(userDepositAddress, totalDepositAmount, _feeRate);
       yield receiveDepositMsg(config.base_url, {
         btcPublicKey,
         txHash,
@@ -3563,6 +3567,148 @@ Sign up now: <a style="color: #ff7a00; text-decoration: underline;" href="https:
     }
   });
 }
+function getWithdrawTransaction(_0) {
+  return __async(this, arguments, function* ({
+    amount,
+    feeRate,
+    env = "mainnet"
+  }) {
+    const provider = getBtcProvider();
+    const btcAddress = yield provider.account;
+    const config = yield getConfig(env);
+    const brgConfig = yield nearCall(config.bridgeContractId, "get_config", {});
+    if (brgConfig.min_withdraw_amount) {
+      if (Number(amount) < Number(brgConfig.min_withdraw_amount)) {
+        throw new Error("Mini withdraw amount is " + brgConfig.min_withdraw_amount);
+      }
+    }
+    const feePercent = Number(brgConfig.withdraw_bridge_fee.fee_rate) * Number(amount);
+    const withdrawFee = feePercent > Number(brgConfig.withdraw_bridge_fee.fee_min) ? feePercent : Number(brgConfig.withdraw_bridge_fee.fee_min);
+    const allUTXO = yield nearCall(config.bridgeContractId, "get_utxos_paged", {});
+    if (!allUTXO || Object.keys(allUTXO).length === 0) {
+      throw new Error("The network is busy, please try again later.");
+    }
+    const utxos = Object.keys(allUTXO).map((key) => {
+      const txid = key.split("@");
+      return {
+        txid: txid[0],
+        vout: allUTXO[key].vout,
+        value: Number(allUTXO[key].balance),
+        script: allUTXO[key].script
+      };
+    });
+    const _feeRate = feeRate || (yield getBtcGasPrice());
+    const { inputs, outputs, fee } = (0, import_coinselect.default)(
+      utxos,
+      [{ address: btcAddress, value: Number(amount) }],
+      Math.ceil(_feeRate)
+    );
+    if (!outputs || !inputs) {
+      throw new Error("The network is busy, please try again later.");
+    }
+    const maxBtcFee = Number(brgConfig.max_btc_gas_fee);
+    const newFee = fee;
+    const withdrawChangeAddress = brgConfig.change_address;
+    if (newFee > maxBtcFee) {
+      throw new Error("Gas exceeds maximum value");
+    }
+    let userOutput, noUserOutput;
+    for (let i = 0; i < outputs.length; i++) {
+      const output = outputs[i];
+      if (output.value.toString() === amount.toString()) {
+        userOutput = output;
+      } else {
+        noUserOutput = output;
+      }
+      if (!output.address) {
+        output.address = withdrawChangeAddress;
+      }
+    }
+    userOutput.value = new import_big.default(userOutput.value).minus(newFee).minus(withdrawFee).toNumber();
+    if (noUserOutput) {
+      noUserOutput.value = new import_big.default(noUserOutput.value).plus(newFee).plus(withdrawFee).toNumber();
+    } else {
+      noUserOutput = {
+        address: withdrawChangeAddress,
+        value: new import_big.default(newFee).plus(withdrawFee).toNumber()
+      };
+      outputs.push(noUserOutput);
+    }
+    const insufficientOutput = outputs.some((item) => item.value < 0);
+    if (insufficientOutput) {
+      throw new Error("Not enough gas");
+    }
+    const inputSum = inputs.reduce((sum, cur) => sum + Number(cur.value), 0);
+    const outputSum = outputs.reduce((sum, cur) => sum + Number(cur.value), 0);
+    if (newFee + outputSum !== inputSum) {
+      throw new Error("compute error");
+    }
+    const network = yield getNetwork();
+    const btcNetwork = network === "mainnet" ? import_bitcoinjs_lib.default.networks.bitcoin : import_bitcoinjs_lib.default.networks.testnet;
+    const psbt = new import_bitcoinjs_lib.default.Psbt({ network: btcNetwork });
+    const btcRpcUrl = yield getBtcRpcUrl();
+    for (let i = 0; i < inputs.length; i++) {
+      const input = inputs[i];
+      const txData = yield fetch(`${btcRpcUrl}/tx/${input.txid}`).then((res) => res.json());
+      const inputOptions = {
+        hash: input.txid,
+        index: input.vout,
+        sequence: 4294967293,
+        witnessUtxo: {
+          script: Buffer.from(txData.vout[input.vout].scriptpubkey, "hex"),
+          value: input.value
+        }
+      };
+      psbt.addInput(inputOptions);
+    }
+    outputs.forEach((output) => {
+      psbt.addOutput({
+        address: output.address,
+        value: output.value
+      });
+    });
+    const _inputs = inputs.map((item) => {
+      return `${item.txid}:${item.vout}`;
+    });
+    const txOutputs = psbt.txOutputs.map((item) => {
+      return {
+        script_pubkey: uint8ArrayToHex(item.script),
+        value: item.value
+      };
+    });
+    const msg = {
+      Withdraw: {
+        target_btc_address: btcAddress,
+        input: _inputs,
+        output: txOutputs
+      }
+    };
+    const csna = yield getCsnaAccountId(env);
+    const transaction = {
+      receiverId: config.token,
+      signerId: csna,
+      actions: [
+        {
+          type: "FunctionCall",
+          params: {
+            methodName: "ft_transfer_call",
+            args: {
+              receiver_id: config.bridgeContractId,
+              amount: amount.toString(),
+              msg: JSON.stringify(msg)
+            },
+            gas: "300000000000000",
+            deposit: "1"
+          }
+        }
+      ]
+    };
+    return transaction;
+  });
+}
+function uint8ArrayToHex(uint8Array) {
+  return Array.from(uint8Array).map((byte) => byte.toString(16).padStart(2, "0")).join("");
+}
 
 // src/core/setupBTCWallet.ts
 var { transfer, functionCall } = import_transactions.actionCreators;
@@ -3788,7 +3934,7 @@ var BTCWallet = (_0) => __async(void 0, [_0], function* ({
       const btcContext = window.btcContext;
       const accountId = state.getAccount();
       const accountInfo = yield getAccountInfo(accountId, currentConfig.accountContractId);
-      yield checkGasTokenArrears(accountInfo, env, true);
+      yield checkGasTokenDebt(accountInfo, env, true);
       const trans = [...params.transactions];
       console.log("raw trans:", trans);
       const gasTokenBalance = (accountInfo == null ? void 0 : accountInfo.gas_token[currentConfig.token]) || "0";
@@ -3997,7 +4143,7 @@ function setupBTCWallet({
       if (!hasShownNotice) {
         Dialog.alert({
           title: "Notice",
-          message: "You are currently using Satoshi Private Mainnet. This is a private version for testing. Please try a small amount of assets in Bridge"
+          message: "You are currently using Satoshi Private Mainnet. This is a private version for testing. Please try a small amount of assets in Ramp"
         });
         localStorage.setItem("satoshi_private_mainnet_notice", "true");
       }
@@ -4026,7 +4172,7 @@ function setupBTCWallet({
 
 // src/index.ts
 var getVersion = () => {
-  return "0.4.4-beta";
+  return "0.4.6-beta";
 };
 if (typeof window !== "undefined") {
   window.__BTC_WALLET_VERSION = getVersion();