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

wagmi

React Hooks library for Ethereum, built on ethers.js.

🚀   20+ hooks for working with wallets, ENS, contracts, transactions, signing, etc.

💼   Built-in wallet connectors for MetaMask, WalletConnect, and Coinbase Wallet

🌀   Auto-refresh data on wallet and network changes

🦄   TypeScript ready

💨   Zero-dependencies (besides ethers.js peer dependency)

🌳   Test suite and documentation

📖   MIT License

Documentation

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

Usage

1. Install the dependencies.

pnpm add wagmi ethers

1. Wrap your app with the Provider component.

import { Provider } from 'wagmi'

const App = () => (
  <Provider>
    <YourRoutes />
  </Provider>
)

1. Use hooks.

import { useAccount } from 'wagmi'

const Page = () => {
  const [{ data, error, loading }, disconnect] = useAccount({
    fetchEns: true,
  })

  return ...
}

Every component inside the Provider is set up with the default InjectedConnector for connecting wallets and ethers.js Default Provider for fetching data.

Want to learn more? Check out the guides or browse the API docs.

Community

Feel free to join the discussions on GitHub or reach out on Twitter!

Support

• awkweb.eth
• GitHub Sponsors
• Sign the guestbook

Thanks

• ricmoo.eth for creating and continued work on ethers.js
• Mirror for creating space to do good work

License

MIT.

wagmi