btc-wallet 0.2.6 → 0.2.8

package/README.md

@@ -1,9 +1,63 @@
-# Particle BTC Connect
+# BTC Wallet
 
-First Account Abstraction Protocol on Bitcoin
+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.
 
-## Learn More
+## Features
 
-- [Documentation](https://docs.particle.network/developers/btc-connect)
-- [Website](https://particle.network)
-- [Dashbord](https://dashboard.particle.network)
+- **NEAR Integration**: Leverage the Satoshi protocol to use Bitcoin on the NEAR blockchain.
+
+## Installation
+
+Install `btc-wallet` using npm or yarn:
+
+```bash
+pnpm install btc-wallet
+or
+yarn add btc-wallet
+```
+
+## Usage
+
+### Initialize BTC Wallet
+
+To use BTC Wallet in your project, wrap your application with the `BtcWalletSelectorContextProvider`:
+
+```javascript
+import BtcWalletSelectorContextProvider from 'btc-wallet';
+function App() {
+  return (
+    <BtcWalletSelectorContextProvider>
+      {/* Your application components */}
+    </BtcWalletSelectorContextProvider>
+  );
+}
+```
+
+### Setup Wallet Selector
+
+Integrate BTC Wallet with NEAR's wallet selector:
+
+```javascript
+import { setupWalletSelector } from '@near-wallet-selector/core';
+import { setupBTCWallet } from 'btc-wallet';
+setupWalletSelector({
+  network: 'mainnet', // or 'testnet'
+  modules: [setupBTCWallet()],
+});
+```
+
+### Execute Burrow Supply
+
+To execute a Burrow supply operation, use the `executeBurrowSupply` function:
+
+```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);
+});
+```

package/dist/components/signModal/index.d.ts

@@ -1,4 +1,4 @@
-declare const SignModal: ({ open, onClose, onOpen }: {
+declare const SignModal: ({ open, onClose, onOpen, }: {
     open: boolean;
     onClose: () => void;
     onOpen: () => void;

package/dist/context/index.d.ts

@@ -1,7 +1,6 @@
 import { SmartAccount, type AAOptions, type AccountContract } from '@particle-network/aa';
 import { type WalletOption } from '@particle-network/wallet';
 import { type BaseConnector } from '../connector/base';
-import type { AccountInfo } from '../types/accountInfo';
 interface GlobalState {
     connectorId?: string;
     setConnectorId: (connectorId?: string) => void;
@@ -24,7 +23,6 @@ interface GlobalState {
     }) => Promise<string>;
     accountContract: AccountContract;
     setAccountContract: (accountContract: AccountContract) => void;
-    getSmartAccountInfo: () => Promise<AccountInfo | undefined>;
 }
 interface ConnectOptions {
     projectId: string;

package/dist/core/bridgeSupplyUtils.d.ts

@@ -0,0 +1,10 @@
+interface ExecuteBurrowSupplyParams {
+    /** btc amount, e.g. 0.01 */
+    amount: string;
+    /** fee rate, if not provided, will use the recommended fee rate from the btc node */
+    feeRate?: number;
+    /** environment, default is mainnet */
+    environment?: 'dev' | 'testnet' | 'mainnet';
+}
+export declare function executeBurrowSupply({ amount, feeRate, environment, }: ExecuteBurrowSupplyParams): Promise<void>;
+export {};

package/dist/{utils → core}/setupBTCWallet.d.ts

@@ -1,5 +1,5 @@
 import type { InjectedWallet, WalletModuleFactory } from '@near-wallet-selector/core';
-import type { useBtcWalletSelector } from './../components/btcWalletSelectorContext';
+import type { useBtcWalletSelector } from './btcWalletSelectorContext';
 declare global {
     interface Window {
         btcContext: ReturnType<typeof useBtcWalletSelector>;

package/dist/index.d.ts

@@ -1,8 +1,7 @@
 export * from './connector';
 export { ConnectProvider } from './context';
 export * from './hooks';
-export * from './components/btcWalletSelectorContext';
-export * from './utils/setupBTCWallet';
-export * from './components/hook';
-export * from './utils/bridgeSupplyUtils';
+export * from './core/btcWalletSelectorContext';
+export * from './core/setupBTCWallet';
+export * from './core/bridgeSupplyUtils';
 export declare const getVersion: () => string;