Giter Club home page Giter Club logo

btc-connect's Introduction

中文   •   Document   •   Example

BTC Connect

BTC Connect is a library that allows you to easily integrate Bitcoin wallets (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.

Features

  • Connect to popular Bitcoin wallets (Unisat and OKX)
  • Manage Bitcoin addresses and check balances
  • Send and receive Bitcoin transactions
  • Sign messages and PSBTs
  • Push transactions and PSBTs to the network
  • Switch between different connectors and networks
  • Customizable UI theme (light and dark)
  • Typescript support
  • Support for React components
  • Support for pure JavaScript usage (compatible with Vue, vanilla JS, etc.)

Installation

You can install the package via npm, yarn, pnpm or bun:

npm

npm install btc-connect

Yarn

yarn add btc-connect

pnpm

pnpm add btc-connect

bun

bun add btc-connect

Requirements

For React:

  • react (>=16.8.0)
  • react-dom (>=16.8.0)

The library also uses the zustand state management library for React hooks.

Usage

React

Import the WalletConnectReact component and wrap your application with it:

import React from 'react';
import { WalletConnectReact } from 'btc-connect/dist/react';
import "btc-connect/dist/style/index.css";

const App = () => {
  const config = {
    network: 'livenet', // or 'testnet'
    defaultConnectorId: 'unisat', // or 'okx'
  };

  return (
    <WalletConnectReact
      config={config}
      onConnectSuccess={(btcWallet) => {
        // Handle successful connection
      }}
      theme="dark"
      onConnectError={(error) => {
        // Handle connection error
      }}
      onDisconnectSuccess={() => {
        // Handle successful disconnection
      }}
      onDisconnectError={(error) => {
        // Handle disconnection error
      }}
    >
      {/* Your app components */}
    </WalletConnectReact>
  );
};

export default App;

You can also use the useReactWalletStore hook to access the wallet store and perform various actions:

import React from 'react';
import { useReactWalletStore } from 'btc-connect/dist/react';

const MyComponent = () => {
  const walletStore = useReactWalletStore();

  const connect = () => {
    walletStore.connect();
  };

  const disconnect = () => {
    walletStore.disconnect();
  };

  const sendBitcoin = async () => {
    const toAddress = '...';
    const amount = 1000;
    const txid = await walletStore.btcWallet?.sendToAddress(toAddress, amount);
    console.log('Transaction ID:', txid);
  };

  return (
    <div>
      <button onClick={connect}>Connect</button>
      <button onClick={disconnect}>Disconnect</button>
      <button onClick={sendBitcoin}>Send Bitcoin</button>
    </div>
  );
};

export default MyComponent;

Pure JavaScript

You can use the BtcWalletConnect class directly in your JavaScript code:

import BtcWalletConnect from 'btc-connect';

const config = {
  network: 'livenet', // or 'testnet'
  defaultConnectorId: 'unisat', // or 'okx'
};

const btcWallet = new BtcWalletConnect(config);

// Connect to the wallet
btcWallet.connect()
  .then(() => {
    // Handle successful connection
  })
  .catch((error) => {
    // Handle connection error
  });

// Send Bitcoin
const toAddress = '...';
const amount = 1000;
btcWallet.sendToAddress(toAddress, amount)
  .then((txid) => {
    console.log('Transaction ID:', txid);
  })
  .catch((error) => {
    // Handle error
  });

// Disconnect from the wallet
btcWallet.disconnect()
  .then(() => {
    // Handle successful disconnection
  })
  .catch((error) => {
    // Handle disconnection error
  });

This pure JavaScript usage makes it compatible with Vue, vanilla JavaScript, and other frameworks or libraries.

For more detailed information and examples, please refer to the Doc.

TODO

  • Support for Vue components

Contributing

Contributions are welcome! Please read the contributing guidelines for more information.

License

BTC Connect is licensed under the MIT License.

Support and Donation

If 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!

Cryptocurrency

You can also donate using the following cryptocurrency addresses:

  • BTC: bc1pnacumj3jhn28x8lwj5fqfwzxcq0kfhyrtzadd4unlg4cu57mp3wghp0j73

Thank you to every supporter for your contributions!

btc-connect's People

Contributors

icehugh avatar imgbotapp avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

btc-connect's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.