dop-wallet-v6 1.3.31 → 1.3.33

package/.eslintrc.js

@@ -63,15 +63,25 @@ module.exports = {
   },
   overrides: [
     {
-      files: ['**/__tests__/**', './src/tests/**'],
+      files: ['**/__tests__/**', './src/tests/**', '**/*.test.ts'],
       rules: {
         '@typescript-eslint/no-explicit-any': 0,
         '@typescript-eslint/no-unsafe-member-access': 0,
+        '@typescript-eslint/no-unsafe-assignment': 0,
+        '@typescript-eslint/no-unsafe-call': 0,
+        '@typescript-eslint/no-unsafe-argument': 0,
+        '@typescript-eslint/no-unsafe-return': 0,
+        '@typescript-eslint/strict-boolean-expressions': 0,
+        '@typescript-eslint/restrict-template-expressions': 0,
+        '@typescript-eslint/no-non-null-assertion': 0,
         'import/no-extraneous-dependencies': 0,
         'no-console': 0,
         '@typescript-eslint/no-unused-vars': 0,
         'no-useless-concat': 0,
         '@typescript-eslint/await-thenable': 0,
+        'no-plusplus': 0,
+        'no-constant-condition': 0,
+        'func-names': 0,
       },
     },
   ],

package/README.md

@@ -1,23 +1,381 @@
+# DOP Wallet SDK v6
 
+**Privacy-preserving blockchain transactions for Ethereum, Polygon, BNB Chain, Arbitrum, and Base**
 
