@0xsequence/catapult 1.3.17 → 1.5.0

package/src/lib/events/cli-adapter.ts

@@ -1,369 +0,0 @@
-import chalk from 'chalk'
-import { DeploymentEvent } from './types'
-import { DeploymentEventEmitter } from './emitter'
-
-/**
- * Verbosity levels for filtering console output:
- * 0 (default): Critical info only - errors, warnings, main deployment steps
- * 1 (-v): Add transaction details and verification steps
- * 2 (-vv): Add action details and file operations
- * 3 (-vvv): Full debug - show everything including template transitions
- */
-export type VerbosityLevel = 0 | 1 | 2 | 3
-
-/**
- * CLI adapter that converts structured deployment events into
- * formatted console output using chalk for colors.
- */
-export class CLIEventAdapter {
-  private emitter: DeploymentEventEmitter
-  private verbosity: VerbosityLevel
-
-  constructor(emitter: DeploymentEventEmitter, verbosity: VerbosityLevel = 0) {
-    this.emitter = emitter
-    this.verbosity = verbosity
-    this.setupListeners()
-  }
-
-  /**
-   * Updates the verbosity level for this adapter.
-   */
-  setVerbosity(verbosity: VerbosityLevel): void {
-    this.verbosity = verbosity
-  }
-
-
-
-  private setupListeners(): void {
-    this.emitter.onAnyEvent((event) => {
-      this.handleEvent(event)
-    })
-  }
-
-  /**
-   * Determines the minimum verbosity level required to show an event.
-   */
-  private getEventVerbosityLevel(eventType: string): VerbosityLevel {
-    // Level 0 (default): Critical info only
-    const level0Events = new Set([
-      'deployment_started', 'deployment_completed', 'deployment_failed',
-      'job_started', 'job_completed', 'job_skipped', 'job_execution_failed',
-      'network_started', 'network_signer_info',
-      'duplicate_artifact_warning', 'missing_network_config_warning',
-      'unhandled_rejection', 'uncaught_exception', 'cli_error',
-      'verification_failed'
-    ])
-
-    // Level 1 (-v): Add transaction details and verification
-    const level1Events = new Set([
-      'project_loading_started', 'project_loaded', 'execution_plan',
-      'transaction_sent', 'transaction_confirmed',
-      'contract_created',
-      'verification_started', 'verification_submitted', 'verification_completed',
-      'output_writing_started', 'output_file_written', 'no_outputs',
-      'run_summary'
-    ])
-
-    // Level 2 (-vv): Add action details and operations
-    const level2Events = new Set([
-      'action_started', 'action_skipped',
-      'template_setup_started', 'template_setup_completed', 'template_setup_skipped', 'template_skipped'
-    ])
-
-    // Level 3 (-vvv): Full debug - everything else
-    const level3Events = new Set([
-      'template_entered', 'template_exited',
-      'primitive_action', 'output_stored',
-      'debug_info', 'action_failed', 'action_info', 'action_completed'
-    ])
-
-    if (level0Events.has(eventType)) return 0
-    if (level1Events.has(eventType)) return 1
-    if (level2Events.has(eventType)) return 2
-    if (level3Events.has(eventType)) return 3
-
-    // Default to level 3 for any new events we haven't categorized
-    return 3
-  }
-
-  private handleEvent(event: DeploymentEvent): void {
-    // Filter events based on verbosity level
-    const requiredLevel = this.getEventVerbosityLevel(event.type)
-    if (this.verbosity < requiredLevel) {
-      return
-    }
-    switch (event.type) {
-      case 'deployment_started':
-        console.log(chalk.bold.inverse(' CATAPULT: STARTING DEPLOYMENT RUN '))
-        break
-
-      case 'project_loading_started':
-        console.log(chalk.blue(`\n1. Loading project from: ${event.data.projectRoot}`))
-        break
-
-      case 'project_loaded':
-        console.log(chalk.green(`   - Loaded ${event.data.jobCount} jobs, ${event.data.templateCount} templates, and registered artifacts.`))
-        break
-
-      case 'execution_plan':
-        console.log(chalk.blue('\n2. Execution Plan'))
-        console.log(chalk.gray(`   - Target Networks: ${event.data.targetNetworks.map(n => `${n.name} (ChainID: ${n.chainId})`).join(', ')}`))
-        console.log(chalk.gray(`   - Job Execution Order: ${event.data.jobExecutionOrder.join(' -> ')}`))
-        break
-
-      case 'network_started':
-        console.log(chalk.cyan.bold(`\nNetwork: ${event.data.networkName} (ChainID: ${event.data.chainId})`))
-        break
-
-      case 'network_signer_info':
-        console.log(chalk.gray(`        Sender: ${event.data.address}`))
-        console.log(chalk.gray(`        Balance: ${event.data.balance} ETH (${event.data.balanceWei} wei)`))
-        break
-
-      case 'job_started':
-        console.log(chalk.cyan.bold(`\n🚀 Starting job: ${event.data.jobName} (v${event.data.jobVersion})`))
-        break
-
-      case 'job_completed':
-        console.log(chalk.green.bold(`✅ Job "${event.data.jobName}" completed successfully.`))
-        break
-
-      case 'job_skipped':
-        console.log(chalk.yellow(`  Skipping job "${event.data.jobName}" on network "${event.data.networkName}" due to configuration.`))
-        break
-
-      case 'action_started':
-        console.log(chalk.blue(`  - Executing: ${event.data.actionName}`))
-        break
-
-      case 'action_skipped':
-        console.log(chalk.yellow(`    ↪ Skipping "${event.data.actionName}": ${event.data.reason}`))
-        break
-
-      case 'template_entered':
-        console.log(chalk.magenta(`    -> Entering template: ${event.data.templateName}`))
-        break
-
-      case 'template_exited':
-        console.log(chalk.magenta(`    <- Exiting template: ${event.data.templateName}`))
-        break
-
-      case 'template_setup_started':
-        console.log(chalk.magenta(`    -> Running setup for template: ${event.data.templateName}`))
-        break
-
-      case 'template_setup_completed':
-        console.log(chalk.magenta(`    <- Finished setup for template: ${event.data.templateName}`))
-        break
-
-      case 'template_setup_skipped':
-        // Don't output anything - this is internal and not user-facing
-        break
-
-      case 'template_skipped':
-        console.log(chalk.yellow(`    ↪ Skipping actions in template "${event.data.templateName}" due to met condition.`))
-        break
-
-      case 'primitive_action':
-        console.log(chalk.gray(`      Executing primitive: ${event.data.actionType}`))
-        break
-
-      case 'transaction_sent':
-        console.log(chalk.gray(`        to: ${event.data.to}, value: ${event.data.value}, data: ${event.data.dataPreview}...`))
-        console.log(chalk.gray(`        tx hash: ${event.data.txHash}`))
-        break
-
-      case 'transaction_confirmed':
-        console.log(chalk.gray(`        tx confirmed in block: ${event.data.blockNumber}`))
-        break
-
-      case 'output_stored':
-        console.log(chalk.gray(`      Stored output: ${event.data.outputKey} = ${event.data.value}`))
-        break
-
-      case 'output_writing_started':
-        console.log(chalk.blue('\n4. Writing output files...'))
-        break
-
-      case 'output_file_written':
-        console.log(chalk.green(`   - Wrote: ${event.data.relativePath}`))
-        break
-
-      case 'no_outputs':
-        console.log(chalk.yellow('\nNo successful job executions to write to output.'))
-        break
-
-      case 'deployment_completed':
-        // Print a compact, high-signal run summary. The Deployer will have emitted
-        // preceding info, so we only render a final banner here. Detailed counts
-        // are printed via a separate 'run_summary' event.
-        console.log(chalk.bold.inverse('\n CATAPULT: DEPLOYMENT RUN COMPLETED SUCCESSFULLY '))
-        break
-
-      case 'deployment_failed':
-        console.error(chalk.red.bold('\n💥 DEPLOYMENT FAILED!'))
-        // Show concise failed jobs table if present
-        const failedJobs = (event as any).data?.failedJobs as Array<{ jobName: string; networkName: string; chainId: number; error: string }> | undefined
-        if (Array.isArray(failedJobs) && failedJobs.length > 0) {
-          console.error(chalk.red('   ✗ Failed jobs:'))
-          for (const f of failedJobs) {
-            const where = `${f.networkName} (ChainID: ${f.chainId})`
-            console.error(chalk.red(`     - ${f.jobName} on ${where}`))
-            console.error(chalk.red(`       Error: ${f.error}`))
-          }
-        }
-        // Always print the top-level error and stack last
-        if ((event as any).data?.stack) {
-          console.error(chalk.red((event as any).data.stack))
-        } else if ((event as any).data?.error) {
-          console.error(chalk.red((event as any).data.error))
-        }
-        break
-
-      case 'duplicate_artifact_warning':
-        console.warn(`Warning: Duplicate artifact contractName found: "${event.data.contractName}". Name-based lookup disabled - use hash or path references instead.`)
-        break
-
-      case 'missing_network_config_warning':
-        console.warn(chalk.yellow(`Warning: Could not find network configurations for specified chain IDs: ${event.data.missingChainIds.join(', ')}`))
-        break
-
-      case 'unhandled_rejection':
-        console.error(chalk.red('Unhandled Rejection:'), event.data.error, chalk.red('origin:'), event.data.origin)
-        break
-
-      case 'uncaught_exception':
-        console.error(chalk.red('Uncaught Exception:'), event.data.error)
-        break
-
-      case 'cli_error':
-        console.error(chalk.red('Error:'), event.data.message)
-        break
-
-      case 'verification_started':
-        console.log(chalk.gray(`        🔍 Verifying contract on ${event.data.platform} (${event.data.networkName})...`))
-        break
-
-      case 'verification_submitted':
-        if (event.data.guid && event.data.guid !== 'N/A') {
-          console.log(chalk.gray(`        📝 Verification submitted to ${event.data.platform} (GUID: ${event.data.guid})`))
-        }
-        break
-
-      case 'verification_completed':
-        if (event.data.message.includes('already verified')) {
-          console.log(chalk.yellow(`        ✓ Already verified on ${event.data.platform}`))
-        } else {
-          console.log(chalk.green(`        ✅ ${event.data.message} on ${event.data.platform}`))
-        }
-        break
-
-      case 'verification_failed':
-        console.log(chalk.red(`        ❌ Verification failed on ${event.data.platform}: ${event.data.error}`))
-        break
-
-      case 'verification_retry':
-        // Keep short to reduce noise
-        console.log(chalk.gray(`        Verification retry ${event.data.attempt}/${event.data.maxRetries}: ${event.data.error}`))
-        break
-
-      case 'verification_skipped':
-        console.log(chalk.yellow(`        ⚠️  ${event.data.reason}`))
-        break
-
-      case 'verification_warnings_report':
-        // Display detailed verification warnings report
-        console.log(chalk.yellow('\n📋 Verification Warnings Report'))
-        console.log(chalk.yellow(`   Total warnings: ${event.data.totalWarnings}`))
-        console.log('')
-        
-        if (event.data.warnings && event.data.warnings.length > 0) {
-          for (const warning of event.data.warnings) {
-            console.log(chalk.red(`   ❌ ${warning.actionName} (${warning.contractName})`))
-            console.log(chalk.gray(`      Address: ${warning.address}`))
-            console.log(chalk.gray(`      Platform: ${warning.platform}`))
-            if (warning.networkName) {
-              console.log(chalk.gray(`      Network: ${warning.networkName}`))
-            }
-            console.log(chalk.gray(`      Error: ${warning.error}`))
-            console.log('')
-          }
-        }
-        break
-      case 'contract_created':
-        console.log(chalk.gray(`        contract: ${event.data.contractAddress}`))
-        break
-
-      case 'context_disposal_warning':
-        console.warn(chalk.yellow(`Warning: context cleanup issue for job "${event.data.jobName}" on ${event.data.networkName}: ${event.data.error}`))
-        break
-
-      case 'deprecated_jobs_skipped':
-        if (Array.isArray(event.data.jobs) && event.data.jobs.length > 0) {
-          const names = event.data.jobs.map((j: any) => typeof j === 'string' ? j : j.name).filter(Boolean)
-          console.log(chalk.yellow(`Skipping deprecated jobs (not requested): ${names.join(', ')}`))
-        }
-        break
-
-      case 'run_summary':
-        // Rich end-of-run summary
-        console.log(chalk.blue('\n5. Summary'))
-        console.log(chalk.gray(`   Networks: ${event.data.networkCount}, Jobs: ${event.data.jobCount}`))
-        console.log(chalk.green(`   ✓ Success: ${event.data.successCount}`))
-        if (event.data.skippedCount > 0) console.log(chalk.yellow(`   ↪ Skipped: ${event.data.skippedCount}`))
-        if (event.data.failedCount > 0) console.log(chalk.red(`   ✗ Failed: ${event.data.failedCount}`))
-        if (Array.isArray(event.data.keyContracts) && event.data.keyContracts.length > 0) {
-          console.log(chalk.gray('   Key contracts:'))
-          for (const c of event.data.keyContracts) {
-            console.log(chalk.gray(`     - ${c.job}.${c.action}: ${c.address}`))
-          }
-        }
-        break
-
-      case 'job_execution_failed':
-        console.error(chalk.red.bold(`❌ Job "${event.data.jobName}" failed on ${event.data.networkName} (Chain ID: ${event.data.chainId})`))
-        console.error(chalk.red(`   Error: ${event.data.error}`))
-        break
-
-      case 'action_completed':
-        console.log(chalk.green(`      ✅ ${event.data.result}`))
-        break
-
-      case 'action_failed':
-        console.log(chalk.red(`      ❌ ${event.data.message}`))
-        break
-
-      case 'action_info':
-        console.log(chalk.gray(`      ℹ️  ${event.data.message}`))
-        break
-
-      case 'debug_info':
-        const levelPrefix = event.level.toUpperCase()
-        const levelColor = event.level === 'warn' ? chalk.yellow :
-                          event.level === 'info' ? chalk.blue :
-                          chalk.gray
-        console.log(levelColor(`        [${levelPrefix}] ${event.data.message}`))
-        break
-
-      default:
-        // Suppress raw debug dumps in CLI output; only show a concise line at highest verbosity
-        if (this.verbosity >= 3) {
-          const level = (event as any).level?.toUpperCase?.() || 'DEBUG'
-          const type = (event as any).type || 'event'
-          const msg = (event as any).data?.message
-          if (msg) {
-            console.log(chalk.gray(`        [${level}] ${type}: ${msg}`))
-          }
-          // Otherwise, remain silent to avoid noisy/broken logs
-        }
-        break
-    }
-  }
-
-  /**
-   * Stop listening to events (cleanup method).
-   */
-  public destroy(): void {
-    this.emitter.removeAllListeners()
-  }
-}

