\n\n# BTC Connect\n\nBTC Connect is a library that allows you to easily integrate Bitcoin wallets (SAT20, Unisat and OKX) into your web application. With this library, you can enable your users to manage their Bitcoin addresses, send and receive transactions, and interact with Bitcoin wallets directly from your web app.\n\n## Features\n\n- Connect to popular Bitcoin wallets (SAT20, Unisat and OKX)\n- Manage Bitcoin addresses and check balances\n- Send and receive Bitcoin transactions\n- Sign messages and PSBTs\n- Push transactions and PSBTs to the network\n- Switch between different connectors and networks\n- Customizable UI theme (light and dark)\n- Typescript support\n- Support for React components\n- Support for pure JavaScript usage (compatible with Vue, vanilla JS, etc.)\n\n## Installation\n\nYou can install the package via npm, yarn, pnpm or bun:\n\n### npm\n```bash\nnpm install btc-connect\n```\n\n### Yarn\n```bash\nyarn add btc-connect\n```\n\n### pnpm\n```bash\npnpm add btc-connect\n```\n\n### bun\n```bash\nbun add btc-connect\n```\n\n## Requirements\n\nFor React:\n- react (>=16.8.0)\n- react-dom (>=16.8.0)\n\nThe library also uses the `zustand` state management library for React hooks.\n\n## Usage\n\n### React\n\nImport the `WalletConnectReact` component and wrap your application with it:\n\n```jsx\nimport React from 'react';\nimport { WalletConnectReact } from 'btc-connect/dist/react';\nimport \"btc-connect/dist/style/index.css\";\n\nconst App = () => {\n const config = {\n network: 'mainnet', // or 'testnet'\n defaultConnectorId: 'sat20', // 'unisat' or 'okx'\n };\n\n return (\n {\n // Handle successful connection\n }}\n theme=\"dark\"\n onConnectError={(error) => {\n // Handle connection error\n }}\n onDisconnectSuccess={() => {\n // Handle successful disconnection\n }}\n onDisconnectError={(error) => {\n // Handle disconnection error\n }}\n >\n {/* Your app components */}\n \n );\n};\n\nexport default App;\n```\n\nYou can also use the `useReactWalletStore` hook to access the wallet store and perform various actions:\n\n```jsx\nimport React from 'react';\nimport { useReactWalletStore } from 'btc-connect/dist/react';\n\nconst MyComponent = () => {\n const walletStore = useReactWalletStore();\n\n const connect = () => {\n walletStore.connect();\n };\n\n const disconnect = () => {\n walletStore.disconnect();\n };\n\n const sendBitcoin = async () => {\n const toAddress = '...';\n const amount = 1000;\n const txid = await walletStore.btcWallet?.sendToAddress(toAddress, amount);\n console.log('Transaction ID:', txid);\n };\n\n return (\n
\n \n \n \n
\n );\n};\n\nexport default MyComponent;\n```\n\n### Pure JavaScript\n\nYou can use the `BtcWalletConnect` class directly in your JavaScript code:\n\n```javascript\nimport BtcWalletConnect from 'btc-connect';\n\nconst config = {\n network: 'mainnet', // or 'testnet'\n defaultConnectorId: 'sat20', // 'unisat' or 'okx'\n};\n\nconst btcWallet = new BtcWalletConnect(config);\n\n// Connect to the wallet\nbtcWallet.connect()\n .then(() => {\n // Handle successful connection\n })\n .catch((error) => {\n // Handle connection error\n });\n\n// Send Bitcoin\nconst toAddress = '...';\nconst amount = 1000;\nbtcWallet.sendToAddress(toAddress, amount)\n .then((txid) => {\n console.log('Transaction ID:', txid);\n })\n .catch((error) => {\n // Handle error\n });\n\n// Disconnect from the wallet\nbtcWallet.disconnect()\n .then(() => {\n // Handle successful disconnection\n })\n .catch((error) => {\n // Handle disconnection error\n });\n```\n\nThis pure JavaScript usage makes it compatible with Vue, vanilla JavaScript, and other frameworks or libraries.\n\nFor more detailed information and examples, please refer to the [Doc](https://github.com/IceHugh/btc-connect/doc.md).\n\n## TODO\n\n- Support for Vue components\n\n## Contributing\n\nContributions are welcome! Please read the [contributing guidelines](https://github.com/IceHugh/btc-connect/blob/main/CONTRIBUTING.md) for more information.\n\n\n\n## License\n\nBTC Connect is licensed under the [MIT License](https://github.com/IceHugh/btc-connect/blob/main/LICENSE).\n\n## Support and Donation\n\nIf you find this project helpful and you would like to support its continued development, feel free to make a donation through one of the following methods. Your support is a tremendous encouragement for us!\n\n\n\n## Cryptocurrency\n\nYou can also donate using the following cryptocurrency addresses:\n\n- BTC: bc1pnacumj3jhn28x8lwj5fqfwzxcq0kfhyrtzadd4unlg4cu57mp3wghp0j73\n\nThank you to every supporter for your contributions!\n","readmeFilename":"README.md"}
![](\"https://github.com/IceHugh/btc-connect/blob/main/images/example_black.png\")
\n ![](\"https://github.com/IceHugh/btc-connect/blob/main/images/example_white.png\")
\n ![](\"https://github.com/IceHugh/btc-connect/blob/main/images/btc_qrcode.jpg\")
\nThank you to every supporter for your contributions!\n","readmeFilename":"README.md"}