Skip to content

Latest commit

 

History

History
136 lines (100 loc) · 2.82 KB

README.md

File metadata and controls

136 lines (100 loc) · 2.82 KB
Raw

Sats-Wagmi


sats-wagmi is a library with a handful of BTC wallet connectors, leaving aside the need of the developer to integrate each one individually. The library also exports useful React hooks that mimic the standard followed in the original EVM wagmi library.

The package is still in an infancy state, but feel free to recommend any adjustments that you see fit.

Table of contents

Features

  • BTC Wallet connectors:
    • Metamask Snap
    • Unisat
    • Leather
    • Xverse
    • Bitget
    • OKX Wallet
  • BTC functionality:
    • send BTC
    • sign PSBTs
  • React hooks
  • Planned BTC functionality
    • inscribe (text and images)
    • send inscription
    • etch runes
    • send runes

Installation

To use sats-wagmi, all you need to do is install the @gobob/sats-wagmi:

# with Yarn
$ yarn add @gobob/sats-wagmi

# with npm
$ npm i @gobob/sats-wagmi

# with pnpm
$ pnpm add @gobob/sats-wagmi

# with Bun
$ bun add @gobob/sats-wagmi

Usage

Connector

import { MMSnapConnector } from './connectors';

const mmSnap = new MMSnapConnector(network);

mmSnap.connect();

React Hooks

  1. Wrap your application with the SatsWagmiConfig provided by @gobob/sats-wagmi.
import { SatsWagmiConfig } from '@gobob/sats-wagmi';

// Do this at the root of your application
function App({ children }) {
  return <SatsWagmiConfig network='testnet'>{children}</SatsWagmiConfig>;
}
  1. Now start by connecting:
import { useConnect, SatsConnector } from '@gobob/sats-wagmi';

function Example() {
  const { connectors, connect } = useConnect();

  const handleConnect = (connector: SatsConnector) => {
    connect({
      connector
    });
  };

  return (
    <div>
      {connectors.map((connector) => (
        <button key={connector.name} onClick={() => handleConnect(connector)}>
          {connector.name}
        </button>
      ))}
    </div>
  );
}
  1. Once connected, you should be able to use the connector utility and have access to the connected BTC account:
import { useConnect, SatsConnector } from '@gobob/sats-wagmi';

function Example() {
  const { address, connector } = useSatsAccount();

  const handleTransfer = () => {
    connector?.sendToAddress('tb1p9gl248kp19jgennea98e2tv8acfrvfv0yws2tc5j6u72e84caapsh2hexs', 100000000);
  };

  return (
    <div>
      <p>Address: {address}</p>
      <button onClick={handleTransfer}>Transfer 1 BTC</button>
    </div>
  );
}

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

License

MIT