@tari-project/tarijs 0.10.1 → 0.11.0

package/README.md

@@ -1,101 +1,161 @@
 # tari.js
 
-This project provides a unified TypeScript library to connect and send requests to a Tari wallet. It's intended for web application developers that want to interact with a Tari wallet (connect, get substates, submit transactions, etc.).
+> **🚀 The complete TypeScript toolkit for building on Tari** — Connect any wallet, query the blockchain, and create powerful dApps with confidence.
 
-Tari wallets supported:
-* Tari Wallet Daemon
-* MetaMask through the [tari-snap](https://github.com/tari-project/tari-snap)
+[![npm version](https://badge.fury.io/js/@tari-project%2Ftarijs.svg)](https://badge.fury.io/js/@tari-project%2Ftarijs)
+[![License](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg)](LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-tari--project.github.io-brightgreen)](https://tari-project.github.io/tari.js/)
 
-An example site (under the `example` folder) contains a web project that allows the user to connect to any type of Tari wallet and perform common actions.
+**✨ What makes tari.js special?**
+- **🔌 Universal Wallet Support** — MetaMask, Wallet Daemon, Universe, WalletConnect — all with one API
+- **🛡️ Privacy-First** — Built-in confidential transactions and zero-knowledge proofs
+- **📱 Developer Friendly** — Full TypeScript support, intuitive APIs, comprehensive docs
+- **⚡ Production Ready** — Battle-tested, optimized, and actively maintained
 
-Please read the [TODO](TODO.md) file for upcoming features.
+## 🎯 Quick Start (5 minutes)
 
-## Library building
+Get your first Tari app running in minutes:
 
-You must have the [tari-ootle](https://github.com/tari-project/tari-ootle) repo cloned at the same folder level as this repo.
+```bash
+# Install tari.js
+npm install @tari-project/tarijs @tari-project/wallet-daemon-signer
+
+# Run your first connection test
+node -e "
+import { WalletDaemonTariSigner, TariPermissions } from '@tari-project/tarijs';
+const wallet = await WalletDaemonTariSigner.buildFetchSigner({
+  serverUrl: 'http://localhost:18103',
+  permissions: new TariPermissions()
+});
+console.log('Connected to Tari!');
+"
+```
 
-### Option 1: Local Build
+**👉 [Complete Installation Guide](https://tari-project.github.io/tari.js/installation) | [5-Minute Tutorial](https://tari-project.github.io/tari.js/guides/getting-started-tutorial)**
 
-To build the library locally:
-First you must install [proto](https://moonrepo.dev/proto) to manage node and pnpm versions 
-```shell
-proto use
-pnpm install
-moon tarijs:build
+## 🏗️ What You Can Build
+
+### 🪙 **DeFi Applications**
+```typescript
+// Transfer tokens
+const transaction = new TransactionBuilder()
+  .feeTransactionPayFromComponent(account.address, "100")
+  .callMethod({
+    componentAddress: account.address,
+    methodName: 'withdraw'
+  }, [{ type: 'Amount', value: '1000' }])
+  .build();
 ```
 
-The bundled files for deployment or publication will be located under the `dist` folder of each package.
+### 🎮 **Gaming & NFTs**  
+```typescript
+// Call a smart contract function
+const transaction = new TransactionBuilder()
+  .feeTransactionPayFromComponent(account.address, "100")
+  .callFunction({
+    templateAddress: nftTemplate.address,
+    functionName: 'mint_nft'
+  }, [{ name: 'metadata', value: { name: "Epic Sword", rarity: "legendary" } }])
+  .build();
+```
 
-### Option 2: Docker Build
+### 💼 **Enterprise Solutions**
+```typescript
+// Multiple operations in one transaction
+const transaction = new TransactionBuilder()
+  .feeTransactionPayFromComponent(account.address, "100")
+  .callMethod({ componentAddress: account1, methodName: 'withdraw' }, [amount1])
+  .callMethod({ componentAddress: account2, methodName: 'withdraw' }, [amount2])
+  .build();
+```
 
-Alternatively, you can build the library using Docker:
+## 🔗 Supported Wallets
 
-```shell
-# Build the Docker image
-docker build -t tarijs .
+| Wallet | Best For | Status |
+|--------|----------|--------|
+| **🖥️ [Tari Wallet Daemon](https://tari-project.github.io/tari.js/signers/wallet-daemon)** | Servers, advanced features | ✅ Production |
+| **🦊 [MetaMask](https://tari-project.github.io/tari.js/signers/metamask)** | Browser apps, familiar UX | ✅ Production |
+| **🌌 [Tari Universe](https://tari-project.github.io/tari.js/signers/tari-universe)** | Mobile, native experience | ✅ Production |
+| **📱 [WalletConnect](https://tari-project.github.io/tari.js/signers/wallet-connect)** | Cross-platform, mobile-first | ✅ Production |
 
-# Run the container and copy the combined dist files
-docker create --name tarijs-build tarijs
-docker cp tarijs-build:/app/combined_dist/ ./dist
-docker rm tarijs-build
-```
+## 📚 Documentation Hub
 
-This will create a combined build output in your local `dist` directory, containing all package distributions organized by package name, with the following structure:
+### 🚀 **Get Started**
+- **[Installation Guide](https://tari-project.github.io/tari.js/installation)** — Set up your development environment
+- **[First App Tutorial](https://tari-project.github.io/tari.js/guides/getting-started-tutorial)** — Build a working wallet app
+- **[Provider vs Signer](https://tari-project.github.io/tari.js/provider-vs-signer)** — Understand the core concepts
 
-```
-dist/
-├── tarijs/
-├── tari_provider/
-├── tari_permissions/
-├── wallet_daemon/
-├── tari_signer/
-├── builders/
-├── metamask_signer/
-├── tari_universe/
-├── tarijs_types/
-├── indexer_provider/
-└── walletconnect/
-```
+### 📖 **Guides & Examples**
+- **[Wallet Integration](https://tari-project.github.io/tari.js/category/signers)** — Connect different wallet types
+- **[Transaction Building](https://tari-project.github.io/tari.js/wallet/submit-transaction/transaction-builder/)** — Create complex transactions
+- **[Production Deployment](https://tari-project.github.io/tari.js/guides/production-deployment)** — Go live with confidence
 
-Each package's dist folder contains its compiled JavaScript files, type definitions, and other build artifacts, excluding node_modules.
+### 🔧 **Reference**
+- **[Complete API Reference](https://tari-project.github.io/tari.js/api-reference)** — Every method documented
+- **[Troubleshooting](https://tari-project.github.io/tari.js/troubleshooting)** — Common issues & solutions
+- **[Templates & Examples](https://github.com/tari-project/tari.js/tree/main/examples)** — Copy-paste code snippets
 
-## Running the example site
+---
 
-To run the example site you will need to:
-* Compile the library following the previous section.
-* Have access to a Tari Wallet Daemon and to the Tari MetaMask Snap.
-* Copy the `example/.env.example` file to `example/.env` and edit the correct environment variable values.
+## 🛠️ Contributing & Development  
+
+**Want to contribute?** We'd love your help! Here's how to get started:
+
+### 🚀 **Quick Development Setup**
+
+```bash
+# 1. Clone with required dependencies
+git clone https://github.com/tari-project/tari.js
+git clone https://github.com/tari-project/tari-ootle ../tari-ootle
 
-To run in development mode, in the packages/tarijs folder:
-```shell
-cd example
+# 2. Install toolchain
+curl -fsSL https://moonrepo.dev/install/proto.sh | bash
+proto use
+
+# 3. Build everything
+pnpm install
 moon tarijs:build
-pnpm run dev
 ```
 
-For building and distribution,  in the packages/tarijs folder
-```shell
-cd example
-moon tarijs:build
+### 🧪 **Run the Example App**
+```bash
+cd packages/tarijs/example
+cp .env.example .env    # Configure your wallet endpoints
+pnpm run dev           # Start development server
 ```
-The distribution files will be under the `example/dist` folder. 
 
-## Documentation
+### 📦 **Docker Development**
+```bash
+docker build -t tarijs .
+docker create --name tarijs-build tarijs
+docker cp tarijs-build:/app/combined_dist/ ./dist
+```
 
-This monorepo includes a documentation site located in the `docusaurus` folder.  It's built using [Docusaurus](https://docusaurus.io/) and generates a static website.
+### 📖 **Documentation Development**
+```bash
+moon tari-docs:start   # http://localhost:3000/tari.js/
+```
 
-### Modifying the Documentation
+**Need help getting started?** Check our **[Contributing Guide](https://tari-project.github.io/tari.js/contributing)** or ask in [GitHub Discussions](https://github.com/tari-project/tari.js/discussions).
 
-To start the documentation site:
+## 🤝 Community & Support
 
-```bash
-$ moon tari-docs:start
-```
+- **📚 [Complete Documentation](https://tari-project.github.io/tari.js/)** — Everything you need to know
+- **💬 [GitHub Discussions](https://github.com/tari-project/tari.js/discussions)** — Ask questions, share ideas  
+- **🐛 [Issue Tracker](https://github.com/tari-project/tari.js/issues)** — Report bugs, request features
+- **🔧 [Troubleshooting Guide](https://tari-project.github.io/tari.js/troubleshooting)** — Common issues & solutions
+- **🎮 [Example Apps](https://github.com/tari-project/tari.js/tree/main/examples)** — See tari.js in action
+
+## 📄 License
+
+This project is licensed under the **BSD 3-Clause License** — see the [LICENSE](LICENSE) file for details.
+
+---
 
-This will open the documentation site in your browser at `http://localhost:3000/tari.js/`
+<div align="center">
 
-You can now update the documentation by editing files in the `docusaurus/tari-docs/docs/` folder. Changes will be reflected automatically.
+**Built with ❤️ by the [Tari Project](https://tari.com)**
 
-### Publishing documentation
+[Website](https://tari.com) • [Blog](https://blog.tari.com) • [Twitter](https://twitter.com/tari) • [Discord](https://discord.gg/tari)
 
-The documentation is hosted on GitHub Pages and served from the `/docs` folder of the `gh-pages` branch. The `documentation-deploy.yml` workflow defines the deployment process.
+</div>

package/TODO.md

@@ -1,4 +1,92 @@
-# TODO
+# 🚀 tari.js Roadmap & Feature Requests
 
-- For the example site:
-  - The `TariConnect` button could be made into a reusable React component, ready to be imported by any web.
+**Welcome to our development roadmap!** This document tracks upcoming features, improvements, and community requests. Want to contribute? Pick an item and let's build together!
+
+## 🎯 **Current Sprint (v0.6.0)**
+
+### 🔧 **Developer Experience Improvements**
+- [ ] **Universal `TariConnect` Component** — Reusable React component for wallet connections
+  - Pre-built UI for all wallet types
+  - Customizable themes and styling
+  - TypeScript definitions included
+  - Ready for any React/Next.js app
+
+### 📱 **Mobile & Web Enhancements**
+- [ ] **Progressive Web App (PWA) Support** — Offline capabilities for mobile apps
+- [ ] **React Native Bindings** — Native mobile app integration
+- [ ] **QR Code Scanner** — Built-in address scanning for mobile wallets
+
+### 🔒 **Security & Privacy Features**
+- [ ] **Hardware Wallet Support** — Ledger and Trezor integration
+- [ ] **Multi-signature Transactions** — Enterprise-grade security
+- [ ] **Advanced Privacy Controls** — Granular confidential transaction settings
+
+## 🌟 **Upcoming Features (v0.7.0+)**
+
+### 🎮 **Gaming & NFT Tools**
+- [ ] **NFT Marketplace SDK** — Complete toolkit for NFT platforms
+- [ ] **Game Asset Management** — In-game currency and item handling
+- [ ] **Achievement System** — Blockchain-based gaming achievements
+
+### 💼 **Enterprise Solutions**
+- [ ] **Batch Transaction Processing** — High-volume transaction handling
+- [ ] **Audit Trail APIs** — Compliance and reporting tools
+- [ ] **Multi-tenant Architecture** — SaaS platform support
+
+### 🏗️ **Developer Tools**
+- [ ] **Visual Transaction Builder** — Drag-and-drop transaction creation
+- [ ] **Real-time Debugging** — Live transaction monitoring
+- [ ] **Template Generator** — Auto-generate smart contract templates
+
+## 💡 **Community Requests**
+
+### Most Requested Features
+1. **🔌 Simplified Wallet Detection** — Auto-detect available wallets
+2. **📊 Analytics Dashboard** — Built-in usage metrics
+3. **🌐 Multi-language Support** — i18n for global apps
+4. **🔄 Auto-retry Logic** — Smart transaction failure handling
+5. **📦 CDN Distribution** — Browser-ready builds via CDN
+
+### Vote for Features
+Have an idea? [Create a feature request](https://github.com/tari-project/tari.js/discussions/categories/ideas) and get community votes!
+
+## 🐛 **Known Issues & Fixes**
+
+### High Priority
+- [ ] **MetaMask Snap Performance** — Optimize snap loading times
+- [ ] **WebRTC Connection Stability** — Improve wallet daemon connections
+- [ ] **Bundle Size Optimization** — Reduce package footprint
+
+### Medium Priority  
+- [ ] **Documentation Search** — Improve search functionality
+- [ ] **TypeScript Strict Mode** — Full strict type checking
+- [ ] **Test Coverage** — Achieve 95%+ code coverage
+
+## 🚀 **How to Contribute**
+
+### 🛠️ **For Developers**
+1. Browse open issues: [Good First Issues](https://github.com/tari-project/tari.js/labels/good%20first%20issue)
+2. Join our [Discord](https://discord.gg/tari) for real-time discussions
+3. Check the [Contributing Guide](https://tari-project.github.io/tari.js/contributing)
+
+### 💭 **For Ideas & Feedback**
+1. [Start a discussion](https://github.com/tari-project/tari.js/discussions) with your ideas
+2. [Request features](https://github.com/tari-project/tari.js/issues/new?template=feature_request.md)
+3. Share your use cases and examples
+
+### 📚 **For Documentation**
+1. Improve existing docs in `/docusaurus/tari-docs/docs/`
+2. Add examples and tutorials
+3. Create video guides and walkthroughs
+
+## 📅 **Release Timeline**
+
+| Version | Expected | Key Features |
+|---------|----------|--------------|
+| **v0.6.0** | Q3 2025 | TariConnect component, PWA support |
+| **v0.7.0** | Q4 2025 | Gaming SDK, enterprise tools |
+| **v1.0.0** | Q1 2026 | Stable API, full platform coverage |
+
+---
+
+**🎉 Want to see something specific?** [Let us know!](https://github.com/tari-project/tari.js/discussions) We prioritize features based on community interest and real-world usage.

package/docusaurus/tari-docs/README.md

@@ -1,41 +1,224 @@
-# Website
+# tari.js Documentation Website 📚
 
-This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+> **Beautiful, comprehensive documentation for tari.js** — Built with Docusaurus for an exceptional developer experience.
 
-### Installation
+This is the source for the official [tari.js documentation site](https://tari-project.github.io/tari.js/), providing comprehensive guides, tutorials, and API reference for building with tari.js.
 
+## 🚀 **Quick Start**
+
+### **Prerequisites**
+- **Node.js 18+** and **pnpm** (recommended) or **yarn**
+- **Git** for version control
+
+### **Development Setup**
+
+```bash
+# Navigate to docs directory
+cd docusaurus/tari-docs
+
+# Install dependencies
+pnpm install
+# or
+yarn install
+
+# Start development server
+pnpm start
+# or  
+yarn start
+```
+
+The development server will start at `http://localhost:3000/tari.js/` with live reload enabled.
+
+## 🏗️ **Building & Deployment**
+
+### **Local Build**
+
+```bash
+# Build static site
+pnpm build
+# or
+yarn build
 ```
-$ yarn
+
+This generates static content in the `build/` directory that can be served by any static hosting service.
+
+### **Production Deployment**
+
+The documentation is automatically deployed to GitHub Pages via CI/CD when changes are merged to the main branch.
+
+**Manual deployment** (maintainers only):
+
+```bash
+# Deploy to GitHub Pages
+GIT_USER=<Your GitHub username> pnpm deploy
+# or
+GIT_USER=<Your GitHub username> yarn deploy
 ```
 
-### Local Development
+## 📁 **Documentation Structure**
 
 ```
-$ yarn start
+docs/
+├── index.md                    # Welcome page
+├── installation.md             # Setup guide
+├── provider-vs-signer.md       # Core concepts
+├── guides/                     # Tutorials and guides
+│   ├── getting-started-tutorial.md
+│   └── production-deployment.md
+├── signers/                    # Wallet integrations
+│   ├── wallet-daemon.md
+│   ├── metamask.md
+│   ├── tari-universe.md
+│   └── wallet-connect.md
+├── wallet/                     # Transaction & account management
+│   ├── submit-transaction/
+│   └── template-definition.md
+├── providers/                  # Data access
+│   └── indexer-provider.md
+├── api-reference.md           # Complete API docs
+├── troubleshooting.md         # Common issues
+└── contributing.md            # How to contribute
 ```
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+## ✍️ **Contributing to Documentation**
 
-### Build
+We welcome documentation improvements! Here's how to contribute:
 
+### **Making Changes**
+
+1. **Fork the repository** and create a feature branch
+2. **Edit documentation files** in the `docs/` directory
+3. **Test locally** using the development server
+4. **Submit a pull request** with your improvements
+
+### **Writing Guidelines**
+
+- ✅ **Clear, concise language** — Write for developers of all experience levels
+- ✅ **Practical examples** — Include working code snippets
+- ✅ **Cross-references** — Link to related documentation
+- ✅ **Consistent formatting** — Follow existing style patterns
+- ✅ **Test code examples** — Ensure all code works as shown
+
+### **Content Types**
+
+| Type | Purpose | Location |
+|------|---------|----------|
+| **Tutorials** | Step-by-step learning | `guides/` |
+| **How-to Guides** | Specific task solutions | `wallet/`, `signers/` |
+| **Reference** | Complete API documentation | `api-reference.md` |
+| **Explanation** | Concepts and architecture | `provider-vs-signer.md` |
+
+## 🎨 **Customization**
+
+### **Docusaurus Configuration**
+
+The site is configured via `docusaurus.config.js`:
+
+- **Theme settings** — Colors, fonts, layout
+- **Plugin configuration** — Search, analytics, etc.
+- **Navigation structure** — Sidebar and navbar
+- **SEO settings** — Meta tags and social cards
+
+### **Styling**
+
+Custom styles are in `src/css/custom.css`:
+
+```css
+/* Example customization */
+:root {
+  --ifm-color-primary: #00d2ff;
+  --ifm-color-primary-dark: #00bdee;
+  /* ... more custom properties */
+}
 ```
-$ yarn build
-```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+## 🧪 **Testing**
+
+### **Link Checking**
 
-### Deployment
+```bash
+# Build and check for broken links manually
+pnpm build
+# Check console output for broken links
+```
 
-Using SSH:
+### **Build Testing**
 
+```bash
+# Test production build
+pnpm build
+pnpm serve
 ```
-$ USE_SSH=true yarn deploy
+
+### **Accessibility**
+
+```bash
+# Manual accessibility testing recommended
+# Use browser dev tools accessibility tab
+# Test with screen readers
 ```
 
-Not using SSH:
+## 📈 **Analytics & SEO**
+
+### **Search Optimization**
+
+The site includes:
+- ✅ **Algolia DocSearch** for fast site search
+- ✅ **Meta tags** for social sharing
+- ✅ **Structured data** for search engines
+- ✅ **Sitemap generation** for better indexing
+
+### **Performance**
+
+- ✅ **Static site generation** for fast loading
+- ✅ **Image optimization** for better performance
+- ✅ **Progressive web app** features
+- ✅ **Offline support** for documentation access
 
+## 🔧 **Troubleshooting**
+
+### **Common Issues**
+
+#### **Build Failures**
+```bash
+# Clear cache and rebuild
+rm -rf .docusaurus build
+pnpm install
+pnpm build
+```
+
+#### **Port Conflicts**
+```bash
+# Use different port
+pnpm start -- --port 3001
 ```
-$ GIT_USER=<Your GitHub username> yarn deploy
+
+#### **Styling Issues**
+```bash
+# Clear browser cache
+# Check custom.css for conflicts
+# Restart development server
 ```
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+### **Getting Help**
+
+- **📖 [Docusaurus Documentation](https://docusaurus.io/docs)**
+- **💬 [tari.js Discussions](https://github.com/tari-project/tari.js/discussions)**
+- **🐛 [Report Issues](https://github.com/tari-project/tari.js/issues)**
+
+## 🌟 **Features**
+
+This documentation site includes:
+
+- **🔍 Instant Search** — Find content quickly with Algolia
+- **🌙 Dark Mode** — Toggle between light and dark themes  
+- **📱 Mobile Responsive** — Optimized for all devices
+- **🔗 Social Sharing** — Share documentation easily
+- **📊 Analytics** — Track usage and improve content
+- **♿ Accessibility** — WCAG 2.1 AA compliant
+- **🚀 Fast Loading** — Optimized performance
+- **📧 Edit Suggestions** — Easy contribution workflow
+
+---
+
+**Built with ❤️ using [Docusaurus](https://docusaurus.io/)** | **Hosted on [GitHub Pages](https://pages.github.com/)**