@xyo-network/os-runtime 3.0.9 → 3.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/os-runtime",
-  "version": "3.0.9",
+  "version": "3.0.11",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -39,16 +39,17 @@
     "@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.9",
-    "@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.9",
-    "@xyo-network/kernel-model": "^3.0.9",
+    "@xyo-network/bios": "^3.0.11",
+    "@xyo-network/bios-model": "^3.0.11",
+    "@xyo-network/bridge-model": "^3.0.5",
+    "@xyo-network/diviner-abstract": "^3.0.5",
+    "@xyo-network/diviner-model": "^3.0.5",
+    "@xyo-network/diviner-payload-generic": "^3.0.5",
+    "@xyo-network/diviner-payload-indexeddb": "^3.0.5",
+    "@xyo-network/diviner-payload-model": "^3.0.5",
+    "@xyo-network/diviner-temporal-indexing-model": "^3.0.5",
+    "@xyo-network/kernel": "^3.0.11",
+    "@xyo-network/kernel-model": "^3.0.11",
     "@xyo-network/manifest": "^3.0.7",
     "@xyo-network/manifest-wrapper": "^3.0.7",
     "@xyo-network/module-abstract": "^3.0.7",
@@ -57,7 +58,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.9",
+    "@xyo-network/os-model": "^3.0.11",
     "@xyo-network/payload-builder": "^3.0.7",
     "@xyo-network/payload-model": "^3.0.7",
     "@xyo-network/wallet-model": "^3.0.7",
@@ -71,7 +72,7 @@
     "@types/uuid": "^10.0.0",
     "@xylabs/ts-scripts-yarn3": "^4.0.0",
     "@xylabs/tsconfig": "^4.0.0",
-    "@xyo-network/bios-nodejs": "^3.0.9",
+    "@xyo-network/bios-nodejs": "^3.0.11",
     "typescript": "^5.5.4",
     "vitest": "^2.0.5"
   },

package/src/XyOs.ts

@@ -10,6 +10,7 @@ import type {
   DappId,
   DappPackageManifestPayload,
   DappParams,
+  SignersExternal,
   StackInitializer,
   XyOsContext,
   XyOsDappContext,
@@ -17,13 +18,14 @@ import type {
 } from '@xyo-network/os-model'
 import type { WalletInstance } from '@xyo-network/wallet-model'
 
+import { Signers } from './classes/index.ts'
 import type { DappRegistrationServiceParams } from './classes/registration/index.ts'
 import { DappRegistrationService } from './classes/registration/index.ts'
 import { EventBus } from './event/index.ts'
 import type { MonitorEventConfig, XyOsMonitor } from './helpers/index.ts'
 import { NameTransforms } from './lib/index.ts'
 import { loadOsNode } from './loadOsNode.ts'
-import type { OsPubSubNetworkStack } from './stack/index.ts'
+import type { OsPubSubNetworkStack, UninitializedStackMap } from './stack/index.ts'
 import { OsStackMap, StackManager } from './stack/index.ts'
 import type { XyOsContextParams } from './XyOsBase.ts'
 import { XyOsContextBase } from './XyOsBase.ts'
@@ -32,6 +34,7 @@ export interface XyOsParams<TManifest extends PackageManifest = PackageManifest>
   dappsConfiguration?: DappRegistrationServiceParams
   developmentMode?: boolean
   kernel?: XyOsContext['kernel']
+  stackMap?: UninitializedStackMap
 }
 
 export class XyOs extends XyOsContextBase<XyOsParams> implements XyOsContext {
@@ -40,18 +43,26 @@ export class XyOs extends XyOsContextBase<XyOsParams> implements XyOsContext {
   protected _kernel: KernelExternal
   protected _locator: ModuleFactoryLocator
   protected dappRegistrationService: DappRegistrationService
+  protected signers: SignersExternal | undefined
   private stackManager: StackManager
 
   constructor({
-    eventBus = new EventBus(), kernel = new Kernel(), locator = new ModuleFactoryLocator(), dappsConfiguration, developmentMode, ...params
+    eventBus = new EventBus(),
+    kernel = new Kernel(),
+    locator = new ModuleFactoryLocator(),
+    dappsConfiguration,
+    developmentMode,
+    stackMap = OsStackMap,
+    ...params
   }: XyOsParams = {}) {
     super({
       eventBus, kernel, locator, ...params,
     })
     this._locator = locator
     this._kernel = kernel
-    this.stackManager = new StackManager(OsStackMap)
+    this.stackManager = new StackManager(stackMap)
     this.dappRegistrationService = new DappRegistrationService(this, dappsConfiguration, this.locator, developmentMode)
+    if (this.signerPaths && this.kernel?.bios?.seedPhraseStore) this.signers = new Signers(this.signerPaths, this.kernel?.bios?.seedPhraseStore)
   }
 
   static get monitoring(): XyOsMonitor | undefined {
@@ -82,6 +93,14 @@ export class XyOs extends XyOsContextBase<XyOsParams> implements XyOsContext {
     return this._locator
   }
 
+  get stacks() {
+    return this.stackManager.stacks
+  }
+
+  override get user() {
+    return { signers: this.signers?.getWalletKindSigner('user') }
+  }
+
   static async monitor<T>(fn: () => Promise<T>, eventConfig: MonitorEventConfig): Promise<T> {
     const { name, additionalProperties } = eventConfig
     const monitor = this.monitoring
@@ -108,6 +127,7 @@ export class XyOs extends XyOsContextBase<XyOsParams> implements XyOsContext {
       this._root = root
 
       this.stackManager.initialize(this)
+      if (this.signers) await this.signers.initialize()
     })
   }
 

package/src/XyOsBase.ts

@@ -8,7 +8,8 @@ import { BaseEmitter } from '@xyo-network/module-abstract'
 import { ModuleFactoryLocator } from '@xyo-network/module-factory-locator'
 import type { NodeInstance } from '@xyo-network/node-model'
 import type {
-  DappId, DappPackageManifestPayload, DappParams, EventBusInterface, StackInitializer, XyOsContext, XyOsDappContext,
+  DappId, DappPackageManifestPayload, DappParams, EventBusInterface, OsUser,
+  StackInitializer, WalletKindSignerPaths, XyOsContext, XyOsDappContext,
 } from '@xyo-network/os-model'
 import { Mutex } from 'async-mutex'
 
@@ -17,6 +18,7 @@ export interface XyOsContextParams<TManifest extends PackageManifest = PackageMa
   locator?: ModuleFactoryLocator
   manifest?: TManifest
   platformLocator?: ModuleFactoryLocator
+  signerPaths?: WalletKindSignerPaths
 }
 
 export class XyOsContextBase<TParams extends XyOsContextParams | void = void> extends BaseEmitter<
@@ -71,10 +73,18 @@ export class XyOsContextBase<TParams extends XyOsContextParams | void = void> ex
     return []
   }
 
