btc-wallet 0.3.24 → 0.3.26

package/README.md

@@ -1,29 +1,44 @@
 # BTC Wallet
 
-BTC Wallet is a toolkit that enables the use of Bitcoin on the NEAR blockchain through the Satoshi protocol. It provides seamless integration for managing Bitcoin transactions and interactions within the NEAR ecosystem.
-
-## Features
-
-- **NEAR Integration**: Leverage the Satoshi protocol to use Bitcoin on the NEAR blockchain.
+BTC Wallet is a toolkit that enables Bitcoin usage on the NEAR blockchain through the Satoshi protocol.
 
 ## Installation
 
-Install `btc-wallet` using npm or yarn:
-
 ```bash
 pnpm install btc-wallet
-or
+# or
 yarn add btc-wallet
 ```
 
-## Usage
+## API Reference
 
-### Initialize BTC Wallet
+### `BtcWalletSelectorContextProvider` and `setupBTCWallet`
 
-To use BTC Wallet in your project, wrap your application with the `BtcWalletSelectorContextProvider`:
+Initialize and integrate BTC wallet with NEAR wallet selector.
+
+```typescript
+// 1. Setup wallet selector with BTC wallet module
+import { setupWalletSelector } from '@near-wallet-selector/core';
+import { setupBTCWallet } from 'btc-wallet';
+
+const selector = await setupWalletSelector({
+  network: 'mainnet', // or 'testnet'
+  debug: true,
+  modules: [
+    setupBTCWallet({
+      iconUrl?: string,         // optional: custom wallet icon URL
+      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
+    }),
+    // setup other wallets...
+  ],
+});
+
+// 2. Wrap your app with BtcWalletSelectorContextProvider
+import { BtcWalletSelectorContextProvider } from 'btc-wallet';
 
-```javascript
-import BtcWalletSelectorContextProvider from 'btc-wallet';
 function App() {
   return (
     <BtcWalletSelectorContextProvider>
@@ -33,31 +48,61 @@ function App() {
 }
 ```
 
-### Setup Wallet Selector
+### `executeBTCDepositAndAction`
+
+Execute a native BTC deposit to receive corresponding BTC tokens on NEAR through the Satoshi bridge. You must provide either `action` or `amount`, but not both.
+
+```typescript
+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
+  };
+  
+  // Option 2: For direct Satoshi bridge deposit
+  amount?: string;         // amount to deposit to Satoshi bridge
+  
+  // 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
+}
 
-Integrate BTC Wallet with NEAR's wallet selector:
+// Example 1: dApp one-click BTC deposit
+await executeBTCDepositAndAction({
+  action: {
+    receiver_id: 'account.near',
+    amount: '1000000',     // in smallest units
+    msg: 'Deposit'
+  },
+  feeRate: 5
+});
 
-```javascript
-import { setupWalletSelector } from '@near-wallet-selector/core';
-import { setupBTCWallet } from 'btc-wallet';
-setupWalletSelector({
-  network: 'mainnet', // or 'testnet'
-  modules: [setupBTCWallet()],
+// Example 2: Direct Satoshi bridge deposit
+await executeBTCDepositAndAction({
+  amount: '1000000',       // amount to deposit to Satoshi bridge
+  feeRate: 5
 });
 ```
 
-### Execute Burrow Supply
+### `getBtcBalance`
 
-To execute a Burrow supply operation, use the `executeBurrowSupply` function:
+Get the native BTC balance for a given Bitcoin address.
 
