@xyo-network/os-runtime 7.2.1 → 7.3.1

package/src/initializer/DappInitializer.ts

@@ -1,57 +0,0 @@
-import { assertEx } from '@xylabs/sdk-js'
-import type {
-  RegisteredDapp, WindowDappNodeSet, XyOsContext,
-} from '@xyo-network/os-model'
-
-import { RunningDappCache } from '../RunningDappCache.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/initializer/index.ts

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

package/src/intent/Caller.ts

@@ -1,74 +0,0 @@
-import { PayloadDivinerQuerySchema } from '@xyo-network/diviner-payload-model'
-import type {
-  DappId, DappIntent, DappIntentTypes, XyOsContext,
-} from '@xyo-network/os-model'
-import { DappIntentSchema, DappMode } from '@xyo-network/os-model'
-import type { WithStorageMeta } from '@xyo-network/payload-model'
-
-import { DappCallerBase } from '../DappCallerBase.ts'
-
-export class DappIntentCaller extends DappCallerBase {
-  static OsDappName = 'XyOs'
-  constructor(context: XyOsContext) {
-    super(context)
-  }
-
-  /**
-   * Build a new intent
-   * @param sourceDappId
-   * @param intent
-   * @param targetDappId
-   * @param targetMode
-   * @param params?
-   * @returns DappIntent
-   */
-  static buildIntent(
-    sourceDappId: DappId,
-    intent: DappIntentTypes,
-    targetDappId?: DappId,
-    targetMode: DappMode = DappMode.Window,
-    params?: DappIntent['params'],
-  ): DappIntent {
-    return {
-      intent,
-      params: params || '',
-      schema: DappIntentSchema,
-      sourceDappId,
-      targetDappId,
-      targetMode: targetMode || DappMode.Window,
-      timestamp: Date.now(),
-    }
-  }
-
-  // Add a new intent
-  async addIntent(id: DappId, intent: DappIntentTypes, mode: DappMode) {
-    const intentArchivist = await this.getDappIntentArchivist()
-    const newIntent = DappIntentCaller.buildIntent(id, intent, mode)
-    await intentArchivist.insert([newIntent])
-  }
-
-  // Get all intents
-  async allIntents() {
-    const archivist = await this.getDappIntentArchivist()
-    return await archivist.all()
-  }
-
-  // Get the latest intent saved to the archivist
-  async latestIntent() {
-    const archivist = await this.getDappIntentArchivist()
-    return (await archivist.all()).at(-1) as WithStorageMeta<DappIntent>
-  }
-
-  // Get the latest intent for a dapp
-  async latestIntentForDappName(dappName: DappId) {
-    const diviner = await this.getDappIntentArchivistPayloadDiviner()
-    const query = {
-      limit: 1,
-      order: 'desc',
-      schema: PayloadDivinerQuerySchema,
-      sourceDappId: dappName,
-    }
-
-    return (await diviner.divine([query])) as DappIntent[]
-  }
-}

package/src/intent/Resource.ts

@@ -1,66 +0,0 @@
-import { assertEx } from '@xylabs/sdk-js'
-import type { DappIntent, XyOsContext } from '@xyo-network/os-model'
-import { isDappIntent } from '@xyo-network/os-model'
-import type { WithSources, WithStorageMeta } from '@xyo-network/payload-model'
-
-import { DappCallerBase } from '../DappCallerBase.ts'
-import type { Listener, ResourceStore } from '../lib/index.ts'
-import { PayloadStore } from '../lib/index.ts'
-
-export type DappIntentViews = 'latestDappIntent' | 'allDappIntents'
-const NO_RESULTS: [] = []
-
-export class DappIntentResource extends DappCallerBase implements ResourceStore<DappIntentViews> {
-  private _allDappIntents: PayloadStore<DappIntent> | undefined
-  private _latestDappIntent: PayloadStore<DappIntent> | undefined
-
-  constructor(context: XyOsContext) {
-    super(context)
-  }
-
-  get allDappIntents() {
-    return assertEx(this._allDappIntents, () => 'allDappIntents not set')
-  }
-
-  get latestDappIntent() {
-    return assertEx(this._latestDappIntent, () => 'latestDappIntent not set')
-  }
-
-  get subscriptions() {
-    return {
-      allDappIntents: (cb: Listener) => this.allDappIntents.subscribe(cb),
-      latestDappIntent: (cb: Listener) => this.latestDappIntent.subscribe(cb),
-    }
-  }
-
-  get views() {
-    return {
-      allDappIntents: () => this.allDappIntents.getSnapshot(),
-      latestDappIntent: () => this.latestDappIntent.getSnapshot(),
-    }
-  }
-
-  cleanupListeners() {
-    this.latestDappIntent.cleanupListeners()
-    this.allDappIntents.cleanupListeners()
-  }
-
-  async start() {
-    const archivist = await this.getDappIntentArchivist()
-
-    this._allDappIntents = await PayloadStore.create<DappIntent>({
-      archivist,
-      getLatest: async () => (await archivist.all()) as WithStorageMeta<WithSources<DappIntent>>[],
-      idFunction: isDappIntent,
-    })
-    this._latestDappIntent = await PayloadStore.create<DappIntent>({
-      archivist,
-      getLatest: async () => {
-        const all = await archivist.all()
-        const result = all.length > 0 ? [all.at(-1)] : NO_RESULTS
-        return result as WithStorageMeta<WithSources<DappIntent>>[]
-      },
-      idFunction: isDappIntent,
-    })
-  }
-}

