@xyo-network/module-abstract 2.95.2 → 2.95.4

package/src/AbstractModule.ts

@@ -16,7 +16,7 @@ import { BoundWitnessBuilder, QueryBoundWitnessBuilder } from '@xyo-network/boun
 import { BoundWitness, QueryBoundWitness } from '@xyo-network/boundwitness-model'
 import { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'
 import { ConfigPayload, ConfigSchema } from '@xyo-network/config-payload-plugin'
-import { ModuleManifestPayload, ModuleManifestPayloadSchema } from '@xyo-network/manifest-model'
+import { ModuleManifestPayload } from '@xyo-network/manifest-model'
 import {
   AddressPreviousHashPayload,
   AddressPreviousHashSchema,
@@ -35,7 +35,6 @@ import {
   ModuleEventData,
   ModuleFactory,
   ModuleManifestQuerySchema,
-  ModuleName,
   ModuleParams,
   ModuleQueriedEventArgs,
   ModuleQueries,
@@ -133,6 +132,10 @@ export abstract class AbstractModule<TParams extends ModuleParams = ModuleParams
     return this.config.archiving
   }
 
+  get archivist() {
+    return this.config.archivist
+  }
+
   get config(): TParams['config'] {
     return this.params.config
   }
@@ -441,6 +444,23 @@ export abstract class AbstractModule<TParams extends ModuleParams = ModuleParams
     assertEx(thisFunc === rootFunc, () => `Override not allowed for [${functionName}] - override ${functionName}Handler instead`)
   }
 
+  protected async archivistInstance(): Promise<ArchivistInstance | undefined>
+  protected async archivistInstance(required: true): Promise<ArchivistInstance>
+  protected async archivistInstance(required = false): Promise<ArchivistInstance | undefined> {
+    const archivist = this.archivist
+    if (!archivist) {
+      if (required) {
+        throw new Error('No archivist specified')
+      }
+      return undefined
+    }
+    const resolved = (await this.upResolver.resolve(archivist)) ?? (await this.downResolver.resolve(archivist))
+    if (required) {
+      assertEx(resolved, () => `Unable to resolve archivist [${archivist}]`)
+    }
+    return resolved ? asArchivistInstance(resolved, () => `Specified archivist is not an Archivist [${archivist}]`) : undefined
+  }
+
   protected bindHashes(hashes: Hash[], schema: Schema[], account?: AccountInstance) {
     // eslint-disable-next-line @typescript-eslint/no-misused-promises
     const promise = new PromiseEx((resolve) => {
@@ -542,10 +562,9 @@ export abstract class AbstractModule<TParams extends ModuleParams = ModuleParams
     return description
   }
 
+  /** @deprecated use archivistInstance() instead */
   protected async getArchivist(): Promise<ArchivistInstance | undefined> {
-    if (!this.config.archivist) return undefined
-    const resolved = await this.upResolver.resolve(this.config.archivist)
-    return asArchivistInstance(resolved)
+    return await this.archivistInstance()
   }
 
   protected async initializeQueryAccounts() {
@@ -568,26 +587,8 @@ export abstract class AbstractModule<TParams extends ModuleParams = ModuleParams
     }
   }
 
-  protected async manifestHandler(maxDepth: number = 1, _ignoreAddresses: Address[] = []): Promise<ModuleManifestPayload> {
-    const cachedResult = this._cachedManifests.get(maxDepth)
-    if (cachedResult) {
-      return cachedResult
-    }
-    const name = this.config.name ?? 'Anonymous'
-    const children = await this.downResolver.resolve('*', { direction: 'down', maxDepth })
-    const childAddressToName: Record<Address, ModuleName | null> = {}
-    for (const child of children) {
-      if (child.address !== this.address) {
-        childAddressToName[child.address] = child.config.name ?? null
-      }
-    }
-    const result = {
-      config: { name, ...this.config },
-      schema: ModuleManifestPayloadSchema,
-      status: { address: this.address, children: childAddressToName },
-    }
-    this._cachedManifests.set(maxDepth, result)
-    return result
+  protected manifestHandler(_maxDepth: number = 1, _ignoreAddresses: Address[] = []): Promisable<ModuleManifestPayload> {
+    throw new Error('Not supported')
   }
 
   protected moduleAddressHandler(): Promisable<AddressPreviousHashPayload[]> {

package/src/AbstractModuleInstance.ts

@@ -5,7 +5,7 @@ import { globallyUnique } from '@xylabs/object'
 import { Promisable } from '@xylabs/promise'
 import { AccountInstance } from '@xyo-network/account-model'
 import { ArchivistInstance, asArchivistInstance } from '@xyo-network/archivist-model'
-import { ModuleManifestPayload } from '@xyo-network/manifest-model'
+import { ModuleManifestPayload, ModuleManifestPayloadSchema } from '@xyo-network/manifest-model'
 import {
   AddressPreviousHashPayload,
   duplicateModules,
@@ -16,6 +16,7 @@ import {
   ModuleInstance,
   ModuleManifestQuery,
   ModuleManifestQuerySchema,
+  ModuleName,
   ModuleNameResolver,
   ModuleParams,
   ModuleQueryResult,
@@ -223,6 +224,28 @@ export abstract class AbstractModuleInstance<TParams extends ModuleParams = Modu
     return this.subscribeHandler()
   }
 
+  protected override async manifestHandler(maxDepth: number = 1, _ignoreAddresses: Address[] = []): Promise<ModuleManifestPayload> {
+    const cachedResult = this._cachedManifests.get(maxDepth)
+    if (cachedResult) {
+      return cachedResult
+    }
+    const name = this.config.name ?? 'Anonymous'
+    const children = await this.publicChildren()
+    const childAddressToName: Record<Address, ModuleName | null> = {}
+    for (const child of children) {
+      if (child.address !== this.address) {
+        childAddressToName[child.address] = child.config.name ?? null
+      }
+    }
+    const result = {
+      config: { name, ...this.config },
+      schema: ModuleManifestPayloadSchema,
+      status: { address: this.address, children: childAddressToName },
+    }
+    this._cachedManifests.set(maxDepth, result)
+    return result
+  }
+
   protected async resolveArchivingArchivists(): Promise<ArchivistInstance[]> {
     const archivists = this.config.archiving?.archivists
     if (!archivists) return []