-```javascript
-import { executeBurrowSupply } from 'btc-wallet';
-executeBurrowSupply({
-  amount: '0.01', // BTC amount
-  environment: 'mainnet', // or 'testnet'
-}).then(() => {
-  console.log('Burrow supply executed successfully');
-}).catch((error) => {
-  console.error('Error executing Burrow supply:', error);
-});
+```typescript
+import { getBtcBalance } from 'btc-wallet';
+
+const balance = await getBtcBalance(address: string);
+// Returns balance in satoshis
 ```
+
+## Requirements
+
+- React 17.0.0 or higher
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

package/dist/index.js

@@ -2616,19 +2616,63 @@ var import_utils7 = require("@near-js/utils");
 var import_bs58 = __toESM(require("bs58"), 1);
 var import_js_sha256 = require("js-sha256");
 
-// src/utils/initWalletButton.ts
-var walletUrlConfig = {
-  dev: "https://wallet-dev.satoshibridge.top",
-  testnet: "https://wallet-test.satoshibridge.top",
-  mainnet: "https://wallet.satoshibridge.top"
+// src/config.ts
+var walletConfig = {
+  dev: {
+    base_url: "https://api.dev.satoshibridge.top",
+    token: "nbtc-dev.testnet",
+    accountContractId: "acc-dev.testnet",
+    bridgeContractId: "brg-dev.testnet",
+    walletUrl: "https://wallet-dev.satoshibridge.top",
+    bridgeUrl: "https://dev.satoshibridge.top/"
+  },
+  testnet: {
+    base_url: "https://api.testnet.satoshibridge.top",
+    token: "nbtc2-nsp.testnet",
+    accountContractId: "acc2-nsp.testnet",
+    bridgeContractId: "brg2-nsp.testnet",
+    walletUrl: "https://wallet-test.satoshibridge.top",
+    bridgeUrl: "https://testnet.satoshibridge.top/"
+  },
+  private_mainnet: {
+    base_url: "https://api.stg.satoshibridge.top",
+    token: "nbtc.toalice.near",
+    accountContractId: "acc.toalice.near",
+    bridgeContractId: "brg.toalice.near",
+    walletUrl: "https://wallet-stg.satoshibridge.top",
+    bridgeUrl: "https://stg.satoshibridge.top/"
+  },
+  mainnet: {
+    base_url: "https://api.mainnet.satoshibridge.top",
+    token: "nbtc.toalice.near",
+    accountContractId: "acc.toalice.near",
+    bridgeContractId: "brg.toalice.near",
+    walletUrl: "https://wallet.satoshibridge.top",
+    bridgeUrl: "https://www.satoshibridge.top/"
+  }
 };
-function setupWalletButton(network, wallet, originalWallet) {
+var nearRpcUrls = {
+  mainnet: [
+    "https://near.lava.build",
+    "https://rpc.mainnet.near.org",
+    "https://free.rpc.fastnear.com",
+    "https://near.drpc.org"
+  ],
+  testnet: ["https://rpc.testnet.near.org"]
+};
+var btcRpcUrls = {
+  mainnet: "https://mempool.space/api",
+  testnet: "https://mempool.space/testnet/api"
+};
+
+// src/utils/initWalletButton.ts
+function setupWalletButton(env, wallet, originalWallet) {
   console.log("setupWalletButton");
   if (document.getElementById("satoshi-wallet-button")) {
     return;
   }
   const iframe = createIframe({
-    iframeUrl: walletUrlConfig[network],
+    iframeUrl: walletConfig[env].walletUrl,
     iframeStyle: { width: "400px", height: "650px" }
   });
   iframe.addEventListener("mouseenter", () => {
@@ -2759,55 +2803,6 @@ function removeWalletButton() {
   iframe == null ? void 0 : iframe.remove();
 }
 
-// src/config.ts
-var walletConfig = {
-  dev: {
-    base_url: "https://api.dev.satoshibridge.top",
-    token: "nbtc-dev.testnet",
-    accountContractId: "acc-dev.testnet",
-    bridgeContractId: "brg-dev.testnet",
-    walletUrl: "https://wallet-dev.satoshibridge.top",
-    bridgeUrl: "https://dev.satoshibridge.top/"
-  },
-  testnet: {
-    base_url: "https://api.testnet.satoshibridge.top",
-    token: "nbtc2-nsp.testnet",
-    accountContractId: "acc2-nsp.testnet",
-    bridgeContractId: "brg2-nsp.testnet",
-    walletUrl: "https://wallet-test.satoshibridge.top",
-    bridgeUrl: "https://testnet.satoshibridge.top/"
-  },
-  private_mainnet: {
-    base_url: "https://api.stg.satoshibridge.top",
-    token: "nbtc.toalice.near",
-    accountContractId: "acc.toalice.near",
-    bridgeContractId: "brg.toalice.near",
-    walletUrl: "https://wallet-stg.satoshibridge.top",
-    bridgeUrl: "https://stg.satoshibridge.top/"
-  },
-  mainnet: {
-    base_url: "https://api.mainnet.satoshibridge.top",
-    token: "nbtc.toalice.near",
-    accountContractId: "acc.toalice.near",
-    bridgeContractId: "brg.toalice.near",
-    walletUrl: "https://wallet.satoshibridge.top",
-    bridgeUrl: "https://www.satoshibridge.top/"
-  }
-};
-var nearRpcUrls = {
-  mainnet: [
-    "https://near.lava.build",
-    "https://rpc.mainnet.near.org",
-    "https://free.rpc.fastnear.com",
-    "https://near.drpc.org"
-  ],
-  testnet: ["https://rpc.testnet.near.org"]
-};
-var btcRpcUrls = {
-  mainnet: "https://mempool.space/api",
-  testnet: "https://mempool.space/testnet/api"
-};
-
 // src/utils/nearUtils.ts
 var import_near_api_js = require("near-api-js");
 function nearCallFunction(contractId, methodName, args, options) {
@@ -3579,7 +3574,7 @@ var BTCWallet = (_0) => __async(void 0, [_0], function* ({
     signAndSendTransaction,
     signAndSendTransactions
   };
-  const env = options.network.networkId || metadata.env || "mainnet";
+  const env = metadata.env || options.network.networkId || "mainnet";
   const currentConfig = walletConfig[env];
   const walletNetwork = ["mainnet", "private_mainnet"].includes(env) ? "mainnet" : "testnet";
   yield initBtcContext();
@@ -3590,7 +3585,7 @@ var BTCWallet = (_0) => __async(void 0, [_0], function* ({
         const accountId = state.getAccount();
         const btcContext = window.btcContext;
         if (accountId && btcContext.account) {
-          setupWalletButton(walletNetwork, wallet, btcContext);
+          setupWalletButton(env, wallet, btcContext);
         } else {
           removeWalletButton();
           setTimeout(() => {
@@ -3949,7 +3944,6 @@ var BTCWallet = (_0) => __async(void 0, [_0], function* ({
       if (!btcContext.account)
         return;
       const btcNetwork = yield btcContext.getNetwork();
-      console.log("btcNetwork:", btcNetwork, network);
       const networkMap = {
         livenet: ["mainnet", "private_mainnet"],
         testnet: ["testnet", "dev"]
@@ -3976,7 +3970,7 @@ function setupBTCWallet({
   syncLogOut = true,
   env = "mainnet"
 } = {}) {
-  console.log("\u26A1\uFE0F BTC Wallet Version:", getVersion());
+  console.log("\u26A1\uFE0F BTC Wallet Version:", getVersion(), "env:", env);
   const btcWallet = () => __async(this, null, function* () {
     return {
       id: "btc-wallet",
@@ -4000,7 +3994,7 @@ function setupBTCWallet({
 
 // src/index.ts
 var getVersion = () => {
-  return "0.3.24";
+  return "0.3.26";
 };
 if (typeof window !== "undefined") {
   window.__BTC_WALLET_VERSION = getVersion();