@xyo-network/xl1-cli 1.6.5 → 1.6.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/xl1-cli",
-  "version": "1.6.5",
+  "version": "1.6.6",
   "description": "XYO Layer One API",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -44,39 +44,39 @@
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@xylabs/array": "^4.12.44",
-    "@xylabs/assert": "^4.12.44",
-    "@xylabs/base": "^4.12.44",
-    "@xylabs/creatable": "^4.12.44",
-    "@xylabs/delay": "^4.12.44",
-    "@xylabs/events": "^4.12.44",
-    "@xylabs/forget": "^4.12.44",
-    "@xylabs/hex": "^4.12.44",
-    "@xylabs/logger": "^4.12.44",
-    "@xylabs/promise": "^4.12.44",
-    "@xylabs/telemetry": "^4.12.44",
+    "@xylabs/array": "^4.13.5",
+    "@xylabs/assert": "^4.13.5",
+    "@xylabs/base": "^4.13.5",
+    "@xylabs/creatable": "^4.13.5",
+    "@xylabs/delay": "^4.13.5",
+    "@xylabs/events": "^4.13.5",
+    "@xylabs/forget": "^4.13.5",
+    "@xylabs/hex": "^4.13.5",
+    "@xylabs/logger": "^4.13.5",
+    "@xylabs/promise": "^4.13.5",
+    "@xylabs/telemetry": "^4.13.5",
     "@xylabs/ts-scripts-yarn3": "^6.5.18",
     "@xylabs/tsconfig": "^6.5.18",
-    "@xylabs/typeof": "^4.12.44",
-    "@xylabs/vitest-extended": "^4.12.44",
-    "@xyo-network/archivist-lmdb": "^4.0.2",
-    "@xyo-network/archivist-memory": "^4.0.2",
-    "@xyo-network/archivist-model": "^4.0.2",
-    "@xyo-network/chain-api": "^1.6.5",
-    "@xyo-network/chain-modules": "^1.6.5",
-    "@xyo-network/chain-orchestration": "^1.6.5",
-    "@xyo-network/chain-protocol": "^1.6.5",
-    "@xyo-network/chain-sdk": "^1.6.5",
-    "@xyo-network/chain-services": "^1.6.5",
-    "@xyo-network/chain-telemetry": "^1.6.5",
-    "@xyo-network/chain-utils": "^1.6.5",
-    "@xyo-network/chain-validation": "^1.6.5",
-    "@xyo-network/payload-builder": "^4.0.2",
-    "@xyo-network/payload-model": "^4.0.2",
-    "@xyo-network/wallet": "^4.0.2",
-    "@xyo-network/wallet-model": "^4.0.2",
-    "@xyo-network/xl1-protocol": "^1.6.1",
-    "@xyo-network/xl1-protocol-sdk": "^1.6.5",
+    "@xylabs/typeof": "^4.13.5",
+    "@xylabs/vitest-extended": "^4.13.5",
+    "@xyo-network/archivist-lmdb": "^4.0.3",
+    "@xyo-network/archivist-memory": "^4.0.3",
+    "@xyo-network/archivist-model": "^4.0.3",
+    "@xyo-network/chain-api": "^1.6.7",
+    "@xyo-network/chain-modules": "^1.6.6",
+    "@xyo-network/chain-orchestration": "^1.6.6",
+    "@xyo-network/chain-protocol": "^1.6.6",
+    "@xyo-network/chain-sdk": "^1.6.6",
+    "@xyo-network/chain-services": "^1.6.6",
+    "@xyo-network/chain-telemetry": "^1.6.6",
+    "@xyo-network/chain-utils": "^1.6.6",
+    "@xyo-network/chain-validation": "^1.6.6",
+    "@xyo-network/payload-builder": "^4.0.3",
+    "@xyo-network/payload-model": "^4.0.3",
+    "@xyo-network/wallet": "^4.0.3",
+    "@xyo-network/wallet-model": "^4.0.3",
+    "@xyo-network/xl1-protocol": "^1.6.2",
+    "@xyo-network/xl1-protocol-sdk": "^1.6.6",
     "async-mutex": "^0.5.0",
     "dotenv": "^17.2.0",
     "ethers": "^6.15.0",

