viem

What is viem?

The 'viem' npm package is a versatile library designed for interacting with Ethereum blockchain networks. It provides a range of functionalities including connecting to Ethereum nodes, sending transactions, interacting with smart contracts, and more.

What are viem's main functionalities?

Connecting to Ethereum Nodes

This feature allows you to create a client that connects to an Ethereum node using a specified URL. In this example, the client connects to the Infura mainnet node.

const { createClient } = require('viem');
const client = createClient({
  url: 'https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID'
});

Sending Transactions

This feature allows you to send transactions on the Ethereum network. The example demonstrates sending 1 ETH from one address to another.

const { sendTransaction } = require('viem');
const tx = await sendTransaction(client, {
  from: '0xYourAddress',
  to: '0xRecipientAddress',
  value: '1000000000000000000' // 1 ETH in wei
});

Interacting with Smart Contracts

This feature allows you to interact with smart contracts by calling their functions. The example shows how to call a function of a smart contract using its ABI and function name.

const { callContractFunction } = require('viem');
const result = await callContractFunction(client, {
  contractAddress: '0xContractAddress',
  abi: [
    // ABI of the contract
  ],
  functionName: 'functionName',
  args: [/* function arguments */]
});

Other packages similar to viem

web3

The 'web3' package is a popular library for interacting with the Ethereum blockchain. It provides similar functionalities to 'viem' such as connecting to nodes, sending transactions, and interacting with smart contracts. However, 'web3' is more established and widely used in the Ethereum developer community.

ethers

The 'ethers' package is another widely-used library for Ethereum development. It offers a clean and simple API for interacting with the Ethereum blockchain, including functionalities for connecting to nodes, sending transactions, and interacting with smart contracts. 'ethers' is known for its ease of use and comprehensive documentation.

README

TypeScript Interface for Ethereum

Features

• Abstractions over the JSON-RPC API to make your life easier
• First-class APIs for interacting with Smart Contracts
• Language closely aligned to official Ethereum terminology
• Import your Browser Extension, WalletConnect or Private Key Wallet
• Browser native BigInt, instead of large BigNumber libraries
• Utilities for working with ABIs (encoding/decoding/inspection)
• TypeScript ready (infer types from ABIs and EIP-712 Typed Data)
• First-class support for Anvil, Hardhat & Ganache
• Test suite running against forked Ethereum network

... and a lot more.

Overview

// 1. Import modules.
import { createPublicClient, http } from 'viem';
import { mainnet } from 'viem/chains';

// 2. Set up your client with desired chain & transport.
const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});

// 3. Consume an action!
const blockNumber = await client.getBlockNumber();

Documentation

Head to the documentation to read and learn more about viem.

Community

Check out the following places for more viem-related content:

• Follow @wevm_dev, @_jxom, and @awkweb on Twitter for project updates
• Join the discussions on GitHub
• Share your project/organization that uses viem

Support

• GitHub Sponsors
• Gitcoin Grant
• wevm.eth

Sponsors

Contributing

If you're interested in contributing, please read the contributing docs before submitting a pull request.

Authors

• @jxom (jxom.eth, Twitter)
• @tmm (awkweb.eth, Twitter)

License

MIT License