Bigmi

TypeScript library and reactive primitives for Bitcoin apps.

Bigmi (short for Bitcoin Is Gonna Make It) is a TypeScript library that provides reactive primitives for building Bitcoin applications. Bigmi simplifies Bitcoin app development by offering:

• Abstractions over the Bitcoin JSON-RPC API
• First-class APIs for interacting with the Bitcoin network, including sending transactions and tracking with Replace-By-Fee (RBF) support
• Connectors for popular Bitcoin wallet extensions
• TypeScript support

Whether you're building a Node.js application or a client-side app, Bigmi provides the tools you need to interact with the Bitcoin.

Packages

Bigmi is modularized into several packages, each suited to different use cases:

• @bigmi/core - Actions, transports, utilities, and other core primitives for Node.js or client-side applications.
• @bigmi/react - Hooks, providers, and other useful primitives for React applications.
• @bigmi/client - Wallet connectors and other tools to connect wallet extensions with Bitcoin applications.

Installation

pnpm add @bigmi/react

pnpm add @bigmi/core

pnpm add @bigmi/client

Getting Started

Here is an example of a basic usage:

import {
  type UTXOAPISchema,
  bitcoin,
  getBalance,
  getBlockCount,
  sendUTXOTransaction,
  utxo,
  waitForTransaction,
} from '@bigmi/core'
import { createClient, fallback, rpcSchema } from 'viem'

// Create a public client for interactions with the Bitcoin
const publicClient = createClient({
  chain: bitcoin,
  rpcSchema: rpcSchema<UTXOAPISchema>(),
  transport: fallback([
    utxo('https://api.blockchair.com', {
      key: 'blockchair',
      includeChainToURL: true,
    }),
    utxo('https://rpc.ankr.com/http/btc_blockbook/api/v2', {
      key: 'ankr',
    }),
    utxo('https://api.blockcypher.com/v1/btc/main', {
      key: 'blockcypher',
    }),
    utxo('https://mempool.space/api', {
      key: 'mempool',
    }),
  ]),
})

// Define the Bitcoin address you're working with
const address = 'BITCOIN_ADDRESS';

// Fetch the balance of the address
const balance = await getBalance(publicClient, { address });
console.log(`Balance for ${address}:`, balance);

// Fetch the current block count (height)
const blockCount = await getBlockCount(publicClient);
console.log('Current block count:', blockCount);

// Prepare the transaction hex (as a string)
const txHex = 'TRANSACTION_HEX';

// Send the transaction to the network
const txId = await sendUTXOTransaction(publicClient, { hex: txHex });
console.log('Transaction sent with ID:', txId);

// Wait for the transaction to be confirmed
const transaction = await waitForTransaction(publicClient, {
  txId,
  txHex,
  senderAddress: address,
  onReplaced: (response) => {
    console.log('Transaction replaced due to:', response.reason);
  },
});

console.log('Transaction confirmed:', transaction);

Examples

We are working on examples to showcase Bigmi's capabilities. Stay tuned!

In the meantime, explore the LI.FI Widget and LI.FI SDK for inspiration.

Documentation

Detailed documentation is coming soon. For now, refer to the source code and type definitions for guidance.

Support

If you encounter any issues or have questions, please open an issue.

Contributing

We welcome contributions from the community!

Changelog

The changelog is regularly updated to reflect what's changed in each new release.

License

This project is licensed under the terms of the MIT License.

Acknowledgments

Bigmi is inspired by the wevm stack. We appreciate the open-source community's contributions to advancing blockchain development.