wagmi

What is wagmi?

The wagmi npm package is a collection of React Hooks for Ethereum, designed to make it easier to work with Ethereum-based applications. It provides a set of tools to manage wallet connections, interact with smart contracts, and handle blockchain data in a React environment.

What are wagmi's main functionalities?

Wallet Connection

This feature allows users to connect and disconnect their Ethereum wallets. It provides hooks to manage the wallet connection state and handle different wallet connectors.

import { useAccount, useConnect, useDisconnect } from 'wagmi';

function Wallet() {
  const { address, isConnected } = useAccount();
  const { connect, connectors } = useConnect();
  const { disconnect } = useDisconnect();

  return (
    <div>
      {isConnected ? (
        <div>
          <p>Connected to {address}</p>
          <button onClick={() => disconnect()}>Disconnect</button>
        </div>
      ) : (
        <div>
          {connectors.map((connector) => (
            <button key={connector.id} onClick={() => connect(connector)}>
              Connect with {connector.name}
            </button>
          ))}
        </div>
      )}
    </div>
  );
}

Smart Contract Interaction

This feature allows users to read from and write to smart contracts. It provides hooks to interact with smart contract functions and manage the state of these interactions.

import { useContractRead, useContractWrite } from 'wagmi';

const contractConfig = {
  addressOrName: '0xContractAddress',
  contractInterface: ContractABI,
};

function ContractInteraction() {
  const { data: balance } = useContractRead({ ...contractConfig, functionName: 'balanceOf', args: ['0xAddress'] });
  const { write: transfer } = useContractWrite({ ...contractConfig, functionName: 'transfer', args: ['0xRecipient', 100] });

  return (
    <div>
      <p>Balance: {balance?.toString()}</p>
      <button onClick={() => transfer()}>Transfer</button>
    </div>
  );
}

Blockchain Data

This feature allows users to access blockchain data such as the current block number and the connected network. It provides hooks to fetch and display this data in a React component.

import { useBlockNumber, useNetwork } from 'wagmi';

function BlockchainData() {
  const { data: blockNumber } = useBlockNumber();
  const { chain } = useNetwork();

  return (
    <div>
      <p>Current Block Number: {blockNumber}</p>
      <p>Connected Network: {chain?.name}</p>
    </div>
  );
}

Other packages similar to wagmi

web3-react

web3-react is a library for managing Ethereum wallet connections in React applications. It provides hooks for connecting to wallets, handling network changes, and interacting with smart contracts. Compared to wagmi, web3-react is more focused on wallet connection management and less on providing a comprehensive set of hooks for various blockchain interactions.

ethers.js

ethers.js is a library for interacting with the Ethereum blockchain and its ecosystem. It provides utilities for connecting to Ethereum nodes, interacting with smart contracts, and managing wallets. While ethers.js is not React-specific, it can be used in conjunction with React to achieve similar functionalities as wagmi.

README

Documentation

Visit https://wagmi-xyz.vercel.app to view the full documentation.

Usage

pnpm add wagmi ethers

Development

pnpm i
pnpm dev

Docs

pnpm dev:docs

Examples

pnpm dev:example:vite-react
pnpm dev:example:next

Testing

pnpm test
pnpm test:watch

CI

Add secrets to GitHub:

NPM_TOKEN