Skip to content
BitcoinKit Logo BitcoinKit Guide

Overview

BitcoinKit Widget

Section titled “BitcoinKit Widget”

The BitcoinKit Widget is a JavaScript/React component library that provides a fully featured and customizable Bitcoin tokenization experience for web and mobile applications. The widget enables users to seamlessly deposit Bitcoin to receive zBTC (tokenized Bitcoin) and withdraw zBTC back to Bitcoin, all through an intuitive, embeddable interface.

The widget can be embedded directly into your organization’s web or mobile applications for a seamless user experience, or used in a popup/modal format for minimal integration effort.

Quick Start

Section titled “Quick Start”

Installation

Section titled “Installation”
Terminal window
# npm
npm install @zeus-network/bitcoin-kit-widget


# yarn
yarn add @zeus-network/bitcoin-kit-widget


# pnpm
pnpm add @zeus-network/bitcoin-kit-widget

Basic Usage

Section titled “Basic Usage”
import {
  Widget,
  BitcoinNetwork,
  SolanaNetwork,
} from "@zeus-network/bitcoin-kit-widget";
import "@zeus-network/bitcoin-kit-widget/assets/style.css";


<Widget.Popover
  config={{
    bitcoinNetwork: BitcoinNetwork.Regtest,
    solanaNetwork: SolanaNetwork.Devnet,
  }}
>
  <Widget.Popover.Trigger asChild>
    <button>Open Widget</button>
  </Widget.Popover.Trigger>


  <Widget.Portal>
    <Widget.Popover.Content />
  </Widget.Portal>
</Widget.Popover>;

Requirements: React 18+ with Solana wallet providers (setup guide)

Evaluation & Testing

Section titled “Evaluation & Testing”

Try the widget without Bitcoin wallet extensions:

import { useDeriveWalletConnector } from "@zeus-network/bitcoin-kit-widget/bitcoin-wallet-adapter";


const deriveWallet = useDeriveWalletConnector(BitcoinNetwork.Regtest);


<Widget.Popover
  config={{
    bitcoinNetwork: BitcoinNetwork.Regtest,
    solanaNetwork: SolanaNetwork.Devnet,
    bitcoinWallets: [deriveWallet], // Uses your Solana wallet
  }}
>
  {/* ... */}
</Widget.Popover>;

Live Demo: playground.bitcoin-kit.dev

Supported Bitcoin Wallets

Section titled “Supported Bitcoin Wallets”

Production Wallets (Mainnet/Testnet)

Section titled “Production Wallets (Mainnet/Testnet)”
  • Phantom: Multi-chain wallet (Mainnet only)
  • UniSat: Desktop/mobile Bitcoin wallet
  • OKX: Multi-chain wallet
  • Xverse: Bitcoin and Stacks wallet

Development Wallets (Regtest)

Section titled “Development Wallets (Regtest)”
  • Derive Wallet: Derived from Solana wallet (no installation needed)
  • Muses: Bitcoin-focused development wallet

Support

Section titled “Support”

Built With

Section titled “Built With”