@xyo-network/os-runtime 3.0.18 → 3.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/os-runtime",
-  "version": "3.0.18",
+  "version": "3.1.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,6 +21,10 @@
   "type": "module",
   "exports": {
     ".": {
+      "node": {
+        "types": "./dist/node/index.d.ts",
+        "default": "./dist/node/index.mjs"
+      },
       "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
@@ -28,53 +32,63 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "bin": {
+    "xyos": "./dist/node/scripts/xyos/index.mjs"
+  },
   "dependencies": {
-    "@xylabs/assert": "^4.0.3",
-    "@xylabs/forget": "^4.0.3",
-    "@xylabs/hex": "^4.0.3",
-    "@xylabs/lodash": "^4.0.3",
-    "@xylabs/object": "^4.0.3",
-    "@xylabs/promise": "^4.0.3",
-    "@xyo-network/account": "^3.0.7",
-    "@xyo-network/archivist": "^3.0.7",
-    "@xyo-network/archivist-indexeddb": "^3.0.7",
-    "@xyo-network/archivist-model": "^3.0.7",
-    "@xyo-network/bios": "^3.0.18",
-    "@xyo-network/bridge-model": "^3.0.7",
-    "@xyo-network/diviner-abstract": "^3.0.7",
-    "@xyo-network/diviner-model": "^3.0.7",
-    "@xyo-network/diviner-payload-generic": "^3.0.7",
-    "@xyo-network/diviner-payload-indexeddb": "^3.0.7",
-    "@xyo-network/diviner-payload-model": "^3.0.7",
-    "@xyo-network/diviner-temporal-indexing-model": "^3.0.7",
-    "@xyo-network/kernel": "^3.0.18",
-    "@xyo-network/kernel-model": "^3.0.18",
-    "@xyo-network/manifest": "^3.0.7",
-    "@xyo-network/manifest-wrapper": "^3.0.7",
-    "@xyo-network/module-abstract": "^3.0.7",
-    "@xyo-network/module-events": "^3.0.7",
-    "@xyo-network/module-factory-locator": "^3.0.7",
-    "@xyo-network/module-model": "^3.0.7",
-    "@xyo-network/module-resolver": "^3.0.7",
-    "@xyo-network/node-model": "^3.0.7",
-    "@xyo-network/os-model": "^3.0.18",
-    "@xyo-network/payload-builder": "^3.0.7",
-    "@xyo-network/payload-model": "^3.0.7",
-    "@xyo-network/storage-model": "^3.0.18",
-    "@xyo-network/wallet-model": "^3.0.7",
+    "@xylabs/assert": "^4.0.9",
+    "@xylabs/forget": "^4.0.9",
+    "@xylabs/hex": "^4.0.9",
+    "@xylabs/lodash": "^4.0.9",
+    "@xylabs/object": "^4.0.9",
+    "@xylabs/promise": "^4.0.9",
+    "@xyo-network/account": "^3.1.6",
+    "@xyo-network/archivist": "^3.1.6",
+    "@xyo-network/archivist-indexeddb": "^3.1.6",
+    "@xyo-network/archivist-model": "^3.1.6",
+    "@xyo-network/bios": "^3.1.1",
+    "@xyo-network/bridge-model": "^3.1.6",
+    "@xyo-network/diviner-abstract": "^3.1.6",
+    "@xyo-network/diviner-model": "^3.1.6",
+    "@xyo-network/diviner-payload-generic": "^3.1.6",
+    "@xyo-network/diviner-payload-indexeddb": "^3.1.6",
+    "@xyo-network/diviner-payload-model": "^3.1.6",
+    "@xyo-network/diviner-temporal-indexing-model": "^3.1.6",
+    "@xyo-network/kernel": "^3.1.1",
+    "@xyo-network/kernel-model": "^3.1.1",
+    "@xyo-network/manifest": "^3.1.6",
+    "@xyo-network/manifest-wrapper": "^3.1.6",
+    "@xyo-network/module-abstract": "^3.1.6",
+    "@xyo-network/module-events": "^3.1.6",
+    "@xyo-network/module-factory-locator": "^3.1.6",
+    "@xyo-network/module-model": "^3.1.6",
+    "@xyo-network/module-resolver": "^3.1.6",
+    "@xyo-network/node-model": "^3.1.6",
+    "@xyo-network/os-model": "^3.1.1",
+    "@xyo-network/payload-builder": "^3.1.6",
+    "@xyo-network/payload-model": "^3.1.6",
+    "@xyo-network/storage-model": "^3.1.1",
+    "@xyo-network/wallet-model": "^3.1.6",
     "async-mutex": "^0.5.0",
+    "chalk": "^5.3.0",
+    "cosmiconfig": "^9.0.0",
+    "cosmiconfig-typescript-loader": "^5.0.0",
     "ethers": "^6.13.2",
     "semver": "^7.6.3",
-    "uuid": "^10.0.0"
+    "terminal-kit": "^3.1.1",
+    "typescript": "^5.5.4",
+    "uuid": "^10.0.0",
+    "yargs": "^17.7.2"
   },
   "devDependencies": {
     "@types/semver": "^7.5.8",
+    "@types/terminal-kit": "^2.5.6",
     "@types/uuid": "^10.0.0",
-    "@xylabs/ts-scripts-yarn3": "^4.0.1",
-    "@xylabs/tsconfig": "^4.0.1",
-    "@xyo-network/bios-model": "^3.0.18",
-    "@xyo-network/bios-nodejs": "^3.0.18",
-    "typescript": "^5.5.4",
+    "@types/yargs": "^17.0.33",
+    "@xylabs/ts-scripts-yarn3": "^4.0.7",
+    "@xylabs/tsconfig": "^4.0.7",
+    "@xyo-network/bios-model": "^3.1.1",
+    "@xyo-network/bios-nodejs": "^3.1.1",
     "vitest": "^2.0.5"
   },
   "publishConfig": {

package/src/XyOs.ts

@@ -47,8 +47,9 @@ export class XyOs extends XyOsContextBase<XyOsParams> implements XyOsContext {
   private stackManager: StackManager
 
   constructor({
+    logger = console,
     eventBus = new EventBus(),
-    kernel = new Kernel(),
+    kernel = new Kernel({ logger }),
     locator = new ModuleFactoryLocator(),
     dappsConfiguration,
     developmentMode,
@@ -111,13 +112,13 @@ export class XyOs extends XyOsContextBase<XyOsParams> implements XyOsContext {
     return result
   }
 
-  override async boot(wallet: WalletInstance, locator = new ModuleFactoryLocator()): Promise<void> {
+  override async boot(wallet: WalletInstance, locator = new ModuleFactoryLocator()) {
     console.warn('XyOs:boot', wallet.address)
     const fullLocator = this._locator.merge(locator)
     return await this._bootMutex.runExclusive(async () => {
       await this.eventBus.start()
       if (this.kernel?.status === 'created') {
-        await this.kernel.boot(await boot(), { locator: fullLocator })
+        await this.kernel.boot(await boot(), { locator: fullLocator, kernelDrivers: [] })
       }
       if (this.kernel?.status !== 'booted') {
         throw new Error('Kernel not booted')
@@ -128,6 +129,7 @@ export class XyOs extends XyOsContextBase<XyOsParams> implements XyOsContext {
 
       this.stackManager.initialize(this)
       if (this.signers) await this.signers.initialize()
+      return this
     })
   }
 

package/src/XyOsBase.ts

@@ -85,7 +85,7 @@ export class XyOsContextBase<TParams extends XyOsContextParams | void = void> ex
     throw new Error('Method not implemented. [user]')
   }
 
-  boot(_wallet: WalletInstance, _locator: ModuleFactoryLocator) {
+  boot(_wallet: WalletInstance, _locator: ModuleFactoryLocator): Promisable<XyOsContext> {
     throw new Error('Method not implemented. [boot]')
   }
 

package/src/XyOsDapp.ts

@@ -61,7 +61,7 @@ export class XyOsDapp extends XyOsContextBase<XyOsDappContextParams> implements
     return this.params.user
   }
 
-  override async boot(wallet: WalletInstance, locator?: ModuleFactoryLocator): Promise<void> {
+  override async boot(wallet: WalletInstance, locator?: ModuleFactoryLocator): Promise<XyOsDappContext> {
     return await this._bootMutex.runExclusive(async () => {
       console.log('XyOsDapp:boot:start', wallet.address, this.dapp.id)
       assertEx(this._root === undefined, () => 'Dapp already booted')
@@ -92,6 +92,7 @@ export class XyOsDapp extends XyOsContextBase<XyOsDappContextParams> implements
 
       this._root = node
       console.log('XyOsDapp:boot:finish', wallet.address, this.dapp.id)
+      return this
     })
   }
 

package/src/classes/node/Creator.ts

@@ -1,7 +1,7 @@
 import { assertEx } from '@xylabs/assert'
 import { asArchivistInstance } from '@xyo-network/archivist-model'
-import type { PackageManifestPayload } from '@xyo-network/manifest'
-import { PackageManifestPayloadSchema } from '@xyo-network/manifest'
+import { replaceManifestTokens } from '@xyo-network/kernel'
+import { DappPackageManifestPayloadSchema } from '@xyo-network/manifest'
 import type { ManifestWrapper } from '@xyo-network/manifest-wrapper'
 import type { ModuleFactoryLocator } from '@xyo-network/module-factory-locator'
 import type { NodeInstance } from '@xyo-network/node-model'
@@ -11,7 +11,7 @@ import type {
 import type { WalletInstance } from '@xyo-network/wallet-model'
 
 import { DappCallerBase } from '../../DappCallerBase.ts'
-import { ReplaceManifestTokens } from '../../manifest/index.ts'
+import { manifestReplacementTokens } from '../../manifest/index.ts'
 import type { DappNodesCreatorParams } from '../lib/index.ts'
 import { DefaultPayloads } from './DefaultPayloads/index.ts'
 import { ExternalModulePermissions } from './ExternalModulePermissions/index.ts'
@@ -70,11 +70,12 @@ export class DappContextCreator {
   private static parseDappPackageManifestPayload(payload: DappPackageManifestPayload, xnsNodeUrl: string | undefined, xnsNetwork: string | undefined) {
     // extract external permissions from package manifest payload
     const { external, ...manifestWithoutExternals } = payload
-    const manifestPayloadRaw: PackageManifestPayload = {
+    const manifestPayloadRaw: DappPackageManifestPayload = {
       ...manifestWithoutExternals,
-      schema: PackageManifestPayloadSchema,
+      schema: DappPackageManifestPayloadSchema,
     }
-    const manifestPayload = ReplaceManifestTokens(manifestPayloadRaw, xnsNodeUrl, xnsNetwork)
+    console.log('DappContextCreator:parseDappPackageManifestPayload', xnsNodeUrl, xnsNetwork)
+    const manifestPayload = replaceManifestTokens(manifestPayloadRaw, manifestReplacementTokens(xnsNodeUrl, xnsNetwork))
     return { external, manifestPayload }
   }
 

package/src/manifest/index.ts

@@ -1,2 +1,2 @@
-export * from './ManifestReplaceableTokens.ts'
+export * from './manifestReplacementTokens.ts'
 export { default as osNodeManifest } from './os-node.manifest.json'

package/src/manifest/manifestReplacementTokens.ts

@@ -0,0 +1,6 @@
+import { getXnsDomain } from '@xyo-network/kernel'
+
+export const manifestReplacementTokens = (
+  xnsNodeUrl: string | undefined,
+  xnsNetwork: string | undefined,
+) => ({ '[REPLACE_WITH_NS_NODE_URL]': getXnsDomain(xnsNodeUrl, xnsNetwork) })

package/src/scripts/xyos/command/config.ts

@@ -0,0 +1,19 @@
+import type { Argv } from 'yargs'
+
+export const commandConfig = (argv: Argv) => {
+  return argv.command('config [action] <target>', 'Create an xyos project', (yargs) => {
+    return yargs
+      .positional('action', {
+        choices: ['create', 'validate', 'display'],
+        description: 'Action to take on config',
+        type: 'string',
+      })
+      .positional('target', {
+        description: 'Location of config file',
+        type: 'string',
+      })
+  }, async ({ action, target }) => {
+    console.log(`Taking action [${action}] on manifest at ${target}`)
+    return await Promise.resolve()
+  })
+}

package/src/scripts/xyos/command/create.ts

@@ -0,0 +1,22 @@
+import type { Argv } from 'yargs'
+
+import type { TemplateName } from '../lib/index.ts'
+import { createFromTemplate } from '../lib/index.ts'
+
+export const commandCreate = (argv: Argv) => {
+  return argv.command('create [template] <target>', 'Create an xyos project', (yargs) => {
+    return yargs
+      .positional('template', {
+        choices: ['react', 'headless', 'dapp', 'diviner', 'witness'] as TemplateName[],
+        description: 'Template to use',
+        type: 'string',
+      })
+      .positional('target', {
+        description: 'Location into which to create the template project',
+        type: 'string',
+      })
+  }, async ({ template, target }) => {
+    console.log(`Using template ${template} at location ${target}`)
+    return await createFromTemplate({ target, template })
+  })
+}

package/src/scripts/xyos/command/index.ts

@@ -0,0 +1,4 @@
+export * from './config.ts'
+export * from './create.ts'
+export * from './manifest.ts'
+export * from './start.ts'

package/src/scripts/xyos/command/manifest.ts

@@ -0,0 +1,19 @@
+import type { Argv } from 'yargs'
+
+export const commandManifest = (argv: Argv) => {
+  return argv.command('manifest [action] <target>', 'Create an xyos project', (yargs) => {
+    return yargs
+      .positional('action', {
+        choices: ['create', 'validate', 'display'],
+        description: 'Action to take on manifest',
+        type: 'string',
+      })
+      .positional('target', {
+        description: 'Location of manifest file',
+        type: 'string',
+      })
+  }, async ({ action, target }) => {
+    console.log(`Taking action [${action}] on manifest at ${target}`)
+    return await Promise.resolve()
+  })
+}

package/src/scripts/xyos/command/start.ts

@@ -0,0 +1,35 @@
+import type { NativeKernelDrivers } from '@xyo-network/kernel-model'
+import type { Argv } from 'yargs'
+
+import { headless } from '../lib/index.ts'
+
+export const commandStart = (argv: Argv) => {
+  return argv.command('start', 'Start xyOS in headless mode', (yargs) => {
+    return yargs
+      .option('config', {
+        alias: 'c',
+        description: 'Config file to use',
+        type: 'string',
+      }).option('manifest', {
+        alias: 'm',
+        description: 'Manifest file to use',
+        type: 'string',
+      }).option('kernelDriver', {
+        alias: 'k',
+        description: 'Kernel driver to load',
+        type: 'string',
+      })
+  }, async ({
+    config, manifest, kernelDriver,
+  }) => {
+    if (config) {
+      console.log(`Using config: ${config}`)
+    }
+    if (config) {
+      console.log(`Using manifest: ${manifest}`)
+    }
+    await headless({
+      manifest, config, kernelDrivers: kernelDriver ? [kernelDriver as NativeKernelDrivers] : [],
+    })
+  })
+}

package/src/scripts/xyos/index.ts

@@ -0,0 +1,32 @@
+import { default as yargs } from 'yargs'
+// eslint-disable-next-line import-x/no-internal-modules
+import { hideBin } from 'yargs/helpers'
+
+import {
+  commandConfig, commandCreate, commandManifest, commandStart,
+} from './command/index.ts'
+
+(
+  (
+    commandManifest(
+      commandConfig(
+        commandCreate(
+          commandStart(
+            yargs(
+              hideBin(
+                process.argv,
+              ),
+            ),
+          ),
+        ),
+      ),
+    )
+      .usage('Usage: $0 <command> [options]')
+      .scriptName('xyos')
+      .demandCommand(1)
+      .parse()
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ) as Promise<any>
+).catch(
+  console.error,
+)

package/src/scripts/xyos/lib/createFromTemplate.ts

@@ -0,0 +1,11 @@
+export type TemplateName = 'react' | 'headless' | 'dapp' | 'diviner' | 'witness'
+
+export interface CreateFromTemplateParams {
+  target?: string
+  template?: TemplateName
+}
+
+export const createFromTemplate = async ({ target, template }: CreateFromTemplateParams) => {
+  console.log('Creating from template', template, 'at', target)
+  return await Promise.resolve()
+}

package/src/scripts/xyos/lib/headless.ts

@@ -0,0 +1,68 @@
+import fs from 'node:fs'
+
+import { HDWallet } from '@xyo-network/account'
+import { boot } from '@xyo-network/bios'
+import { Kernel } from '@xyo-network/kernel'
+import type { NativeKernelDrivers } from '@xyo-network/kernel-model'
+import type { PackageManifest } from '@xyo-network/manifest'
+import chalk from 'chalk'
+import { cosmiconfig } from 'cosmiconfig'
+import { TypeScriptLoader } from 'cosmiconfig-typescript-loader'
+import { default as tk } from 'terminal-kit'
+
+const { terminal } = tk
+
+import { XyOs } from '../../../XyOs.ts'
+
+const terminate = () => {
+  terminal.grabInput(false)
+  setTimeout(function () {
+    // eslint-disable-next-line unicorn/no-process-exit
+    process.exit(0)
+  }, 100)
+}
+
+interface XyOsConfig {
+  developmentMode?: boolean
+  manifest?: string | PackageManifest
+}
+
+export interface HeadlessParams {
+  config?: string
+  kernelDrivers?: NativeKernelDrivers[]
+  manifest?: string
+}
+
+export const headless = async ({
+  manifest, config, kernelDrivers,
+}: HeadlessParams = {}) => {
+  console.log(chalk.green('Starting Headless xyOS...'))
+  const configExplorer = cosmiconfig('xyos', { cache: true, loaders: { '.ts': TypeScriptLoader() } })
+  const configResult = await (config ? configExplorer.load(config) : configExplorer.search())
+  const xyosConfig: XyOsConfig = (configResult?.config ?? {}) as XyOsConfig
+  const manifestToLoad: string | undefined = manifest ?? (typeof xyosConfig.manifest === 'string' ? xyosConfig.manifest : undefined)
+  const manifestObject: PackageManifest | undefined = manifestToLoad
+    ? JSON.parse(fs.readFileSync(manifestToLoad, 'utf8')) as PackageManifest
+    : typeof xyosConfig.manifest === 'object' ? xyosConfig.manifest : undefined
+
+  const osWallet = await HDWallet.random()
+  const kernel = new Kernel({ logColor: 'cyan', logger: console })
+  await kernel.boot(await boot(), { kernelDrivers })
+  const xyOs = new XyOs({
+    kernel,
+    stackMap: {},
+    manifest: manifestObject,
+    developmentMode: xyosConfig.developmentMode,
+  })
+  await xyOs.boot(osWallet)
+  console.log(chalk.green('Started Headless xyOS...'))
+
+  terminal.grabInput({ mouse: 'button' })
+
+  terminal.on('key', function (name: string) {
+    console.log("'key' event:", name)
+    if (name === 'CTRL_C') {
+      terminate()
+    }
+  })
+}

package/src/scripts/xyos/lib/index.ts

@@ -0,0 +1,2 @@
+export * from './createFromTemplate.ts'
+export * from './headless.ts'

package/src/stack/Base.ts

@@ -1,6 +1,7 @@
 import { assertEx } from '@xylabs/assert'
 import { forget } from '@xylabs/forget'
 import type { BaseParams } from '@xylabs/object'
+import type { Promisable } from '@xylabs/promise'
 import { BaseEmitter } from '@xyo-network/module-abstract'
 import type { ModuleIdentifier } from '@xyo-network/module-model'
 import { isModuleInstance } from '@xyo-network/module-model'
@@ -39,7 +40,7 @@ export class StackBase extends BaseEmitter<BaseParams, StackBaseEvents> implemen
     adapter: NodeAdapter
     eventName: string
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    listener: (args: any) => void
+    listener: (args: any) => Promisable<void>
   }[] = []
 
   constructor(context: XyOsContext, adapterSet: AdapterSetCreator, stackNodeModuleId: ModuleIdentifier) {

package/xy.config.ts

@@ -2,8 +2,8 @@ import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
 const config: XyTsupConfig = {
   compile: {
     browser: {},
-    node: {},
-    neutral: { src: true },
+    node: { src: { entry: ['./src/index.ts', './src/scripts/**/index.ts'] } },
+    neutral: { src: { entry: ['./src/index.ts'] } },
   },
 }
 

package/dist/neutral/manifest/ManifestReplaceableTokens.d.ts

@@ -1,6 +0,0 @@
-import type { Payload } from '@xyo-network/payload-model';
-export declare const ManifestReplaceableTokens: (xnsNodeUrl: string | undefined, xnsNetwork: string | undefined) => {
-    '[REPLACE_WITH_NS_NODE_URL]': string;
-};
-export declare const ReplaceManifestTokens: (manifest: Payload, xnsNodeUrl: string | undefined, xnsNetwork: string | undefined) => any;
-//# sourceMappingURL=ManifestReplaceableTokens.d.ts.map

package/dist/neutral/manifest/ManifestReplaceableTokens.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ManifestReplaceableTokens.d.ts","sourceRoot":"","sources":["../../../src/manifest/ManifestReplaceableTokens.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEzD,eAAO,MAAM,yBAAyB,eACxB,MAAM,GAAG,SAAS,cAClB,MAAM,GAAG,SAAS;;CAC6C,CAAA;AAE7E,eAAO,MAAM,qBAAqB,aAAc,OAAO,cAAc,MAAM,GAAG,SAAS,cAAc,MAAM,GAAG,SAAS,QAStH,CAAA"}

package/src/manifest/ManifestReplaceableTokens.ts

@@ -1,18 +0,0 @@
-import { getXnsDomain } from '@xyo-network/kernel'
-import type { Payload } from '@xyo-network/payload-model'
-
-export const ManifestReplaceableTokens = (
-  xnsNodeUrl: string | undefined,
-  xnsNetwork: string | undefined,
-) => ({ '[REPLACE_WITH_NS_NODE_URL]': getXnsDomain(xnsNodeUrl, xnsNetwork) })
-
-export const ReplaceManifestTokens = (manifest: Payload, xnsNodeUrl: string | undefined, xnsNetwork: string | undefined) => {
-  // Replace ReplaceableTokens in the manifest
-  let stringifiedManifestReplaced = JSON.stringify(manifest)
-
-  for (const [token, value] of Object.entries(ManifestReplaceableTokens(xnsNodeUrl, xnsNetwork))) {
-    stringifiedManifestReplaced = stringifiedManifestReplaced.replaceAll(token, value)
-  }
-
-  return JSON.parse(stringifiedManifestReplaced)
-}