@xyo-network/os-runtime 4.2.10 → 4.2.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/os-runtime",
-  "version": "4.2.10",
+  "version": "4.2.12",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -46,7 +46,7 @@
     "@xyo-network/archivist": "^3.6.9",
     "@xyo-network/archivist-indexeddb": "^3.6.9",
     "@xyo-network/archivist-model": "^3.6.9",
-    "@xyo-network/bios": "^4.2.10",
+    "@xyo-network/bios": "^4.2.12",
     "@xyo-network/bridge-model": "^3.6.9",
     "@xyo-network/diviner-abstract": "^3.6.9",
     "@xyo-network/diviner-model": "^3.6.9",
@@ -54,8 +54,8 @@
     "@xyo-network/diviner-payload-indexeddb": "^3.6.9",
     "@xyo-network/diviner-payload-model": "^3.6.9",
     "@xyo-network/diviner-temporal-indexing-model": "^3.6.9",
-    "@xyo-network/kernel": "^4.2.10",
-    "@xyo-network/kernel-model": "^4.2.10",
+    "@xyo-network/kernel": "^4.2.12",
+    "@xyo-network/kernel-model": "^4.2.12",
     "@xyo-network/manifest": "^3.6.9",
     "@xyo-network/manifest-wrapper": "^3.6.9",
     "@xyo-network/module-event-emitter": "^3.6.9",
@@ -64,10 +64,10 @@
     "@xyo-network/module-model": "^3.6.9",
     "@xyo-network/module-resolver": "^3.6.9",
     "@xyo-network/node-model": "^3.6.9",
-    "@xyo-network/os-model": "^4.2.10",
+    "@xyo-network/os-model": "^4.2.12",
     "@xyo-network/payload-builder": "^3.6.9",
     "@xyo-network/payload-model": "^3.6.9",
-    "@xyo-network/storage-model": "^4.2.10",
+    "@xyo-network/storage-model": "^4.2.12",
     "@xyo-network/wallet-model": "^3.6.9",
     "async-mutex": "^0.5.0",
     "chalk": "^5.4.1",
@@ -88,8 +88,8 @@
     "@types/yargs": "^17.0.33",
     "@xylabs/ts-scripts-yarn3": "^4.2.6",
     "@xylabs/tsconfig": "^4.2.6",
