@btc-vision/walletconnect 1.5.0 → 1.5.2

package/.prettierrc.json

@@ -9,4 +9,4 @@
     "bracketSameLine": true,
     "arrowParens": "always",
     "singleAttributePerLine": true
-}
+}

package/CHANGELOG.md

@@ -0,0 +1,83 @@
+# OP_NET - WalletConnect
+
+## V2
+
+This new version makes it easier for developer to use the library to connect to wallets and to implements support for new wallets.
+
+### New features
+
+-   Themes support (current themes are light, dark and moto)
+-   Auto reconnect only if already logged in the wallet
+
+### Breaking changes
+
+-   Some properties are moved to the WalletConnect context for easier use
+
+### Migration
+
+```
+Old version            -->      New version
+{                               {
+                                    allWallets
+                                    openConnectModal
+    connect                         connectToWallet
+    disconnect                      disconnect
+    walletType                      walletType
+    walletWindowInstance            provider
+    account                         -
+      - isConnected                 publicKey != null
+      - signer                      signer
+      - address                     address (Address.fromString(publicKey))
+                                    publicKey (account publicKey)
+                                    walletAddress (account address)
+      - addressTyped
+      - network                     network
+      - provider                    -
+                                    connecting
+} = useWallet()                 } = useWalletConnect()
+```
+
+walletAddress,
+
+### Sample use of new version (snipets)
+
+**App.tsx**
+
+```typescript jsx
+createRoot(document.getElementById('root')!).render(
+    <StrictMode>
+        <WalletConnectProvider theme="light">
+            <App />
+        </WalletConnectProvider>
+    </StrictMode>,
+);
+```
+
+**Main.tsx**
+
+```typescript jsx
+function App() {
+    const { openConnectModal, publicKey, provider } = useWalletConnect();
+
+    const [balance, setBalance] = useState<number | undefined>(undefined);
+
+    useEffect(() => {
+        const updateBalance = async () => {
+            const balance = await provider?.getBalance();
+            setBalance(balance?.total);
+        };
+        void updateBalance();
+    }, [provider, setBalance]);
+
+    return (
+        <div>
+            <button onClick={() => openConnectModal()}>Connect Wallet</button>
+
+            <div>
+                <div>Public Key: {publicKey}</div>
+                <div>Balance: {balance}</div>
+            </div>
+        </div>
+    );
+}
+```

package/README.md

@@ -19,8 +19,8 @@ from the connected wallet.
 
 ### Prerequisites
 
-- Node.js version 22.x
-- npm (Node Package Manager)
+-   Node.js version 22.x
+-   npm (Node Package Manager)
 
 ### Installation
 
@@ -35,17 +35,17 @@ Documentation is available at [docs.opnet.org](https://docs.opnet.org)
 #### Development
 
 1. Clone the repository:
-   ```bash
-   git clone https://github.com/btc-vision/walletconnect.git
-   ```
+    ```bash
+    git clone https://github.com/btc-vision/walletconnect.git
+    ```
 2. Navigate to the repository directory:
-   ```bash
-   cd walletconnect
-   ```
+    ```bash
+    cd walletconnect
+    ```
 3. Install the required dependencies:
-   ```bash
-   npm i
-   ```
+    ```bash
+    npm i
+    ```
 
 ## Contribution
 

package/browser/consts.d.ts

@@ -0,0 +1,2 @@
+import { WalletConnectNetwork } from './types';
+export declare const DefaultWalletConnectNetwork: WalletConnectNetwork;

package/browser/context/WalletConnectContext.d.ts

@@ -0,0 +1,18 @@
+import { Address, Unisat, UnisatSigner } from '@btc-vision/transaction';
+import type { WalletConnectNetwork, WalletInformation } from '../types.ts';
+import { SupportedWallets } from '../wallets';
+export type WalletConnectContextType = {
+    allWallets: WalletInformation[];
+    walletType: string | null;
+    walletAddress: string | null;
+    network: WalletConnectNetwork;
+    publicKey: string | null;
+    address: Address | null;
+    openConnectModal: () => void;
+    connectToWallet: (wallet: SupportedWallets) => void;
+    connecting: boolean;
+    disconnect: () => void;
+    provider: Unisat | null;
+    signer: UnisatSigner | null;
+};
+export declare const WalletConnectContext: import("react").Context<WalletConnectContextType | undefined>;

package/browser/hooks/WalletConnectHook.d.ts

@@ -0,0 +1,2 @@
+import { type WalletConnectContextType } from '../context/WalletConnectContext';
+export declare const useWalletConnect: () => WalletConnectContextType;

package/browser/index.d.ts

@@ -1,2 +1,4 @@
-export * from './WalletConnection';
-export * from './WalletProvider';
+export { WalletConnectContext } from './context/WalletConnectContext';
+export { useWalletConnect } from './hooks/WalletConnectHook';
+export * from './types';
+export { default as WalletConnectProvider } from './provider/WalletConnectProvider';