package/src/lib/events/emitter.ts

@@ -1,62 +0,0 @@
-import { EventEmitter } from 'events'
-import { DeploymentEvent } from './types'
-
-/**
- * Type-safe event emitter for deployment events.
- * Extends Node.js EventEmitter with typed event methods.
- */
-export class DeploymentEventEmitter extends EventEmitter {
-  /**
-   * Emits a deployment event with automatic timestamp injection.
-   */
-  public emitEvent(event: any): void {
-    const fullEvent = {
-      ...event,
-      timestamp: new Date()
-    }
-
-    // Emit on both the specific event type and a general 'event' channel
-    this.emit(event.type, fullEvent)
-    this.emit('event', fullEvent)
-  }
-
-  /**
-   * Type-safe event listener registration.
-   */
-  public onEvent<T extends DeploymentEvent>(
-    eventType: T['type'],
-    listener: (event: T) => void
-  ): this {
-    return this.on(eventType, listener)
-  }
-
-  /**
-   * Listen to all events.
-   */
-  public onAnyEvent(listener: (event: DeploymentEvent) => void): this {
-    return this.on('event', listener)
-  }
-
-  /**
-   * One-time event listener.
-   */
-  public onceEvent<T extends DeploymentEvent>(
-    eventType: T['type'],
-    listener: (event: T) => void
-  ): this {
-    return this.once(eventType, listener)
-  }
-
-  /**
-   * Remove event listener.
-   */
-  public offEvent<T extends DeploymentEvent>(
-    eventType: T['type'],
-    listener: (event: T) => void
-  ): this {
-    return this.off(eventType, listener)
-  }
-}
-
-// Singleton instance for global access
-export const deploymentEvents = new DeploymentEventEmitter() 

package/src/lib/events/index.ts

@@ -1,3 +0,0 @@
-export * from './types'
-export * from './emitter'
-export * from './cli-adapter'