feat: add UTXO namespace to WalletConnect hub provider

Author: RyukTheCoder

wallets/provider-walletconnect-2/package.json

@@ -21,6 +21,7 @@
     "lint": "eslint \"**/*.{ts,tsx}\""
   },
   "dependencies": {
+    "@bitcoinerlab/secp256k1": "^1.2.0",
     "@hub3js/core": "^0.60.1",
     "@hub3js/evm": "^0.2.1",
     "@hub3js/std": "^0.1.1",
@@ -34,6 +35,7 @@
     "@walletconnect/sign-client": "2.23.7",
     "@walletconnect/universal-provider": "2.23.7",
     "@walletconnect/utils": "2.23.7",
+    "bitcoinjs-lib": "^6.1.7",
     "bs58": "^5.0.0",
     "caip": "^1.1.1",
     "rango-types": "^0.5.0"

wallets/provider-walletconnect-2/src/constants.ts

@@ -1,9 +1,11 @@
 import type { ProviderMetadata } from '@hub3js/core';
 
+import { Networks } from '@rango-dev/wallets-shared';
 import {
   type BlockchainMeta,
   type EvmBlockchainMeta,
   isEvmBlockchain,
+  type TransferBlockchainMeta,
 } from 'rango-types';
 
 import getSigners from './signer.js';
@@ -31,6 +33,16 @@ export const metadata: ProviderMetadata = {
                 isEvmBlockchain(chain)
               ),
           },
+          {
+            label: 'BTC',
+            value: 'UTXO',
+            id: 'BTC',
+            getSupportedChains: (allBlockchains: BlockchainMeta[]) =>
+              allBlockchains.filter(
+                (chain): chain is TransferBlockchainMeta =>
+                  chain.name === Networks.BTC
+              ),
+          },
         ],
       },
     },

wallets/provider-walletconnect-2/src/legacy/signer.ts

@@ -25,6 +25,12 @@ export default async function getSigners(
       async () => await import('../signers/solana.js')
     )
   ).default;
+  const UtxoSigner = (
+    await dynamicImportWithRefinedError(
+      async () => await import('../signers/utxo.js')
+    )
+  ).default;
+
   signers.registerSigner(
     TxType.EVM,
     new EVMSigner(instance.client, () => instance.getSession('evm'))
@@ -35,6 +41,10 @@ export default async function getSigners(
       instance.getSession('solana' as WalletConnectNamespace)
     )
   );
+  signers.registerSigner(
+    TxType.TRANSFER,
+    new UtxoSigner(instance.client, () => instance.getSession('utxo'))
+  );
 
   return signers;
 }

wallets/provider-walletconnect-2/src/namespaces/utxo/hooks.ts

@@ -0,0 +1,118 @@
+import type { Subscriber, SubscriberCleanUp } from '@hub3js/core';
+import type { UtxoActions } from '@rango-dev/wallets-core/namespaces/utxo';
+import type { SignClientTypes } from '@walletconnect/types';
+
+import {
+  CAIP_BITCOIN_CHAIN_ID,
+  utils,
+} from '@rango-dev/wallets-core/namespaces/utxo';
+import { AccountId } from 'caip';
+
+import { BitcoinEvents, NAMESPACES } from '../../legacy/constants.js';
+import { getAdapter } from '../../provider.js';
+import {
+  type Bip122AddressEntry,
+  pickPaymentAddress,
+} from '../../session/bip122.js';
+import { expireWalletConnectTopic } from '../../session/teardown.js';
+
+export function sessionEventSubscriber(): [
+  Subscriber<UtxoActions>,
+  SubscriberCleanUp<UtxoActions>
+] {
+  let sessionUpdateHandler: (
+    args: SignClientTypes.EventArguments['session_update']
+  ) => void;
+  let sessionEventHandler: (
+    args: SignClientTypes.EventArguments['session_event']
+  ) => void;
+  let sessionDeleteHandler: (
+    args: SignClientTypes.EventArguments['session_delete']
+  ) => void;
+
+  return [
+    async (context) => {
+      const adapter = getAdapter();
+      const client = await adapter.getClient();
+      const [, setState] = context.state();
+
+      sessionUpdateHandler = (args) => {
+        const session = adapter.getSession('utxo');
+        if (!session || args.topic !== session.topic) {
+          return;
+        }
+
+        const bip122Namespace = args.params.namespaces[NAMESPACES.BITCOIN];
+        if (!bip122Namespace?.accounts?.length) {
+          return;
+        }
+
+        const address = new AccountId(bip122Namespace.accounts[0]).address;
+        setState(
+          'accounts',
+          utils.formatAccountsToCAIP([address], CAIP_BITCOIN_CHAIN_ID)
+        );
+      };
+
+      sessionEventHandler = (args) => {
+        const session = adapter.getSession('utxo');
+        if (!session || args.topic !== session.topic) {
+          return;
+        }
+
+        if (args.params.event.name !== BitcoinEvents.ADDRESSES_CHANGED) {
+          return;
+        }
+
+        const data = args.params.event.data as Bip122AddressEntry[];
+        if (!data?.length) {
+          void context.action('disconnect');
+          return;
+        }
+
+        const paymentAddress = pickPaymentAddress(data);
+
+        if (!paymentAddress) {
+          void context.action('disconnect');
+          return;
+        }
+
+        setState(
+          'accounts',
+          utils.formatAccountsToCAIP([paymentAddress], CAIP_BITCOIN_CHAIN_ID)
+        );
+      };
+
+      sessionDeleteHandler = (event) => {
+        const session = adapter.getSession('utxo');
+        if (!session || event.topic !== session.topic) {
+          return;
+        }
+
+        adapter.clearSession('utxo');
+        void expireWalletConnectTopic(client, event.topic);
+        context.action('disconnect');
+      };
+
+      client.on('session_update', sessionUpdateHandler);
+      client.on('session_event', sessionEventHandler);
+      client.on('session_delete', sessionDeleteHandler);
+    },
+    (_, err) => {
+      const adapter = getAdapter();
+      void adapter.getClient().then((client) => {
+        if (sessionUpdateHandler) {
+          client.off('session_update', sessionUpdateHandler);
+        }
+        if (sessionEventHandler) {
+          client.off('session_event', sessionEventHandler);
+        }
+        if (sessionDeleteHandler) {
+          client.off('session_delete', sessionDeleteHandler);
+        }
+      });
+
+      return err;
+    },
+  ];
+}

