WalletMesh Modal Core

⚠️ IMPORTANT: This package is for FRAMEWORK DEVELOPERS ONLY

If you're building a dApp, use one of our framework packages instead:

• React: @walletmesh/modal-react
• Vue: @walletmesh/modal-vue (coming soon)
• Svelte: @walletmesh/modal-svelte (coming soon)
• Angular: @walletmesh/modal-angular (coming soon)
• Lit: @walletmesh/modal-lit (coming soon)

Framework-agnostic wallet connection modal system with standardized events, type-safe APIs, and multi-chain support.

📦 Installation

npm install @walletmesh/modal-core

🚀 Quick Start

For dApp developers: Please use a framework package (see above).

For framework developers: See our documentation.

📖 Documentation

All documentation is organized in the documentation/ directory:

• Getting Started - Installation and basic setup
• Developer Guides - Role-specific guides
  • Framework Developers
  • Wallet Adapter Developers
  • dApp Developers (if using modal-core directly)
  • Aztec Proving Flow - Zero-knowledge proof generation
• API Reference - Complete API documentation
• Architecture - System design and patterns
• Examples - Code examples

Service Documentation

• Service Integration Guide - How services interact and integrate
• Service Sequence Diagrams - Visual service interaction flows
• Service API Reference - Quick reference for all service APIs

🛠️ Core Features

• Framework Agnostic - Works with any UI framework or vanilla JavaScript
• Type-Safe - Full TypeScript support with runtime validation
• Multi-Chain - Support for EVM, Solana, Aztec, and more
• Provider Access - Direct access to wallet providers
• Event System - Standardized wallet events
• SSR Compatible - Server-side rendering support
• Resource Management - Automatic cleanup
• Aztec Proving Support - Dedicated UI state for zero-knowledge proof generation

🏗️ Basic Usage

import { createWalletMeshClient } from '@walletmesh/modal-core';

// Create client instance
const client = createWalletMeshClient({
  appName: 'My dApp',
  appDescription: 'My decentralized application',
  appUrl: 'https://mydapp.com',
  appIcon: 'https://mydapp.com/icon.png'
});

// Connect to a wallet
const session = await client.connect();
console.log('Connected:', session.address);

// Use the provider
const provider = session.provider;
const balance = await provider.getBalance(session.address);

🤝 Contributing

See our Contributing Guide for development setup and guidelines.

📄 License

MIT License - see LICENSE for details.

🔗 Links

• npm Package
• GitHub Repository
• Documentation
• Examples