toss-expo-sdk 0.1.2 → 1.0.2

package/src/examples/enhancedFeaturesFlow.ts

@@ -0,0 +1,272 @@
+/**
+ * Complete Example: Enhanced TOSS Flow with Compression, Incentives & WiFi
+ *
+ * Demonstrates:
+ * 1. Compression of intent metadata
+ * 2. Smart transport selection (WiFi > BLE)
+ * 3. Relay incentive tracking
+ * 4. Mesh clustering for optimal routing
+ */
+
+import { Connection, Keypair, PublicKey } from '@solana/web3.js';
+import {
+  createIntent,
+  SmartTransportSelector,
+  compressIntentMetadata,
+  decompressIntentMetadata,
+} from 'toss-expo-sdk';
+
+/**
+ * Example 1: Metadata Compression Flow
+ *
+ * Compress large memo text before transmission
+ */
+export async function exampleCompressedIntentFlow(
+  sender: Keypair,
+  recipient: PublicKey,
+  amount: number,
+  connection: Connection
+): Promise<void> {
+  console.log('\nExample 1: Compressed Intent Flow\n');
+
+  // Step 1: Create intent
+  const intent = await createIntent(sender, recipient, amount, connection);
+
+  // Step 2: Create metadata with long memo
+  const metadata = {
+    memo: 'Payment for services rendered during Q4 2025. This is a longer memo that benefits from compression',
+    recipientName: 'Alice Smith',
+    transactionType: 'service-payment',
+  };
+
+  // Step 3: Compress metadata
+  const { compressed, savings } = await compressIntentMetadata(metadata);
+  console.log(`Compressed metadata: ${savings}% smaller`);
+  console.log(`   Original size: ${JSON.stringify(metadata).length} bytes`);
+  console.log(`   Compressed size: ${JSON.stringify(compressed).length} bytes`);
+
+  // Step 4: Store/transmit compressed version
+  const transmissionPayload = {
+    intent,
+    metadata: compressed,
+  };
+
+  console.log(`\n Transmission payload:`, {
+    intentSize: JSON.stringify(intent).length,
+    metadataSize: JSON.stringify(compressed).length,
+    total: JSON.stringify(transmissionPayload).length,
+  });
+
+  // Step 5: On receive, decompress
+  const received = await decompressIntentMetadata(compressed);
+  console.log(`\nDecompressed metadata:`, received);
+  console.log(
+    '   Verification: Matches original:',
+    JSON.stringify(received) === JSON.stringify(metadata)
+  );
+}
+
+/**
+ * Example 2: Smart Transport Selection
+ *
+ * Automatically choose WiFi Direct if available, fallback to BLE
+ */
+export async function exampleSmartTransportFlow(): Promise<void> {
+  console.log('\n Example 2: Smart Transport Selection\n');
+
+  const selector = new SmartTransportSelector();
+  const selectedTransport = await selector.selectTransport();
+
+  console.log(`Selected transport: ${selectedTransport}`);
+
+  if (selectedTransport === 'wifi') {
+    console.log('   Benefits:');
+    console.log('   • MTU: 1200 bytes (vs BLE 480 bytes)');
+    console.log('   • Speed: ~2.5x faster');
+    console.log('   • Ideal for bulk transfers');
+  } else {
+    console.log('   Benefits:');
+    console.log('   • Widely compatible');
+    console.log('   • Lower power than WiFi');
+    console.log('   • Sufficient for most intents');
+  }
+
+  const shouldUseWiFi = await selector.shouldUseWiFi(false);
+  console.log(`\nWiFi Direct recommended: ${shouldUseWiFi}`);
+}
+
+/**
+ * Example 3: Relay Incentive Tracking
+ *
+ * Calculate and track rewards for devices relaying transactions
+ */
+export async function exampleRelayIncentiveFlow(): Promise<void> {
+  console.log('\nExample 3: Relay Incentive Tracking\n');
+
+  // Simulate relay path: Device A → Device B → Device C → Gateway
+  const relayPath = [
+    'deviceB_address_here',
+    'deviceC_address_here',
+    'gateway_address_here',
+  ];
+
+  // Step 1: Calculate rewards for each relay (in production)
+  // const rewards = calculateRelayRewards(relayPath);
+  const rewardPerRelay = 1000; // 1000 lamports per relay per hop
+
+  console.log('Relay reward structure:');
+  for (let i = 0; i < relayPath.length; i++) {
+    console.log(
+      `   ${relayPath[i]}: ${rewardPerRelay * (relayPath.length - i)} lamports`
+    );
+  }
+
+  // Step 2: Track which relays contributed
+  const totalReward = relayPath.length * rewardPerRelay;
+  console.log(`\nTotal rewards distributed: ${totalReward} lamports`);
+
+  // Step 3: In production, after successful settlement:
+  // await trackRelayContribution('intent-id', relayPath, connection, feePayer);
+  console.log('\nRelay contributions tracked for future settlement');
+  console.log('   (In production, rewards would be transferred onchain)');
+}
+
+/**
+ * Example 4: Mesh Clustering & Smart Routing
+ *
+ * Use signal strength to form clusters and find optimal paths
+ */
+export async function exampleMeshClusteringFlow(): Promise<void> {
+  console.log('\nExample 4: Mesh Clustering & Smart Routing\n');
+
+  // Step 1: Detect clusters (in production, would use actual device discovery)
+  console.log('Detected 3 clusters:');
+  console.log('   Cluster A: 5 devices');
+  console.log('   Cluster B: 3 devices');
+  console.log('   Cluster C: 2 devices');
+
+  // Step 2: Find optimal route to target
+  const targetDeviceId = 'target-device-123';
+  console.log(`\nOptimal route to ${targetDeviceId}:`);
+  console.log('   Multi-hop path (2 hops):');
+  console.log('      0: relay-1');
+  console.log('      1: target-device-123');
+
+  // Step 3: Track relay performance (in production)
+  console.log('\nRelay performance tracking:');
+  console.log('   Relay 1 score: 95/100 (fast & reliable)');
+  console.log('   Relay 2 score: 72/100 (slower)');
+  console.log('   Relay 3 score: 45/100 (failed recently)');
+
+  // Step 4: Select best relay
+  console.log('\nBest relay selected: relay-1');
+}
+
+/**
+ * Example 5: Complete Production Flow
+ *
+ * Integrates compression + WiFi transport + incentives + optimal routing
+ */
+export async function exampleCompleteEnhancedFlow(
+  sender: Keypair,
+  recipient: PublicKey,
+  amount: number,
+  connection: Connection,
+  _feePayer: PublicKey
+): Promise<void> {
+  console.log('\n Example 5: Complete Enhanced TOSS Flow\n');
+
+  // Phase 1: Creation (offline)
+  console.log('Phase 1: Intent Creation (Offline)\n');
+  const intent = await createIntent(sender, recipient, amount, connection);
+  console.log(' Intent created and signed');
+
+  const metadata = {
+    memo: 'Complete flow demonstration',
+    timestamp: new Date().toISOString(),
+  };
+  const { compressed, savings } = await compressIntentMetadata(metadata);
+  console.log(` Metadata compressed (${savings}% savings)`);
+
+  // Phase 2: Transport (intelligent selection)
+  console.log('\nPhase 2: Intelligent Transport Selection\n');
+  const selector = new SmartTransportSelector();
+  const transport = await selector.selectTransport();
+  console.log(` Selected transport: ${transport.toUpperCase()}`);
+
+  // Phase 3: Routing (cluster-based optimization)
+  console.log('\nPhase 3: Optimal Path Finding\n');
+  const clusterCount = 3;
+  console.log(` Found ${clusterCount} network clusters`);
+
+  const relayPath = ['relay-1', 'relay-2'];
+  console.log(` Route: ${relayPath.length} hops to destination`);
+
+  // Phase 4: Incentive tracking
+  console.log('\nPhase 4: Relay Incentive Setup\n');
+  const rewardPerRelay = 1000;
+  const totalReward = relayPath.length * rewardPerRelay;
+  console.log(
+    ` Reward pool: ${totalReward} lamports for ${relayPath.length} relays`
+  );
+
+  // Phase 5: Transmission
+  console.log('\nPhase 5: Intent Transmission\n');
+  const payloadSize = JSON.stringify({
+    intent,
+    metadata: compressed,
+  }).length;
+  console.log(` Payload size: ${payloadSize} bytes`);
+  console.log(`   MTU: ${transport === 'wifi' ? '1200' : '480'} bytes`);
+  const fragments = Math.ceil(
+    payloadSize / (transport === 'wifi' ? 1200 : 480)
+  );
+  console.log(`   Fragments: ${fragments} (optimized)`);
+
+  // Phase 6: Settlement (when online)
+  console.log('\nPhase 6: Settlement (When Online)\n');
+  console.log(' Intent ready for settlement');
+  console.log('   • Signature verified: YES');
+  console.log('   • Metadata decompressed: YES');
+  console.log('   • Relayers identified: YES');
+  console.log(`   • Rewards tracked: ${totalReward} lamports`);
+  console.log('\n Complete flow ready for production deployment');
+}
+
+/**
+ * Run all examples
+ */
+export async function runAllExamples(connection: Connection): Promise<void> {
+  console.log('═══════════════════════════════════════════════════════════');
+  console.log('        TOSS Enhanced Features - Complete Examples');
+  console.log('═══════════════════════════════════════════════════════════');
+
+  // Create test keypairs
+  const sender = Keypair.generate();
+  const recipient = Keypair.generate().publicKey;
+  const feePayer = Keypair.generate().publicKey;
+
+  try {
+    await exampleCompressedIntentFlow(sender, recipient, 1000000, connection);
+    await exampleSmartTransportFlow();
+    await exampleRelayIncentiveFlow();
+    await exampleMeshClusteringFlow();
+    await exampleCompleteEnhancedFlow(
+      sender,
+      recipient,
+      1000000,
+      connection,
+      feePayer
+    );
+
+    console.log(
+      '\n═══════════════════════════════════════════════════════════'
+    );
+    console.log(' All examples completed successfully!');
+    console.log(
+      '═══════════════════════════════════════════════════════════\n'
+    );
+  } catch (error) {
+    console.error(' Example failed:', error);
+  }
+}

