@xyo-network/xl1-cli-lib 1.7.10 → 1.7.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/xl1-cli-lib",
-  "version": "1.7.10",
+  "version": "1.7.12",
   "description": "XYO Layer One CLI Library",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -40,35 +40,37 @@
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@xylabs/array": "^4.13.21",
-    "@xylabs/assert": "^4.13.21",
-    "@xylabs/base": "^4.13.21",
-    "@xylabs/creatable": "^4.13.21",
-    "@xylabs/delay": "^4.13.21",
-    "@xylabs/forget": "^4.13.21",
-    "@xylabs/hex": "^4.13.21",
-    "@xylabs/logger": "^4.13.21",
-    "@xylabs/promise": "^4.13.21",
-    "@xylabs/telemetry": "^4.13.21",
-    "@xylabs/typeof": "^4.13.21",
-    "@xyo-network/archivist-lmdb": "^4.1.6",
-    "@xyo-network/archivist-memory": "^4.1.6",
-    "@xyo-network/archivist-model": "^4.1.6",
-    "@xyo-network/chain-api": "^1.7.10",
-    "@xyo-network/chain-modules": "^1.7.10",
-    "@xyo-network/chain-orchestration": "^1.7.10",
-    "@xyo-network/chain-protocol": "^1.7.10",
-    "@xyo-network/chain-services": "^1.7.10",
-    "@xyo-network/chain-telemetry": "^1.7.10",
-    "@xyo-network/chain-utils": "^1.7.10",
-    "@xyo-network/chain-validation": "^1.7.10",
-    "@xyo-network/payload-builder": "^4.1.6",
-    "@xyo-network/payload-model": "^4.1.6",
-    "@xyo-network/wallet": "^4.1.6",
-    "@xyo-network/wallet-model": "^4.1.6",
-    "@xyo-network/xl1-protocol": "^1.7.10",
-    "@xyo-network/xl1-protocol-sdk": "^1.7.10",
+    "@xylabs/array": "^4.13.23",
+    "@xylabs/assert": "^4.13.23",
+    "@xylabs/base": "^4.13.23",
+    "@xylabs/creatable": "^4.13.23",
+    "@xylabs/delay": "^4.13.23",
+    "@xylabs/forget": "^4.13.23",
+    "@xylabs/hex": "^4.13.23",
+    "@xylabs/logger": "^4.13.23",
+    "@xylabs/object": "^4.13.23",
+    "@xylabs/promise": "^4.13.23",
+    "@xylabs/telemetry": "^4.13.23",
+    "@xylabs/typeof": "^4.13.23",
+    "@xyo-network/archivist-lmdb": "^4.1.7",
+    "@xyo-network/archivist-memory": "^4.1.7",
+    "@xyo-network/archivist-model": "^4.1.7",
+    "@xyo-network/chain-api": "^1.7.12",
+    "@xyo-network/chain-modules": "^1.7.12",
+    "@xyo-network/chain-orchestration": "^1.7.12",
+    "@xyo-network/chain-protocol": "^1.7.12",
+    "@xyo-network/chain-services": "^1.7.12",
+    "@xyo-network/chain-telemetry": "^1.7.12",
+    "@xyo-network/chain-utils": "^1.7.12",
+    "@xyo-network/chain-validation": "^1.7.12",
+    "@xyo-network/payload-builder": "^4.1.7",
+    "@xyo-network/payload-model": "^4.1.7",
+    "@xyo-network/wallet": "^4.1.7",
+    "@xyo-network/wallet-model": "^4.1.7",
+    "@xyo-network/xl1-protocol": "^1.7.19",
+    "@xyo-network/xl1-protocol-sdk": "^1.7.12",
     "async-mutex": "^0.5.0",
+    "cosmiconfig": "^9.0.0",
     "dotenv": "^17.2.0",
     "ethers": "^6.15.0",
     "lmdb": "^3.4.1",
@@ -76,10 +78,10 @@
     "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0",
-    "@xylabs/tsconfig": "^7.0.0",
-    "@xylabs/vitest-extended": "^4.13.21",
-    "@xyo-network/chain-sdk": "^1.7.10",
+    "@xylabs/ts-scripts-yarn3": "^7.0.1",
+    "@xylabs/tsconfig": "^7.0.1",
+    "@xylabs/vitest-extended": "^4.13.23",
+    "@xyo-network/chain-sdk": "^1.7.12",
     "nodemon": "^3.1.10",
     "rimraf": "^6.0.1",
     "typescript": "^5.8.3",

package/src/orchestration/services/implementation/account.ts

