@smartledger/bsv 3.4.3 → 3.4.4

package/examples/smart_contract_templates.js

@@ -1,718 +0,0 @@
-/**
- * Smart Contract Examples - Working Code Templates
- * ===============================================
- * 
- * Complete, runnable examples for smartledger-bsv smart contract development.
- * Each example demonstrates different aspects of preimage validation contracts.
- * 
- * Usage: node examples/smart_contract_templates.js
- */
-
-const bsv = require('../index.js')
-const path = require('path')
-
-// Enable colored output if available
-let chalk
-try {
-  chalk = require('chalk')
-} catch (e) {
-  // Fallback for environments without chalk
-  chalk = {
-    green: (text) => `✅ ${text}`,
-    red: (text) => `❌ ${text}`,
-    yellow: (text) => `⚠️ ${text}`,
-    blue: (text) => `ℹ️ ${text}`,
-    magenta: (text) => `🔮 ${text}`,
-    cyan: (text) => `🌊 ${text}`,
-    bold: (text) => `**${text}**`
-  }
-}
-
-console.log(chalk.bold.blue('\n🚀 SmartLedger-BSV Smart Contract Templates\n'))
-
-// ============================================================================
-// 1. BASIC AMOUNT VALIDATION CONTRACT
-// ============================================================================
-
-class BasicAmountContract {
-  constructor(expectedAmount) {
-    this.expectedAmount = expectedAmount
-    this.privateKey = new bsv.PrivateKey()
-    this.script = this._buildScript()
-    this.address = this._createAddress()
-    
-    console.log(chalk.green(`✅ BasicAmountContract created`))
-    console.log(chalk.blue(`   Expected Amount: ${expectedAmount} satoshis`))
-    console.log(chalk.blue(`   Contract Address: ${this.address.toString()}`))
-  }
-  
-  _buildScript() {
-    const builder = new bsv.SmartContract.CovenantBuilder()
-    
-    const builtScript = builder
-      .comment(`Validates payment of exactly ${this.expectedAmount} satoshis`)
-      .extractField('value')
-      .push(this.expectedAmount)
-      .numEqual()
-      .verify()
-      .build()
-    
-    // Convert to BSV Script object
-    return new bsv.Script(builtScript.hex)
-  }
-  
-  _createAddress() {
-    return bsv.SmartContract.utils.createCovenantAddress(this.script)
-  }
-  
-  validatePayment(preimageHex) {
-    try {
-      console.log(chalk.yellow('🔍 Testing payment validation...'))
-      
-      const result = bsv.SmartContract.testScript(
-        preimageHex,
-        this.script.toHex(),
-        { verbose: true }
-      )
-      
-      if (result.valid) {
-        console.log(chalk.green('✅ Payment validation PASSED'))
-      } else {
-        console.log(chalk.red('❌ Payment validation FAILED'))
-        console.log(chalk.red(`   Error: ${result.error}`))
-      }
-      
-      return {
-        success: result.valid,
-        error: result.error
-      }
-    } catch (error) {
-      console.log(chalk.red('❌ Validation error:', error.message))
-      return {
-        success: false,
-        error: error.message
-      }
-    }
-  }
-  
-  getDeploymentInfo() {
-    return {
-      address: this.address,
-      script: {
-        asm: this.script.toASM(),
-        hex: this.script.toHex()
-      },
-      expectedAmount: this.expectedAmount
-    }
-  }
-}
-
-// ============================================================================
-// 2. MULTI-FIELD VALIDATION CONTRACT
-// ============================================================================
-
-class MultiFieldValidationContract {
-  constructor(params) {
-    this.params = {
-      minAmount: params.minAmount,
-      maxAmount: params.maxAmount || null,
-      requiredOutputsHash: params.requiredOutputsHash || null,
-      minLocktime: params.minLocktime || null,
-      ...params
-    }
-    
-    this.privateKey = new bsv.PrivateKey()
-    this.script = this._buildScript()
-    this.address = this._createAddress()
-    
-    console.log(chalk.green(`✅ MultiFieldValidationContract created`))
-    console.log(chalk.blue(`   Min Amount: ${this.params.minAmount} satoshis`))
-    if (this.params.maxAmount) {
-      console.log(chalk.blue(`   Max Amount: ${this.params.maxAmount} satoshis`))
-    }
-    console.log(chalk.blue(`   Contract Address: ${this.address.toString()}`))
-  }
-  
-  _buildScript() {
-    const builder = new bsv.SmartContract.CovenantBuilder()
-    
-    builder
-      .comment('Multi-field validation contract')
-      .comment(`Minimum amount: ${this.params.minAmount} satoshis`)
-    
-    // Validate minimum amount
-    builder
-      .extractField('value')
-      .push(this.params.minAmount)
-      .greaterThanOrEqual()
-      .verify()
-    
-    // Validate maximum amount (if specified)
-    if (this.params.maxAmount) {
-      builder
-        .comment(`Maximum amount: ${this.params.maxAmount} satoshis`)
-        .extractField('value')
-        .push(this.params.maxAmount)
-        .lessThanOrEqual()
-        .verify()
-    }
-    
-    // Validate outputs (if specified)
-    if (this.params.requiredOutputsHash) {
-      builder
-        .comment('Validate required outputs')
-        .extractField('hashOutputs')
-        .push(this.params.requiredOutputsHash)
-        .equalVerify()
-    }
-    
-    // Validate locktime (if specified)
-    if (this.params.minLocktime) {
-      builder
-        .comment(`Minimum locktime: ${this.params.minLocktime}`)
-        .extractField('nLocktime')
-        .push(this.params.minLocktime)
-        .greaterThanOrEqual()
-        .verify()
-    }
-    
-    const builtScript = builder.build()
-    return new bsv.Script(builtScript.hex)
-  }
-  
-  _createAddress() {
-    return bsv.SmartContract.utils.createCovenantAddress(this.script)
-  }
-  
-  validateTransaction(preimageHex) {
-    try {
-      console.log(chalk.yellow('🔍 Testing multi-field validation...'))
-      
-      // Test each field validation
-      const results = {}
-      
-      // Test complete script
-      const result = bsv.SmartContract.testScript(
-        preimageHex,
-        this.script.toHex(),
-        { verbose: true }
-      )
-      
-      if (result.valid) {
-        console.log(chalk.green('✅ All validations PASSED'))
-      } else {
-        console.log(chalk.red('❌ Validation FAILED'))
-        console.log(chalk.red(`   Error: ${result.error}`))
-      }
-      
-      return {
-        success: result.valid,
-        error: result.error,
-        details: results
-      }
-    } catch (error) {
-      console.log(chalk.red('❌ Validation error:', error.message))
-      return {
-        success: false,
-        error: error.message
-      }
-    }
-  }
-}
-
-// ============================================================================
-// 3. ESCROW CONTRACT
-// ============================================================================
-
-class EscrowContract {
-  constructor(params) {
-    this.params = {
-      buyerPubKey: params.buyerPubKey,
-      sellerPubKey: params.sellerPubKey,
-      arbiterPubKey: params.arbiterPubKey,
-      escrowAmount: params.escrowAmount,
-      timeoutBlocks: params.timeoutBlocks,
-      ...params
-    }
-    
-    this.privateKey = new bsv.PrivateKey()
-    this.script = this._buildScript()
-    this.address = this._createAddress()
-    
-    console.log(chalk.green(`✅ EscrowContract created`))
-    console.log(chalk.blue(`   Escrow Amount: ${this.params.escrowAmount} satoshis`))
-    console.log(chalk.blue(`   Timeout: ${this.params.timeoutBlocks} blocks`))
-    console.log(chalk.blue(`   Contract Address: ${this.address.toString()}`))
-  }
-  
-  _buildScript() {
-    const builder = new bsv.SmartContract.CovenantBuilder()
-    
-    const builtScript = builder
-      .comment('Escrow contract with 2-of-3 release or timeout refund')
-      .comment(`Amount: ${this.params.escrowAmount} satoshis`)
-      .comment(`Timeout: ${this.params.timeoutBlocks} blocks`)
-      
-      // Validate escrow amount
-      .extractField('value')
-      .push(this.params.escrowAmount)
-      .greaterThanOrEqual()
-      .verify()
-      
-      // Additional escrow logic would go here
-      // This is a simplified version for demonstration
-      
-      .build()
-    
-    return new bsv.Script(builtScript.hex)
-  }
-  
-  _createAddress() {
-    return bsv.SmartContract.utils.createCovenantAddress(this.script)
-  }
-  
-  createReleaseTransaction(utxo, beneficiary, arbiterSignature) {
-    // Create transaction that releases funds to beneficiary
-    const tx = new bsv.Transaction()
-      .from({
-        txId: utxo.txid,
-        outputIndex: utxo.vout,
-        script: this.script.toHex(),
-        satoshis: utxo.satoshis
-      })
-      .to(beneficiary, this.params.escrowAmount - 1000) // minus fee
-    
-    return tx
-  }
-  
-  createRefundTransaction(utxo, refundAddress) {
-    // Create transaction that refunds to original sender after timeout
-    const tx = new bsv.Transaction()
-      .from({
-        txId: utxo.txid,
-        outputIndex: utxo.vout,
-        script: this.script.toHex(),
-        satoshis: utxo.satoshis
-      })
-      .to(refundAddress, this.params.escrowAmount - 1000) // minus fee
-    
-    return tx
-  }
-}
-
-// ============================================================================
-// 4. SUBSCRIPTION CONTRACT
-// ============================================================================
-
-class SubscriptionContract {
-  constructor(params) {
-    this.params = {
-      serviceProvider: params.serviceProvider,
-      monthlyAmount: params.monthlyAmount,
-      maxPayments: params.maxPayments,
-      ...params
-    }
-    
-    this.privateKey = new bsv.PrivateKey()
-    this.script = this._buildScript()
-    this.address = this._createAddress()
-    
-    console.log(chalk.green(`✅ SubscriptionContract created`))
-    console.log(chalk.blue(`   Monthly Amount: ${this.params.monthlyAmount} satoshis`))
-    console.log(chalk.blue(`   Max Payments: ${this.params.maxPayments}`))
-    console.log(chalk.blue(`   Provider: ${this.params.serviceProvider}`))
-    console.log(chalk.blue(`   Contract Address: ${this.address.toString()}`))
-  }
-  
-  _buildScript() {
-    const builder = new bsv.SmartContract.CovenantBuilder()
-    
-    const builtScript = builder
-      .comment('Subscription contract with fixed monthly payments')
-      .comment(`Monthly: ${this.params.monthlyAmount} satoshis`)
-      .comment(`Max payments: ${this.params.maxPayments}`)
-      
-      // Validate payment amount
-      .extractField('value')
-      .push(this.params.monthlyAmount)
-      .numEqual()
-      .verify()
-      
-      // Additional subscription logic would go here
-      // Payment counting, provider validation, etc.
-      
-      .build()
-    
-    return new bsv.Script(builtScript.hex)
-  }
-  
-  _createAddress() {
-    return bsv.SmartContract.utils.createCovenantAddress(this.script)
-  }
-}
-
-// ============================================================================
-// 5. COMPLETE WORKFLOW DEMONSTRATION
-// ============================================================================
-
-class ContractWorkflowDemo {
-  constructor() {
-    console.log(chalk.bold.magenta('\n🔄 Complete Contract Workflow Demonstration\n'))
-  }
-  
-  async demonstrateFullWorkflow() {
-    console.log(chalk.cyan('Step 1: Create a basic payment validation contract'))
-    
-    // Step 1: Create contract
-    const contract = new BasicAmountContract(100000) // 100,000 sats
-    
-    console.log(chalk.cyan('\nStep 2: Deploy contract (simulate)'))
-    const deploymentInfo = contract.getDeploymentInfo()
-    console.log('Contract Script (ASM):', deploymentInfo.script.asm)
-    console.log('Contract Script (Hex):', deploymentInfo.script.hex)
-    
-    console.log(chalk.cyan('\nStep 3: Generate test UTXO and preimage'))
-    
-    // Create a test UTXO that funds the contract
-    const utxoGenerator = new bsv.SmartContract.UTXOGenerator({
-      network: 'testnet',
-      apiKey: 'test'
-    })
-    
-    // Generate test preimage for validation
-    try {
-      const testPreimage = this._generateTestPreimage(contract, 100000)
-      
-      console.log(chalk.cyan('\nStep 4: Validate contract execution'))
-      const validationResult = contract.validatePayment(testPreimage)
-      
-      if (validationResult.success) {
-        console.log(chalk.green('✅ Contract workflow completed successfully!'))
-      } else {
-        console.log(chalk.red('❌ Contract validation failed'))
-      }
-      
-    } catch (error) {
-      console.log(chalk.yellow('⚠️ Test preimage generation skipped (requires real UTXO)'))
-      console.log(chalk.blue('   In production, you would:'))
-      console.log(chalk.blue('   1. Fund the contract address'))
-      console.log(chalk.blue('   2. Create spending transaction'))
-      console.log(chalk.blue('   3. Generate preimage from spending transaction'))
-      console.log(chalk.blue('   4. Validate against contract'))
-    }
-  }
-  
-  _generateTestPreimage(contract, amount) {
-    // This would generate a real preimage in production
-    // For demo purposes, we'll return a placeholder
-    const dummyTx = new bsv.Transaction()
-      .from({
-        txId: 'a'.repeat(64),
-        outputIndex: 0,
-        script: contract.script.toHex(),
-        satoshis: 200000
-      })
-      .to(contract.address, amount)
-    
-    // Generate preimage
-    return bsv.Transaction.sighash.sighashPreimage(
-      dummyTx,
-      bsv.crypto.Signature.SIGHASH_ALL | bsv.crypto.Signature.SIGHASH_FORKID,
-      0,
-      contract.script,
-      new bsv.crypto.BN(200000)
-    ).toString('hex')
-  }
-}
-
-// ============================================================================
-// 6. CONTRACT TESTING FRAMEWORK
-// ============================================================================
-
-class ContractTester {
-  constructor() {
-    this.testResults = []
-    console.log(chalk.bold.yellow('\n🧪 Smart Contract Testing Framework\n'))
-  }
-  
-  async testAllContracts() {
-    console.log(chalk.cyan('Running comprehensive contract tests...\n'))
-    
-    // Test 1: Basic Amount Contract
-    await this._testBasicAmountContract()
-    
-    // Test 2: Multi-Field Contract
-    await this._testMultiFieldContract()
-    
-    // Test 3: Escrow Contract
-    await this._testEscrowContract()
-    
-    // Test 4: Subscription Contract
-    await this._testSubscriptionContract()
-    
-    // Print results
-    this._printTestResults()
-  }
-  
-  async _testBasicAmountContract() {
-    console.log(chalk.blue('Test 1: Basic Amount Contract'))
-    
-    try {
-      const contract = new BasicAmountContract(50000)
-      
-      // Test with testFieldExtraction
-      const testPreimage = this._createMockPreimage({
-        value: 50000,
-        version: 2,
-        locktime: 0
-      })
-      
-      // Test field extraction specifically
-      const fieldTest = bsv.SmartContract.testFieldExtraction(
-        testPreimage,
-        'value'
-      )
-      
-      console.log(chalk.blue('  Field extraction ASM:'), fieldTest)
-      
-      this.testResults.push({
-        name: 'Basic Amount Contract - Creation',
-        passed: true,
-        details: 'Contract created successfully'
-      })
-      
-    } catch (error) {
-      console.log(chalk.red('❌ Basic amount contract test failed:', error.message))
-      this.testResults.push({
-        name: 'Basic Amount Contract',
-        passed: false,
-        error: error.message
-      })
-    }
-  }
-  
-  async _testMultiFieldContract() {
-    console.log(chalk.blue('Test 2: Multi-Field Contract'))
-    
-    try {
-      const contract = new MultiFieldValidationContract({
-        minAmount: 100000,
-        maxAmount: 500000,
-        minLocktime: 600000
-      })
-      
-      this.testResults.push({
-        name: 'Multi-Field Contract - Creation',
-        passed: true,
-        details: 'Multi-field contract created successfully'
-      })
-      
-    } catch (error) {
-      console.log(chalk.red('❌ Multi-field contract test failed:', error.message))
-      this.testResults.push({
-        name: 'Multi-Field Contract',
-        passed: false,
-        error: error.message
-      })
-    }
-  }
-  
-  async _testEscrowContract() {
-    console.log(chalk.blue('Test 3: Escrow Contract'))
-    
-    try {
-      const buyer = new bsv.PrivateKey()
-      const seller = new bsv.PrivateKey()
-      const arbiter = new bsv.PrivateKey()
-      
-      const contract = new EscrowContract({
-        buyerPubKey: buyer.publicKey,
-        sellerPubKey: seller.publicKey,
-        arbiterPubKey: arbiter.publicKey,
-        escrowAmount: 1000000,
-        timeoutBlocks: 144
-      })
-      
-      this.testResults.push({
-        name: 'Escrow Contract - Creation',
-        passed: true,
-        details: 'Escrow contract created successfully'
-      })
-      
-    } catch (error) {
-      console.log(chalk.red('❌ Escrow contract test failed:', error.message))
-      this.testResults.push({
-        name: 'Escrow Contract',
-        passed: false,
-        error: error.message
-      })
-    }
-  }
-  
-  async _testSubscriptionContract() {
-    console.log(chalk.blue('Test 4: Subscription Contract'))
-    
-    try {
-      const provider = new bsv.Address('1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2')
-      
-      const contract = new SubscriptionContract({
-        serviceProvider: provider,
-        monthlyAmount: 10000000, // 0.1 BSV per month
-        maxPayments: 12
-      })
-      
-      this.testResults.push({
-        name: 'Subscription Contract - Creation',
-        passed: true,
-        details: 'Subscription contract created successfully'
-      })
-      
-    } catch (error) {
-      console.log(chalk.red('❌ Subscription contract test failed:', error.message))
-      this.testResults.push({
-        name: 'Subscription Contract',
-        passed: false,
-        error: error.message
-      })
-    }
-  }
-  
-  _createMockPreimage(params) {
-    // Create a simplified mock preimage for testing
-    // In production, use real transaction preimages
-    
-    const version = Buffer.alloc(4)
-    version.writeUInt32LE(params.version || 2)
-    
-    const hashPrevouts = Buffer.alloc(32, 0)
-    const hashSequence = Buffer.alloc(32, 0)
-    
-    const outpoint = Buffer.alloc(36)
-    const scriptLen = Buffer.from([0]) // 0-length script
-    
-    const value = Buffer.alloc(8)
-    value.writeUInt32LE(params.value || 0, 0)
-    
-    const sequence = Buffer.alloc(4, 0xff)
-    const hashOutputs = Buffer.alloc(32, 0)
-    
-    const locktime = Buffer.alloc(4)
-    locktime.writeUInt32LE(params.locktime || 0)
-    
-    const sighash = Buffer.alloc(4)
-    sighash.writeUInt32LE(0x41) // SIGHASH_ALL | SIGHASH_FORKID
-    
-    return Buffer.concat([
-      version,
-      hashPrevouts,
-      hashSequence,
-      outpoint,
-      scriptLen,
-      value,
-      sequence,
-      hashOutputs,
-      locktime,
-      sighash
-    ]).toString('hex')
-  }
-  
-  _printTestResults() {
-    console.log(chalk.bold.cyan('\n📊 Test Results Summary'))
-    console.log(chalk.cyan('========================\n'))
-    
-    let passed = 0
-    let failed = 0
-    
-    this.testResults.forEach(result => {
-      if (result.passed) {
-        console.log(chalk.green(`✅ ${result.name}`))
-        if (result.details) console.log(chalk.blue(`   ${result.details}`))
-        passed++
-      } else {
-        console.log(chalk.red(`❌ ${result.name}`))
-        if (result.error) console.log(chalk.red(`   Error: ${result.error}`))
-        failed++
-      }
-    })
-    
-    console.log(chalk.cyan(`\nTotal: ${this.testResults.length} tests`))
-    console.log(chalk.green(`Passed: ${passed}`))
-    console.log(chalk.red(`Failed: ${failed}`))
-    
-    if (failed === 0) {
-      console.log(chalk.bold.green('\n🎉 All tests passed!'))
-    } else {
-      console.log(chalk.bold.yellow('\n⚠️ Some tests failed. Review errors above.'))
-    }
-  }
-}
-
-// ============================================================================
-// 7. MAIN EXECUTION
-// ============================================================================
-
-async function main() {
-  try {
-    console.log(chalk.bold.blue('Smart Contract Templates Demo'))
-    console.log(chalk.blue('============================\n'))
-    
-    // Create example contracts
-    console.log(chalk.bold.cyan('1. Creating Example Contracts\n'))
-    
-    const basicContract = new BasicAmountContract(100000)
-    console.log()
-    
-    const multiContract = new MultiFieldValidationContract({
-      minAmount: 50000,
-      maxAmount: 200000,
-      minLocktime: 600000
-    })
-    console.log()
-    
-    const escrowContract = new EscrowContract({
-      buyerPubKey: new bsv.PrivateKey().publicKey,
-      sellerPubKey: new bsv.PrivateKey().publicKey,
-      arbiterPubKey: new bsv.PrivateKey().publicKey,
-      escrowAmount: 1000000,
-      timeoutBlocks: 144
-    })
-    console.log()
-    
-    // Run workflow demo
-    const workflowDemo = new ContractWorkflowDemo()
-    await workflowDemo.demonstrateFullWorkflow()
-    
-    // Run tests
-    const tester = new ContractTester()
-    await tester.testAllContracts()
-    
-    console.log(chalk.bold.green('\n🎯 Smart Contract Templates Demo Complete!\n'))
-    
-    // Show usage instructions
-    console.log(chalk.bold.yellow('Next Steps:'))
-    console.log(chalk.yellow('1. Use these templates as starting points for your contracts'))
-    console.log(chalk.yellow('2. Modify the validation logic for your specific use cases'))
-    console.log(chalk.yellow('3. Test thoroughly before deploying to mainnet'))
-    console.log(chalk.yellow('4. Consider security implications and edge cases'))
-    console.log(chalk.yellow('5. See the full guide in docs/SMART_CONTRACT_DEVELOPMENT_GUIDE.md'))
-    
-  } catch (error) {
-    console.error(chalk.bold.red('Demo Error:'), error.message)
-    console.error(chalk.red('Stack:'), error.stack)
-  }
-}
-
-// Export classes for use in other modules
-module.exports = {
-  BasicAmountContract,
-  MultiFieldValidationContract,
-  EscrowContract,
-  SubscriptionContract,
-  ContractWorkflowDemo,
-  ContractTester
-}
-
-// Run demo if executed directly
-if (require.main === module) {
-  main().catch(console.error)
-}