btc-wallet 0.5.53-beta → 0.5.56-beta

package/README.md

@@ -30,15 +30,24 @@ const selector = await setupWalletSelector({
       deprecated?: boolean,     // optional: mark as deprecated
       autoConnect?: boolean,    // optional: enable auto-connect, defaults to true
       syncLogOut?: boolean,     // optional: sync logout across tabs, defaults to true
-      env?: 'mainnet' | 'testnet' | 'private_mainnet' | 'dev' // optional: defaults to NEAR network environment
+      env?: 'mainnet' | 'testnet' | 'private_mainnet' | 'dev', // optional: defaults to NEAR network environment
+      gasStrategy?: 'auto' | 'near' | 'btc' // optional: specify gas payment strategy, defaults to 'auto'
+                                           // 'auto': use NEAR if balance > 0.5, otherwise use BTC token
+                                           // 'near': force use NEAR for gas payment
+                                           // 'btc': force use BTC token for gas payment
     }),
     // setup other wallets...
   ],
 });
 
-// 2. Setup wallet selector modal,params see setupModal @near-wallet-selector/modal-ui
+// 2. Setup wallet selector modal
+// Note: For enhanced functionality, use setupWalletSelectorModal exported from btc-wallet
+// If using setupModal from @near-wallet-selector/modal-ui, the showChainGroups and showWalletUIForNearAccount parameters below are not supported
 setupWalletSelectorModal(selector, {
-  contractId:'xxx.near',
+  contractId: 'xxx.near',
+  showChainGroups?: boolean,    // optional: show chain group selection, defaults to true
+  showWalletUIForNearAccount?: boolean, // optional: show wallet UI for regular NEAR accounts, defaults to true
+  env?: 'mainnet' | 'testnet' | 'private_mainnet' | 'dev', // optional: defaults to NEAR network environment
 });
 
 // 3. Wrap your app with BtcWalletSelectorContextProvider
@@ -62,18 +71,18 @@ Execute a native BTC deposit to receive corresponding BTC tokens on NEAR through
 interface ExecuteBTCDepositAndActionParams<T extends boolean = true> {
   // Option 1: For dApp one-click BTC deposit and action
   action?: {
-    receiver_id: string;    // receiver account on NEAR
-    amount: string;         // amount to deposit
-    msg: string;           // message for the transaction
+    receiver_id: string; // receiver account on NEAR
+    amount: string; // amount to deposit
+    msg: string; // message for the transaction
   };
-  
+
   // Option 2: For direct Satoshi bridge deposit
-  amount?: string;         // amount to deposit to Satoshi bridge
-  
+  amount?: string; // amount to deposit to Satoshi bridge
+
   // Common optional parameters
-  feeRate?: number;        // optional: custom fee rate for the BTC transaction
+  feeRate?: number; // optional: custom fee rate for the BTC transaction
   env?: 'mainnet' | 'testnet' | 'private_mainnet' | 'dev'; // optional: defaults to NEAR network environment
-  pollResult?: T;         // optional: whether to poll for transaction result
+  pollResult?: T; // optional: whether to poll for transaction result
   registerDeposit?: string; // optional: whether to register deposit,default 0.000125 NEAR
   newAccountMinDepositAmount?: boolean; // default is true, if true, new account minimum deposit BTC amount 1000sat, otherwise 0
   registerContractId?: string; // if registerContractId is provided, it will be used to register the contract, otherwise it will be the default contract id
@@ -84,15 +93,15 @@ await executeBTCDepositAndAction({
   action: {
     receiver_id: 'token.near',
     amount: '1000000',
-    msg: 'ft_transfer_call message' // ft_transfer_call message
+    msg: 'ft_transfer_call message', // ft_transfer_call message
   },
-  registerDeposit: '100000000000000000000000',  // default 0.000125 NEAR, you can set it according to your needs
+  registerDeposit: '100000000000000000000000', // default 0.000125 NEAR, you can set it according to your needs
 });
 
 // Example 2: Direct Satoshi bridge deposit
 await executeBTCDepositAndAction({
-  amount: '1000000',       // amount to deposit to Satoshi bridge
-  feeRate: 5
+  amount: '1000000', // amount to deposit to Satoshi bridge
+  feeRate: 5,
 });
 ```
 
@@ -158,4 +167,4 @@ const transaction = await getWithdrawTransaction({
 
 ## License
 
-This project is licensed under the MIT License - see the LICENSE file for details.
+This project is licensed under the MIT License - see the LICENSE file for details.

package/dist/core/setupBTCWallet/index.d.ts

@@ -13,8 +13,9 @@ interface BTCWalletParams {
     syncLogOut?: boolean;
     env?: ENV;
     walletUrl?: string;
+    gasStrategy?: 'auto' | 'near' | 'btc';
 }
-export declare function setupBTCWallet({ iconUrl, deprecated, autoConnect, syncLogOut, env, walletUrl, }?: BTCWalletParams | undefined): WalletModuleFactory<InjectedWallet>;
+export declare function setupBTCWallet({ iconUrl, deprecated, autoConnect, syncLogOut, env, walletUrl, gasStrategy, }?: BTCWalletParams | undefined): WalletModuleFactory<InjectedWallet>;
 declare const _default: {
     setupBTCWallet: typeof setupBTCWallet;
 };

package/dist/core/setupModal.d.ts

@@ -1,5 +1,11 @@
 import { type WalletSelectorModal as _WalletSelectorModal, type ModalOptions as _ModalOptions } from 'ref-modal-ui';
 import type { WalletSelector } from '@near-wallet-selector/core';
-export type WalletSelectorModalOptions = _ModalOptions;
+import { ENV } from '../config';
+export interface WalletSelectorModalOptions extends _ModalOptions {
+    showChainGroups?: boolean;
+    showWalletUIForNearAccount?: boolean;
+    walletUrl?: string;
+    env?: ENV;
+}
 export type WalletSelectorModal = _WalletSelectorModal;
 export declare function setupWalletSelectorModal(selector: WalletSelector, options: WalletSelectorModalOptions): _WalletSelectorModal;