@@ -14,7 +14,11 @@ export const initAccount: Initializable<InitializableParams<{ config: Config }>,
   if (isUndefined(walletPhrase)) {
     logger?.warn('[Producer] No wallet mnemonic specified!')
     const randomMnemonic = HDWallet.generateMnemonic()
-    logger?.warn(`[Producer] Using randomly generated mnemonic: ${randomMnemonic}`)
+    logger?.warn(`[Producer] Using randomly generated mnemonic:
+    
+${randomMnemonic}
+      
+    `)
     walletPhrase = randomMnemonic
   }
   const wallet = await generateXyoBaseWalletFromPhrase(walletPhrase)

package/src/runCLI.ts

@@ -1,4 +1,5 @@
 import type { Logger } from '@xylabs/logger'
+import { deepMerge } from '@xylabs/object'
 import { isDefined } from '@xylabs/typeof'
 import { type Config, ConfigSchema } from '@xyo-network/xl1-protocol-sdk'
 import type { Argv } from 'yargs'
@@ -11,6 +12,7 @@ import { XL1LogoColorizedAscii } from './images.ts'
 import { initLogger } from './initLogger.ts'
 import { optionsFromZodSchema } from './optionsFromZodSchema.ts'
 import { Orchestrator } from './orchestration/index.ts'
+import { tryParseConfig } from './tryParseConfig.ts'
 import { waitForHostPort } from './waitForHostPort.ts'
 
 /** Version string injected by Rollup at build time. */
@@ -62,15 +64,27 @@ Run various components of the XL1 ecosystem.
 
 Usage:
 $0 <command> [options]`)
-    .parserConfiguration({ 'dot-notation': true }) // foo.bar → { foo: { bar } }
+    .parserConfiguration({
+      'dot-notation': true, // foo.bar → { foo: { bar } }
+      'populate--': true, // Populate -- with all options so we can detected user-supplied vs defaults
+    })
     .env('XL1')
     .scriptName('xl1')
-    .config()
     .version(version)
     .middleware((argv) => {
       try {
-        // Parse and validate the config
-        config = ConfigSchema.parse(argv)
+        // Parse the various config sources
+        const parsedConfigFile = tryParseConfig() // Config file
+        const parsedConfigArgs = argv // Command-line arguments & ENV VARs
+        // Deep merge with precedence
+        // TODO: Would like precedence to be defaults < file < ENV < CLI Args
+        // but there is currently no way to determine which are defaults vs
+        // user-supplied CLI Args since we set the CLI args to the defaults
+        // and receive a flattened object. We might need to manually invoke
+        // the parser without the defaults to achieve this.
+        const mergedConfig = deepMerge(parsedConfigArgs, parsedConfigFile)
+        // Validate the merged configuration
+        config = ConfigSchema.parse(mergedConfig)
       } catch (err) {
         if (err instanceof ZodError) {
           for (const issue of err.errors) {

package/src/tryParseConfig.ts

@@ -0,0 +1,41 @@
+import { isDefined, isNull } from '@xylabs/typeof'
+import { cosmiconfigSync, defaultLoaders } from 'cosmiconfig'
+
+/**
+ * The name of the configuration file to search for.
+ */
+const configName = 'xyo'
+
+/**
+ * The name of the section within the configuration file to parse.
+ */
+const configSection = 'xl1' // Default section in the config file
+
+/**
+ * Attempts to parse the configuration from a file using cosmiconfig.
+ * @returns The parsed configuration object if found and valid, otherwise undefined.
+ */
+export const tryParseConfig = (): Record<string, unknown> => {
+  const explorer = cosmiconfigSync(
+    configName,
+    /* {
+      searchPlaces: [
+        'package.json', // Looks under `xyo` key in package.json
+        '.xyorc.json', // Supports common dotfile format
+        'xyo.config.json', // Supports custom-named config file
+      ],
+      loaders: {
+        '.json': defaultLoaders['.json'],
+        'noExt': defaultLoaders['.json'],
+      },
+    }, */
+  )
+  const result = explorer.search()
+  if (!isNull(result)) {
+    const section = result?.config?.[configSection]
+    if (isDefined(section) && typeof section === 'object') {
+      return section
+    }
+  }
+  return {}
+}

package/dist/node/initConfig.d.ts

@@ -1,3 +0,0 @@
-import { type Config as Config } from '@xyo-network/xl1-protocol-sdk';
-export declare const initConfig: () => Config;
-//# sourceMappingURL=initConfig.d.ts.map

package/dist/node/initConfig.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"initConfig.d.ts","sourceRoot":"","sources":["../../src/initConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,IAAI,MAAM,EAAgB,MAAM,+BAA+B,CAAA;AAEnF,eAAO,MAAM,UAAU,QAAO,MAG7B,CAAA"}

package/src/initConfig.ts

@@ -1,6 +0,0 @@
-import { type Config as Config, ConfigSchema } from '@xyo-network/xl1-protocol-sdk'
-
-export const initConfig = (): Config => {
-  const config: Config = ConfigSchema.parse({})
-  return config
-}