+  get signerPaths() {
+    return this.params.signerPaths
+  }
+
   get state() {
     return this._root ? 'running' : 'stopped'
   }
 
+  get user(): OsUser {
+    throw new Error('Method not implemented. [user]')
+  }
+
   boot(_wallet: WalletInstance, _locator: ModuleFactoryLocator) {
     throw new Error('Method not implemented. [boot]')
   }

package/src/XyOsDapp.ts

@@ -3,7 +3,7 @@ import type { WalletInstance } from '@xyo-network/account'
 import { ManifestWrapper } from '@xyo-network/manifest-wrapper'
 import { ModuleFactoryLocator } from '@xyo-network/module-factory-locator'
 import type {
-  DappPackageManifestPayload, XyOsContext, XyOsDappContext, XyOsDappDetails,
+  DappPackageManifestPayload, OsUser, XyOsContext, XyOsDappContext, XyOsDappDetails,
 } from '@xyo-network/os-model'
 import { DappPackageManifestPayloadSchema } from '@xyo-network/os-model'
 
@@ -15,6 +15,7 @@ export interface XyOsDappContextParams extends XyOsContextParams<DappPackageMani
   dapp: XyOsDappDetails
   locator: ModuleFactoryLocator
   parent: XyOsContext
+  user: OsUser
 }
 
 export class XyOsDapp extends XyOsContextBase<XyOsDappContextParams> implements XyOsDappContext {
@@ -52,6 +53,14 @@ export class XyOsDapp extends XyOsContextBase<XyOsDappContextParams> implements
     return this.params.parent
   }
 
