@tari-project/tarijs 0.10.1 → 0.12.0

package/docusaurus/tari-docs/docs/index.md

@@ -1,21 +1,124 @@
 ---
 sidebar_position: 1
 slug: /
+title: tari.js Documentation
+description: Complete guide to building with tari.js - the TypeScript toolkit for Tari blockchain applications
 ---
 
-# Overview
+# Welcome to tari.js! 👋
 
-This is the documentation of `tari.js` library, which enables interaction with Tari L2 (Ootle) wallet using TypeScript or JavaScript.
+> **Build powerful Tari applications with confidence** — tari.js is the complete TypeScript toolkit for connecting wallets, querying the blockchain, and creating amazing dApps.
 
-### Note
+<div className="hero-badges">
 
-> This documentation covers version **v0.5.0**.
->
-> The biggest difference between version 0.4.0 and 0.5.0 is the _Signer_ and _Provider_ split. Learn more in the [Tari Provider](./providers/indexer-provider.md) and [Tari Signer](./signers/wallet-connect.md) sections.
+![npm version](https://badge.fury.io/js/@tari-project%2Ftarijs.svg)
+![License](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg)
+![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)
 
-At its core, `TariSigner` is an abstract interface implemented by multiple concrete signers. To access a wallet, you need to create an instance of one of these signers:
+</div>
 
-- [Tari WalletConnect signer](./signers/wallet-connect.md)
-- [Tari Universe signer](./signers/tari-universe.md)
-- [Tari Wallet Daemon signer](./signers/wallet-daemon.md)
-- Tari Metamask signer
+## 🚀 **What is tari.js?**
+
+tari.js is the **universal JavaScript/TypeScript library** for building on Tari. Whether you're creating a DeFi app, an NFT marketplace, or an enterprise solution, tari.js provides everything you need:
+
+- **🔌 Universal Wallet Support** — Connect MetaMask, Wallet Daemon, Universe, WalletConnect 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
+
+## ✨ **What Makes tari.js Special?**
+
+### 🎯 **Provider/Signer Architecture**
+Clean separation between reading data and wallet operations:
+
+```typescript
+// 📖 Provider: Read blockchain data (no wallet needed)
+const provider = new IndexerProvider('http://localhost:18300');
+const balance = await provider.getSubstate(substateId);
+
+// ✍️ Signer: Wallet operations (requires authentication)  
+const signer = new WalletDaemonSigner('http://localhost:18103');
+const tx = await signer.submitTransaction(transaction);
+```
+
+### 🧩 **Unified API Across All Wallets**
+Same code works with any wallet type:
+
+```typescript
+// Works with MetaMask, Universe, Wallet Daemon, WalletConnect
+const wallet = await connectWallet();
+const account = await wallet.getDefaultAccount();
+const result = await wallet.submitTransaction(tx);
+```
+
+### 🏗️ **Powerful Transaction Builder**
+Fluent API for complex operations:
+
+```typescript
+const transaction = new TransactionBuilder()
+  .fee(100)
+  .callMethod('account', 'transfer', { amount: 1000, destination })
+  .callFunction('nft_template', 'mint', { metadata })
+  .build();
+```
+
+## 🎯 **Quick Navigation**
+
+### 🚀 **Get Started (5 minutes)**
+- **[Installation](/docs/installation)** — Set up your development environment
+- **[Getting Started Tutorial](/docs/guides/getting-started-tutorial)** — Build your first app
+- **[Provider vs Signer](/docs/provider-vs-signer)** — Understand core concepts
+
+### 🔌 **Wallet Integration**
+- **[Wallet Daemon](/docs/signers/wallet-daemon)** — Full-featured server integration
+- **[MetaMask](/docs/signers/metamask)** — Browser wallet via tari-snap
+- **[Tari Universe](/docs/signers/tari-universe)** — Native mobile experience
+- **[WalletConnect](/docs/signers/wallet-connect)** — Cross-platform mobile wallets
+
+### 🏗️ **Building Transactions**
+- **[Transaction Builder](/docs/wallet/submit-transaction/transaction-builder/)** — Create complex transactions
+- **[Template System](/docs/wallet/template-definition)** — Work with smart contracts
+- **[Fee Management](/docs/wallet/submit-transaction/transaction-builder/fee)** — Optimize transaction costs
+
+### 🔧 **Reference**
+- **[Complete API Reference](/docs/api-reference)** — Every method documented
+- **[Troubleshooting](/docs/troubleshooting)** — Common issues & solutions
+- **[Production Deployment](/docs/guides/production-deployment)** — Go live securely
+
+## 📚 **Documentation Structure**
+
+This documentation is organized for different user journeys:
+
+| If you're... | Start here |
+|--------------|------------|
+| **🆕 New to tari.js** | [Installation](/docs/installation) → [Getting Started Tutorial](/docs/guides/getting-started-tutorial) |
+| **🔌 Integrating wallets** | [Provider vs Signer](/docs/provider-vs-signer) → [Wallet Documentation](/docs/category/signers) |
+| **🏗️ Building transactions** | [Transaction Builder](/docs/wallet/submit-transaction/transaction-builder/) → [Templates](/docs/wallet/template-definition) |
+| **🚨 Having issues** | [Troubleshooting](/docs/troubleshooting) → [GitHub Issues](https://github.com/tari-project/tari.js/issues) |
+| **📖 Looking for specifics** | [API Reference](/docs/api-reference) → Search this site |
+
+## 🆕 **What's New in v0.5.0**
+
+:::info Major Update
+**Provider/Signer Split** — We've separated data access from wallet operations for better security and flexibility. [Learn about the changes →](/docs/provider-vs-signer)
+:::
+
+### 🎉 **New Features**
+- **🔌 Unified wallet connection API** across all wallet types
+- **🏗️ Enhanced transaction builder** with fluent API design
+- **📱 Improved mobile support** for React Native and PWAs
+- **🛡️ Better error handling** and debugging tools
+
+### 🔄 **Migration Guide**
+Upgrading from v0.4.0? Check our [GitHub releases](https://github.com/tari-project/tari.js/releases) for upgrade instructions.
+
+## 🤝 **Community & Support**
+
+- **💬 [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  
+- **📺 [Discord Community](https://discord.gg/tari)** — Real-time chat with developers
+- **🎮 [Example Apps](https://github.com/tari-project/tari.js/tree/main/examples)** — See tari.js in action
+
+---
+
+**Ready to build something amazing?** [Install tari.js](/docs/installation) and create your first Tari application in 5 minutes! 🚀

package/docusaurus/tari-docs/docs/installation.md

@@ -105,4 +105,145 @@ npm install @tari-project/tarijs
 
 In order to use the wallet, you will need to connect either to an Ootle indexer or a signer that allows you to interact with the Ootle via several clients. We explain more about providers and signers in the following section, but in short:
 - You will use an indexer when you simply want to obtain information from the Ootle.
-- A signer is used when you wish to modify, interact with or create on the Ootle.
+- A signer is used when you wish to modify, interact with or create on the Ootle.
+
+### Quick Install Commands
+
+For most use cases, install both provider and signer packages:
+
+```bash npm2yarn
+# Complete installation with indexer provider and wallet daemon signer
+npm install @tari-project/tarijs @tari-project/indexer-provider @tari-project/wallet-daemon-signer
+```
+
+For specific wallet types:
+
+```bash npm2yarn
+# MetaMask integration
+npm install @tari-project/tarijs @tari-project/metamask-signer
+
+# Tari Universe wallet
+npm install @tari-project/tarijs @tari-project/tari-universe
+
+# WalletConnect integration  
+npm install @tari-project/tarijs @tari-project/walletconnect
+```
+
+## Verification
+
+After installation, verify everything works:
+
+```typescript
+import { TariProvider } from '@tari-project/tarijs';
+
+// This should not throw any import errors
+console.log('tari.js installed successfully!');
+```
+
+## Common Installation Issues
+
+### ❌ Package not found errors
+
+**Problem:** `Module '@tari-project/tarijs' not found`
+
+**Solution:**
+```bash
+# Clear package manager cache
+npm cache clean --force
+# or for pnpm
+pnpm store prune
+
+# Reinstall
+rm -rf node_modules package-lock.json
+npm install
+```
+
+### ❌ TypeScript compilation errors
+
+**Problem:** TypeScript can't find type definitions
+
+**Solution:**
+```bash
+# Install TypeScript and Node types
+npm install --save-dev typescript @types/node
+
+# Ensure your tsconfig.json includes:
+{
+  "compilerOptions": {
+    "moduleResolution": "node",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true
+  }
+}
+```
+
+### ❌ Version compatibility issues
+
+**Problem:** Conflicting dependency versions
+
+**Solution:**
+```bash
+# Check for peer dependency warnings during install
+npm install --legacy-peer-deps
+
+# or use exact versions
+npm install @tari-project/tarijs@latest
+```
+
+### ❌ Build tool configuration
+
+**Problem:** Vite/Webpack build errors with tari.js
+
+**Solution:**
+
+For **Vite**, add to `vite.config.ts`:
+```typescript
+export default defineConfig({
+  optimizeDeps: {
+    include: ['@tari-project/tarijs']
+  },
+  define: {
+    global: 'globalThis',
+  }
+});
+```
+
+For **Webpack**, add to config:
+```javascript
+module.exports = {
+  resolve: {
+    fallback: {
+      "buffer": require.resolve("buffer"),
+      "crypto": require.resolve("crypto-browserify")
+    }
+  }
+};
+```
+
+### ❌ Node.js polyfill errors in browser
+
+**Problem:** `Buffer is not defined` or similar Node.js polyfill errors
+
+**Solution:**
+```bash
+# Install polyfills
+npm install --save-dev buffer crypto-browserify
+
+# For Vite projects, also install:
+npm install --save-dev @esbuild-plugins/node-globals-polyfill
+```
+
+## Next Steps
+
+Once installation is complete:
+
+1. 📖 Read about [Provider vs Signer concepts](./provider-vs-signer.md)
+2. 🚀 Follow our [Getting Started Tutorial](./guides/getting-started-tutorial.md)  
+3. 🔧 Set up your [wallet connections](./signers/wallet-daemon.md)
+4. 💼 Learn about [transaction building](./wallet/submit-transaction/transaction-builder/)
+
+## Need Help?
+
+- 📚 Check our [Troubleshooting Guide](./troubleshooting.md)
+- 💬 Ask questions in [GitHub Discussions](https://github.com/tari-project/tari.js/discussions)
+- 🐛 Report bugs in [GitHub Issues](https://github.com/tari-project/tari.js/issues)