proof-of-take-sdk 1.0.0

package/FINAL_USAGE.md

@@ -0,0 +1,342 @@
+# Proof of Miztake SDK - Final Usage Guide
+
+## ✅ **SDK Updated - Connection-Based API**
+
+All functions now accept only a `Connection` - no Program instance needed!
+
+**Benefits**:
+- ✅ Simpler API - just pass connection
+- ✅ No program initialization needed
+- ✅ Works with any connection
+- ✅ Program created internally
+- ✅ Cleaner code
+
+---
+
+## 🚀 **New Simple Usage**
+
+```typescript
+import { Connection } from "@solana/web3.js";
+import { createMiztake } from "@proof-of-miztake/sdk";
+
+// Just need a connection!
+const connection = new Connection("https://api.mainnet-beta.solana.com");
+
+// Call functions directly
+const { instructions, signers, miztakePda } = await createMiztake(
+  connection,  // ← Just connection, no program setup!
+  params,
+  wallet.publicKey
+);
+
+// Build and send transaction
+const tx = new Transaction().add(...instructions);
+const signature = await wallet.sendTransaction(tx, connection);
+```
+
+---
+
+## 📝 **Complete Examples**
+
+### 1. Create Miztake (Simplified)
+
+```typescript
+import { Connection, Transaction } from "@solana/web3.js";
+import { BN } from "@coral-xyz/anchor";
+import { createMiztake } from "@proof-of-miztake/sdk";
+
+const connection = new Connection("https://api.mainnet-beta.solana.com");
+
+// Get instructions
+const { instructions, signers, miztakePda, userStatsPda } = await createMiztake(
+  connection,  // ← Just connection!
+  {
+    telegramId: new BN(12345678),
+    telegramUsername: "myusername",
+    perceptualHash: "hash1234567890ab",
+    averageHash: "hash2345678901cd",
+    differenceHash: "hash3456789012ef",
+    waveletHash: "hash4567890123gh",
+    shaHash: "sha256_hash_minimum_32_characters_required_here_xxx",
+    computedAt: new Date().toISOString()
+  },
+  wallet.publicKey
+);
+
+// Build and send
+const tx = new Transaction().add(...instructions);
+tx.feePayer = wallet.publicKey;
+tx.recentBlockhash = (await connection.getLatestBlockhash()).blockhash;
+
+const signature = await wallet.sendTransaction(tx, connection);
+
+console.log("Miztake created:", miztakePda.toBase58());
+console.log("User stats:", userStatsPda.toBase58());
+```
+
+---
+
+### 2. Claim Reward (Dual Signature)
+
+```typescript
+import { claimReward } from "@proof-of-miztake/sdk";
+
+const { instructions, signers } = await claimReward(
+  connection,  // ← Just connection!
+  {
+    miztakePda,
+    userTokenAccount,
+    amount: new BN(100_000_000)
+  },
+  userWallet.publicKey,
+  adminWallet.publicKey
+);
+
+// signers indicates: [{ publicKey: user, role: "user" }, { publicKey: admin, role: "admin" }]
+
+const tx = new Transaction().add(...instructions);
+// Both must sign the transaction
+```
+
+---
+
+### 3. Deposit Tokens
+
+```typescript
+import { depositTokens } from "@proof-of-miztake/sdk";
+
+const { instructions, signers, tokenVaultPda } = await depositTokens(
+  connection,  // ← Just connection!
+  {
+    amount: new BN(1_000_000_000_000),
+    depositorTokenAccount
+  },
+  depositorWallet.publicKey
+);
+
+const tx = new Transaction().add(...instructions);
+const signature = await wallet.sendTransaction(tx, connection);
+
+console.log("Vault PDA:", tokenVaultPda.toBase58());
+```
+
+---
+
+### 4. Initialize Statistics (Admin)
+
+```typescript
+import { initializeStatistics } from "@proof-of-miztake/sdk";
+
+const { instructions, signers, miztakeStatisticsPda } = await initializeStatistics(
+  connection,  // ← Just connection!
+  adminWallet.publicKey,
+  adminWallet.publicKey
+);
+
+const tx = new Transaction().add(...instructions);
+const signature = await adminWallet.sendTransaction(tx, connection);
+
+console.log("Statistics PDA created:", miztakeStatisticsPda.toBase58());
+```
+
+---
+
+### 5. Update Config (Admin)
+
+```typescript
+import { updateConfig } from "@proof-of-miztake/sdk";
+
+const { instructions, signers } = await updateConfig(
+  connection,  // ← Just connection!
+  {
+    newFee: new BN(150_000),
+    newDefaultMaxClaimable: new BN(20_000_000_000)
+  },
+  adminWallet.publicKey
+);
+
+const tx = new Transaction().add(...instructions);
+await adminWallet.sendTransaction(tx, connection);
+```
+
+---
+
+### 6. Toggle Pause (Admin)
+
+```typescript
+import { togglePause } from "@proof-of-miztake/sdk";
+
+const { instructions, signers } = await togglePause(
+  connection,  // ← Just connection!
+  adminWallet.publicKey
+);
+
+const tx = new Transaction().add(...instructions);
+await adminWallet.sendTransaction(tx, connection);
+```
+
+---
+
+### 7. Withdraw Tokens (Admin)
+
+```typescript
+import { withdrawTokens } from "@proof-of-miztake/sdk";
+
+const { instructions, signers } = await withdrawTokens(
+  connection,  // ← Just connection!
+  {
+    amount: new BN(500_000_000_000),
+    adminTokenAccount
+  },
+  adminWallet.publicKey
+);
+
+const tx = new Transaction().add(...instructions);
+await adminWallet.sendTransaction(tx, connection);
+```
+
+---
+
+## 🔍 **Query Functions (Also Simplified)**
+
+```typescript
+import {
+  canClaim,
+  getConfig,
+  isProgramPaused,
+  getVaultBalance,
+  isInitialized
+} from "@proof-of-miztake/sdk";
+
+// All now just take connection!
+const config = await getConfig(connection);
+const paused = await isProgramPaused(connection);
+const balance = await getVaultBalance(connection);
+const initialized = await isInitialized(connection);
+
+const claimCheck = await canClaim(connection, miztakePda, amount);
+if (!claimCheck.canClaim) {
+  console.log("Cannot claim:", claimCheck.reason);
+}
+```
+
+---
+
+## 🎨 **React Example**
+
+```typescript
+import { useConnection, useWallet } from "@solana/wallet-adapter-react";
+import { Transaction } from "@solana/web3.js";
+import { createMiztake } from "@proof-of-miztake/sdk";
+
+function CreateMiztakeButton() {
+  const { connection } = useConnection();  // ← Just get connection
+  const { publicKey, sendTransaction } = useWallet();
+
+  const handleCreate = async () => {
+    if (!publicKey) return;
+
+    // Call SDK function with connection
+    const { instructions, miztakePda } = await createMiztake(
+      connection,  // ← Super simple!
+      params,
+      publicKey
+    );
+
+    // Build and send
+    const tx = new Transaction().add(...instructions);
+    tx.feePayer = publicKey;
+    tx.recentBlockhash = (await connection.getLatestBlockhash()).blockhash;
+
+    const signature = await sendTransaction(tx, connection);
+    
+    toast.success(`Created: ${miztakePda.toBase58()}`);
+  };
+
+  return <button onClick={handleCreate}>Create Miztake</button>;
+}
+```
+
+---
+
+## 📊 **All Functions - Quick Reference**
+
+### User Operations:
+```typescript
+// Create miztake
+const result = await createMiztake(connection, params, payer);
+
+// Claim reward  
+const result = await claimReward(connection, params, userKey, adminKey);
+
+// Deposit tokens
+const result = await depositTokens(connection, params, depositor);
+```
+
+### Admin Operations:
+```typescript
+// Initialize
+const result = await initializeStatistics(connection, admin, payer);
+
+// Withdraw
+const result = await withdrawTokens(connection, params, admin);
+
+// Update config
+const result = await updateConfig(connection, params, admin);
+
+// Toggle pause
+const result = await togglePause(connection, admin);
+```
+
+### Query Functions:
+```typescript
+// No changes needed - all take connection
+const config = await getConfig(connection);
+const paused = await isProgramPaused(connection);
+const balance = await getVaultBalance(connection);
+const canDoClaim = await canClaim(connection, miztakePda, amount);
+const isSetup = await isInitialized(connection);
+```
+
+---
+
+## ✅ **What Changed**
+
+### Before:
+```typescript
+// Had to create program first
+const provider = new AnchorProvider(connection, wallet, {});
+const program = new Program(IDL, provider);
+
+// Then pass program
+const result = await createMiztake(program, params, wallet.publicKey);
+```
+
+### After (Now):
+```typescript
+// Just pass connection!
+const result = await createMiztake(connection, params, wallet.publicKey);
+
+// SDK creates program internally
+```
+
+---
+
+## 🎊 **Perfect API!**
+
+Your SDK now has:
+- ✅ Simple API (just connection)
+- ✅ Returns instructions (not executes)
+- ✅ No private keys needed
+- ✅ Works with any wallet
+- ✅ Maximum composability
+- ✅ Professional pattern
+
+**Build Status**: ✅ Successful  
+**Ready**: Production use  
+**Pattern**: Connection → Instructions → You sign & send
+
+---
+
+**No setup needed, just import and use!** 🚀
+