+  get stacks() {
+    return []
+  }
+
+  override get user() {
+    return this.params.user
+  }
+
   override async boot(wallet: WalletInstance, locator?: ModuleFactoryLocator): Promise<void> {
     return await this._bootMutex.runExclusive(async () => {
       console.log('XyOsDapp:boot:start', wallet.address, this.dapp.id)

package/src/classes/index.ts

@@ -5,4 +5,5 @@ export * from './menu/index.ts'
 export * from './node/index.ts'
 export * from './registration/index.ts'
 export * from './settings/index.ts'
+export * from './signer/index.ts'
 export * from './system/index.ts'

package/src/classes/node/Creator.ts

@@ -62,7 +62,7 @@ export class DappContextCreator {
   // Reset the dapp archivist to remove all payloads
   static async resetDappArchivist(context: XyOsContext) {
     const dappModule = await context.root.resolve('DappArchivist')
-    const dappArchivist = assertEx(asArchivistInstance(dappModule), () => 'DappArchivist not found')
+    const dappArchivist = assertEx(asArchivistInstance(dappModule), () => 'resetDappArchivist: DappArchivist not found')
 
     await dappArchivist.clear()
   }

package/src/classes/registration/DappRegistrationService.ts

@@ -76,16 +76,17 @@ export class DappRegistrationService {
     this.addConnectionRequests()
   }
 
-  buildDapp(
+  async buildDapp(
     manifest: DappPackageManifestPayload,
     dappId = NameTransforms.slug(manifest.nodes[0]?.config.name),
     name = NameTransforms.moduleName(manifest.nodes[0]?.config.name),
-  ): Promisable<XyOsDappContext> {
+  ): Promise<XyOsDappContext> {
     const dapp = new XyOsDapp({
       dapp: { id: dappId, name },
       locator: this.locator,
       manifest,
       parent: this.context,
+      user: await this.getUser(),
     }) as XyOsDappContext
     this.builtDapps[dappId] = dapp
     return dapp
@@ -130,6 +131,14 @@ export class DappRegistrationService {
     this.context.eventBus.addConnection(this.exposeDappRequestConnection)
   }
 
+  /**
+   * A method to get the user property from context and eventually modify it before handing it to a dapp
+   * i.e. curating user-approved signers
+   */
+  private getUser(): Promisable<XyOsContext['user']> {
+    return this.context.user
+  }
+
   private async postRegistrationHandlers(registeredDapp: RegisteredDappSetResult) {
     if (registeredDapp.dapp) {
       if (isRegisteredDappExposedDappSet(registeredDapp)) {

package/src/classes/signer/Signers.ts

@@ -0,0 +1,73 @@
+import { assertEx } from '@xylabs/assert'
+import { type AccountInstance, HDWallet } from '@xyo-network/account'
+import type {
+  WalletKind,
+  WalletSeedPhraseStore,
+} from '@xyo-network/bios-model'
+import type {
+  SignerAccounts, SignersExternal, WalletKindSignerPaths,
+} from '@xyo-network/os-model'
+
+export class Signers implements SignersExternal {
+  private _paths: WalletKindSignerPaths
+  private _signerAccounts: Map<WalletKind, SignerAccounts>
+  private _walletStore: WalletSeedPhraseStore
+
+  constructor(paths: WalletKindSignerPaths, walletStore: WalletSeedPhraseStore) {
+    this._paths = paths
+    this._walletStore = walletStore
+    this._signerAccounts = new Map()
+  }
+
+  private get paths(): WalletKindSignerPaths {
+    return assertEx(this._paths, () => 'Paths not initialized')
+  }
+
+  private get signerAccounts(): Map<WalletKind, SignerAccounts> {
+    return assertEx(this._signerAccounts, () => 'Signer accounts not initialized')
+  }
+
+  private get walletStore(): WalletSeedPhraseStore {
+    return assertEx(this._walletStore, () => 'Wallet store not initialized')
+  }
+
+  getSigner(walletKind: WalletKind, signer: string): AccountInstance | undefined {
+    return this.signerAccounts.get(walletKind)?.get(signer)
+  }
+
+  getWalletKindSigner(walletKind: WalletKind): SignerAccounts | undefined {
+    return this.signerAccounts.get(walletKind)
+  }
+
+  async initialize() {
+    for (const [walletKindName, signerPaths] of this.paths) {
+      for (const [signerName, walletPath] of signerPaths.entries()) {
+        await this.initializeSigners(walletKindName, signerName, walletPath)
+      }
+    }
+  }
+
+  private async initializeSigners(walletKindName: WalletKind, signerName: string, path: string) {
+    // test if the name and path are valid
+    assertEx(signerName, () => 'Name not found in signer paths')
+    assertEx(path, () => 'Path not found in signer paths')
+
+    // test if the wallet exists
+    const phrase = assertEx(await this.walletStore.get(walletKindName), () => `Wallet not found: ${walletKindName}`)
+
+    if (path) {
+      // get the signer map for the wallet kind or create a new one
+      const signerMap = this.signerAccounts.get(walletKindName) ?? new Map()
+
+      // derive the wallet from the path
+      const wallet = await HDWallet.fromPhrase(phrase)
+      const derivedWallet = await wallet.derivePath(path)
+
+      // add the derived wallet to the signer map
+      signerMap.set(signerName, derivedWallet)
+
+      // set the signer map for the wallet kind
+      this.signerAccounts.set(walletKindName, signerMap)
+    }
+  }
+}

package/src/classes/signer/index.ts

@@ -0,0 +1 @@
+export * from './Signers.ts'

package/src/stack/Manager.ts

@@ -21,7 +21,11 @@ export class StackManager {
     this.stackMap = stackMap
   }
 
-  private get stacks() {
+  get stacks() {
+    return Object.keys(this.initializedStacksMap)
+  }
+
+  private get initializedStacks() {
     return this.initializedStacksMap
   }
 
@@ -31,15 +35,16 @@ export class StackManager {
 
   initialize(context: XyOsContext) {
     for (const [key, stackSet] of Object.entries(this.stackMap)) {
+      console.log('stack-initialize', key)
       const { stack: Stack, adapters: stackNodeModuleId } = stackSet
       const initializedStack = new Stack(context, stackNodeModuleId)
       initializedStack.initialize()
-      this.stacks.set(key, initializedStack)
+      this.initializedStacks.set(key, initializedStack)
     }
   }
 
   stop() {
-    for (const stack of this.stacks.values()) {
+    for (const stack of this.initializedStacks.values()) {
       stack.stop()
     }
   }