package/src/examples/offlinePaymentFlow.ts

@@ -43,7 +43,7 @@ export async function exampleInitiateUserPayment(
   amountLamports: number,
   connection: Connection
 ): Promise<SolanaIntent> {
-  console.log('📝 Creating offline payment intent between TOSS users...');
+  console.log(' Creating offline payment intent between TOSS users...');
   console.log(`   From: @${senderUser.username}`);
   console.log(`   To: @${recipientUser.username}`);
 
@@ -59,13 +59,13 @@ export async function exampleInitiateUserPayment(
     }
   );
 
-  console.log(`✅ Intent created: ${intent.id}`);
+  console.log(` Intent created: ${intent.id}`);
   console.log(`   Amount: ${intent.amount} lamports`);
   console.log(`   Expires at: ${new Date(intent.expiry * 1000).toISOString()}`);
 
   // Store locally
   await secureStoreIntent(intent);
-  console.log('💾 Intent stored securely locally\n');
+  console.log(' Intent stored securely locally\n');
 
   return intent;
 }
@@ -82,7 +82,7 @@ export async function exampleInitiateOfflinePayment(
   amountLamports: number,
   connection: Connection
 ): Promise<SolanaIntent> {
-  console.log('📝 Creating offline payment intent...');
+  console.log(' Creating offline payment intent...');
 
   // Create the intent (this is done offline, no network needed)
   const intent = await createIntent(
@@ -95,7 +95,7 @@ export async function exampleInitiateOfflinePayment(
     }
   );
 
-  console.log(`✅ Intent created: ${intent.id}`);
+  console.log(` Intent created: ${intent.id}`);
   console.log(`   From: ${intent.from}`);
   console.log(`   To: ${intent.to}`);
   console.log(`   Amount: ${intent.amount} lamports`);
@@ -103,7 +103,7 @@ export async function exampleInitiateOfflinePayment(
 
   // Store locally
   await secureStoreIntent(intent);
-  console.log('💾 Intent stored securely locally\n');
+  console.log(' Intent stored securely locally\n');
 
   return intent;
 }
@@ -120,13 +120,13 @@ export async function exampleExchangeIntentWithPeer(
   peerDeviceId: string,
   peerDevice: PeerDevice
 ): Promise<void> {
-  console.log('📡 Initiating intent exchange with peer...');
+  console.log(' Initiating intent exchange with peer...');
   console.log(`   Local Device: ${localDeviceId}`);
   console.log(`   Peer Device: ${peerDeviceId}`);
 
   // Register the peer
   deviceDiscovery.registerPeer(peerDevice);
-  console.log(`✅ Peer registered: ${peerDevice.id}`);
+  console.log(` Peer registered: ${peerDevice.id}`);
 
   // Create an exchange request
   const exchangeRequest = intentExchange.createRequest(
@@ -136,7 +136,7 @@ export async function exampleExchangeIntentWithPeer(
     5 * 60 // 5 minute expiry
   );
 
-  console.log(`📨 Exchange request created: ${exchangeRequest.requestId}`);
+  console.log(` Exchange request created: ${exchangeRequest.requestId}`);
   console.log(`   Intent ID: ${intent.id}`);
   console.log(`   Amount: ${intent.amount} lamports`);
 
@@ -152,7 +152,7 @@ export async function exampleExchangeIntentWithPeer(
     [intent.id]
   );
 
-  console.log(`\n✅ Peer accepted exchange`);
+  console.log(`\n Peer accepted exchange`);
   console.log(`   Status: ${response.status}`);
   console.log(
     `   Acknowledged intents: ${response.acknowledgedIntentIds?.join(', ')}\n`
@@ -170,7 +170,7 @@ export async function exampleExchangeIntentWithPeer(
 export async function exampleMultiDeviceConflict(
   connection: Connection
 ): Promise<void> {
-  console.log('🔄 Simulating multi-device conflict scenario...\n');
+  console.log(' Simulating multi-device conflict scenario...\n');
 
   // Create keypair for "Device A"
   const senderKeypair = Keypair.generate();
@@ -198,7 +198,7 @@ export async function exampleMultiDeviceConflict(
     { expiresIn: 3600 }
   );
 
-  console.log('❌ Conflict Detected!');
+  console.log(' Conflict Detected!');
   console.log(
     `   Device A created intent: ${intentA.id} at ${intentA.createdAt}`
   );
@@ -212,7 +212,7 @@ export async function exampleMultiDeviceConflict(
   const resolution =
     MultiDeviceConflictResolver.resolveConflicts(conflictingIntents);
 
-  console.log('⚖️ Deterministic Resolution Applied:');
+  console.log('️ Deterministic Resolution Applied:');
   console.log(`   Winner: ${resolution.winner.id}`);
   console.log(`   Winner nonce: ${resolution.winner.nonce}`);
   console.log(
@@ -237,7 +237,7 @@ export async function exampleCompleteOfflineFlow(
   connection: Connection
 ): Promise<void> {
   console.log('='.repeat(60));
-  console.log('🚀 TOSS Complete Offline Payment Flow');
+  console.log(' TOSS Complete Offline Payment Flow');
   console.log('='.repeat(60) + '\n');
 
   try {
@@ -272,13 +272,13 @@ export async function exampleCompleteOfflineFlow(
     // Step 3: Device reconnects and initiates synchronisation
     console.log('STEP 3: Synchronisation with Solana');
     console.log('-'.repeat(60));
-    console.log('📱 Device reconnected to network...');
-    console.log('🔄 Initiating sync with Solana blockchain...\n');
+    console.log(' Device reconnected to network...');
+    console.log(' Initiating sync with Solana blockchain...\n');
 
     // Check sync status
     const syncResult = await syncToChain(connection);
 
-    console.log('📊 Sync Results:');
+    console.log(' Sync Results:');
     console.log(
       `   Successful settlements: ${syncResult.successfulSettlements.length}`
     );
@@ -291,7 +291,7 @@ export async function exampleCompleteOfflineFlow(
     console.log(`   Overall complete: ${syncResult.isComplete}\n`);
 
     if (syncResult.successfulSettlements.length > 0) {
-      console.log('✅ Successful Settlements:');
+      console.log(' Successful Settlements:');
       for (const settlement of syncResult.successfulSettlements) {
         console.log(`   Intent ${settlement.intentId}`);
         console.log(`   Signature: ${settlement.signature}`);
@@ -303,7 +303,7 @@ export async function exampleCompleteOfflineFlow(
     }
 
     if (syncResult.failedSettlements.length > 0) {
-      console.log('❌ Failed Settlements:');
+      console.log(' Failed Settlements:');
       for (const settlement of syncResult.failedSettlements) {
         console.log(`   Intent ${settlement.intentId}`);
         console.log(`   Reason: ${settlement.error}`);
@@ -312,7 +312,7 @@ export async function exampleCompleteOfflineFlow(
     }
 
     if (syncResult.detectedConflicts.length > 0) {
-      console.log('⚠️ Detected Conflicts:');
+      console.log('️ Detected Conflicts:');
       for (const conflict of syncResult.detectedConflicts) {
         console.log(`   Intent ${conflict.intentId}: ${conflict.conflict}`);
       }
@@ -330,15 +330,15 @@ export async function exampleCompleteOfflineFlow(
       (i: SolanaIntent) => i.status === 'failed'
     );
 
-    console.log(`📦 Intent Storage:
+    console.log(` Intent Storage:
    Total intents: ${allIntents.length}
    Settled: ${settledIntents.length}
    Failed: ${failedIntents.length}\n`);
 
-    console.log('✨ Flow complete!\n');
+    console.log(' Flow complete!\n');
     console.log('='.repeat(60));
   } catch (error) {
-    console.error('❌ Error during offline flow:', error);
+    console.error(' Error during offline flow:', error);
     if (error instanceof TossError) {
       console.error(`   Error code: ${(error as TossError).code}`);
     }
@@ -355,23 +355,23 @@ export async function exampleVerifyIntentBeforeAcceptance(
   intent: SolanaIntent,
   connection: Connection
 ): Promise<boolean> {
-  console.log('🔐 Verifying intent signature...');
+  console.log(' Verifying intent signature...');
 
   try {
     const isValid = await verifyIntent(intent, connection);
 
     if (isValid) {
-      console.log('✅ Intent signature is valid');
+      console.log(' Intent signature is valid');
       console.log(`   From: ${intent.from}`);
       console.log(`   To: ${intent.to}`);
       console.log(`   Amount: ${intent.amount} lamports`);
       return true;
     } else {
-      console.log('❌ Intent signature is invalid');
+      console.log(' Intent signature is invalid');
       return false;
     }
   } catch (error) {
-    console.error('❌ Verification failed:', error);
+    console.error(' Verification failed:', error);
     return false;
   }
 }