package/src/intent/index.ts

@@ -1,2 +0,0 @@
-export * from './Caller.ts'
-export * from './Resource.ts'

package/src/lib/ExternalStore.ts

@@ -1,7 +0,0 @@
-import type { Payload } from '@xyo-network/payload-model'
-
-export interface ExternalStore<T extends Payload = Payload> {
-  getSnapshot: () => T[]
-  latest: T[]
-  subscribe: (onStoreChange: () => void) => () => void
-}

package/src/lib/Listener.ts

@@ -1 +0,0 @@
-export type Listener = (...args: Array<unknown>) => void

package/src/lib/ModuleAccountPaths.ts

@@ -1,23 +0,0 @@
-import { DevelopArchivist, NodeSentinel } from './ModuleNames.ts'
-
-export const RemoteNodeArchivistOffsetPaths: Record<string, Record<string, string>> = {
-  Kerplunk: { [DevelopArchivist]: '118' },
-  Local: { [DevelopArchivist]: '115' },
-  Main: { [DevelopArchivist]: '121' },
-}
-
-export const ModuleOffsetPaths: Record<string, string> = {
-  IdWitness: '1',
-  DomainWitness: '2',
-  LocationWitness: '3',
-  SchemaWitness: '4',
-  CryptoCardsGameWitness: '5',
-  CryptoCardsMoveWitness: '6',
-  EthereumGasEtherchainV2Witness: '7',
-  CoingeckoCryptoMarketWitness: '8',
-  UniswapCryptoMarketWitness: '9',
-  EthereumGasEtherscanWitness: '10',
-  [NodeSentinel]: '11',
-  [DevelopArchivist]: '12',
-  BowserSystemInfoPluginWitness: '13',
-}

package/src/lib/ModuleNames.ts

@@ -1,3 +0,0 @@
-export const DevelopArchivist = 'DevelopArchivist'
-
-export const NodeSentinel = 'NodeSentinel'

package/src/lib/NameTransforms.ts

@@ -1,34 +0,0 @@
-export class NameTransforms {
-  private value: string
-  constructor(value: string) {
-    this.value = value
-  }
-
-  static deSlug(value: string) {
-    return value
-      .replaceAll('-', ' ')
-      .split(' ')
-      .map(word => word.charAt(0).toUpperCase() + word.slice(1))
-      .join(' ')
-  }
-
-  static moduleName(value: string) {
-    return value.replaceAll(' ', '')
-  }
-
-  static slug(value: string) {
-    return value.replaceAll(' ', '-').toLocaleLowerCase()
-  }
-
-  deSlug() {
-    return NameTransforms.deSlug(this.value)
-  }
-
-  moduleName() {
-    return NameTransforms.moduleName(this.value)
-  }
-
-  slug() {
-    return NameTransforms.slug(this.value)
-  }
-}

package/src/lib/PayloadStore.ts

