/nuxt-web3kit

Web3 composables for your decentralized application.

Primary LanguageTypeScript

Nuxt Web3 Kit

npm version npm downloads License

Web3 composables for Nuxt

Features

  • 🚀 Composables for working with wallets, ENS, contracts, transactions, signing, etc.
  • 💼 Built-in wallet connectors for MetaMask, WalletConnect, Coinbase Wallet, and Injected
  • 🌀 Auto-refresh data on wallet, block, and network changes
  • 💾 Store files to IPFS
  • 🖳 Server-side authentication with EIP712 signatures
  • 🦄 TypeScript ready
  • 🖧 SSR friendly

Quick Setup

  1. Add @zaifer/nuxt-web3kit dependency to your project
# Using pnpm
pnpm add -D @zaifer/nuxt-web3kit

# Using yarn
yarn add --dev @zaifer/nuxt-web3kit

# Using npm
npm install --save-dev @zaifer/nuxt-web3kit
  1. Add @zaifer/nuxt-web3kit to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: [
    '@zaifer/nuxt-web3kit'
  ]
})

That's it! You can now use Nuxt Web3 Kit in your Nuxt app ✨

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release