package/src/commands/api/runApi.ts

@@ -1,7 +1,11 @@
+import type { Logger } from '@xylabs/logger'
 import { getServer } from '@xyo-network/chain-api'
-import { config } from 'dotenv'
 
-export function runApi() {
-  config()
-  void getServer()
+interface RunApiContext {
+  logger?: Logger
+}
+
+export function runApi(context: RunApiContext) {
+  const { logger } = context
+  void getServer(undefined, undefined, logger)
 }

package/src/commands/producer/runProducer.ts

@@ -1,20 +1,28 @@
+import type { Logger } from '@xylabs/logger'
+
 import type { Orchestrator } from '../../orchestration/index.ts'
 import {
   BalanceActor, ChainHeadUpdateActor, initServices, ProducerActor,
 } from '../../orchestration/index.ts'
 
-export const runProducer = async (orchestrator: Orchestrator) => {
+interface RunProducerContext {
+  logger: Logger
+  orchestrator: Orchestrator
+}
+
+export const runProducer = async (context: RunProducerContext) => {
+  const { logger, orchestrator } = context
+
   // Initialize services
-  console.log('Services: Initializing...')
-  const services = await initServices()
-  console.log('Services: Initialized')
+  logger?.log('Services: Initializing...')
+  const services = await initServices(logger)
+  logger?.log('Services: Initialized')
 
   // Create actors
   const chainHeadUpdate = await ChainHeadUpdateActor.create(services)
   const producer = await ProducerActor.create(services)
   const balances = await BalanceActor.create(services)
   const actors = [chainHeadUpdate, producer, balances]
-  // const actors = [chainHeadUpdate, producer]
 
   for (const actor of actors) {
   // Register the actor with the orchestrator

package/src/commands/validator/runValidator.ts

@@ -1,7 +1,16 @@
+import type { Logger } from '@xylabs/logger'
+
 import type { Orchestrator } from '../../orchestration/index.ts'
 import { Actor } from '../../orchestration/index.ts'
 
-export const runValidator = async (orchestrator: Orchestrator) => {
+interface RunValidatorContext {
+  logger: Logger
+  orchestrator: Orchestrator
+}
+
+export const runValidator = async (context: RunValidatorContext) => {
+  const { orchestrator } = context
+
   // Create a single actor
   const myActor = new Actor('Validator', 'Validator', {})
 

package/src/initEnv.ts

@@ -1,7 +1,7 @@
 import dotenv from 'dotenv'
 
 export const initEnv = () => {
-  dotenv.config()
+  dotenv.config({ quiet: true })
   if (process.env.ENV_FILE !== undefined) {
     dotenv.config({ path: process.env.ENV_FILE, override: true })
   }

package/src/initLogger.ts

@@ -0,0 +1,15 @@
+import { Base } from '@xylabs/base'
+import type { Logger } from '@xylabs/logger'
+import { ConsoleLogger, LogLevel } from '@xylabs/logger'
+import { isDefined } from '@xylabs/typeof'
+
+export const initLogger = (): Logger => {
+  let level: LogLevel = LogLevel.info
+  if (isDefined(process.env.LOG_LEVEL)) {
+    const parsed = LogLevel[process.env.LOG_LEVEL.toLowerCase() as keyof typeof LogLevel]
+    if (isDefined(parsed)) level = parsed
+  }
+  const logger = new ConsoleLogger(level)
+  Base.defaultLogger = logger
+  return logger
+}

package/src/orchestration/actor/implementation/ChainHeadUpdateActor.ts

@@ -2,6 +2,7 @@ import { filterAs } from '@xylabs/array'
 import { assertEx } from '@xylabs/assert'
 import type { BaseParams } from '@xylabs/base'
 import { toHex } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
 import { findMostRecentBlock, sortBlocks } from '@xyo-network/chain-protocol'
 import type { Payload } from '@xyo-network/payload-model'
 import type { BlockBoundWitness } from '@xyo-network/xl1-protocol'
@@ -25,8 +26,7 @@ export class ChainHeadUpdateActor extends Actor<ChainHeadUpdateActorParams> {
     return assertEx(this.params.chainIterator, () => 'chainIterator not set')
   }
 
-  static async create(params: ChainHeadUpdateActorParams): Promise<ChainHeadUpdateActor> {
-    await Promise.resolve()
+  static create(params: ChainHeadUpdateActorParams): Promisable<ChainHeadUpdateActor> {
     return new ChainHeadUpdateActor(params)
   }
 

package/src/orchestration/actor/implementation/ProducerActor.ts

@@ -1,6 +1,7 @@
 import { assertEx } from '@xylabs/assert'
 import type { BaseParams } from '@xylabs/base'
 import { toHex } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
 import { isDefined, isUndefined } from '@xylabs/typeof'
 import { createDeclarationIntent } from '@xyo-network/chain-protocol'
 import { BaseBlockProducerService } from '@xyo-network/chain-services'
@@ -39,7 +40,7 @@ export class ProducerActor extends Actor<ProducerActorParams> {
   protected _lastRedeclarationIntent: ChainStakeIntent | undefined
 
   protected constructor(params: ProducerActorParams) {
-    super(assertEx(params.producer?.address, () => 'Missing producer in params'), 'Producer', params)
+    super(params.producer.address, 'Producer', params)
   }
 
   protected get account() {
@@ -74,8 +75,7 @@ export class ProducerActor extends Actor<ProducerActorParams> {
     return assertEx(this.params.stakeIntentService, () => 'stakeIntentService not set')
   }
 
-  static async create(params: ProducerActorParams): Promise<ProducerActor> {
-    await Promise.resolve()
+  static create(params: ProducerActorParams): Promisable<ProducerActor> {
     return new ProducerActor(params)
   }
 

package/src/orchestration/actor/model/Actor.ts

@@ -1,6 +1,5 @@
 import type { TracerProvider } from '@opentelemetry/api'
-import type { BaseParams } from '@xylabs/base'
-import { BaseEmitter } from '@xylabs/events'
+import { Base, type BaseParams } from '@xylabs/base'
 import { forget } from '@xylabs/forget'
 import { IdLogger } from '@xylabs/logger'
 import type { Promisable } from '@xylabs/promise'
@@ -15,14 +14,14 @@ export type ActorParams = BaseParams<{
   traceProvider?: TracerProvider
 }>
 
-export class Actor<TParams extends ActorParams = ActorParams> extends BaseEmitter<TParams> implements IActor {
+export class Actor<TParams extends ActorParams = ActorParams> extends Base<TParams> implements IActor {
   protected readonly _timers: Map<string, ReturnType<typeof setTimeout>> = new Map()
   private _active = false
   private readonly _displayName: string
   private readonly _id: string
 
   constructor(id: string, displayName: string = 'Actor', params: TParams) {
-    const logger = params.logger ?? new IdLogger(console, () => `[${displayName} (${id})] `)
+    const logger = params.logger ?? new IdLogger(Base.defaultLogger ?? console, () => `[${displayName} (${id})] `)
     super({ ...params, logger })
     this._displayName = displayName
     this._id = id

package/src/orchestration/actor/model/Orchestrator.ts

@@ -1,15 +1,21 @@
+import type { Logger } from '@xylabs/logger'
+
+import type { IActor } from './Actor.ts'
+
 export interface IOrchestrator {
   start(): Promise<void>
   stop(): Promise<void>
 }
 
-import type { IActor } from './Actor.ts'
-
-// TODO: Inject logger
 export class Orchestrator implements IOrchestrator {
-  private actors: IActor[] = []
-  private keepAliveHandle: NodeJS.Timeout | null = null
-  private running = false
+  protected actors: IActor[] = []
+  protected keepAliveHandle: NodeJS.Timeout | null = null
+  protected readonly logger?: Logger
+  protected running = false
+
+  constructor(logger?: Logger) {
+    this.logger = logger
+  }
 
   /**
    * Registers an actor.
@@ -29,11 +35,11 @@ export class Orchestrator implements IOrchestrator {
   async start() {
     await Promise.resolve()
     if (this.running) {
-      console.log('[Orchestrator] Already started.')
+      this.logger?.warn('[Orchestrator] Already started.')
       return
     }
 
-    console.log('[Orchestrator] Starting...')
+    this.logger?.log('[Orchestrator] Starting...')
     this.running = true
     for (const actor of this.actors) {
       await actor.start()
@@ -50,16 +56,16 @@ export class Orchestrator implements IOrchestrator {
   async stop() {
     await Promise.resolve()
     if (!this.running) {
-      console.log('[Orchestrator] Already stopped.')
+      this.logger?.log('[Orchestrator] Already stopped.')
       return
     }
 
-    console.log('[Orchestrator] Stopping...')
+    this.logger?.log('[Orchestrator] Stopping...')
     for (const actor of this.actors) {
       await actor.stop()
     }
     this.running = false
     if (this.keepAliveHandle) clearInterval(this.keepAliveHandle)
-    console.log('[Orchestrator] Stopped...')
+    this.logger?.log('[Orchestrator] Stopped...')
   }
 }

package/src/orchestration/archivists/StakeIntentState/local.ts

@@ -11,9 +11,7 @@ let singleton: ArchivistInstance | undefined
 export const initLocalStakeIntentStateArchivist: Initializable<void, ArchivistInstance> = async (): Promise<ArchivistInstance> => {
   return await mutex.runExclusive(async () => {
     if (singleton) return singleton
-    console.log('[InitServices:LocalStakeIntentStateArchivist:Initializing]')
     singleton = await getLocalPersistentArchivist('stakeIntent', 'state')
-    console.log('[InitServices:LocalStakeIntentStateArchivist:Initialized]')
     return assertEx(singleton, () => new Error('Failed to initialize stake intent state archivist'))
   })
 }

package/src/orchestration/initServices.ts

@@ -1,12 +1,9 @@
 import { assertEx } from '@xylabs/assert'
-import { Base } from '@xylabs/base'
 import { asAddress } from '@xylabs/hex'
 import type { Logger } from '@xylabs/logger'
 import { isDefined } from '@xylabs/typeof'
 import { balanceSummaryRepositoryFromMap } from '@xyo-network/chain-modules'
-import type {
-  BaseBlockProducerServiceParams, BaseService, XyoValidatorParams,
-} from '@xyo-network/chain-services'
+import type { BaseBlockProducerServiceParams, XyoValidatorParams } from '@xyo-network/chain-services'
 import { initTelemetry } from '@xyo-network/chain-telemetry'
 import { startupSpanAsync } from '@xyo-network/chain-utils'
 import { validateHydratedBlockState } from '@xyo-network/chain-validation'
@@ -43,15 +40,13 @@ const isStartable = (value: unknown): value is Startable => {
   return isDefined((value as Startable).start) && typeof (value as Startable).start === 'function'
 }
 
-export const initServices = async (logger?: Logger): Promise<ChainServiceCollectionV2> => {
-  Base.defaultLogger = logger ?? console
-
-  const statusReporter = new RuntimeStatusMonitor(logger ?? console)
+export const initServices = async (logger: Logger): Promise<ChainServiceCollectionV2> => {
+  const statusReporter = new RuntimeStatusMonitor(logger)
   statusReporter.onGlobalTransition({ to: 'started' }, () => {
-    Base.defaultLogger?.log('All services started.')
+    logger.log('All services started.')
   })
   statusReporter.onGlobalTransition({ to: 'error' }, () => {
-    Base.defaultLogger?.error('Producer encountered an unhandled error!')
+    logger.error('Producer encountered an unhandled error!')
     // eslint-disable-next-line unicorn/no-process-exit
     process.exit(1)
   })
@@ -166,7 +161,6 @@ export const initServices = async (logger?: Logger): Promise<ChainServiceCollect
       chainArchivist,
       chainIterator,
       chainStakeViewer,
-      logger: console,
       stakeIntentStateArchivist,
       traceProvider,
       statusReporter,
@@ -229,7 +223,7 @@ export const initServices = async (logger?: Logger): Promise<ChainServiceCollect
     stakeIntentService,
   }
 
-  Base.defaultLogger?.log('All services created. Starting...')
+  logger?.log('All services created. Starting...')
   const startableServices = [balanceSummaryMap, ...Object.values(result)].filter(isStartable)
   // Start all services that have a start method
   await Promise.all(startableServices.map(service => service.start()))

package/src/runCLI.ts

@@ -1,5 +1,6 @@
 import net from 'node:net'
 
+import type { Logger } from '@xylabs/logger'
 import yargs from 'yargs'
 import { hideBin } from 'yargs/helpers'
 
@@ -33,21 +34,23 @@ function waitForPort(host: string, port: number): Promise<void> {
   })
 }
 
+interface RunCliContext {
+  logger: Logger
+  orchestrator: Orchestrator
+}
+
 // Main entry point
-export async function runCLI(orchestrator: Orchestrator) {
+export async function runCLI(context: RunCliContext) {
   async function validateTransaction() {
-    console.log('Validating transaction...')
-    await Promise.resolve()
+    await Promise.reject('Not implemented yet')
   }
 
   async function submitTransaction() {
-    console.log('Submitting transaction...')
-    await Promise.resolve()
+    await Promise.reject('Not implemented yet')
   }
 
   async function checkBalance() {
-    console.log('Checking account balance...')
-    await Promise.resolve()
+    await Promise.reject('Not implemented yet')
   }
 
   // Parse command-line arguments using Yargs
@@ -57,11 +60,11 @@ export async function runCLI(orchestrator: Orchestrator) {
     .command('validator', 'Run the XL1 validator', (yargs) => {
       return yargs
       // Default command is to run
-        .command('$0', 'Run as a XL1 validator node', () => {}, () => runValidator(orchestrator))
+        .command('$0', 'Run as a XL1 validator node', () => {}, () => runValidator(context))
     })
     .command('producer', 'Run the XL1 producer', (yargs) => {
       return yargs
-        .command('$0', 'Run as a XL1 producer node', () => {}, () => runProducer(orchestrator))
+        .command('$0', 'Run as a XL1 producer node', () => {}, () => runProducer(context))
     })
     .command('client', 'Client-related operations', (yargs) => {
       return yargs
@@ -73,15 +76,15 @@ export async function runCLI(orchestrator: Orchestrator) {
     })
     .command('api', 'Run as a api node', (yargs) => {
       return yargs
-        .command('$0', 'Run as a api node', () => {}, () => runApi())
-        .command('run', 'Run as a api node', () => {}, () => runApi())
+        .command('$0', 'Run as a api node', () => {}, () => runApi(context))
+        .command('run', 'Run as a api node', () => {}, () => runApi(context))
     })
     .command('$0', 'Run a full XL1 deployment', (yargs) => {
       return yargs
         .command('$0', 'Start the API and a producer', () => {}, async () => {
-          runApi()
+          runApi(context)
           await waitForPort('localhost', 8080)
-          await runProducer(orchestrator)
+          await runProducer(context)
         })
     })
     .command('account', 'Account-related operations', (yargs) => {

package/src/start.ts

@@ -1,26 +1,28 @@
 import { initEnv } from './initEnv.ts'
+import { initLogger } from './initLogger.ts'
 import { Orchestrator } from './orchestration/index.ts'
 import { runCLI } from './runCLI.ts'
 
 export const start = async () => {
   initEnv()
-  const orchestrator = new Orchestrator()
+  const logger = initLogger()
+  const orchestrator = new Orchestrator(logger)
 
   // Handle cancellation (Ctrl+C)
   process.on('SIGINT', () => {
     void (async () => {
       try {
-        console.log('\nSIGINT received. Attempting graceful shutdown...')
+        logger.log('\nSIGINT received. Attempting graceful shutdown...')
         await orchestrator?.stop()
-        console.log('Orchestrator stopped, exiting now.')
+        logger.log('Orchestrator stopped, exiting now.')
         process.exit(0)
       } catch (err) {
-        console.error('Error stopping orchestrator:', err)
+        logger.error('Error stopping orchestrator:', err)
         process.exit(1)
       }
     })()
   })
 
   // Execute the CLI logic
-  await runCLI(orchestrator)
+  await runCLI({ logger, orchestrator })
 }