@@ -1,105 +0,0 @@
-import type { ArchivistInstance, ArchivistModuleEventData } from '@xyo-network/archivist'
-import type { Payload } from '@xyo-network/payload-model'
-
-import type { ExternalStore } from './ExternalStore.ts'
-import { isEqual } from './isEqual.ts'
-import type { Listener } from './Listener.ts'
-
-export interface PayloadStoreConfig<T extends Payload = Payload> {
-  archivist: ArchivistInstance
-  getLatest: () => Promise<T[]>
-  idFunction: (schema: Payload) => boolean
-}
-
-export class PayloadStore<T extends Payload = Payload> implements ExternalStore {
-  latest: T[] = []
-  private archivist: ArchivistInstance
-  private deleteListeners: WeakRef<(args: ArchivistModuleEventData['deleted']) => void>[] = []
-  private insertListeners: WeakRef<(args: ArchivistModuleEventData['inserted']) => void>[] = []
-  private listeners: Listener[] = []
-
-  private constructor(archivist: ArchivistInstance) {
-    this.archivist = archivist
-  }
-
-  /**
-   * Initialize listeners on the archivist that update class member variables when new payloads are inserted
-   */
-  static async create<T extends Payload = Payload>({
-    archivist, getLatest, idFunction,
-  }: PayloadStoreConfig<T>) {
-    const instance = new this<T>(archivist)
-
-    const insertListener = async ({ payloads }: ArchivistModuleEventData['inserted']) => {
-      // if any of the newly inserted payloads pass the idFunction check, rerun the query
-      if (payloads.some(idFunction)) {
-        const latest = await getLatest()
-        if (isEqual(latest, instance.latest)) return
-        instance.latest = latest
-        instance.emitChange()
-      }
-    }
-
-    // when payloads are deleted, rerun the diviner query
-    const deleteListener = async () => {
-      instance.latest = await getLatest()
-      instance.emitChange()
-    }
-
-    const weakRefInsertListener = new WeakRef(insertListener)
-    const weakRefDeleteListener = new WeakRef(deleteListener)
-    const insertListenerRef = weakRefInsertListener.deref()
-    const deleteListenerRef = weakRefDeleteListener.deref()
-
-    if (insertListenerRef) instance.archivist.on('inserted', insertListenerRef)
-    if (deleteListenerRef) instance.archivist.on('deleted', deleteListenerRef)
-
-    instance.insertListeners.push(weakRefInsertListener)
-    instance.deleteListeners.push(weakRefDeleteListener)
-
-    instance.latest = await getLatest()
-    return instance
-  }
-
-  /**
-   * Remove all listeners and reset their class members
-   */
-  cleanupListeners() {
-    this.removeListeners(this.insertListeners, 'inserted')
-    this.removeListeners(this.deleteListeners, 'deleted')
-    this.insertListeners = []
-    this.deleteListeners = []
-  }
-
-  /**
-   * Get the current value of the store
-   */
-  getSnapshot(): T[] {
-    return this.latest
-  }
-
-  /**
-   * Add a call back function that is invoked when new Payloads are inserted
-   * @param onStoreChange
-   */
-  subscribe(onStoreChange: Listener) {
-    this.listeners.push(onStoreChange)
-    return () => {
-      this.listeners = this.listeners.filter(l => l !== onStoreChange)
-    }
-  }
-
-  private emitChange() {
-    for (const listener of this.listeners) {
-      listener()
-    }
-  }
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  private removeListeners(listeners: WeakRef<(args: any) => void>[], eventName: string) {
-    for (const listener of listeners) {
-      const listenerRef = listener.deref()
-      if (listenerRef) this.archivist.off(eventName, listenerRef)
-    }
-  }
-}

package/src/lib/ResourceStores.ts

@@ -1,7 +0,0 @@
-import type { ExternalStore } from './ExternalStore.ts'
-
-export interface ResourceStore<Name extends string = string> {
-  cleanupListeners: () => void
-  subscriptions: Record<Name, ExternalStore['subscribe']>
-  views: Record<Name, ExternalStore['getSnapshot']>
-}

package/src/lib/index.ts

@@ -1,11 +0,0 @@
-export * from './ExternalStore.ts'
-export * from './initializeXns.ts'
-export * from './isEqual.ts'
-export * from './isPayload.ts'
-export * from './Listener.ts'
-export * from './ModuleAccountPaths.ts'
-export * from './ModuleNames.ts'
-export * from './NameTransforms.ts'
-export * from './PayloadStore.ts'
-export * from './ResourceStores.ts'
-export * from './tokenPlacesSplit.ts'

package/src/lib/initializeXns.ts

@@ -1,16 +0,0 @@
-import { asDivinerInstance } from '@xyo-network/diviner-model'
-import { ResolveHelper } from '@xyo-network/module-model'
-import { NameRegistrarTransformer } from '@xyo-network/module-resolver'
-import type { NodeInstance } from '@xyo-network/node-model'
-
-export const initializeXns = async (xnsNode: NodeInstance) => {
-  if (ResolveHelper.transformers.length === 0) {
-    const registrarDiviner = asDivinerInstance(await xnsNode?.resolve('AddressRecords:AddressRecordIndexDiviner'))
-    if (registrarDiviner) {
-      const transformer = new NameRegistrarTransformer(registrarDiviner, 'xyo')
-      ResolveHelper.transformers = [transformer]
-      return true
-    }
-  }
-  return false
-}

package/src/lib/isEqual.ts