wallets/provider-walletconnect-2/src/namespaces/utxo/namespace.ts

@@ -0,0 +1,60 @@
+import { ActionBuilder, NamespaceBuilder } from '@hub3js/core';
+import * as commonBuilders from '@hub3js/std/builders';
+import { standardizeAndThrowError } from '@hub3js/std/operators';
+import {
+  builders,
+  CAIP_BITCOIN_CHAIN_ID,
+  utils,
+  type UtxoActions,
+} from '@rango-dev/wallets-core/namespaces/utxo';
+
+import { WALLET_ID } from '../../constants.js';
+import { getAdapter } from '../../provider.js';
+import { filterBip122Accounts } from '../../session/bip122.js';
+
+import { sessionEventSubscriber } from './hooks.js';
+
+const [sessionSubscriber, sessionSubscriberCleanup] = sessionEventSubscriber();
+
+const connect = builders
+  .connect()
+  .action(async function () {
+    const adapter = getAdapter();
+    const session = await adapter.ensureSession({ namespace: 'utxo' });
+    const bip122Accounts = filterBip122Accounts(session);
+
+    if (!bip122Accounts.length) {
+      throw new Error('No Bitcoin accounts found in WalletConnect session.');
+    }
+
+    return utils.formatAccountsToCAIP(
+      [bip122Accounts[0].address],
+      CAIP_BITCOIN_CHAIN_ID
+    );
+  })
+  .before(sessionSubscriber)
+  .or(sessionSubscriberCleanup)
+  .or(standardizeAndThrowError)
+  .build();
+
+const canEagerConnect = new ActionBuilder<UtxoActions, 'canEagerConnect'>(
+  'canEagerConnect'
+)
+  .action(async () => getAdapter().tryRestoreEagerSession('utxo'))
+  .build();
+
+const disconnect = commonBuilders
+  .disconnect<UtxoActions>()
+  .after(() => {
+    void getAdapter().disconnectSession('utxo');
+  })
+  .after(sessionSubscriberCleanup)
+  .build();
+
+const utxo = new NamespaceBuilder<UtxoActions>('UTXO', WALLET_ID)
+  .action(connect)
+  .action(disconnect)
+  .action(canEagerConnect)
+  .build();
+
+export { utxo };

wallets/provider-walletconnect-2/src/provider.ts

@@ -5,6 +5,7 @@ import { ProviderBuilder } from '@hub3js/core';
 import { WalletConnectAdapter } from './adapter/adapter.js';
 import { metadata, WALLET_ID } from './constants.js';
 import { evm } from './namespaces/evm/namespace.js';
+import { utxo } from './namespaces/utxo/namespace.js';
 
 let adapter: WalletConnectAdapter;
 
@@ -29,6 +30,7 @@ const buildProvider = () =>
     })
     .config('metadata', metadata)
     .add('evm', evm)
+    .add('utxo', utxo)
     .build();
 
 export { buildProvider };