-# DOP Wallet SDK
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![npm version](https://img.shields.io/npm/v/dop-wallet-v6.svg)](https://www.npmjs.com/package/dop-wallet-v6)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D16-brightgreen.svg)](https://nodejs.org)
+[![React Native](https://img.shields.io/badge/react--native-%3E%3D0.70-blue.svg)](https://reactnative.dev)
 
-The DOP Wallet SDK is an open-source project developed by [DOP](https://www.dop.org) contributors.
+The DOP Wallet SDK enables developers to integrate private token transfers, shielding, and zero-knowledge proofs into their applications. Built with TypeScript and compatible with **Node.js**, **browsers**, and **React Native**.
 
-The Wallet SDK enables dApp and DeFi developers to provide privacy to users safely and conveniently on Ethereum, Polygon and BNB Chain.
+**Developed by [DOP](https://www.dop.org) contributors.**
 
-The repo is written in TypeScript, and compatible with **Node.js**, **modern web browsers**, and **React Native**.
+---
 
-## 📱 React Native Support
+## 📚 Complete Documentation
 
-This SDK now has comprehensive React Native support with optimized polyfills and easy integration:
+**See [SDK_DOCS.md](./SDK_DOCS.md) for complete API reference, installation guides, and working examples.**
+
+The SDK_DOCS.md contains:
+- Installation for Node.js, Browser, and React Native
+- Complete API reference verified against working test files
+- Step-by-step workflows for Shield, Unshield, and Private Transfers
+- Real code examples that compile and run
+- Error handling and performance tips
+- React Native integration guide
+
+---
+
+## ✨ Features
+
+- 🔒 **Private Transfers**: Send ERC20, ERC721, ERC1155 tokens without revealing amounts or recipients
+- 🛡️ **Shield/Unshield**: Convert between public and private token balances
+- 📊 **Balance Queries**: View private balances across multiple chains
+- 🔐 **Zero-Knowledge Proofs**: Generate and verify zk-SNARK proofs
+- 🌐 **Multi-Chain**: Ethereum, Polygon, BNB Chain, Arbitrum, Base
+- 📱 **React Native**: Full mobile support with custom proof generation
+
+---
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+npm install dop-wallet-v6 dop-sharedmodels-v3
+```
+
+For Node.js:
+```bash
+npm install leveldown snarkjs
+```
+
+For React Native:
+```bash
+npm install react-native-get-random-values @react-native-async-storage/async-storage
+npm install buffer assert stream-browserify crypto-browserify events
+```
+
+### Node.js Example
+
+```typescript
+import { 
+  startDopEngine,
+  createOrImportDopWallet,
+  gasEstimateForEncrypt,
+  populateEncrypt,
+  getSerializedERC20Balances,
+  getProver
+} from 'dop-wallet-v6';
+import { NetworkName, NETWORK_CONFIG, TXIDVersion } from 'dop-sharedmodels-v3';
+import { groth16 } from 'snarkjs';
+import LevelDOWN from 'leveldown';
+
+// Initialize
+const db = new LevelDOWN('./dop-db');
+await startDopEngine('my-app', db, false, artifactStore, false, false, true);
+
+// Setup prover (required for transfers/unshield)
+const prover = getProver();
+prover.setSnarkJSGroth16(groth16);
+
+// Create wallet
+const { walletInfo, mnemonic } = await createOrImportDopWallet('encryption-key');
+console.log('Save this mnemonic:', mnemonic);
+
+// Shield tokens (3-step process)
+const { gasEstimate } = await gasEstimateForEncrypt(/* ... */);
+const txRequest = await populateEncrypt(/* ... */);
+await publicWallet.sendTransaction(txRequest);
+
+// Check balance
+const balances = getSerializedERC20Balances(
+  TXIDVersion.V3_PoseidonMerkle,
+  NETWORK_CONFIG[NetworkName.Polygon].chain,
+  walletInfo.id
+);
+```
+
+**See [SDK_DOCS.md](./SDK_DOCS.md) for complete working examples.**
+
+### React Native Example
+
+```typescript
+import 'react-native-get-random-values'; // MUST BE FIRST!
+import { Buffer } from 'buffer';
+global.Buffer = global.Buffer || Buffer;
+import 'dop-wallet-v6/react-native-shims';
+
+import { 
+  startDopEngine,
+  createOrImportDopWallet,
+  populateEncrypt,
+  getSerializedERC20Balances
+} from 'dop-wallet-v6';
+import MemDOWN from 'memdown';
+
+// Initialize with React Native settings
+const db = new MemDOWN();
+await startDopEngine('my-app', db, __DEV__, artifactStore, true, false, __DEV__);
+
+// Create wallet
+const { walletInfo } = await createOrImportDopWallet('encryption-key');
+
+// Shield works immediately
+const txRequest = await populateEncrypt(/* ... */);
+await wallet.sendTransaction(txRequest);
+
+// Check balance
+const balances = getSerializedERC20Balances(TXIDVersion.V3_PoseidonMerkle, chain, walletInfo.id);
+
+// For private transfers, configure custom Rapidsnark prover
+// See SDK_DOCS.md React Native section
+```
+
+---
+
+## 📚 Documentation
+
+**📖 [SDK_DOCS.md](./SDK_DOCS.md)** - Complete unified documentation (RECOMMENDED)
+
+The SDK_DOCS.md contains everything you need:
+- Installation for all platforms
+- Complete API reference verified against tests
+- Step-by-step workflows with real code
+- React Native integration guide
+- Error handling and performance tips
+
+### Quick Navigation
+
+- **New to DOP?** → Start with [SDK_DOCS.md](./SDK_DOCS.md)
+- **Looking for specific function?** → See API Reference section in SDK_DOCS.md
+- **React Native setup?** → See React Native section in SDK_DOCS.md
+- **Complete workflows?** → See Complete Workflows section in SDK_DOCS.md
+
+---
+
+## 🔧 Environment Support
+
+| Feature | Node.js | Browser | React Native |
+|---------|---------|---------|--------------|
+| Shield (encrypt) tokens | ✅ | ✅ | ✅ |
+| View private balances | ✅ | ✅ | ✅ |
+| Private transfers | ✅ | ✅ | ✅* |
+| Unshield (decrypt) tokens | ✅ | ✅ | ✅* |
+| Wallet management | ✅ | ✅ | ✅ |
+| Transaction history | ✅ | ✅ | ✅ |
+
+*React Native private transfers require custom Rapidsnark prover setup. See [REACT_NATIVE_USER_CONFIGURABLE_PROVER.md](./REACT_NATIVE_USER_CONFIGURABLE_PROVER.md).
+
+---
+
+## 🎯 Use Cases
+
+- **Privacy-preserving DeFi**: Let users trade and transfer without revealing balances
+- **Private payroll**: Pay employees privately on-chain
+- **Confidential treasury**: Manage organizational funds with selective transparency
+- **Private gaming economies**: In-game token transfers without public visibility
+- **Compliant privacy**: Optional selective transparency for regulatory requirements
+
+---
+
+## 🛠️ Core Operations
+
+### Important: Multi-Step Process
+
+DOP transactions require 3 steps:
+1. **Gas Estimation** - Calculate transaction cost
+2. **Proof Generation** - Create zero-knowledge proof (30s-2min for transfers/unshield)
+3. **Transaction** - Populate and submit transaction
+
+### Shield Tokens (Public → Private)
 
 ```typescript
+// Step 1: Estimate gas
+const { gasEstimate } = await gasEstimateForEncrypt(/* ... */);
+
+// Step 2: Populate transaction
+const txRequest = await populateEncrypt(/* ... */);
+
+// Step 3: Send
+await wallet.sendTransaction(txRequest);
+```
+
+### Check Private Balances
+
+```typescript
+const balances = getSerializedERC20Balances(
+  TXIDVersion.V3_PoseidonMerkle,
+  chain,
+  walletId
+);
+```
+
+### Private Transfer
+
+```typescript
+// Step 1: Estimate gas
+const { gasEstimate } = await gasEstimateForUnprovenTransfer(/* ... */);
+
+// Step 2: Generate proof (1-2 minutes)
+const { proof, publicInputs } = await generateTransferProofForExplorer(/* ... */);
+
+// Step 3: Populate and send
+const txRequest = await populateProvedTransfer(/* ... */);
+await wallet.sendTransaction(txRequest);
+```
+
+### Unshield Tokens (Private → Public)
+
+```typescript
+// Step 1: Estimate gas
+const { gasEstimate } = await gasEstimateForUnprovenDecrypt(/* ... */);
+
+// Step 2: Generate proof (30s-2min)
+const { proof, publicInputs } = await generateDecryptToOriginProof(/* ... */);
+
+// Step 3: Populate and send
+const txRequest = await populateProvedDecrypt(/* ... */);
+await wallet.sendTransaction(txRequest);
+```
+
+**See [SDK_DOCS.md](./SDK_DOCS.md) for complete working examples.**
+
+---
+
+## 🌐 Supported Networks
+
+- **Ethereum Mainnet**
+- **Polygon**
+- **BNB Chain**
+- **Arbitrum**
+- **Base**
+
+All networks support ERC20, ERC721, and ERC1155 tokens.
+
+---
+
+## 📱 React Native Setup
+
+### Prerequisites
+
+```bash
+npm install react-native-get-random-values @react-native-async-storage/async-storage
+npm install buffer assert stream-browserify crypto-browserify events
+```
+
+### Entry Point Setup (CRITICAL)
+
+**At the very top of index.js or App.js:**
+
+```typescript
+// MUST BE FIRST IMPORTS
 import 'react-native-get-random-values';
-import { DopWallet } from 'dop-wallet-v6/react-native';
+import { Buffer } from 'buffer';
+global.Buffer = global.Buffer || Buffer;
+
+// Import DOP shims
+import 'dop-wallet-v6/react-native-shims';
+
+// Now your app code
 ```
 
-**📚 Quick Start:** See [REACT_NATIVE_INTEGRATION_GUIDE.md](./REACT_NATIVE_INTEGRATION_GUIDE.md) for complete setup instructions.
+### Basic Setup
+
+```typescript
+import { startDopEngine } from 'dop-wallet-v6';
+import MemDOWN from 'memdown';
+
+const db = new MemDOWN();
+await startDopEngine(
+  'my-rn-app',
+  db,
+  __DEV__,
+  artifactStore,
+  true,    // useNativeArtifacts for React Native
+  false,
+  __DEV__
+);
+```
+
+### What Works Out of the Box
+
+- ✅ Shield tokens
+- ✅ Check balances
+- ✅ Wallet management
+- ❌ Private transfers (needs Rapidsnark)
+- ❌ Unshield (needs Rapidsnark)
+
+**📖 Complete React Native Guide**: See React Native section in [SDK_DOCS.md](./SDK_DOCS.md)
+
+---
+
+## 🔐 Security
+
+- **Zero-Knowledge Proofs**: Transactions are cryptographically private
+- **Client-Side Keys**: Private keys never leave user's device
+- **Open Source**: Fully auditable codebase
+- **BIP39 Mnemonics**: Standard 12/24-word recovery phrases
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes with tests
+4. Submit a pull request
+
+---
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) file for details
+
+---
+
+## 🆘 Support
+
+- **Documentation**: [SDK_DOCS.md](./SDK_DOCS.md)
+- **Issues**: [GitHub Issues](https://github.com/VAR-META-Tech/new-dop-wallet-v3/issues)
+- **Website**: [https://www.dop.org](https://www.dop.org)
+
+---
+
+## 🏗️ Architecture
+
+```
+Application
+    ↓
+DOP Wallet SDK
+    ↓
+├─ DOP Engine (core logic)
+├─ Merkletree Sync (blockchain scanning)
+├─ Proof Generation
+│  ├─ SnarkJS (Node.js/Browser)
+│  └─ Rapidsnark (React Native - custom setup required)
+└─ Blockchain Interface (ethers.js)
+    ↓
+Ethereum, Polygon, BNB Chain, Arbitrum, Base
+```
+
+---
+
+## 📊 Status
+
+**Version**: 1.3.32  
+**Status**: Production Ready ✅  
+**Last Updated**: December 7, 2025
+
+**Recent Updates:**
+- ✅ Comprehensive SDK documentation rewrite
+- ✅ API verified against working test files
+- ✅ Complete workflows with real code examples
+- ✅ React Native integration guide
 
-**🔧 Verify Compatibility:** Run `npm run verify-rn-compatibility` to ensure your setup is correct.
+---
 
+**Built by the DOP community**

package/dist/services/dop/core/index.d.ts

@@ -1,9 +1,13 @@
 export * from './artifacts';
 export * from './init';
 export * from './react-native-init';
+export * from './react-native-prover-setup';
 export * from './engine';
 export * from './load-provider';
 export * from './merkletree';
 export * from './prover';
 export * from './providers';
 export * from './encrypts';
+export * from '../crypto/react-native-crypto-provider';
+export * from '../crypto/react-native-rapidsnark-prover';
+export * from '../crypto/user-rapidsnark-adapter';

package/dist/services/dop/core/index.js

@@ -17,10 +17,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./artifacts"), exports);
 __exportStar(require("./init"), exports);
 __exportStar(require("./react-native-init"), exports);
+__exportStar(require("./react-native-prover-setup"), exports);
 __exportStar(require("./engine"), exports);
 __exportStar(require("./load-provider"), exports);
 __exportStar(require("./merkletree"), exports);
 __exportStar(require("./prover"), exports);
 __exportStar(require("./providers"), exports);
 __exportStar(require("./encrypts"), exports);
+// Export React Native crypto provider utilities
+__exportStar(require("../crypto/react-native-crypto-provider"), exports);
+__exportStar(require("../crypto/react-native-rapidsnark-prover"), exports);
+__exportStar(require("../crypto/user-rapidsnark-adapter"), exports);
 //# sourceMappingURL=index.js.map

package/dist/services/dop/core/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/dop/core/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,yCAAuB;AACvB,sDAAoC;AACpC,2CAAyB;AACzB,kDAAgC;AAChC,+CAA6B;AAC7B,2CAAyB;AACzB,8CAA4B;AAC5B,6CAA2B","sourcesContent":["export * from './artifacts';\nexport * from './init';\nexport * from './react-native-init';\nexport * from './engine';\nexport * from './load-provider';\nexport * from './merkletree';\nexport * from './prover';\nexport * from './providers';\nexport * from './encrypts';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/dop/core/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,yCAAuB;AACvB,sDAAoC;AACpC,8DAA4C;AAC5C,2CAAyB;AACzB,kDAAgC;AAChC,+CAA6B;AAC7B,2CAAyB;AACzB,8CAA4B;AAC5B,6CAA2B;AAE3B,gDAAgD;AAChD,yEAAuD;AACvD,2EAAyD;AACzD,oEAAkD","sourcesContent":["export * from './artifacts';\nexport * from './init';\nexport * from './react-native-init';\nexport * from './react-native-prover-setup';\nexport * from './engine';\nexport * from './load-provider';\nexport * from './merkletree';\nexport * from './prover';\nexport * from './providers';\nexport * from './encrypts';\n\n// Export React Native crypto provider utilities\nexport * from '../crypto/react-native-crypto-provider';\nexport * from '../crypto/react-native-rapidsnark-prover';\nexport * from '../crypto/user-rapidsnark-adapter';\n"]}

package/dist/services/dop/core/react-native-init.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.startDopEngineReactNative = exports.ReactNativeLevelDB = void 0;
 const init_1 = require("./init");
@@ -593,8 +616,12 @@ const startDopEngineReactNative = async (walletSource, shouldDebug, artifactStor
         });
     }
     // Initialize the DOP Engine with the React Native database
-    return (0, init_1.startDopEngine)(walletSource, db, // Cast to any since TypeScript doesn't know about our custom implementation
+    await (0, init_1.startDopEngine)(walletSource, db, // Cast to any since TypeScript doesn't know about our custom implementation
     shouldDebug, artifactStore, useNativeArtifacts, skipMerkletreeScans, verboseScanLogging);
+    // CRITICAL: Auto-setup Rapidsnark prover for React Native
+    // This enables proof generation for transfers, shield, and unshield operations
+    const { autoSetupProverForReactNative } = await Promise.resolve().then(() => __importStar(require('./react-native-prover-setup')));
+    await autoSetupProverForReactNative();
 };
 exports.startDopEngineReactNative = startDopEngineReactNative;
 //# sourceMappingURL=react-native-init.js.map