-    "@xyo-network/bios-model": "^4.2.10",
-    "@xyo-network/bios-nodejs": "^4.2.10",
+    "@xyo-network/bios-model": "^4.2.12",
+    "@xyo-network/bios-nodejs": "^4.2.12",
     "vitest": "^2.1.8"
   },
   "publishConfig": {

package/src/helpers/DappInitializer.ts

@@ -0,0 +1,57 @@
+import { assertEx } from '@xylabs/assert'
+import type {
+  RegisteredDapp, WindowDappNodeSet, XyOsContext,
+} from '@xyo-network/os-model'
+
+import { RunningDappCache } from '../classes/index.ts'
+import { DappSeedPhraseRepository } from '../wallet/index.ts'
+
+/** Helper class to simulate full dapp initialization by the OS  */
+export interface DappInitializerConfig<T extends RegisteredDapp = RegisteredDapp> {
+  allowedNames: string[]
+  dapp: T
+  xnsNetwork: string | undefined
+  xnsNodeUrl: string | undefined
+  xyOs: XyOsContext
+}
+
+export class DappInitializer<T extends RegisteredDapp = RegisteredDapp> {
+  private _config: DappInitializerConfig
+
+  constructor(config: DappInitializerConfig) {
+    this._config = config
+  }
+
+  get config() {
+    return assertEx(this._config, () => new Error('Options not set'))
+  }
+
+  async install(): Promise<WindowDappNodeSet> {
+    const dappWithWalletId = await this.installDappWallet()
+
+    return await this.initializeDappContext(dappWithWalletId)
+  }
+
+  private async initializeDappContext(dappWithWalletId: T): Promise<WindowDappNodeSet> {
+    const {
+      allowedNames, xnsNetwork, xnsNodeUrl, xyOs,
+    } = this.config
+
+    return await RunningDappCache.findOrCreate(dappWithWalletId, xyOs, allowedNames ?? [], xnsNodeUrl, xnsNetwork)
+  }
+
+  private async installDappWallet(): Promise<T> {
+    const { xyOs, dapp } = this.config
+    const dappSeedPhraseRepository = new DappSeedPhraseRepository(xyOs, [dapp.config.name])
+    const walletId = await dappSeedPhraseRepository.findOrCreate(dapp.config.name)
+
+    // Update the dapp with the walletId
+    return {
+      ...dapp,
+      config: {
+        ...dapp.config,
+        walletId,
+      },
+    } as T
+  }
+}

package/src/helpers/index.ts

@@ -1 +1,2 @@
+export * from './DappInitializer.ts'
 export * from './monitor/index.ts'

package/src/spec/boot.test.ts

@@ -0,0 +1,89 @@
+import type { WalletInstance } from '@xyo-network/account'
+import { HDWallet } from '@xyo-network/account'
+import type { BiosExternalInterface } from '@xyo-network/bios-model'
+import { boot } from '@xyo-network/bios-nodejs'
+import { Kernel } from '@xyo-network/kernel'
+import type { KernelExternal } from '@xyo-network/kernel-model'
+import type { WalletKindSignerPaths } from '@xyo-network/os-model'
+import {
+  beforeEach,
+  describe, expect, test,
+} from 'vitest'
+
+import type { DappRegistrationServiceParams } from '../classes/index.ts'
+import { XyOs } from '../XyOs.ts'
+
+describe('os', () => {
+  let bios: BiosExternalInterface
+  let osWallet: WalletInstance
+  let kernel: KernelExternal
+
+  const testSigner0Path = '0/0'
+  const testSigner1Path = '0/1'
+  const userPaths = new Map([['testSigner0', testSigner0Path], ['testSigner1', testSigner1Path]])
+  const paths: WalletKindSignerPaths = new Map([['user', userPaths]])
+
+  beforeEach(async () => {
+    bios = await boot()
+    const osWalletSeedPhrase = await bios.seedPhraseStore.get('os')
+    osWallet = await HDWallet.fromPhrase(osWalletSeedPhrase as string)
+    kernel = new Kernel({ bios })
+  })
+
+  describe('boot', () => {
+    test('with default params', async () => {
+      const xyOs = new XyOs()
+      await xyOs.boot(osWallet)
+      expect(xyOs).toBeDefined()
+    })
+
+    test('with dapps', async () => {
+      const dappsConfiguration: DappRegistrationServiceParams = {
+        dappNames: ['testDapp'],
+        dappParams: {},
+        dappPayloads: [],
+      }
+
+      const xyOs = new XyOs({ dappsConfiguration })
+      await xyOs.boot(osWallet)
+      expect(xyOs).toBeDefined()
+    })
+
+    test('default stacks', async () => {
+      const bios = await boot()
+      const kernel = new Kernel()
+      await kernel.boot(bios)
+      const xyOs = new XyOs({ kernel })
+      expect(xyOs).toBeDefined()
+      if (xyOs) {
+        const osWalletSeedPhrase = await bios.seedPhraseStore.get('os')
+        expect(osWalletSeedPhrase).toBeDefined()
+        const osWallet = await HDWallet.fromPhrase(osWalletSeedPhrase as string)
+        expect(osWallet).toBeDefined()
+        await xyOs.boot(osWallet)
+      }
+    })
+
+    test('no stacks', async () => {
+      const xyOs = new XyOs({ stackMap: {} })
+      expect(xyOs).toBeDefined()
+      if (xyOs) {
+        await xyOs.boot(osWallet)
+      }
+    })
+
+    test('supports users signing', async () => {
+      const params = { kernel, signerPaths: paths }
+
+      const xyOs = new XyOs(params)
+
+      expect(xyOs).toBeDefined()
+
+      if (xyOs) {
+        await xyOs.boot(osWallet)
+        expect(xyOs.user).toBeDefined()
+        expect(xyOs.user.signers).toBeDefined()
+      }
+    })
+  })
+})