@@ -1,42 +0,0 @@
-import { isObject } from '@xylabs/sdk-js'
-
-export function isEqual(a: unknown, b: unknown): boolean {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  if ((a as any) === (b as any)) return true
-
-  if (typeof a !== typeof b) return false
-
-  if (isObject(a) && isObject(b)) {
-    const aKeys = Object.keys(a)
-    const bKeys = Object.keys(b)
-
-    if (aKeys.length !== bKeys.length) {
-      return false
-    }
-
-    for (const key of aKeys) {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      if (!b.hasOwnProperty(key) || !isEqual((a as any)[key], (b as any)[key])) {
-        return false
-      }
-    }
-
-    return true
-  }
-
-  if (Array.isArray(a) && Array.isArray(b)) {
-    if (a.length !== b.length) {
-      return false
-    }
-
-    for (const [i, element] of a.entries()) {
-      if (!isEqual(element, b[i])) {
-        return false
-      }
-    }
-
-    return true
-  }
-
-  return false
-}

package/src/lib/isPayload.ts

@@ -1,24 +0,0 @@
-import { AsObjectFactory } from '@xylabs/sdk-js'
-import type { Payload, Schema } from '@xyo-network/payload-model'
-
-export const isObject = (x: unknown): x is Record<string | symbol | number, unknown> => {
-  return typeof x === 'object' && !Array.isArray(x)
-}
-
-export const isAnyPayload = (obj: unknown): obj is Payload => {
-  if (isObject(obj)) {
-    return typeof obj.schema === 'string'
-  }
-  return false
-}
-
-export const isPayload
-  = <T extends Payload>(schema: Schema[]) =>
-    (obj: unknown): obj is T => {
-      if (isAnyPayload(obj)) {
-        return schema.includes(obj.schema)
-      }
-      return false
-    }
-
-export const asPayload = <T extends Payload>(schema: Schema[]) => AsObjectFactory.create(isPayload<T>(schema))

package/src/lib/tokenPlacesSplit.ts

@@ -1,17 +0,0 @@
-import { assertEx } from '@xylabs/sdk-js'
-
-export const tokenPlacesSplit = (value: bigint, places: number): [bigint, bigint] => {
-  assertEx(places >= 0, () => 'Places has to be >= 0')
-  const factor = BigInt(10 ** Math.abs(places))
-  const remainder = value % factor
-  const wholeValue = value / factor
-  return [wholeValue, remainder]
-}
-
-export const tokenPlacesSplitString = (value: bigint | undefined, places: number): string => {
-  if (value === undefined) {
-    return '-'
-  }
-  const [wholeValue, remainder] = tokenPlacesSplit(value, places)
-  return `${wholeValue}.${remainder.toString().padStart(Math.abs(places), '0')}`
-}

package/src/loadOsNode.ts

@@ -1,44 +0,0 @@
-import { IndexedDbArchivist } from '@xyo-network/archivist-indexeddb'
-import { IndexedDbPayloadDiviner } from '@xyo-network/diviner-payload-indexeddb'
-import type { PackageManifestPayload } from '@xyo-network/manifest'
-import { ManifestWrapper } from '@xyo-network/manifest-wrapper'
-import { ModuleFactoryLocator } from '@xyo-network/module-factory-locator'
-import type { ModuleFactoryLocatorInstance } from '@xyo-network/module-model'
-import type { AttachableNodeInstance } from '@xyo-network/node-model'
-import type { WalletInstance } from '@xyo-network/wallet-model'
-
-import { osNodeManifest } from './manifest/index.ts'
-
-// NOTE: Path "0'" is reserved for the exposed node in the kernel
-const OS_NODE_PATH = "1'"
-
-const getDefaultOsNodeLocator = (): ModuleFactoryLocator => {
-  const locator = new ModuleFactoryLocator()
-  locator.register(IndexedDbArchivist.factory(), { 'network.xyo.archivist.persistence.scope': 'device' })
-  locator.register(IndexedDbPayloadDiviner.factory(), { 'network.xyo.archivist.persistence.scope': 'device' })
-  return locator
-}
-
-export const loadOsNode = async (
-  osWallet: WalletInstance,
-  locator?: ModuleFactoryLocatorInstance,
-): Promise<[AttachableNodeInstance]> => {
-  try {
-    // Create wallets for the OS & kernel nodes
-    const osNodeWallet = await osWallet.derivePath(OS_NODE_PATH)
-
-    // Create the OS node manifest
-    const osNodeLocator: ModuleFactoryLocatorInstance = locator ?? getDefaultOsNodeLocator()
-    const manifestWrapper = new ManifestWrapper(osNodeManifest as unknown as PackageManifestPayload, osNodeWallet, osNodeLocator)
-
-    // Create the OS & kernel nodes
-    const osNode = (await manifestWrapper.loadNodes())[0]
-
-    return [osNode]
-  } catch (e) {
-    const error = e as Error
-    console.error(`Error creating os node: ${error.message}`)
-    console.error(`Error creating os node: ${error.stack}`)
-    throw new Error(`Error creating os node: ${error.message}`)
-  }
-}

package/src/manifest/index.ts

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

package/src/manifest/manifestReplacementTokens.ts

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